Merge remote-tracking branch 'IQSS/develop' into indexingperf3

Author: qqmyers

doc/release-notes/11914-set-template-default-api.md

@@ -0,0 +1,15 @@
+## New Endpoint: POST `/dataverses/{id}/template/default/{templateId}`
+
+A new endpoint has been implemented to set the default template to a given dataverse collection.
+
+### Functionality
+- Sets the default template of the given dataverse collection.
+- You must have edit dataverse permission in the collection in order to use this endpoint.
+
+## New Endpoint: DELETE `/dataverses/{id}/template/default`
+
+A new endpoint has been implemented to remove the default template to a given dataverse collection.
+
+### Functionality
+- Removes the default template of the given dataverse collection.
+- You must have edit dataverse permission in the collection in order to use this endpoint.

doc/release-notes/12009-my-data-api-params.md

@@ -0,0 +1 @@
+The My Data API now supports the `metadata_fields`, `sort` and `order`, `show_collections` and `fq` parameters, which enhances its functionality and brings it in line with the search API.

doc/release-notes/315-fix-handle-to-citation-processing.md

@@ -0,0 +1,5 @@
+### Bug Fix
+
+Handles from hdl.handle.net with urls of `/citation` instead of `/dataset.xhtml` were not properly redirecting. This fix adds a lookup for alternate PID so `/citation` endpoint will redirect to `/dataset.xhtml`
+
+

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

@@ -1639,6 +1639,50 @@ The fully expanded example above (without environment variables) looks like this
 
   curl -H "X-Dataverse-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X POST "https://demo.dataverse.org/api/dataverses/1/templates" --upload-file dataverse-template.json
 
+Set a Default Template for a Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sets a template as the default template for a collection:
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export ID=1
+  export TEMPLATEID=2
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X POST "$SERVER_URL/api/dataverses/$ID/template/default/$TEMPLATEID"
+
+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 POST "https://demo.dataverse.org/api/dataverses/1/template/default/2"
+
+You must have Edit Dataverse permission within the given dataverse collection to invoke this api.
+
+Remove a Default Template for a Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Remove a template as the default template for a collection(Note: the template is not deleted; it will still be available for use in the collection):
+
+.. 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/default"
+
+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/default"
+
+You must have Edit Dataverse permission within the given dataverse collection to invoke this api.
+
 
 Dataverse Role Assignment History
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -8690,6 +8734,16 @@ Parameters:
 
 ``per_page`` Number of results returned per page.
 
+``metadata_fields`` Includes the requested fields for each dataset in the response. Multiple "metadata_fields" parameters can be used to include several fields. See :doc:`search` for further information on this parameter.
+
+``show_collections`` Whether or not to include a list of parent and linked collections for each dataset search result.
+
+``sort`` The sort field. Supported values include "name", "date" and "relevance".
+
+``order`` The order in which to sort. Can either be "asc" or "desc".
+
+``fq`` A filter query to filter the list returned. Multiple "fq" parameters can be used.
+
 MyData Collection List
 ~~~~~~~~~~~~~~~~~~~~~~
 

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

@@ -27,7 +27,7 @@ Name             Type     Description
 q                string   The search term or terms. Using "title:data" will search only the "title" field. "*" can be used as a wildcard either alone or adjacent to a term (i.e. "bird*"). For example, https://demo.dataverse.org/api/search?q=title:data . For a list of fields to search, please see https://github.com/IQSS/dataverse/issues/2558 (for now).
 type             string   Can be either "dataverse", "dataset", or "file". Multiple "type" parameters can be used to include multiple types (i.e. ``type=dataset&type=file``). If omitted, all types will be returned.  For example, https://demo.dataverse.org/api/search?q=*&type=dataset
 subtree          string   The identifier of the Dataverse collection to which the search should be narrowed. The subtree of this Dataverse collection and all its children will be searched.  Multiple "subtree" parameters can be used to include multiple Dataverse collections. For example, https://demo.dataverse.org/api/search?q=data&subtree=birds&subtree=cats .
