metadata-added-provenance

dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControl.java

@@ -45,6 +45,7 @@
 import org.dspace.app.util.DSpaceObjectUtilsImpl;
 import org.dspace.app.util.service.DSpaceObjectUtils;
 import org.dspace.authorize.AuthorizeException;
+import org.dspace.authorize.ResourcePolicy;
 import org.dspace.authorize.factory.AuthorizeServiceFactory;
 import org.dspace.authorize.service.ResourcePolicyService;
 import org.dspace.content.Bitstream;
@@ -55,6 +56,7 @@
 import org.dspace.content.service.ItemService;
 import org.dspace.core.Constants;
 import org.dspace.core.Context;
+import org.dspace.core.ProvenanceService;
 import org.dspace.discovery.DiscoverQuery;
 import org.dspace.discovery.SearchService;
 import org.dspace.discovery.SearchServiceException;
@@ -111,6 +113,8 @@ public class BulkAccessControl extends DSpaceRunnable<BulkAccessControlScriptCon
 
     protected String eperson = null;
 
+    protected ProvenanceService provenanceService = ContentServiceFactory.getInstance().getProvenanceService();
+
     @Override
     @SuppressWarnings("unchecked")
     public void setup() throws ParseException {
@@ -465,6 +469,7 @@ private void setItemPolicies(Item item, BulkAccessControlInput accessControl)
                 itemAccessConditions.get(accessCondition.getName())));
 
         itemService.adjustItemPolicies(context, item, item.getOwningCollection(), false);
