metadata-added-provenance

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

@@ -45,14 +45,20 @@
 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;
 import org.dspace.content.Collection;
+import org.dspace.content.DCDate;
 import org.dspace.content.DSpaceObject;
 import org.dspace.content.Item;
+import org.dspace.content.MetadataSchemaEnum;
+import org.dspace.content.factory.ClarinServiceFactory;
 import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.InstallItemService;
 import org.dspace.content.service.ItemService;
+import org.dspace.content.service.clarin.ClarinItemService;
 import org.dspace.core.Constants;
 import org.dspace.core.Context;
 import org.dspace.discovery.DiscoverQuery;
@@ -458,13 +464,26 @@ private void updateItemPolicies(Item item, BulkAccessControlInput accessControl)
     private void setItemPolicies(Item item, BulkAccessControlInput accessControl)
         throws SQLException, AuthorizeException {
 
+        String resPoliciesStr = accessControl
+                .getItem()
+                .getAccessConditions()
+                .stream()
+                .map(accessCondition -> accessCondition.getName())
+                .collect(Collectors.joining(";"));
+
         accessControl
             .getItem()
             .getAccessConditions()
             .forEach(accessCondition -> createResourcePolicy(item, accessCondition,
                 itemAccessConditions.get(accessCondition.getName())));
 
         itemService.adjustItemPolicies(context, item, item.getOwningCollection(), false);
+
+        if (resPoliciesStr.isEmpty()) {
+            return;
+        }
+        String msg = "Access condition (" + resPoliciesStr + ") was added to item";
+        addProvenanceMetadata(context, item, msg);
     }
 
     /**
@@ -552,12 +571,86 @@ private void updateBitstreamPolicies(Bitstream bitstream, Item item, BulkAccessC
      */
     private void removeReadPolicies(DSpaceObject dso, String type) {
         try {
+            List<ResourcePolicy> resPolicies = resourcePolicyService.find(context, dso, type);
+            if (resPolicies.isEmpty()) {
+                return;
+            }
+
+            String resPoliciesStr = resPolicies.stream()
+                    .filter(rp -> rp.getAction() == Constants.READ)  // Filter out non-READ actions
+                    .map(rp -> {
+                        return "[" + rp.getRpName() + ", "
+                                + rp.getRpType() + ", "
+                                + rp.getAction() + ", "
+                                + (rp.getEPerson() == null ? null : rp.getEPerson().getEmail()) + ", "
+                                + (rp.getGroup() == null ? null : rp.getGroup().getName()) + ", "
+                                + (rp.getStartDate() == null ? null : rp.getStartDate().toString()) + ", "
+                                + (rp.getEndDate() == null ? null : rp.getEndDate().toString()) + "]";
+                    })
+                    .collect(Collectors.joining(";"));
+
             resourcePolicyService.removePolicies(context, dso, type, Constants.READ);
+
+            if (dso.getType() != Constants.BITSTREAM && dso.getType() != Constants.ITEM) {
+                return;
+            }
+
+            if (dso.getType() == Constants.ITEM) {
+                // Add suitable provenance
+                Item item = (Item) dso;
+                // Build some provenance data.
+                String msg = "Resource policies (" + (Objects.equals(resPoliciesStr, "") ? "empty" : resPoliciesStr)
+                        + ") of item (" + item.getID() + ") were removed";
+                addProvenanceMetadata(context, item, msg);
+            }
+
+            if (dso.getType() == Constants.BITSTREAM) {
+                // Add suitable provenance
+                Bitstream bitstream = (Bitstream) dso;
+                ClarinItemService clarinItemService = ClarinServiceFactory.getInstance().getClarinItemService();
+                List<Item> items = clarinItemService.findByBitstreamUUID(context, dso.getID());
+                if (items.isEmpty()) {
+                    return;
+                }
+                Item item = items.get(0);
+                // Build some provenance data while we're at it.
+                String msg = "Resource policies (" + (Objects.equals(resPoliciesStr, "") ? "empty" : resPoliciesStr)
+                        + ") of bitstream (" + bitstream.getID() + ") were removed";
+                addProvenanceMetadata(context, item, msg);
+            }
         } catch (SQLException | AuthorizeException e) {
             throw new BulkAccessControlException(e);
         }
     }
 
