11710 find dataverses for linking

doc/release-notes/11710-get-available-dataverses-api.md

@@ -0,0 +1,5 @@
+### New API endpoint for retrieving a list of Dataverse Collections to which a given Dataset or Dataverse Collection may be linked
+
+-The end point also takes in a search term which currently must be part of the collections' names.
+-The user calling this API must have Link Dataset or Link Dataverse permission on the Dataverse Collections returned.
+-If the Collection has already been linked to the given Dataset or Collection, it will not be returned.

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

@@ -732,6 +732,50 @@ Note: you must have "Add Dataset" permission in the given collection to invoke t
 
 .. _featured-collections:
 
+List Dataverse Collections to Which a Given Dataset or Dataverse Collection May Be Linked
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The user may provide a search term to limit the list of Dataverse Collections returned. The search term will be compared to the name of the Dataverse Collections.
+The response is a JSON array of the ids, aliases, and names of the Dataverse collections to which a given Dataset or Dataverse Collection may be linked:
+
+For a given Dataverse Collection:
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export OBJECT_TYPE=dataverse
+  export ID=collectionAlias
+  export SEARCH_TERM=searchOn
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X GET "$SERVER_URL/api/dataverses/$ID/$OBJECT_TYPE/linkingDataverses?searchTerm=$SEARCH_TERM" 
+
+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/collectionAlias/dataverse/linkingDataverses?searchTerm=searchOn" 
+
+For a given Dataset:
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export OBJECT_TYPE=dataset
+  export PERSISTENT_IDENTIFIER=doi:10.5072/FK2/J8SJZB
+  export SEARCH_TERM=searchOn
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X GET "$SERVER_URL/api/dataverses/:persistentId/$OBJECT_TYPE/linkingDataverses?searchTerm=SEARCH_TERM&persistentId=$PERSISTENT_IDENTIFIER" 
+
+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/:persistentId/dataset/linkingDataverses?searchTerm=searchOn&persistentId=doi:10.5072/FK2/J8SJZB" 
+
+
+
 List Featured Collections for a Dataverse Collection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

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

@@ -13,7 +13,6 @@
 import jakarta.persistence.EntityManager;
 import jakarta.persistence.NoResultException;
 import jakarta.persistence.PersistenceContext;
