Added an optional parameter to the quota APIs to show the quota that may be inherited from a parent collection. #11987

Author: landreev

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

@@ -1250,7 +1250,8 @@ Collection Storage Quotas
 
   curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/dataverses/$ID/storage/quota"
 
-Will output the storage quota allocated (in bytes), or a message indicating that the quota is not defined for the specific collection. The user identified by the API token must have the ``Edit`` permission on the collection. 
+Will output the storage quota allocated (in bytes), or a message indicating that the quota is not defined for the collection. The user identified by the API token must have the ``Edit`` permission on the collection. 
+With an optional query parameter ``showInherited=true`` it will show the applicable quota potentially defined on the nearest parent when the collection does not have a quota configured directly.
 
 .. code-block:: 
 
@@ -1282,7 +1283,8 @@ Storage Quotas on Individual Datasets
 
   curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/datasets/$ID/storage/quota"
 
-Will output the storage quota allocated (in bytes), or a message indicating that the quota is not defined for the specific collection. The user identified by the API token must have the ``Edit`` permission on the dataset. 
+Will output the storage quota allocated (in bytes), or a message indicating that the quota is not defined for this dataset. The user identified by the API token must have the ``Edit`` permission on the dataset.
+With an optional query parameter ``showInherited=true`` it will show the applicable quota potentially defined on the nearest parent collection when the dataset does not have a quota configured directly.
 
 .. code-block:: 
 

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

@@ -6170,9 +6170,9 @@ public Response updateLicense(@Context ContainerRequestContext crc,
     @GET
     @AuthRequired
     @Path("{identifier}/storage/quota")
-    public Response getDatasetQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf) throws WrappedResponse {
+    public Response getDatasetQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf, @QueryParam("showInherited") boolean showInherited) throws WrappedResponse {
         try {
-            Long bytesAllocated = execCommand(new GetDatasetQuotaCommand(createDataverseRequest(getRequestUser(crc)), findDatasetOrDie(dvIdtf)));
+            Long bytesAllocated = execCommand(new GetDatasetQuotaCommand(createDataverseRequest(getRequestUser(crc)), findDatasetOrDie(dvIdtf), showInherited));
             if (bytesAllocated != null) {
                 return ok(MessageFormat.format(BundleUtil.getStringFromBundle("dataset.storage.quota.allocation"),bytesAllocated));
             }

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

@@ -1236,9 +1236,9 @@ public Response getStorageSize(@Context ContainerRequestContext crc, @PathParam(
     @GET
     @AuthRequired
     @Path("{identifier}/storage/quota")
-    public Response getCollectionQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf) throws WrappedResponse {
+    public Response getCollectionQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf, @QueryParam("showInherited") boolean showInherited) throws WrappedResponse {
         try {
-            Long bytesAllocated = execCommand(new GetCollectionQuotaCommand(createDataverseRequest(getRequestUser(crc)), findDataverseOrDie(dvIdtf)));
+            Long bytesAllocated = execCommand(new GetCollectionQuotaCommand(createDataverseRequest(getRequestUser(crc)), findDataverseOrDie(dvIdtf), showInherited));
             if (bytesAllocated != null) {
                 return ok(MessageFormat.format(BundleUtil.getStringFromBundle("dataverse.storage.quota.allocation"),bytesAllocated));
             }

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

@@ -23,17 +23,30 @@ public class GetCollectionQuotaCommand  extends AbstractCommand<Long> {
     private static final Logger logger = Logger.getLogger(GetCollectionQuotaCommand.class.getCanonicalName());
 
     private final Dataverse dataverse;
+    private final boolean inherited;
 
-    public GetCollectionQuotaCommand(DataverseRequest aRequest, Dataverse target) {
+    public GetCollectionQuotaCommand(DataverseRequest aRequest, Dataverse target, boolean inherited) {
         super(aRequest, target);
         dataverse = target;
+        this.inherited = inherited;
     } 
 
     @Override
     public Long execute(CommandContext ctxt) throws CommandException {
 
-        if (dataverse != null && dataverse.getStorageQuota() != null) {
-            return dataverse.getStorageQuota().getAllocation();
+        if (dataverse != null) {
+
+            if (dataverse.getStorageQuota() != null) {
+                return dataverse.getStorageQuota().getAllocation();
+            } else if (inherited) {
+                Dataverse uptree = dataverse; 
+                while (uptree.getStorageQuota() == null && uptree.getOwner() != null) {
+                    uptree = uptree.getOwner(); 
+                    if (uptree.getStorageQuota() != null) {
+                        return uptree.getStorageQuota().getAllocation();
+                    }
+                }
+            }
         }
 
         return null;

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

@@ -1,6 +1,7 @@
 package edu.harvard.iq.dataverse.engine.command.impl;
 
 import edu.harvard.iq.dataverse.Dataset;
+import edu.harvard.iq.dataverse.DvObjectContainer;
 import edu.harvard.iq.dataverse.authorization.Permission;
 import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
 import edu.harvard.iq.dataverse.engine.command.CommandContext;
@@ -23,19 +24,31 @@ public class GetDatasetQuotaCommand extends AbstractCommand<Long> {
     private static final Logger logger = Logger.getLogger(GetDatasetQuotaCommand.class.getCanonicalName());
 
     private final Dataset dataset;
+    private final boolean inherited;
 
-    public GetDatasetQuotaCommand(DataverseRequest aRequest, Dataset target) {
+    public GetDatasetQuotaCommand(DataverseRequest aRequest, Dataset target, boolean inherited) {
         super(aRequest, target);
         dataset = target;
+        this.inherited = inherited; 
     } 
 
     @Override
     public Long execute(CommandContext ctxt) throws CommandException {
 
-        if (dataset != null && dataset.getStorageQuota() != null) {
-            return dataset.getStorageQuota().getAllocation();
+        if (dataset != null) {
+            if (dataset.getStorageQuota() != null) {
+                return dataset.getStorageQuota().getAllocation();
+            } else if (inherited) {
+                DvObjectContainer uptree = dataset;
+                while (uptree.getStorageQuota() == null && uptree.getOwner() != null) {
+                    uptree = uptree.getOwner();
+                    if (uptree.getStorageQuota() != null) {
+                        return uptree.getStorageQuota().getAllocation();
+                    }
+                }
+            }
         }
-        
+
         return null;
     }