+    /**
+     * Adds provenance metadata to an item, documenting changes made to its resource policies
+     * and bitstream. This method records the user who performed the action, the action taken,
+     * and the timestamp of the action. It also appends a bitstream provenance message generated
+     * by the InstallItemService.
+     *
+     * @param context the current DSpace context, which provides details about the current user
+     *                and authorization information.
+     * @param item    the DSpace item to which the provenance metadata should be added.
+     * @param msg     a custom message describing the action taken on the resource policies.
+     * @throws SQLException         if there is a database access error while updating the item.
+     * @throws AuthorizeException   if the current user is not authorized to add metadata to the item.
+     */
+    protected void addProvenanceMetadata(Context context, Item item, String msg)
+            throws SQLException, AuthorizeException {
+        InstallItemService installItemService = ContentServiceFactory.getInstance().getInstallItemService();
+        String timestamp = DCDate.getCurrent().toString();
+        EPerson e = context.getCurrentUser();
+        StringBuilder prov = new StringBuilder();
+        prov.append(msg).append(" by ").append(e.getFullName()).append(" (").append(e.getEmail()).append(") on ")
+                .append(timestamp).append("\n");
+        prov.append(installItemService.getBitstreamProvenanceMessage(context, item));
+        itemService.addMetadata(context, item, MetadataSchemaEnum.DC.getName(),
+                "description", "provenance", "en", prov.toString());
+        //Update item in DB
+        itemService.update(context, item);
+    }
+
     /**
      * create the new resource policies of bitstream.
      * then, call {@link ItemService#adjustItemPolicies(
@@ -573,13 +666,29 @@ private void removeReadPolicies(DSpaceObject dso, String type) {
     private void setBitstreamPolicies(Bitstream bitstream, Item item, BulkAccessControlInput accessControl)
         throws SQLException, AuthorizeException {
 
+        String accConditionsScr = accessControl
+                .getBitstream()
+                .getAccessConditions()
+                .stream()
+                .map(accessCondition -> accessCondition.getName())
+                .collect(Collectors.joining(";"));
+
         accessControl.getBitstream()
                      .getAccessConditions()
                      .forEach(accessCondition -> createResourcePolicy(bitstream, accessCondition,
                          uploadAccessConditions.get(accessCondition.getName())));
 
         itemService.adjustBitstreamPolicies(context, item, item.getOwningCollection(), bitstream);
         mediaFilterService.updatePoliciesOfDerivativeBitstreams(context, item, bitstream);
+
+        if (accConditionsScr.isEmpty()) {
+            return;
+        }
+
+        // Add suitable provenance
+        String msg = "Access condition (" + accConditionsScr + ") was added to bitstream (" +
+                bitstream.getID() + ") of item";
+        addProvenanceMetadata(context, item, msg)   ;
     }
 
     /**

dspace-server-webapp/src/main/java/org/dspace/app/rest/BundleUploadBitstreamController.java

@@ -25,9 +25,16 @@
 import org.dspace.app.rest.repository.BundleRestRepository;
 import org.dspace.app.rest.utils.ContextUtil;
 import org.dspace.app.rest.utils.Utils;
+import org.dspace.authorize.AuthorizeException;
 import org.dspace.content.Bundle;
+import org.dspace.content.DCDate;
+import org.dspace.content.Item;
+import org.dspace.content.MetadataSchemaEnum;
 import org.dspace.content.service.BundleService;
+import org.dspace.content.service.InstallItemService;
+import org.dspace.content.service.ItemService;
 import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.rest.webmvc.ControllerUtils;
 import org.springframework.data.rest.webmvc.ResourceNotFoundException;
@@ -71,6 +78,12 @@ public class BundleUploadBitstreamController {
     @Autowired
     private BundleService bundleService;
 
+    @Autowired
+    private ItemService itemService;
+
+    @Autowired
+    private InstallItemService installItemService;
+
     @Autowired
     private BundleRestRepository bundleRestRepository;
 
@@ -111,6 +124,30 @@ public ResponseEntity<RepresentationModel<?>> uploadBitstream(
             throw new UnprocessableEntityException("The InputStream from the file couldn't be read", e);
         }
 
+        // We do this before calling `updateBitstream` because that function calls `context.commit`
+        // Add suitable provenance
+        EPerson e = context.getCurrentUser();
+        String timestamp = DCDate.getCurrent().toString();
+        Item item = bundle.getItems().get(0);
+
+        StringBuilder prov = new StringBuilder();
+        prov.append("Item was added bitstream to bundle (").append(bundle.getID())
+                .append(") by ").append(e.getFullName()).append(" (").append(e.getEmail())
+                .append(") on ").append(timestamp).append("\n");
+        try {
+            prov.append(installItemService.getBitstreamProvenanceMessage(context, item));
+            itemService.addMetadata(context, item, MetadataSchemaEnum.DC.getName(),
+                    "description", "provenance", "en", prov.toString());
+            //Update item in DB
+            itemService.update(context, item);
+        } catch (SQLException ex) {
+            throw new RuntimeException("SQLException in BundleUploadBitstreamConverter.uploadBitstream when " +
+                    "adding new provenance metadata.", ex);
+        } catch (AuthorizeException ex) {
+            throw new RuntimeException("AuthorizeException in BundleUploadBitstreamConverter.uploadBitstream " +
+                    "when adding new provenance metadata.", ex);
+        }
+
         BitstreamRest bitstreamRest = bundleRestRepository.uploadBitstream(
                 context, bundle, uploadfile.getOriginalFilename(), fileInputStream, properties);
         BitstreamResource bitstreamResource = converter.toResource(bitstreamRest);

dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemAddBundleController.java

@@ -31,13 +31,18 @@
 import org.dspace.authorize.AuthorizeException;
 import org.dspace.content.Bitstream;
 import org.dspace.content.Bundle;
+import org.dspace.content.DCDate;
 import org.dspace.content.Item;
+import org.dspace.content.MetadataSchemaEnum;
 import org.dspace.content.clarin.ClarinLicense;
+import org.dspace.content.clarin.ClarinLicenseResourceMapping;
+import org.dspace.content.service.InstallItemService;
 import org.dspace.content.service.ItemService;
 import org.dspace.content.service.clarin.ClarinLicenseResourceMappingService;
 import org.dspace.content.service.clarin.ClarinLicenseService;
 import org.dspace.core.Constants;
 import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -98,6 +103,9 @@ public class ItemAddBundleController {
     @Autowired
     ClarinLicenseResourceMappingService clarinLicenseResourceMappingService;
 
+    @Autowired
+    InstallItemService installItemService;
+
     /**
      * Method to add a Bundle to an Item with the given UUID in the URL. This will create a Bundle with the
      * name provided in the request and attach this to the Item that matches the UUID in the URL.
@@ -166,9 +174,18 @@ public ItemRest updateLicenseForBundle(@PathVariable UUID uuid,
                     "but the new one will not be attached.");
         }
         List<Bundle> bundles = item.getBundles(Constants.CONTENT_BUNDLE_NAME);
+        String oldLicense = null;
         for (Bundle clarinBundle : bundles) {
             List<Bitstream> bitstreamList = clarinBundle.getBitstreams();
             for (Bitstream bundleBitstream : bitstreamList) {
+                if (Objects.isNull(oldLicense)) {
+                    List<ClarinLicenseResourceMapping> mappings =
+                            this.clarinLicenseResourceMappingService.findByBitstreamUUID(
+                                    context, bundleBitstream.getID());
+                    if (!mappings.isEmpty()) {
+                        oldLicense = mappings.get(0).getLicense().getName();
+                    }
+                }
                 // in case bitstream ID exists in license table for some reason .. just remove it
                 this.clarinLicenseResourceMappingService.detachLicenses(context, bundleBitstream);
                 if (Objects.nonNull(clarinLicense)) {
@@ -182,6 +199,21 @@ public ItemRest updateLicenseForBundle(@PathVariable UUID uuid,
             clarinLicenseService.addLicenseMetadataToItem(context, clarinLicense, item);
         }
 
+        // Add suitable provenance
+        EPerson e = context.getCurrentUser();
+        String timestamp = DCDate.getCurrent().toString();
+        StringBuilder prov = new StringBuilder();
+
+        prov.append("License (").append(Objects.isNull(oldLicense) ? "empty" : oldLicense).append(") was ")
+                .append(Objects.isNull(clarinLicense) ? "removed" : Objects.isNull(oldLicense) ? "added" : "updated")
+                .append(" by ").append(e.getFullName()).append(" (").append(e.getEmail()).append(") on ")
+                .append(timestamp).append("\n");
+        prov.append(installItemService.getBitstreamProvenanceMessage(context, item));
+
+        itemService.addMetadata(context, item, MetadataSchemaEnum.DC.getName(),
+                "description", "provenance", "en", prov.toString());
+
+        // Update item in DB
         itemService.update(context, item);
         context.commit();
 

dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemOwningCollectionUpdateRestController.java

@@ -26,12 +26,16 @@
 import org.dspace.authorize.AuthorizeException;
 import org.dspace.authorize.service.AuthorizeService;
 import org.dspace.content.Collection;
+import org.dspace.content.DCDate;
 import org.dspace.content.DSpaceObject;
 import org.dspace.content.Item;
+import org.dspace.content.MetadataSchemaEnum;
 import org.dspace.content.service.CollectionService;
+import org.dspace.content.service.InstallItemService;
 import org.dspace.content.service.ItemService;
 import org.dspace.core.Constants;
 import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.rest.webmvc.ResourceNotFoundException;
 import org.springframework.security.access.prepost.PostAuthorize;
@@ -52,6 +56,8 @@ public class ItemOwningCollectionUpdateRestController {
 
     @Autowired
     ItemService itemService;
+    @Autowired
+    InstallItemService installItemService;
 
     @Autowired
     CollectionService collectionService;
@@ -125,6 +131,26 @@ private Collection moveItem(final Context context, final Item item, final Collec
                                 final boolean inheritPolicies)
             throws SQLException, IOException, AuthorizeException {
         itemService.move(context, item, currentCollection, targetCollection, inheritPolicies);
+
+        // Add suitable provenance
+        String timestamp = DCDate.getCurrent().toString();
+        EPerson e = context.getCurrentUser();
+        StringBuilder prov = new StringBuilder();
+
+        prov.append("Item was moved from collection (")
+                .append(currentCollection.getID()).append(") to different collection by ").append(e.getFullName())
+                .append(" (").append(e.getEmail()).append(") on ").append(timestamp).append("\n");
+
+        prov.append(installItemService.getBitstreamProvenanceMessage(context, item));
+
+        itemService.addMetadata(context, item, MetadataSchemaEnum.DC.getName(),
+                "description", "provenance", "en", prov.toString());
+        // Update item in DB
+        // Because a user can move an item without authorization turn off authorization
+        context.turnOffAuthorisationSystem();
+        itemService.update(context, item);
+        context.restoreAuthSystemState();
+
         // Necessary because Controller does not pass through general RestResourceController, and as such does not do
         // its commit in DSpaceRestRepository.createAndReturn() or similar
         context.commit();