[MNT-24127] Added Endpoint To Calculate Folder Size

remote-api/src/main/java/org/alfresco/rest/api/nodes/NodeFolderSizeRelation.java

@@ -0,0 +1,209 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2024 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.nodes;
+
+import org.alfresco.model.FolderSizeModel;
+import org.alfresco.repo.action.executer.NodeSizeActionExecuter;
+import org.alfresco.repo.security.permissions.AccessDeniedException;
+import org.alfresco.rest.api.Nodes;
+import org.alfresco.rest.api.model.Node;
+import org.alfresco.rest.api.model.NodePermissions;
+import org.alfresco.rest.framework.WebApiDescription;
+import org.alfresco.rest.framework.WebApiParam;
+import org.alfresco.rest.framework.WebApiParameters;
+import org.alfresco.rest.framework.core.exceptions.InvalidNodeTypeException;
+import org.alfresco.rest.framework.resource.RelationshipResource;
+import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction;
+import org.alfresco.rest.framework.resource.parameters.Parameters;
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.action.Action;
+import org.alfresco.service.cmr.action.ActionService;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.search.SearchService;
+import org.alfresco.service.cmr.security.AccessStatus;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.util.ParameterCheck;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.extensions.webscripts.Status;
+
+import java.io.Serializable;
+import java.util.*;
+
+/**
+ * Node Size
+ *
+ * - get folder size
+ *
+ */
+@RelationshipResource(name = "calculateSize",  entityResource = NodesEntityResource.class, title = "Calculate size")
+public class NodeFolderSizeRelation implements
+        RelationshipResourceAction.CalculateSize<Map<String, Object>>,
+        RelationshipResourceAction.ReadById<Map<String, Object>>,
+        InitializingBean {
+
+    private Nodes nodes;
+    private SearchService searchService;
+    private ServiceRegistry serviceRegistry;
+    private PermissionService permissionService;
+    private NodeService nodeService;
+    private ActionService actionService;
+    static final String NOT_A_VALID_NODEID = "Node Id does not refer to a valid type [folder type]";
+
+    /**
+     * The logger
+     */
+    private static Log logger = LogFactory.getLog(NodeFolderSizeRelation.class);
+
+    /**
+     * The class that wraps the ReST APIs from core.
+     */
+
+    public void setNodes(Nodes nodes) {
+        this.nodes = nodes;
+    }
+
+    public void setSearchService(SearchService searchService) {
+        this.searchService = searchService;
+    }
+
+    public void setServiceRegistry(ServiceRegistry serviceRegistry) {
+        this.serviceRegistry = serviceRegistry;
+        this.permissionService = serviceRegistry.getPermissionService();
+    }
+
+    public void setNodeService(NodeService nodeService) {
+        this.nodeService = nodeService;
+    }
+
+    public void setActionService(ActionService actionService) {
+        this.actionService = actionService;
+    }
+
+    @Override
+    public void afterPropertiesSet() {
+        ParameterCheck.mandatory("nodes", this.nodes);
+    }
+
+    /**
+     * Folder Size - returns size of a folder.
+     *
+     * @param nodeId String id of folder - will also accept well-known alias, eg. -root- or -my- or -shared-
+     *               Please refer to OpenAPI spec for more details !
+     *               <p>
+     *               If NodeId does not exist, EntityNotFoundException (status 404).
+     */
+    @Override
+    @WebApiDescription(title = "Calculating Folder Size", description = "Calculating size of a folder/file", successStatus = Status.STATUS_ACCEPTED)
+    public Map<String, Object> createById(String nodeId, Parameters params) {
+
+        NodeRef nodeRef = nodes.validateNode(nodeId);
+        nodeService.setProperty(nodeRef, FolderSizeModel.PROP_STATUS, "IN-PROGRESS");
+        Node nodeInfo = nodes.getNode(nodeId);
+        NodePermissions nodePerms = nodeInfo.getPermissions();
+        int maxItems = params.getPaging().getMaxItems();
+        QName qName = nodeService.getType(nodeRef);
+
+        if (nodePerms != null) {
+            if (permissionService.hasPermission(nodeRef, PermissionService.READ) == AccessStatus.DENIED) {
+                throw new AccessDeniedException("permissions.err_access_denied");
+            }
+        }
+
+        if(!"folder".equals(qName.getLocalName()))
+        {
+            throw new InvalidNodeTypeException(NOT_A_VALID_NODEID);
+        }
+
+        try
+        {
+            Action folderSizeAction = actionService.createAction(NodeSizeActionExecuter.NAME);
+            folderSizeAction.setTrackStatus(true);
+            folderSizeAction.setExecuteAsynchronously(true);
+            folderSizeAction.setParameterValue(NodeSizeActionExecuter.PAGE_SIZE, maxItems);
+            actionService.executeAction(folderSizeAction, nodeRef, false, true);
+            Map<String, Object> result = new HashMap<>();
+            result.put("executionId", nodeId);
+            return result;
+        }
+        catch (Exception ex)
+        {
+            logger.error("Exception occured in NodeFolderSizeRelation:createById "+ex.getMessage());
+        }
+        return null;
+    }
+
+    @Override
+    @WebApiDescription(title = "Returns Folder Node Size", description = "Returning a Folder Node Size")
+    @WebApiParameters({
+            @WebApiParam(name = "nodeId", title = "The unique id of the Node being addressed", description = "A single node id")})
+    public Map<String, Object> readById(String nodeId, String id, Parameters parameters)
+    {
+        NodeRef nodeRef = nodes.validateNode(nodeId);
+        Node nodeInfo = nodes.getNode(nodeId);
+        NodePermissions nodePerms = nodeInfo.getPermissions();
+        QName qName = nodeService.getType(nodeRef);
+
+        if (nodePerms != null) {
+            if (permissionService.hasPermission(nodeRef, PermissionService.READ) == AccessStatus.DENIED) {
+                throw new AccessDeniedException("permissions.err_access_denied");
+            }
+        }
+
+        if(!"folder".equals(qName.getLocalName()))
+        {
+            throw new InvalidNodeTypeException(NOT_A_VALID_NODEID);
+        }
+
+        try
+        {
+            Map<QName, Serializable> properties = nodeService.getProperties(nodeRef);
+            Map<String, Object> result = new HashMap<>();
+
+            if (properties == null || !properties.containsKey(FolderSizeModel.PROP_OUTPUT)) {
+                result.put("status", "NOT INITIATED");
+            } else {
+                String status = (String) properties.get(FolderSizeModel.PROP_STATUS);
+                if ("IN-PROGRESS".equals(status)) {
+                    result.put("status", status);
+                } else {
+                    Map<String, Object> mapResult = (Map<String, Object>) properties.get(FolderSizeModel.PROP_OUTPUT);
+                    mapResult.put("status", status);
+                    result = mapResult;
+                }
+            }
+            return result;
+        }
+        catch (Exception ex)
+        {
+            logger.error("Exception occured in NodeFolderSizeRelation:readById "+ex.getMessage());
+        }
+        return null;
+    }
+}

