[pull] develop from IQSS:develop

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

doc/release-notes/11918-template-apis.md

@@ -0,0 +1,17 @@
+## New Endpoint: GET `/dataverses/{id}/template`
+
+A new endpoint has been implemented to manage templates belonging to a given dataverse collection.
+
+### Functionality
+- Returns the template of the given {id} in json format.
+- You must have add dataset permission in the collection in order to use this endpoint.
+
+## New Endpoint: DELETE `/dataverses/{id}/template`
+
+A new endpoint has been implemented to manage templates belonging to a given dataverse collection.
+
+### Functionality
+- Deletes the template of the given {id}.
+- You must have Edit Dataverse permission in order to use this endpoint.
+
+

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

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

@@ -1576,6 +1576,48 @@ The fully expanded example above (without environment variables) looks like this
 
   curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X GET "https://demo.dataverse.org/api/dataverses/1/templates"
 
+List Single Template by its Identifier
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Gets the json representation of a template by its ``id``:
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export ID=1
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X GET "$SERVER_URL/api/dataverses/{ID}/template"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X GET "https://demo.dataverse.org/api/dataverses/1/template"
+
+You must have Create Dataset permission within the given dataverse collection to invoke this api.
+
+Delete a Template by its Identifier
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Deletes a template by its ``id``:
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export ID=1
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X DELETE "$SERVER_URL/api/dataverses/{ID}/template"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X DELETE "https://demo.dataverse.org/api/dataverses/1/template"
+
+You must have Edit Dataverse permission within the given dataverse collection to invoke this api.
+
 Create a Template for a Collection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

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:

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());

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) {

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

@@ -3,6 +3,7 @@
 import com.google.common.collect.Lists;
 import com.google.api.client.util.ArrayMap;
 import edu.harvard.iq.dataverse.*;
+import static edu.harvard.iq.dataverse.api.AbstractApiBean.error;
 import edu.harvard.iq.dataverse.api.auth.AuthRequired;
 import edu.harvard.iq.dataverse.api.datadeposit.SwordServiceBean;
 import edu.harvard.iq.dataverse.api.dto.*;
@@ -23,6 +24,7 @@
 import edu.harvard.iq.dataverse.dataverse.featured.DataverseFeaturedItem;
 import edu.harvard.iq.dataverse.dataverse.featured.DataverseFeaturedItemServiceBean;
 import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
+import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
 import edu.harvard.iq.dataverse.engine.command.impl.*;
 import edu.harvard.iq.dataverse.pidproviders.PidProvider;
 import edu.harvard.iq.dataverse.pidproviders.PidUtil;
@@ -118,6 +120,9 @@ public class Dataverses extends AbstractApiBean {
 
     @EJB
     PermissionServiceBean permissionService;
+
+    @EJB
+    TemplateServiceBean templateService;
 
     @EJB
     DataverseFeaturedItemServiceBean dataverseFeaturedItemServiceBean;
@@ -1989,6 +1994,21 @@ public Response getTemplates(@Context ContainerRequestContext crc, @PathParam("i
             return e.getResponse();
         }
     }
+
+    @GET
+    @AuthRequired
+    @Path("{id}/template/")
+    public Response getTemplate(@Context ContainerRequestContext crc, @PathParam("id") Long templateId) {
+        try {
+            Template template = templateService.find(templateId);
+            if (template == null){
+                return error(Response.Status.NOT_FOUND, "Template with id " + templateId + " -  not found.");
+            }
+            return ok(jsonTemplate(execCommand(new GetTemplateCommand(createDataverseRequest(getRequestUser(crc)), template))));
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
 
     @POST
     @AuthRequired
@@ -2002,7 +2022,10 @@ public Response createTemplate(@Context ContainerRequestContext crc, String body
             } catch (JsonParseException ex) {
                 return error(Status.BAD_REQUEST, MessageFormat.format(BundleUtil.getStringFromBundle("dataverse.createTemplate.error.jsonParseMetadataFields"), ex.getMessage()));
             }
-            return ok(jsonTemplate(execCommand(new CreateTemplateCommand(newTemplateDTO.toTemplate(), createDataverseRequest(getRequestUser(crc)), dataverse, true))));
+            Template created = execCommand(new CreateTemplateCommand(newTemplateDTO.toTemplate(), createDataverseRequest(getRequestUser(crc)), dataverse, true));
+
+            return created("/dataverses/template/" + created.getId(), jsonTemplate(created));
+
         } catch (WrappedResponse e) {
             return e.getResponse();
         }
@@ -2036,6 +2059,27 @@ public Response setMetadataLanguage(@Context ContainerRequestContext crc, @PathP
         }, getRequestUser(crc));
     }
 
+    @Path("{id}/template")
+    @AuthRequired
+    @DELETE
+    public Response deleteTemplate(@Context ContainerRequestContext crc, @PathParam("id") long id) {
+
+        Template doomed = templateService.find(id);
+        if (doomed == null) {
+            return error(Response.Status.NOT_FOUND, "Template with id " + id + " -  not found.");
+        }
+
+        Dataverse dv = doomed.getDataverse();
+        List<Dataverse> dataverseWDefaultTemplate = templateService.findDataversesByDefaultTemplateId(doomed.getId());
+        try {
+            execCommand(new DeleteTemplateCommand(createDataverseRequest(getRequestUser(crc)), dv, doomed, dataverseWDefaultTemplate));
+        } catch (WrappedResponse wr) {
+            return handleWrappedResponse(wr);
+        }
+
+        return ok("Template " + doomed.getName() + " deleted.");
+    }
+
     @GET
     @AuthRequired
     @Path("{identifier}/assignments/history")

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;

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);
 

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/CreateTemplateCommand.java

@@ -49,16 +49,15 @@ public Template execute(CommandContext ctxt) throws CommandException {
         }
 
         Template createdTemplate = ctxt.templates().save(template);
-
         createdTemplate.setIsDefaultForDataverse(template.isIsDefaultForDataverse());
         if (initialize && createdTemplate.isIsDefaultForDataverse()) {
             dataverse.setDefaultTemplate(createdTemplate);
             ctxt.em().merge(dataverse);
-        }      
+        }
 
+        //Flush so that api response can include the id
         ctxt.em().flush();
         return createdTemplate;
-
     }
 
     private static void updateTermsOfUseAndAccess(CommandContext ctxt, Template template) {

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/GetTemplateCommand.java

@@ -0,0 +1,50 @@
+
+package edu.harvard.iq.dataverse.engine.command.impl;
+
+import edu.harvard.iq.dataverse.Template;
+import edu.harvard.iq.dataverse.authorization.Permission;
+import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
+import edu.harvard.iq.dataverse.engine.command.CommandContext;
+import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
+import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ *
+ * @author stephenkraffmiller
+ */
+public class GetTemplateCommand extends AbstractCommand<Template>  {
+
+    private final Template template;
+
+    public GetTemplateCommand (DataverseRequest aRequest, Template template){
+        super(aRequest, template.getDataverse());
+        this.template = template;
+    }
+
+
+
+    @Override
+    public Template execute(CommandContext ctxt) throws CommandException {
+        return template;
+    }
+
+    @Override
+    public Map<String, Set<Permission>> getRequiredPermissions() {
+        //at least need add dataset if not published also - view unpublished
+        Set<Permission> requiredPermissions = new HashSet<>();
+
+        requiredPermissions.add(Permission.AddDataset);
+        if (!template.getDataverse().isReleased()) {
+            requiredPermissions.add(Permission.ViewUnpublishedDataverse);
+        }
+
+        return Collections.singletonMap("", requiredPermissions);
+
+    }
+
+
+}