Merge pull request #11805 from IQSS/11670-notification-of-moved-datasets

sekmiller · web-flow · commit f5049acc884e · 2026-01-07T14:37:55.000-05:00
New Dataset Move Notification
diff --git a/doc/release-notes/11670-notification-of-moved-datasets.md b/doc/release-notes/11670-notification-of-moved-datasets.md
@@ -0,0 +1,6 @@
+## Notifications
+
+New notification was added for Datasets moving between Dataverses.
+Requires SettingsServiceBean.Key.SendNotificationOnDatasetMove setting to be enabled.
+
+See #11670
diff --git a/doc/sphinx-guides/source/admin/user-administration.rst b/doc/sphinx-guides/source/admin/user-administration.rst
@@ -98,6 +98,7 @@ This enables additional settings for each user in the notifications tab of their
 * ``CREATEDS`` Your dataset is created
 * ``CREATEDV`` Dataverse collection is created
 * ``DATASETCREATED`` Dataset was created by user
+* ``DATASETMOVED`` Dataset was moved by user
 * ``FILESYSTEMIMPORT`` Dataset has been successfully uploaded and verified
 * ``GRANTFILEACCESS`` Access to file is granted
 * ``INGESTCOMPLETEDWITHERRORS`` Ingest completed with errors
diff --git a/src/main/java/edu/harvard/iq/dataverse/MailServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/MailServiceBean.java
@@ -478,6 +478,12 @@ public String getMessageTextBasedOnNotification(UserNotification userNotificatio
                 String[] paramArrayDatasetCreated = {getDatasetLink(dataset), dataset.getDisplayName(), userNotification.getRequestor().getName(), dataset.getOwner().getDisplayName()};
                 messageText += MessageFormat.format(pattern, paramArrayDatasetCreated);
                 return messageText;
+            case DATASETMOVED:
+                dataset = (Dataset) targetObject;
+                pattern = BundleUtil.getStringFromBundle("notification.email.datasetWasMoved");
+                String[] paramArrayDatasetMoved = {getDatasetLink(dataset), dataset.getDisplayName(), userNotification.getRequestor().getName(), dataset.getOwner().getDisplayName()};
+                messageText += MessageFormat.format(pattern, paramArrayDatasetMoved);
+                return messageText;
             case CREATEDS:
                 version =  (DatasetVersion) targetObject;
                 String datasetCreatedMessage = BundleUtil.getStringFromBundle("notification.email.createDataset", Arrays.asList(
@@ -785,6 +791,7 @@ public Object getObjectOfNotification (UserNotification userNotification){
             case GRANTFILEACCESS:
             case REJECTFILEACCESS:
             case DATASETCREATED:
+            case DATASETMOVED:
             case DATASETMENTIONED:
                 return datasetService.find(userNotification.getObjectId());
             case CREATEDS:
diff --git a/src/main/java/edu/harvard/iq/dataverse/UserNotification.java b/src/main/java/edu/harvard/iq/dataverse/UserNotification.java
@@ -40,7 +40,8 @@ public enum Type {
         PUBLISHFAILED_PIDREG, WORKFLOW_SUCCESS, WORKFLOW_FAILURE, STATUSUPDATED, DATASETCREATED, DATASETMENTIONED,
         GLOBUSUPLOADCOMPLETED, GLOBUSUPLOADCOMPLETEDWITHERRORS,
         GLOBUSDOWNLOADCOMPLETED, GLOBUSDOWNLOADCOMPLETEDWITHERRORS, REQUESTEDFILEACCESS,
-        GLOBUSUPLOADREMOTEFAILURE, GLOBUSUPLOADLOCALFAILURE, PIDRECONCILED;
+        GLOBUSUPLOADREMOTEFAILURE, GLOBUSUPLOADLOCALFAILURE, PIDRECONCILED,
+        DATASETMOVED;
         
         public String getDescription() {
             return BundleUtil.getStringFromBundle("notification.typeDescription." + this.name());
diff --git a/src/main/java/edu/harvard/iq/dataverse/api/Datasets.java b/src/main/java/edu/harvard/iq/dataverse/api/Datasets.java
@@ -1430,8 +1430,7 @@ public Response moveDataset(@Context ContainerRequestContext crc, @PathParam("id
             }
             //Command requires Super user - it will be tested by the command
             execCommand(new MoveDatasetCommand(
-                    createDataverseRequest(u), ds, target, force
-            ));
+                    createDataverseRequest(u), ds, target, force, true));
             return ok(BundleUtil.getStringFromBundle("datasets.api.moveDataset.success"));
         } catch (WrappedResponse ex) {
             if (ex.getCause() instanceof UnforcedCommandException) {
diff --git a/src/main/java/edu/harvard/iq/dataverse/authorization/providers/builtin/DataverseUserPage.java b/src/main/java/edu/harvard/iq/dataverse/authorization/providers/builtin/DataverseUserPage.java
@@ -509,6 +509,7 @@ public void displayNotification() {
                 case GRANTFILEACCESS:
                 case REJECTFILEACCESS:
                 case DATASETCREATED:
+                case DATASETMOVED:
                 case DATASETMENTIONED:
                     userNotification.setTheObject(datasetService.find(userNotification.getObjectId()));
                     break;
diff --git a/src/main/java/edu/harvard/iq/dataverse/dashboard/DashboardMoveDatasetPage.java b/src/main/java/edu/harvard/iq/dataverse/dashboard/DashboardMoveDatasetPage.java
@@ -153,8 +153,7 @@ public void move(){
             HttpServletRequest httpServletRequest = (HttpServletRequest) FacesContext.getCurrentInstance().getExternalContext().getRequest();
             DataverseRequest dataverseRequest = new DataverseRequest(authUser, httpServletRequest);
             commandEngine.submit(new MoveDatasetCommand(
-                    dataverseRequest, ds, target, false
-            ));
+                    dataverseRequest, ds, target, false, true));
             
             logger.info("Moved " + dsPersistentId + " from " + srcAlias + " to " + dstAlias);
             
diff --git a/src/main/java/edu/harvard/iq/dataverse/engine/command/impl/MoveDatasetCommand.java b/src/main/java/edu/harvard/iq/dataverse/engine/command/impl/MoveDatasetCommand.java
@@ -5,13 +5,10 @@
  */
 package edu.harvard.iq.dataverse.engine.command.impl;
 
-import edu.harvard.iq.dataverse.Dataset;
-import edu.harvard.iq.dataverse.DatasetLinkingDataverse;
-import edu.harvard.iq.dataverse.DatasetLock;
-import edu.harvard.iq.dataverse.Dataverse;
-import edu.harvard.iq.dataverse.Guestbook;
+import edu.harvard.iq.dataverse.*;
 import edu.harvard.iq.dataverse.authorization.Permission;
 import edu.harvard.iq.dataverse.authorization.users.AuthenticatedUser;
+import edu.harvard.iq.dataverse.authorization.users.User;
 import edu.harvard.iq.dataverse.engine.command.AbstractVoidCommand;
 import edu.harvard.iq.dataverse.engine.command.CommandContext;
 import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
@@ -21,11 +18,12 @@
 import edu.harvard.iq.dataverse.engine.command.exception.IllegalCommandException;
 import edu.harvard.iq.dataverse.engine.command.exception.PermissionException;
 import edu.harvard.iq.dataverse.engine.command.exception.UnforcedCommandException;
+import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
 import edu.harvard.iq.dataverse.util.BundleUtil;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
+
+import java.sql.Timestamp;
+import java.time.Instant;
+import java.util.*;
 import java.util.logging.Logger;
 
 /**
@@ -34,8 +32,8 @@
  * @author skraffmi
  */
 @RequiredPermissionsMap({
-    @RequiredPermissions(dataverseName = "moved", value = {Permission.PublishDataset})
-    ,	@RequiredPermissions(dataverseName = "destination", value = {Permission.AddDataset, Permission.PublishDataset})
+    @RequiredPermissions(dataverseName = "moved", value = {Permission.PublishDataset}),
+    @RequiredPermissions(dataverseName = "destination", value = {Permission.AddDataset, Permission.PublishDataset})
 })
 public class MoveDatasetCommand extends AbstractVoidCommand {
 
@@ -44,8 +42,13 @@ public class MoveDatasetCommand extends AbstractVoidCommand {
     final Dataset moved;
     final Dataverse destination;
     final Boolean force;
+    final Boolean allowSelfNotification;
+    final Dataverse originalOwner;
 
     public MoveDatasetCommand(DataverseRequest aRequest, Dataset moved, Dataverse destination, Boolean force) {
+        this( aRequest, moved, destination, force, null);
+    }
+    public MoveDatasetCommand(DataverseRequest aRequest, Dataset moved, Dataverse destination, Boolean force, Boolean allowSelfNotification) {
         super(
                 aRequest,
                 dv("moved", moved),
@@ -54,6 +57,8 @@ public MoveDatasetCommand(DataverseRequest aRequest, Dataset moved, Dataverse de
         this.moved = moved;
         this.destination = destination;
         this.force= force;
+        this.allowSelfNotification = allowSelfNotification;
+        this.originalOwner = moved.getOwner();
     }
 
     @Override
@@ -72,13 +77,13 @@ public void executeImpl(CommandContext ctxt) throws CommandException {
         if (moved.getOwner().equals(destination)) {
             throw new IllegalCommandException(BundleUtil.getStringFromBundle("dashboard.move.dataset.command.error.targetDataverseSameAsOriginalDataverse"), this);
         }
-        
+
         // if dataset is published make sure that its target is published
-        
+
         if (moved.isReleased() && !destination.isReleased()){
             throw new IllegalCommandException(BundleUtil.getStringFromBundle("dashboard.move.dataset.command.error.targetDataverseUnpublishedDatasetPublished", Arrays.asList(destination.getDisplayName())), this);
         }
-                
+
         //if the datasets guestbook is not contained in the new dataverse then remove it
         if (moved.getGuestbook() != null) {
             Guestbook gb = moved.getGuestbook();
@@ -97,15 +102,15 @@ public void executeImpl(CommandContext ctxt) throws CommandException {
                 }
             }
         }
-        
+
         // generate list of all possible parent dataverses to check against
         List<Dataverse> ownersToCheck = new ArrayList<>();
         ownersToCheck.add(destination);
         if (destination.getOwners() != null) {
             ownersToCheck.addAll(destination.getOwners());
         }
-        
-        // if the dataset is linked to the new dataverse or any of 
+
+        // if the dataset is linked to the new dataverse or any of
         // its parent dataverses then remove the link
         List<DatasetLinkingDataverse> linkingDatasets = new ArrayList<>();
         if (moved.getDatasetLinkingDataverses() != null) {
@@ -124,7 +129,7 @@ public void executeImpl(CommandContext ctxt) throws CommandException {
                 }
             }
         }
-        
+
         if (removeGuestbook || removeLinkDs) {
             StringBuilder errorString = new StringBuilder();
             if (removeGuestbook) {
@@ -135,10 +140,10 @@ public void executeImpl(CommandContext ctxt) throws CommandException {
             }
             throw new UnforcedCommandException(errorString.toString(), this);
         }
-        
+
         // 6575 if dataset is submitted for review and the default contributor
         // role includes dataset publish then remove the lock
-        
+
         if (moved.isLockedFor(DatasetLock.Reason.InReview)
                 && destination.getDefaultContributorRole().permissions().contains(Permission.PublishDataset)) {
             ctxt.datasets().removeDatasetLocks(moved, DatasetLock.Reason.InReview);
@@ -153,4 +158,56 @@ public void executeImpl(CommandContext ctxt) throws CommandException {
 
     }
 
+    @Override
+    public boolean onSuccess(CommandContext ctxt, Object r) {
+        sendNotification(moved, originalOwner, ctxt);
+        return true;
+    }
+
+    /**
+     * Sends notifications to those able to publish the dataset upon the successful move of a dataset.
+     * <p>
+     * This method checks if dataset move notifications are enabled. If so, it
+     * notifies all users with {@code Permission.PublishDataset} on the original owning Dataverse.
+     * The user who initiated the action can be included or excluded from this
+     * notification based on the allowSelfNotification flag.
+     *
+     * @param dataset The moved {@code Dataset}.
+     * @param originalOwner The original owning {@code Dataverse}.
+     * @param ctxt    The {@code CommandContext} providing access to application services.
+     */
+    protected void sendNotification(Dataset dataset, Dataverse originalOwner, CommandContext ctxt) {
+        // 1. Exit early if the SendNotificationOnDatasetMove setting is disabled.
+        if (!ctxt.settings().isTrueForKey(SettingsServiceBean.Key.SendNotificationOnDatasetMove, false)) {
+            return;
+        }
+
+        // 2. Identify the user who initiated the action.
+        final User user = getUser();
+        final AuthenticatedUser requestor = user.isAuthenticated() ? (AuthenticatedUser) user : null;
+
+        // 3. Get all users with publish permission on the dataset's original owner (dataverse) and notify them.
+        Map<String, AuthenticatedUser> recipients = ctxt.permissions().getDistinctUsersWithPermissionOn(Permission.PublishDataset, originalOwner);
+        // make sure the requestor is in the recipient list in case they don't match the permission but only if allowSelfNotification is true
+        if (requestor != null) {
+            if (Boolean.TRUE.equals(allowSelfNotification)) {
+                recipients.put(requestor.getIdentifier(), requestor);
+            } else {
+                recipients.remove(requestor.getIdentifier());
+            }
+        }
+
+        recipients.values()
+                .stream()
+                .forEach(recipient -> ctxt.notifications().sendNotification(
+                        recipient,
+                        Timestamp.from(Instant.now()),
+                        UserNotification.Type.DATASETMOVED,
+                        dataset.getId(),
+                        null,
+                        requestor,
+                        true
+                ));
+    }
 }
+
diff --git a/src/main/java/edu/harvard/iq/dataverse/settings/SettingsServiceBean.java b/src/main/java/edu/harvard/iq/dataverse/settings/SettingsServiceBean.java
@@ -652,6 +652,12 @@ Whether Harvesting (OAI) service is enabled
          * ability/permission necessary to publish the dataset
          */
         SendNotificationOnDatasetCreation,
+        /**
+         * A boolean setting that, if true will send an email and notification to users
+         * when a Dataset is moved. Messages go to those who have the
+         * ability/permission necessary to publish the dataset
+         */
+        SendNotificationOnDatasetMove,
         /**
          * A JSON Object containing named comma separated sets(s) of allowed labels (up
          * to 32 characters, spaces allowed) that can be set on draft datasets, via API
diff --git a/src/main/java/edu/harvard/iq/dataverse/util/MailUtil.java b/src/main/java/edu/harvard/iq/dataverse/util/MailUtil.java
@@ -47,6 +47,8 @@ public static String getSubjectTextBasedOnNotification(UserNotification userNoti
                 return BundleUtil.getStringFromBundle("notification.email.rejected.file.access.subject", rootDvNameAsList);
             case DATASETCREATED:
                 return BundleUtil.getStringFromBundle("notification.email.dataset.created.subject", Arrays.asList(rootDvNameAsList.get(0), datasetDisplayName));
+            case DATASETMOVED:
+                return BundleUtil.getStringFromBundle("notification.email.dataset.moved.subject", Arrays.asList(rootDvNameAsList.get(0), datasetDisplayName));
             case CREATEDS:
                 return BundleUtil.getStringFromBundle("notification.email.create.dataset.subject", Arrays.asList(rootDvNameAsList.get(0), datasetDisplayName));
             case SUBMITTEDDS:
diff --git a/src/main/java/edu/harvard/iq/dataverse/util/json/InAppNotificationsJsonPrinter.java b/src/main/java/edu/harvard/iq/dataverse/util/json/InAppNotificationsJsonPrinter.java
@@ -132,6 +132,9 @@ public void addFieldsByType(final NullSafeJsonBuilder notificationJson, final Au
             case DATASETMENTIONED:
                 addDatasetMentionedFields(notificationJson, userNotification);
                 break;
+            case DATASETMOVED:
+                addDatasetMovedFields(notificationJson, userNotification, requestor);
+                break;
         }
     }
 
@@ -289,4 +292,9 @@ private void addDatasetMentionedFields(final NullSafeJsonBuilder notificationJso
             }
         }
     }
+
+    private void addDatasetMovedFields(final NullSafeJsonBuilder notificationJson, final UserNotification userNotification, final AuthenticatedUser requestor) {
+        addDatasetFields(notificationJson, userNotification);
+        addRequestorFields(notificationJson, requestor);
+    }
 }
diff --git a/src/main/java/propertyFiles/Bundle.properties b/src/main/java/propertyFiles/Bundle.properties
@@ -242,6 +242,7 @@ notification.createDataverse={0} was created in {1} . To learn more about what y
 notification.dataverse.management.title=Dataverse Management - Dataverse User Guide
 notification.createDataset={0} was created in {1}. To learn more about what you can do with a dataset, check out the {2}.
 notification.datasetCreated={0} was created in {1} by {2}.
+notification.datasetMoved={0} was moved to {1} by {2}.
 notification.dataset.management.title=Dataset Management - Dataset User Guide
 notification.wasSubmittedForReview={0} was submitted for review to be published in {1}. Don''t forget to publish it or send it back to the contributor, {2} ({3})\!
 notification.wasReturnedByReviewer={0} was returned by the curator of {1}.
@@ -316,6 +317,7 @@ notification.typeDescription.WORKFLOW_FAILURE=External workflow run has failed
 notification.typeDescription.STATUSUPDATED=Status of dataset has been updated
 notification.typeDescription.DATASETCREATED=Dataset was created by user
 notification.typeDescription.DATASETMENTIONED=Dataset was referenced in remote system
+notification.typeDescription.DATASETMOVED=Dataset was moved by user
 notification.typeDescription.PIDRECONCILED=The Persistent identifier of dataset has been updated
 notification.typeDescription.GLOBUSUPLOADCOMPLETED=Globus upload is completed
 notification.typeDescription.GLOBUSUPLOADCOMPLETEDWITHERRORS=Globus upload completed with errors
@@ -816,6 +818,7 @@ dashboard.move.dataverse.menu.invalidMsg=No matches found
 notification.email.create.dataverse.subject={0}: Your dataverse has been created
 notification.email.create.dataset.subject={0}: Dataset "{1}" has been created
 notification.email.dataset.created.subject={0}: Dataset "{1}" has been created
+notification.email.dataset.moved.subject={0}: Dataset "{1}" has been moved
 notification.email.request.file.access.subject={0}: {1} {2} ({3}) requested access to dataset "{4}"
 notification.email.requested.file.access.subject={0}: You have requested access to a restricted file in dataset "{1}"
 notification.email.grant.file.access.subject={0}: You have been granted access to a restricted file
@@ -866,6 +869,7 @@ notification.email.changeEmail=Hello, {0}.{1}\n\nPlease contact us if you did no
 notification.email.passwordReset=Hi {0},\n\nSomeone, hopefully you, requested a password reset for {1}.\n\nPlease click the link below to reset your Dataverse account password:\n\n {2} \n\n The link above will only work for the next {3} minutes.\n\n Please contact us if you did not request this password reset or need further help.
 notification.email.passwordReset.subject=Dataverse Password Reset Requested
 notification.email.datasetWasCreated=Dataset "<a href = "{0}">{1}</a>" was just created by {2} in the {3} collection.
+notification.email.datasetWasMoved=Dataset "<a href = "{0}">{1}</a>" was just moved by {2} to the {3} collection.
 notification.email.requestedFileAccess=You have requested access to a file(s) in dataset "<a href = "{0}">{1}</a>". Your request has been sent to the managers of this dataset who will grant or reject your request. If you have any questions, you may reach the dataset managers using the "Contact" link on the upper right corner of the dataset page.
 hours=hours
 hour=hour
diff --git a/src/main/webapp/dataverseuser.xhtml b/src/main/webapp/dataverseuser.xhtml
@@ -166,6 +166,20 @@
                                                         </o:param>
                                                     </h:outputFormat>
                                                 </ui:fragment>
+                                                <ui:fragment rendered="#{item.type == 'DATASETMOVED'}">
+                                                    <span class="icon-dataset text-icon-inline text-muted"></span>
+                                                    <h:outputFormat value="#{bundle['notification.datasetMoved']}" escape="false">
+                                                        <o:param>
+                                                            <a href="/dataset.xhtml?persistentId=#{item.theObject.getGlobalId()}" title="#{item.theObject.getDisplayName()}">#{item.theObject.getDisplayName()}</a>
+                                                        </o:param>
+                                                        <o:param>
+                                                            <a href="/dataverse/#{item.theObject.getOwner().getAlias()}" title="#{item.theObject.getOwner().getDisplayName()}">#{item.theObject.getOwner().getDisplayName()}</a>
+                                                        </o:param>
+                                                        <o:param>
+                                                            #{item.requestor.name}
+                                                        </o:param>
+                                                    </h:outputFormat>
+                                                </ui:fragment>
                                                 <ui:fragment rendered="#{item.type == 'SUBMITTEDDS'}">
                                                     <span class="icon-dataset text-icon-inline text-muted"></span>
                                                     <h:outputFormat value="#{bundle['notification.wasSubmittedForReview']}" escape="false">
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/MoveIT.java b/src/test/java/edu/harvard/iq/dataverse/api/MoveIT.java
