Merge pull request #11696 from IQSS/11648-notifications-api-extension

Notifications API extension and new notifications generated by API operations

Author: ofahimIQSS

doc/release-notes/11648-notifications-api-extension.md

@@ -0,0 +1,7 @@
+# getAllNotificationsForUser API extension
+
+- Extended endpoint getAllNotificationsForUser(``/notifications/all``), which now supports an optional query parameter ``inAppNotificationFormat`` which, if sent as ``true``, retrieves the fields needed to build the in-app notifications for the Notifications section of the Dataverse UI, omitting fields related to email notifications. See also #11648 and #11696.
+
+# Notifications triggered by API endpoints
+
+The addDataset and addDataverse API endpoints now trigger user notifications upon successful execution. See also #1342 and #11696.

doc/sphinx-guides/source/api/native-api.rst

@@ -6001,6 +6001,35 @@ The expected OK (200) response looks something like this:
               }
   ...
 
+This endpoint supports an optional query parameter ``inAppNotificationFormat`` which, if sent as ``true``, retrieves the fields needed to build the in-app notifications for the Notifications section of the Dataverse UI, omitting fields related to email notifications.
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/notifications/all?inAppNotificationFormat=true"
+
+The expected OK (200) response looks something like this:
+
+.. code-block:: text
+
+  {
+      "status": "OK",
+      "data": {
+          "notifications": [
+              {
+                  "id": 79,
+                  "type": "CREATEACC",
+                  "displayAsRead": false,
+                  "sentTimestamp": "2025-08-08T08:00:16Z",
+                  "installationBrandName": "Your Installation Name",
+                  "userGuidesBaseUrl": "https://guides.dataverse.org",
+                  "userGuidesVersion": "6.7.1",
+                  "userGuidesSectionPath": "user/index.html"
+              }
+          ]
+      }
+  }
+  ...
+
 Get Unread Count
 ~~~~~~~~~~~~~~~~
 

src/main/java/edu/harvard/iq/dataverse/PermissionServiceBean.java

@@ -13,16 +13,13 @@
 import edu.harvard.iq.dataverse.authorization.users.AuthenticatedUser;
 import edu.harvard.iq.dataverse.authorization.users.User;
 import edu.harvard.iq.dataverse.engine.command.Command;
-import java.util.EnumSet;
-import java.util.Map;
-import java.util.Set;
+
+import java.util.*;
 import java.util.logging.Logger;
 import jakarta.ejb.EJB;
 import jakarta.ejb.Stateless;
 import jakarta.inject.Inject;
 import jakarta.inject.Named;
-import java.util.HashSet;
-import java.util.List;
 import jakarta.persistence.EntityManager;
 import jakarta.persistence.PersistenceContext;
 import static edu.harvard.iq.dataverse.engine.command.CommandHelper.CH;
@@ -34,11 +31,9 @@
 import edu.harvard.iq.dataverse.workflow.PendingWorkflowInvocation;
 import edu.harvard.iq.dataverse.workflow.WorkflowServiceBean;
 
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.LinkedList;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
 import static java.util.stream.Collectors.toList;
 import jakarta.persistence.Query;
 import jakarta.persistence.criteria.CriteriaBuilder;
@@ -926,6 +921,7 @@ private boolean hasUnrestrictedReleasedFiles(DatasetVersion targetDatasetVersion
     public List<Dataverse> findPermittedCollections(DataverseRequest request, AuthenticatedUser user, Permission permission) {
         return findPermittedCollections(request, user, 1 << permission.ordinal());
     }
+
     public List<Dataverse> findPermittedCollections(DataverseRequest request, AuthenticatedUser user, int permissionBit) {
         if (user != null) {
             // IP Group - Only check IP if a User is calling for themself
@@ -963,5 +959,31 @@ public List<Dataverse> findPermittedCollections(DataverseRequest request, Authen
         }
         return null;
     }
+
+    /**
+     * Calculates the complete list of role assignments for a given user on a DvObject.
+     * This includes roles assigned directly to the user and roles inherited from any groups
+     * the user is a member of.
+     * <p>
+     * This method's logic is based on the private method {@code getRoleStringFromUser}
+     * in the {@code DataverseUserPage} class, which produces a concatenated string of
+     * effective user role names required for displaying role-related user notifications.
+     * The common logic from these two methods may be centralized in the future to
+     * avoid code duplication.
+     *
+     * @param user The authenticated user whose roles are being checked.
+     * @param dvObject The dataverse object to check for role assignments.
+     * @return A List containing all effective RoleAssignments for the user. Never null.
+     */
+    public List<RoleAssignment> getEffectiveRoleAssignments(AuthenticatedUser user, DvObject dvObject) {
+        Stream<RoleAssignment> directAssignments = assignmentsFor(user, dvObject).stream();
+
+        Stream<RoleAssignment> groupAssignments = groupService.groupsFor(user, dvObject)
+                .stream()
+                .flatMap(group -> assignmentsFor(group, dvObject).stream());
+
+        return Stream.concat(directAssignments, groupAssignments)
+                .collect(Collectors.toList());
+    }
 }
 

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

@@ -151,7 +151,7 @@ public Response addDataverse(@Context ContainerRequestContext crc, String body,
             }
 
             AuthenticatedUser u = getRequestAuthenticatedUserOrDie(crc);
-            newDataverse = execCommand(new CreateDataverseCommand(newDataverse, createDataverseRequest(u), facets, inputLevels, metadataBlocks));
+            newDataverse = execCommand(new CreateDataverseCommand(newDataverse, createDataverseRequest(u), facets, inputLevels, metadataBlocks, true));
             return created("/dataverses/" + newDataverse.getAlias(), json(newDataverse));
 
         } catch (WrappedResponse ww) {
@@ -407,9 +407,9 @@ public Response createDataset(@Context ContainerRequestContext crc, String jsonB
             ds.setIdentifier(null);
             ds.setProtocol(null);
             ds.setGlobalIdCreateTime(null);
-            Dataset managedDs = null;
+            Dataset managedDs;
             try {
-                managedDs = execCommand(new CreateNewDatasetCommand(ds, createDataverseRequest(u), null, validate));
+                managedDs = execCommand(new CreateNewDatasetCommand(ds, createDataverseRequest(u), validate, true));
             } catch (WrappedResponse ww) {
                 Throwable cause = ww.getCause();
                 StringBuilder sb = new StringBuilder();