+        provenanceService.setItemPolicies(context, item, accessControl);
     }
 
     /**
@@ -552,7 +557,10 @@ private void updateBitstreamPolicies(Bitstream bitstream, Item item, BulkAccessC
      */
     private void removeReadPolicies(DSpaceObject dso, String type) {
         try {
+            // Get all read policies of the dso before removing them
+            List<ResourcePolicy> resPolicies = resourcePolicyService.find(context, dso, type);
             resourcePolicyService.removePolicies(context, dso, type, Constants.READ);
+            provenanceService.removeReadPolicies(context, dso, resPolicies);
         } catch (SQLException | AuthorizeException e) {
             throw new BulkAccessControlException(e);
         }
@@ -580,6 +588,7 @@ private void setBitstreamPolicies(Bitstream bitstream, Item item, BulkAccessCont
 
         itemService.adjustBitstreamPolicies(context, item, item.getOwningCollection(), bitstream);
         mediaFilterService.updatePoliciesOfDerivativeBitstreams(context, item, bitstream);
+        provenanceService.setBitstreamPolicies(context, bitstream, item, accessControl);
     }
 
     /**

dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactory.java

@@ -34,6 +34,7 @@
 import org.dspace.content.service.RelationshipTypeService;
 import org.dspace.content.service.SiteService;
 import org.dspace.content.service.WorkspaceItemService;
+import org.dspace.core.ProvenanceService;
 import org.dspace.eperson.service.SubscribeService;
 import org.dspace.handle.service.HandleClarinService;
 import org.dspace.services.factory.DSpaceServicesFactory;
@@ -77,6 +78,7 @@ public abstract class ContentServiceFactory {
     public abstract SiteService getSiteService();
 
     public abstract SubscribeService getSubscribeService();
+
     public abstract PreviewContentService getPreviewContentService();
 
     /**
@@ -123,6 +125,13 @@ public abstract class ContentServiceFactory {
      */
     public abstract HandleClarinService getHandleClarinService();
 
+    /**
+     * Return the implementation of the ProvenanceService interface
+     *
+     * @return the ProvenanceService
+     */
+    public abstract ProvenanceService getProvenanceService();
+
     public InProgressSubmissionService getInProgressSubmissionService(InProgressSubmission inProgressSubmission) {
         if (inProgressSubmission instanceof WorkspaceItem) {
             return getWorkspaceItemService();

dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactoryImpl.java

@@ -31,6 +31,7 @@
 import org.dspace.content.service.RelationshipTypeService;
 import org.dspace.content.service.SiteService;
 import org.dspace.content.service.WorkspaceItemService;
+import org.dspace.core.ProvenanceService;
 import org.dspace.eperson.service.SubscribeService;
 import org.dspace.handle.service.HandleClarinService;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -93,6 +94,9 @@ public class ContentServiceFactoryImpl extends ContentServiceFactory {
     @Autowired(required = true)
     private HandleClarinService handleClarinService;
 
+    @Autowired(required = true)
+    private ProvenanceService provenanceService;
+
     @Override
     public List<DSpaceObjectService<? extends DSpaceObject>> getDSpaceObjectServices() {
         return dSpaceObjectServices;
@@ -173,6 +177,11 @@ public PreviewContentService getPreviewContentService() {
         return previewContentService;
     }
 
+    @Override
+    public ProvenanceService getProvenanceService() {
+        return provenanceService;
+    }
+
     @Override
     public RelationshipTypeService getRelationshipTypeService() {
         return relationshipTypeService;

dspace-api/src/main/java/org/dspace/core/ProvenanceMessageFormatter.java

@@ -0,0 +1,100 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.core;
+
+import java.sql.SQLException;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.dspace.authorize.AuthorizeException;
+import org.dspace.authorize.ResourcePolicy;
+import org.dspace.content.Bitstream;
+import org.dspace.content.Collection;
+import org.dspace.content.DCDate;
+import org.dspace.content.Item;
+import org.dspace.content.MetadataField;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.InstallItemService;
+import org.dspace.eperson.EPerson;
+
+/**
+ * The ProvenanceMessageProvider providing methods to generate provenance messages for DSpace items.
+ * It loads message templates
+ * from a JSON file and formats messages based on the context, including user details and timestamps.
+ *
+ * @author Michaela Paurikova (dspace at dataquest.sk)
+ */
+public class ProvenanceMessageFormatter {
+    private InstallItemService installItemService = ContentServiceFactory.getInstance().getInstallItemService();
+
+    public ProvenanceMessageFormatter() {}
+
+    public String getMessage(Context context, String messageTemplate, Item item, Object... args)
+            throws SQLException, AuthorizeException {
+        String msg = getMessage(context, messageTemplate, args);
+        msg = msg + "\n" + installItemService.getBitstreamProvenanceMessage(context, item);
+        return msg;
+    }
+
+    public String getMessage(Context context, String messageTemplate, Object... args) {
+        EPerson currentUser = context.getCurrentUser();
+        String timestamp = DCDate.getCurrent().toString();
+        String details = validateMessageTemplate(messageTemplate, args);
+        return String.format("%s by %s (%s) on %s",
+                details,
+                currentUser.getFullName(),
+                currentUser.getEmail(),
+                timestamp);
+    }
+
+    public String getMessage(Item item) {
+        String msg = "Item was in collections:\n";
+        List<Collection> collsList = item.getCollections();
+        for (Collection coll : collsList) {
+            msg = msg + coll.getName() + " (ID: " + coll.getID() + ")\n";
+        }
+        return msg;
+    }
+
+    public String getMessage(Bitstream bitstream) {
+        // values of deleted bitstream
+        String msg = bitstream.getName() + ": " +
+                bitstream.getSizeBytes() + " bytes, checksum: " +
+                bitstream.getChecksum() + " (" +
+                bitstream.getChecksumAlgorithm() + ")\n";
+        return msg;
+    }
+
+    public String getMessage(List<ResourcePolicy> resPolicies) {
+        return resPolicies.stream()
+                .filter(rp -> rp.getAction() == Constants.READ)
+                .map(rp -> String.format("[%s, %s, %d, %s, %s, %s, %s]",
+                        rp.getRpName(), rp.getRpType(), rp.getAction(),
+                        rp.getEPerson() != null ? rp.getEPerson().getEmail() : null,
+                        rp.getGroup() != null ? rp.getGroup().getName() : null,
+                        rp.getStartDate() != null ? rp.getStartDate().toString() : null,
+                        rp.getEndDate() != null ? rp.getEndDate().toString() : null))
+                .collect(Collectors.joining(";"));
+    }
+
+    public String getMetadata(String oldMtdKey, String oldMtdValue) {
+        return oldMtdKey + ": " + oldMtdValue;
+    }
+
+    public String getMetadataField(MetadataField metadataField) {
+        return metadataField.toString()
+                .replace('_', '.');
+    }
+
+    private String validateMessageTemplate(String messageTemplate, Object... args) {
+        if (messageTemplate == null) {
+            throw new IllegalArgumentException("The provenance message template is null!");
+        }
+        return String.format(messageTemplate, args);
+    }
+}

dspace-api/src/main/java/org/dspace/core/ProvenanceMessageTemplates.java

@@ -0,0 +1,38 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.core;
+
+/**
+ * The ProvenanceMessageTemplates enum provides message templates for provenance messages.
+ *
+ * @author Michaela Paurikova (dspace at dataquest.sk)
+ */
+public enum ProvenanceMessageTemplates {
+    ACCESS_CONDITION("Access condition (%s) was added to %s (%s)"),
+    RESOURCE_POLICIES_REMOVED("Resource policies (%s) of %s (%s) were removed"),
+    BUNDLE_ADDED("Item was added bitstream to bundle (%s)"),
+    EDIT_LICENSE("License (%s) was %s"),
+    MOVE_ITEM("Item was moved from collection (%s) to different collection"),
+    MAPPED_ITEM("Item was mapped to collection (%s)"),
+    DELETED_ITEM_FROM_MAPPED("Item was deleted from mapped collection (%s)"),
+    EDIT_BITSTREAM("Item (%s) was deleted bitstream (%s)"),
+    ITEM_METADATA("Item metadata (%s) was %s"),
+    BITSTREAM_METADATA("Item metadata (%s) was %s bitstream (%s)"),
+    ITEM_REPLACE_SINGLE_METADATA("Item bitstream (%s) metadata (%s) was updated"),
+    DISCOVERABLE("Item was made %sdiscoverable");
+
+    private final String template;
+
+    ProvenanceMessageTemplates(String template) {
+        this.template = template;
+    }
+
+    public String getTemplate() {
+        return template;
+    }
+}