-sort             string   The sort field. Supported values include "name" and "date". See example under "order".
+sort             string   The sort field. Supported values include "name", "date" and "relevance". See example under "order".
 order            string   The order in which to sort. Can either be "asc" or "desc".  For example, https://demo.dataverse.org/api/search?q=data&sort=name&order=asc
 per_page         int      The number of results to return per request. The default is 10. The max is 1000. See :ref:`iteration example <iteration-example>`.
 start            int      A cursor for paging through search results. See :ref:`iteration example <iteration-example>`.

docker-compose-dev.yml

@@ -141,6 +141,8 @@ services:
     restart: on-failure
     ports:
       - "8983:8983"
+    environment:
+      - SOLR_OPTS=-Dsolr.jetty.request.header.size=102400
     networks:
       - dataverse
     command:

docker/compose/demo/compose.yml

@@ -141,6 +141,8 @@ services:
     restart: on-failure
     ports:
       - "8983:8983"
+    environment:
+      - SOLR_OPTS=-Dsolr.jetty.request.header.size=102400
     networks:
       - dataverse
     command:

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

@@ -38,7 +38,12 @@ protected void processRequest(HttpServletRequest request, HttpServletResponse re
 
         String persistentId = request.getParameter("persistentId");
         if (persistentId != null) {
-            DvObject dob = dvObjectService.findByGlobalId(PidUtil.parseAsGlobalID(persistentId));
+            GlobalId globalId = PidUtil.parseAsGlobalID(persistentId);
+            DvObject dob = dvObjectService.findByGlobalId(globalId);
+            if (dob == null) {
+                // try to find with alternative PID
+                dob = dvObjectService.findByAltGlobalId(globalId, DvObject.DType.Dataset);
+            }
             if (dob != null) {
                 if (dob instanceof Dataset) {
                     response.sendRedirect("dataset.xhtml?persistentId=" + persistentId);

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

@@ -370,6 +370,25 @@ protected Dataverse findDataverseOrDie( String dvIdtf ) throws WrappedResponse {
         }
         return dv;
     }
+
+    protected Template findTemplateOrDie(Long templateId, Dataverse dataverse) throws WrappedResponse {
+        
+        List<Template> templates = new ArrayList<>();
+        
+        templates.addAll(dataverse.getTemplates());
+        templates.addAll(dataverse.getParentTemplates());
+        
+        Template template = templates.stream()
+                .filter(t -> Objects.equals(t.getId(), templateId))
+                .findFirst()
+                .orElse(null);
+
+        if (template == null) {
+            throw new WrappedResponse(
+                    error(Response.Status.NOT_FOUND, "Can't find template with identifier='" + templateId + "'"));
+        }
+        return template;
+    }
 
     protected DataverseLinkingDataverse findDataverseLinkingDataverseOrDie(String dataverseId, String linkedDataverseId) throws WrappedResponse {
         DataverseLinkingDataverse dvld;

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

@@ -2031,6 +2031,45 @@ public Response createTemplate(@Context ContainerRequestContext crc, String body
         }
     }
 
+    @POST
+    @AuthRequired
+    @Path("{identifier}/template/default/{templateId}")
+    public Response setDefaultTemplate(@Context ContainerRequestContext crc,
+            @PathParam("identifier") String dvId,
+            @PathParam("templateId") Long templateId) {
+
+        try {
+
+            Dataverse dataverse = findDataverseOrDie(dvId);
+            Template template = findTemplateOrDie(templateId, dataverse);
+            DataverseRequest dvReq = createDataverseRequest(getRequestUser(crc));
+            SetDefaultTemplateCommand command = new SetDefaultTemplateCommand(template, dvReq, dataverse);
+            
+            execCommand(command);
+
+            return ok(BundleUtil.getStringFromBundle("dataverse.setDefaultTemplate.success"));
+        
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+    @DELETE
+    @AuthRequired
+    @Path("{identifier}/template/default")
+    public Response removeDefaultTemplate(@Context ContainerRequestContext crc,
+            @PathParam("identifier") String dvId) {
+        try {
+            Dataverse dataverse = findDataverseOrDie(dvId);
+            RemoveDefaultTemplateCommand command = new RemoveDefaultTemplateCommand(createDataverseRequest(getRequestUser(crc)), dataverse);
+            execCommand(command);
+            return ok(BundleUtil.getStringFromBundle("dataverse.removeDefaultTemplate.success"));
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+
     @GET
     @AuthRequired
     @Path("{identifier}/allowedMetadataLanguages")