-import jakarta.persistence.Query;
 import jakarta.persistence.TypedQuery;
 
 /**

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

@@ -505,35 +505,99 @@ public List<Dataverse> filterByAliasQuery(String filterQuery) {
         return ret;
     }
 
-    public List<Dataverse> filterDataversesForLinking(String query, DataverseRequest req, Dataset dataset) {
+    public List<Dataverse> filterDataversesForLinking(String query, DataverseRequest req, DvObject dvo) {
 
         List<Dataverse> dataverseList = new ArrayList<>();
 
         List<Dataverse> results = filterDataversesByNamePattern(query);
-
-        if (results == null || results.size() == 0) {
-            return null; 
+
+        if (results == null || results.isEmpty()) {
+            return null;
+        }
+
+        Dataset linkedDataset = null;
+        Dataverse linkedDataverse = null;
+        List<Object> alreadyLinkeddv_ids;
+
+        if ((dvo instanceof Dataset)) {
+            linkedDataset = (Dataset) dvo;
+            alreadyLinkeddv_ids = em.createNativeQuery("SELECT linkingdataverse_id   FROM datasetlinkingdataverse WHERE dataset_id = " + linkedDataset.getId()).getResultList();
+        } else {
+            linkedDataverse = (Dataverse) dvo;
+            alreadyLinkeddv_ids = em.createNativeQuery("SELECT linkingdataverse_id   FROM dataverselinkingdataverse WHERE dataverse_id = " + linkedDataverse.getId()).getResultList();
         }
 
-        List<Object> alreadyLinkeddv_ids = em.createNativeQuery("SELECT linkingdataverse_id   FROM datasetlinkingdataverse WHERE dataset_id = " + dataset.getId()).getResultList();
         List<Dataverse> remove = new ArrayList<>();
 
         if (alreadyLinkeddv_ids != null && !alreadyLinkeddv_ids.isEmpty()) {
             alreadyLinkeddv_ids.stream().map((testDVId) -> this.find(testDVId)).forEachOrdered((removeIt) -> {
                 remove.add(removeIt);
             });
         }
-
+
+        if (dvo instanceof Dataverse dataverse) {
+            remove.add(dataverse);
+        }
+
         for (Dataverse res : results) {
             if (!remove.contains(res)) {
-                if (this.permissionService.requestOn(req, res).has(Permission.LinkDataset)) {
+                if ((linkedDataset != null && this.permissionService.requestOn(req, res).has(Permission.LinkDataset))
+                        || (linkedDataverse != null && this.permissionService.requestOn(req, res).has(Permission.LinkDataverse))) {
                     dataverseList.add(res);
                 }
             }
         }
 
         return dataverseList;
     }
+
+    public List<Dataverse> removeUnlinkableDataverses(List<Dataverse> allWithPerms, DvObject dvo) {
+        List<Dataverse> dataverseList = new ArrayList<>();
+        Dataset linkedDataset = null;
+        Dataverse linkedDataverse = null;
+        List<Object> alreadyLinkeddv_ids;
+
+        if ((dvo instanceof Dataset)) {
+            linkedDataset = (Dataset) dvo;
+            alreadyLinkeddv_ids = em.createNativeQuery("SELECT linkingdataverse_id FROM datasetlinkingdataverse WHERE dataset_id = " + linkedDataset.getId()).getResultList();
+        } else {
+            linkedDataverse = (Dataverse) dvo;
+            alreadyLinkeddv_ids = em.createNativeQuery("SELECT linkingdataverse_id FROM dataverselinkingdataverse WHERE dataverse_id = " + linkedDataverse.getId()).getResultList();
+        }
+
+        List<Dataverse> remove = new ArrayList<>();
+
+        if (alreadyLinkeddv_ids != null && !alreadyLinkeddv_ids.isEmpty()) {
+            alreadyLinkeddv_ids.stream().map((testDVId) -> this.find(testDVId)).forEachOrdered((removeIt) -> {
+                remove.add(removeIt);
+            });
+        }
+
+
+        if (dvo instanceof Dataverse dataverse) {
+            remove.add(dataverse);
+        } 
+
+        DvObject testDVO = dvo;
+        //Remove DVO's parent up to Root
+        while (testDVO != null) {
+            if (testDVO.getOwner() == null) {
+                break; // we are at the root; which by definition is metadata block root, regardless of the value
+            }           
+            remove.add((Dataverse) testDVO.getOwner());
+            testDVO = testDVO.getOwner();
+        }       
+
+        for (Dataverse res : allWithPerms) {
+            if (!remove.contains(res)) {
+                dataverseList.add(res);
+            }
+        }
+
+        return dataverseList;
+    }
+
+
     public List<Dataverse> filterDataversesForUnLinking(String query, DataverseRequest req, Dataset dataset) {
         List<Object> alreadyLinkeddv_ids = em.createNativeQuery("SELECT linkingdataverse_id FROM datasetlinkingdataverse WHERE dataset_id = " + dataset.getId()).getResultList();
         List<Dataverse> dataverseList = new ArrayList<>();

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

@@ -96,7 +96,7 @@ public class PermissionServiceBean {
     DatasetVersionFilesServiceBean datasetVersionFilesServiceBean;
 
     private static final String LIST_ALL_DATAVERSES_SUPERUSER_HAS_PERMISSION = """
-        SELECT id, name, alias FROM DATAVERSE
+        SELECT id, name, alias FROM DATAVERSE dv
     """;
 
     private static final String LIST_ALL_DATAVERSES_USER_HAS_PERMISSION = """
@@ -105,7 +105,7 @@ WITH grouplist AS (
                   WHERE explicitgroup_authenticateduser.containedauthenticatedusers_id = @USERID
                 )
 
-                SELECT * FROM DATAVERSE WHERE id IN (
+                SELECT * FROM DATAVERSE dv WHERE id IN (
                   SELECT definitionpoint_id
                   FROM roleassignment
                   WHERE roleassignment.assigneeidentifier IN (
@@ -161,8 +161,24 @@ AND EXISTS (SELECT id FROM dataverserole WHERE dataverserole.id = roleassignment
                        AND @IPRANGESQL
                      )
                   )
-                )
+                ) 
             """;
+
+        private static final String AND = """
+                                          and
+                                          """;
+
+        private static final String WHERE = """
+                                          where
+                                          """;
+
+        private static final String SEARCH_PARAMS  = """
+                                                             ((LOWER(dv.name) LIKE ? and ((SUBSTRING(LOWER(dv.name),0,(LENGTH(dv.name)-9)) LIKE ?)
+                                                                         or (SUBSTRING(LOWER(dv.name),0,(LENGTH(dv.name)-9)) LIKE ?))) 
+                                                                     or (LOWER(dv.name) NOT LIKE ? and ((LOWER(dv.name) LIKE ?)
+                                                                     or (LOWER(dv.name) LIKE ?))))
+                                                     """;
+
     /**
      * A request-level permission query (e.g includes IP ras).
      */