remote-api/src/main/java/org/alfresco/rest/framework/core/ResourceInspector.java

@@ -126,6 +126,8 @@ public class ResourceInspector
 
         ALL_RELATIONSHIP_RESOURCE_INTERFACES.add(MultiPartRelationshipResourceAction.Create.class);
 
+        ALL_RELATIONSHIP_RESOURCE_INTERFACES.add(RelationshipResourceAction.CalculateSize.class);
+
         ALL_PROPERTY_RESOURCE_INTERFACES.add(BinaryResourceAction.Read.class);
         ALL_PROPERTY_RESOURCE_INTERFACES.add(BinaryResourceAction.Delete.class);
         ALL_PROPERTY_RESOURCE_INTERFACES.add(BinaryResourceAction.Update.class);
@@ -291,6 +293,7 @@ private static List<ResourceMetadata> inspectRelationship(RelationshipResource a
         findOperation(RelationshipResourceAction.DeleteSetWithResponse.class,   DELETE, helper);
 
         findOperation(MultiPartRelationshipResourceAction.Create.class, POST, helper);
+        findOperation(RelationshipResourceAction.CalculateSize.class, POST, helper);
 
         boolean noAuth = resource.isAnnotationPresent(WebApiNoAuth.class);
         if (noAuth)

remote-api/src/main/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java

@@ -163,4 +163,15 @@ public static interface DeleteSetWithResponse extends ResourceAction
          */
         public void deleteSet(String entityResourceId, Parameters params, WithResponse withResponse);
     }
+
+    interface CalculateSize<E> extends ResourceAction
+    {
+        /**
+         * Calculate the size of Folder/File.
+         *
+         * @param nodeId Entity resource context for this relationship.
+         * @param params implementation may choose to restrict the set to be deleted based on params (ie. not necessarily "all")
+         */
+        E createById(String nodeId,Parameters params);
+    }
 }

