metadata-added-provenance

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

@@ -55,6 +55,8 @@
 import org.dspace.content.service.ItemService;
 import org.dspace.core.Constants;
 import org.dspace.core.Context;
+import org.dspace.core.ProvenanceService;
+import org.dspace.core.factory.CoreServiceFactory;
 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;
+
     @Override
     @SuppressWarnings("unchecked")
     public void setup() throws ParseException {
@@ -143,6 +147,7 @@ public void setup() throws ParseException {
         help = commandLine.hasOption('h');
         filename = commandLine.getOptionValue('f');
         uuids = commandLine.hasOption('u') ? Arrays.asList(commandLine.getOptionValues('u')) : null;
+        this.provenanceService = CoreServiceFactory.getInstance().getProvenanceService();
     }
 
     @Override
@@ -465,6 +470,8 @@ private void setItemPolicies(Item item, BulkAccessControlInput accessControl)
                 itemAccessConditions.get(accessCondition.getName())));
 
         itemService.adjustItemPolicies(context, item, item.getOwningCollection(), false);
+
+        provenanceService.setItemPolicies(context, item, accessControl);
     }
 
     /**
@@ -552,6 +559,10 @@ private void updateBitstreamPolicies(Bitstream bitstream, Item item, BulkAccessC
      */
     private void removeReadPolicies(DSpaceObject dso, String type) {
         try {
+            String resPoliciesStr = provenanceService.removedReadPolicies(context, dso, type);
+            if (Objects.isNull(resPoliciesStr)) {
+                return;
+            }
             resourcePolicyService.removePolicies(context, dso, type, Constants.READ);
         } catch (SQLException | AuthorizeException e) {
             throw new BulkAccessControlException(e);
@@ -580,6 +591,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/core/ProvenanceMessageProvider.java

@@ -0,0 +1,35 @@
+/**
+ * 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 org.dspace.authorize.AuthorizeException;
+import org.dspace.authorize.ResourcePolicy;
+import org.dspace.content.Bitstream;
+import org.dspace.content.Item;
+import org.dspace.content.MetadataField;
+
+/**
+ * Interface for providing provenance messages.
+ *
+ * @author Michaela Paurikova (dspace at dataquest.sk)
+ */
+public interface ProvenanceMessageProvider {
+    public String getMessage(Context context, String templateKey, Object... args)
+            throws SQLException, AuthorizeException;
+    public String getMessage(Context context, String templateKey, Item item, Object... args)
+            throws SQLException, AuthorizeException;
+    public String getMessage(String templateKey, Object... args);
+    public String addCollectionsToMessage(Item item);
+    public String getBitstreamMessage(Bitstream bitstream);
+    public String getResourcePoliciesMessage(List<ResourcePolicy> resPolicies);
+    public String getMetadata(String oldMtdKey, String oldMtdValue);
+    public String getMetadataField(MetadataField metadataField);
+}

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

@@ -0,0 +1,137 @@
+/**
+ * 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.io.IOException;
+import java.io.InputStream;
+import java.sql.SQLException;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+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;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * The ProvenanceMessageProviderImpl class implements the ProvenanceMessageProvider interface,
+ * 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 ProvenanceMessageProviderImpl implements ProvenanceMessageProvider {
+    private static final String PROVENANCE_MSG_JSON = "provenance_messages.json";
+    private static final Logger log = LoggerFactory.getLogger(ProvenanceMessageProviderImpl.class);
+    private Map<String, String> messageTemplates;
+    private InstallItemService installItemService = ContentServiceFactory.getInstance().getInstallItemService();
+
+    public ProvenanceMessageProviderImpl() {
+        loadMessageTemplates();
+    }
+
+    private void loadMessageTemplates() {
+        ObjectMapper mapper = new ObjectMapper();
+        String msg;
+        try (InputStream inputStream = getClass().getResourceAsStream(PROVENANCE_MSG_JSON)) {
+            if (inputStream == null) {
+                msg = "Failed to find message templates file.";
+                log.error(msg);
+                throw new RuntimeException(msg);
+            }
+            messageTemplates = mapper.readValue(inputStream, Map.class);
+        } catch (IOException e) {
+            msg = "Failed to load message templates.";
+            log.error(msg);
+            throw new RuntimeException(msg, e);
+        }
+    }
+
+    @Override
+    public String getMessage(Context context, String templateKey, Item item, Object... args)
+            throws SQLException, AuthorizeException {
+        String msg = getMessage(context, templateKey, args);
+        msg = msg + "\n" + installItemService.getBitstreamProvenanceMessage(context, item);
+        return msg;
+    }
+
+    @Override
+    public String getMessage(String templateKey, Object... args) {
+        String template = messageTemplates.get(templateKey);
+        if (template == null) {
+            throw new IllegalArgumentException("No message template found for key: " + templateKey);
+        }
+        return String.format(template, args);
+    }
+
+    @Override
+    public String getMessage(Context context, String templateKey, Object... args) {
+        EPerson currentUser = context.getCurrentUser();
+        String timestamp = DCDate.getCurrent().toString();
+        String details = getMessage(templateKey, args);
+        return String.format("%s by %s (%s) on %s",
+                details,
+                currentUser.getFullName(),
+                currentUser.getEmail(),
+                timestamp);
+    }
+
+    @Override
+    public String addCollectionsToMessage(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;
+    }
+
+    @Override
+    public String getBitstreamMessage(Bitstream bitstream) {
+        // values of deleted bitstream
+        String msg = bitstream.getName() + ": " +
+                bitstream.getSizeBytes() + " bytes, checksum: " +
+                bitstream.getChecksum() + " (" +
+                bitstream.getChecksumAlgorithm() + ")\n";
+        return msg;
+    }
+
+    @Override
+    public String getResourcePoliciesMessage(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(";"));
+    }
+
+    @Override
+    public String getMetadata(String oldMtdKey, String oldMtdValue) {
+        return oldMtdKey + ": " + oldMtdValue;
+    }
+
+    @Override
+    public String getMetadataField(MetadataField metadataField) {
+        return metadataField.toString()
+                .replace('_', '.');
+    }
+}

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

@@ -0,0 +1,58 @@
+/**
+ * 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 org.dspace.app.bulkaccesscontrol.model.BulkAccessControlInput;
+import org.dspace.authorize.AuthorizeException;
+import org.dspace.content.Bitstream;
+import org.dspace.content.Bundle;
+import org.dspace.content.Collection;
+import org.dspace.content.DSpaceObject;
+import org.dspace.content.Item;
+import org.dspace.content.MetadataField;
+import org.dspace.content.MetadataValue;
+
+/**
+ * The ProvenanceService interface defines methods for creating provenance metadata
+ * for items based on the actions performed.
+ *
+ * @author Michaela Paurikova (dspace at dataquest.sk)
+ */
+public interface ProvenanceService {
+    public void setBitstreamPolicies(Context context, Bitstream bitstream, Item item,
+                                     BulkAccessControlInput accessControl) throws SQLException, AuthorizeException;
+
+    public void setItemPolicies(Context context, Item item, BulkAccessControlInput accessControl)
+            throws SQLException, AuthorizeException;
+
+    public String removedReadPolicies(Context context, DSpaceObject dso, String type)
+            throws SQLException, AuthorizeException;
+    public void uploadBitstream(Context context, Bundle bundle) throws SQLException, AuthorizeException;
+    public void editLicense(Context context, Item item, boolean newLicense) throws SQLException, AuthorizeException;
+
+    public void moveItem(Context context, Item item, Collection collection) throws SQLException, AuthorizeException;
+    public void mappedItem(Context context, Item item, Collection collection) throws SQLException, AuthorizeException;
+    public void deletedItemFromMapped(Context context, Item item, Collection collection)
+            throws SQLException, AuthorizeException;
+    public void deleteBitstream(Context context,Bitstream bitstream) throws SQLException, AuthorizeException;
+    public void addMetadata(Context context, DSpaceObject dso, MetadataField metadataField)
+            throws SQLException, AuthorizeException;
+    public void removeMetadata(Context context, DSpaceObject dso, MetadataField metadataField)
+            throws SQLException, AuthorizeException;
+    public void removeMetadataAtIndex(Context context, DSpaceObject dso, List<MetadataValue> metadataValues,
+                                      int indexInt) throws SQLException, AuthorizeException;
+    public void replaceMetadata(Context context, DSpaceObject dso, MetadataField metadataField, String oldMtdVal)
+            throws SQLException, AuthorizeException;
+    public void replaceMetadataSingle(Context context, DSpaceObject dso, MetadataField metadataField, String oldMtdVal)
+            throws SQLException, AuthorizeException;
+    public void makeDiscoverable(Context context, Item item, boolean discoverable)
+            throws SQLException, AuthorizeException;
+}