@@ -921,12 +937,21 @@ private boolean hasUnrestrictedReleasedFiles(DatasetVersion targetDatasetVersion
         Long result = em.createQuery(criteriaQuery).getSingleResult();
         return result > 0;
     }
-
+    
     public List<Dataverse> findPermittedCollections(DataverseRequest request, AuthenticatedUser user, Permission permission) {
-        return findPermittedCollections(request, user, 1 << permission.ordinal());
+        return findPermittedCollections(request, user, 1 << permission.ordinal(), "");
     }
 
+    public List<Dataverse> findPermittedCollections(DataverseRequest request, AuthenticatedUser user, Permission permission, String searchTerm) {
+        return findPermittedCollections(request, user, 1 << permission.ordinal(), searchTerm);
+    }
+
     public List<Dataverse> findPermittedCollections(DataverseRequest request, AuthenticatedUser user, int permissionBit) {
+        return findPermittedCollections(request, user, permissionBit, "");
+    }
+
+
+    public List<Dataverse> findPermittedCollections(DataverseRequest request, AuthenticatedUser user, int permissionBit, String searchTerm) {
         if (user != null) {
             // IP Group - Only check IP if a User is calling for themself
             String ipRangeSQL = "FALSE";
@@ -958,13 +983,64 @@ public List<Dataverse> findPermittedCollections(DataverseRequest request, Authen
             String sqlCode;
             if (user.isSuperuser()) {
                 sqlCode = LIST_ALL_DATAVERSES_SUPERUSER_HAS_PERMISSION;
+
+                if (searchTerm == null || searchTerm.isEmpty()) {
+                    return em.createNativeQuery(sqlCode, Dataverse.class).getResultList();
+                } else {
+                    sqlCode = LIST_ALL_DATAVERSES_SUPERUSER_HAS_PERMISSION.concat(WHERE).concat(SEARCH_PARAMS);
+
+                    String pattern = searchTerm.toLowerCase();
+                    String pattern1 = pattern + "%";
+                    String pattern2 = "% " + pattern + "%";
+
+                    // Adjust the queries for very short, 1 
+                    if (pattern.length() == 1) {
+                        pattern1 = pattern;
+                        pattern2 = pattern + " %";
+                    }
+                    Query query = em.createNativeQuery(sqlCode, Dataverse.class);
+                    query.setParameter(1, "%dataverse");
+                    query.setParameter(2, pattern1);
+                    query.setParameter(3, pattern2);
+                    query.setParameter(4, "%dataverse");
+                    query.setParameter(5, pattern1);
+                    query.setParameter(6, pattern2);
+                    return query.getResultList();
+
+                }
             } else {
-                sqlCode = LIST_ALL_DATAVERSES_USER_HAS_PERMISSION
-                        .replace("@USERID", String.valueOf(user.getId()))
-                        .replace("@PERMISSIONBIT", String.valueOf(permissionBit))
-                        .replace("@IPRANGESQL", ipRangeSQL);
+                if (searchTerm == null || searchTerm.isEmpty()) {
+                    sqlCode = LIST_ALL_DATAVERSES_USER_HAS_PERMISSION
+                            .replace("@USERID", String.valueOf(user.getId()))
+                            .replace("@PERMISSIONBIT", String.valueOf(permissionBit))
+                            .replace("@IPRANGESQL", ipRangeSQL);
+                    return em.createNativeQuery(sqlCode, Dataverse.class).getResultList();
+                } else {
+                    String pattern = searchTerm.toLowerCase();
+                    String pattern1 = pattern + "%";
+                    String pattern2 = "% " + pattern + "%";
+
+                    // Adjust the queries for very short, 1 
+                    if (pattern.length() == 1) {
+                        pattern1 = pattern;
+                        pattern2 = pattern + " %";
+                    }
+
+                    sqlCode = LIST_ALL_DATAVERSES_USER_HAS_PERMISSION.concat(AND).concat(SEARCH_PARAMS)
+                            .replace("@USERID", String.valueOf(user.getId()))
+                            .replace("@PERMISSIONBIT", String.valueOf(permissionBit))
+                            .replace("@IPRANGESQL", ipRangeSQL);
+
+                    Query query = em.createNativeQuery(sqlCode, Dataverse.class);
+                    query.setParameter(1, "%dataverse");
+                    query.setParameter(2, pattern1);
+                    query.setParameter(3, pattern2);
+                    query.setParameter(4, "%dataverse");
+                    query.setParameter(5, pattern1);
+                    query.setParameter(6, pattern2);
+                    return query.getResultList();
+                }
             }
-            return em.createNativeQuery(sqlCode, Dataverse.class).getResultList();
         }
         return null;
     }

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

@@ -615,11 +615,12 @@ protected DvObject findDvo(@NotNull final String id) throws WrappedResponse {
      *
      * @param dvIdtf
      * @param type
+     * @param testForReleased
      * @return DvObject if type matches or throw exception
      * @throws WrappedResponse
      */
     @NotNull
-    protected DvObject findDvoByIdAndFeaturedItemTypeOrDie(@NotNull final String dvIdtf, String type) throws WrappedResponse {
+    protected DvObject findDvoByIdAndTypeOrDie(@NotNull final String dvIdtf, String type, boolean testForReleased) throws WrappedResponse {
         try {
             DataverseFeaturedItem.TYPES dvType = DataverseFeaturedItem.getDvType(type);
             DvObject dvObject = null;
@@ -652,7 +653,12 @@ protected DvObject findDvoByIdAndFeaturedItemTypeOrDie(@NotNull final String dvI
                     }
                 }
             }
-            DataverseFeaturedItem.validateTypeAndDvObject(dvIdtf, dvObject, dvType);
+            if (testForReleased){
+                DataverseFeaturedItem.validateTypeAndDvObject(dvIdtf, dvObject, dvType);
+            }
+            if (dvObject == null) {
+                throw new WrappedResponse(notFound(BundleUtil.getStringFromBundle("find.dvo.error.dvObjectNotFound", Collections.singletonList(dvIdtf))));
+            }
             return dvObject;
         } catch (IllegalArgumentException e) {
             throw new WrappedResponse(error(Response.Status.BAD_REQUEST, e.getMessage()));

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

@@ -63,7 +63,7 @@ public Response updateFeaturedItem(@Context ContainerRequestContext crc,
             if (dataverseFeaturedItem == null) {
                 throw new WrappedResponse(error(Response.Status.NOT_FOUND, MessageFormat.format(BundleUtil.getStringFromBundle("dataverseFeaturedItems.errors.notFound"), id)));
             }
-            DvObject dvObject = (dvObjectIdtf != null) ? findDvoByIdAndFeaturedItemTypeOrDie(dvObjectIdtf, type) : null;
+            DvObject dvObject = (dvObjectIdtf != null) ? findDvoByIdAndTypeOrDie(dvObjectIdtf, type, true) : null;
             UpdatedDataverseFeaturedItemDTO updatedDataverseFeaturedItemDTO = UpdatedDataverseFeaturedItemDTO.fromFormData(content, displayOrder, keepFile, imageFileInputStream, contentDispositionHeader, type, dvObject);
             return ok(json(execCommand(new UpdateDataverseFeaturedItemCommand(createDataverseRequest(getRequestUser(crc)), dataverseFeaturedItem, updatedDataverseFeaturedItemDTO))));
         } catch (WrappedResponse e) {