remote-api/src/main/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptGet.java

@@ -238,6 +238,16 @@ else if (EntityResourceAction.ReadByIdWithResponse.class.isAssignableFrom(resour
                         CollectionWithPagingInfo<?> relations = relationGetter.readAll(params.getEntityId(),params);
                         return relations;
                     }
+                    else if (RelationshipResourceAction.ReadById.class.isAssignableFrom(resource.getResource().getClass()))
+                    {
+                        if (resource.getMetaData().isDeleted(RelationshipResourceAction.ReadById.class))
+                        {
+                            throw new DeletedResourceException("(GET by id) "+resource.getMetaData().getUniqueId());
+                        }
+                        RelationshipResourceAction.ReadById<?> relationGetter = (RelationshipResourceAction.ReadById<?>) resource.getResource();
+                        Object result = relationGetter.readById(params.getEntityId(), params.getRelationshipId(), params);
+                        return result;
+                    }
                     else
                     {
                         if (resource.getMetaData().isDeleted(RelationshipResourceAction.ReadWithResponse.class))

remote-api/src/main/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPost.java

@@ -109,6 +109,10 @@ else if (StringUtils.isNotBlank(relationshipId))
                 {
                     throw new UnsupportedResourceOperationException("POST is executed against a collection URL");
                 }
+                else if ("calculateSize".equals(operationName))
+                {
+                    return Params.valueOf(entityId, params, "", req);
+                }
                 else
                 {
                     Object postedRel = processRequest(resourceMeta, operation, req);
@@ -366,6 +370,16 @@ public Object executeAction(ResourceWithMetadata resource, Params params, WithRe
                             return wrapWithCollectionWithPaging(createdRel);
                         }
                     }
+                    else if (RelationshipResourceAction.CalculateSize.class.isAssignableFrom(resource.getResource().getClass()))
+                    {
+                        if (resource.getMetaData().isDeleted(RelationshipResourceAction.CalculateSize.class))
+                        {
+                            throw new DeletedResourceException("(GET by id) " + resource.getMetaData().getUniqueId());
+                        }
+                        RelationshipResourceAction.CalculateSize<?> relationGetter = (RelationshipResourceAction.CalculateSize<?>) resource.getResource();
+                        Object result = relationGetter.createById(params.getEntityId(),params);
+                        return result;
+                    }
                 }
             case OPERATION:
                 return executeOperation(resource, params, withResponse);

remote-api/src/main/resources/alfresco/public-rest-context.xml

@@ -1768,4 +1768,12 @@
             </list>
         </property>
     </bean>
+
+    <bean class="org.alfresco.rest.api.nodes.NodeFolderSizeRelation">
+        <property name="nodes" ref="Nodes" />
+        <property name="searchService" ref="SearchService" />
+        <property name="serviceRegistry" ref="ServiceRegistry"/>
+        <property name="nodeService" ref="nodeService" />
+        <property name="actionService" ref="ActionService"/>
+    </bean>
 </beans>

remote-api/src/test/java/org/alfresco/AppContext02TestSuite.java

@@ -76,6 +76,7 @@
     org.alfresco.rest.api.tests.BufferedResponseTest.class,
     org.alfresco.rest.workflow.api.tests.DeploymentWorkflowApiTest.class,
     org.alfresco.rest.workflow.api.tests.ProcessDefinitionWorkflowApiTest.class,
+    org.alfresco.rest.api.tests.NodeFolderSizeApiTest.class
 })
 public class AppContext02TestSuite
 {

remote-api/src/test/java/org/alfresco/rest/api/tests/AbstractBaseApiTest.java

@@ -105,6 +105,7 @@ public abstract class AbstractBaseApiTest extends EnterpriseTestApi
 
     private static final String URL_CHILDREN = "children";
     private static final String URL_CONTENT = "content";
+    private static final String URL_CALCULATESIZE = "calculateSize";
 
     protected static final String TYPE_CM_FOLDER = "cm:folder";
     protected static final String TYPE_CM_CONTENT = "cm:content";
@@ -1120,5 +1121,10 @@ protected void disableRestDirectAccessUrls()
         RestApiDirectUrlConfig restDauConfig = (RestApiDirectUrlConfig) applicationContext.getBean("restApiDirectUrlConfig");
         restDauConfig.setEnabled(false);
     }
+
+    protected String getFolderSizeUrl(String nodeId)
+    {
+        return URL_NODES + "/" + nodeId + "/" + URL_CALCULATESIZE;
+    }
 }