Merged FILE-FOLDER-API (5.2.0) to HEAD (5.2)

124740 gjames: RA-847, RA-848 Retrieving deleted nodes


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@126581 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/rest/api/DeletedNodes.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2005-2016 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * 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/>.
+ */
+package org.alfresco.rest.api;
+
+import org.alfresco.rest.api.model.Node;
+import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
+import org.alfresco.rest.framework.resource.parameters.Parameters;
+
+/**
+ * Handles trashcan / deleted nodes
+ *
+ * @author Gethin James
+ */
+public interface DeletedNodes
+{
+    CollectionWithPagingInfo<Node> listDeleted(Parameters parameters);
+    Node getDeletedNode(String originalId, Parameters parameters);
+}

source/java/org/alfresco/rest/api/Nodes.java

@@ -19,11 +19,14 @@
 package org.alfresco.rest.api;
 
 import java.io.InputStream;
+import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import org.alfresco.rest.api.model.Document;
 import org.alfresco.rest.api.model.Folder;
 import org.alfresco.rest.api.model.Node;
+import org.alfresco.rest.api.model.UserInfo;
 import org.alfresco.rest.framework.resource.content.BasicContentInfo;
 import org.alfresco.rest.framework.resource.content.BinaryResource;
 import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
@@ -77,7 +80,21 @@ public interface Nodes
      * @return
      */
     Node getFolderOrDocument(String nodeId, Parameters parameters);
-    
+
+    Node getFolderOrDocumentFullInfo(NodeRef nodeRef, NodeRef parentNodeRef, QName nodeTypeQName, Parameters parameters, Map<String, UserInfo> mapUserInfo);
+
+    /**
+     * Get the folder or document representation (as appropriate) for the given node.
+     *
+     * @param nodeRef A real Node
+     * @param parentNodeRef
+     * @param nodeTypeQName
+     * @param includeParam
+     * @param mapUserInfo
+     * @return
+     */
+    Node getFolderOrDocument(NodeRef nodeRef, NodeRef parentNodeRef, QName nodeTypeQName, List<String> includeParam, Map<String, UserInfo> mapUserInfo);
+
     /**
      * Get list of children of a parent folder.
      *

source/java/org/alfresco/rest/api/impl/DeletedNodesImpl.java

@@ -0,0 +1,131 @@
+/*
+ * Copyright (C) 2005-2016 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * 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/>.
+ */
+package org.alfresco.rest.api.impl;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.query.PagingRequest;
+import org.alfresco.query.PagingResults;
+import org.alfresco.repo.node.archive.ArchivedNodesCannedQueryBuilder;
+import org.alfresco.rest.api.model.Node;
+import org.alfresco.repo.node.archive.NodeArchiveService;
+import org.alfresco.rest.api.DeletedNodes;
+import org.alfresco.rest.api.Nodes;
+import org.alfresco.rest.api.model.UserInfo;
+import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
+import org.alfresco.rest.framework.resource.parameters.Parameters;
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.repository.StoreRef;
+import org.alfresco.service.cmr.security.PersonService;
+import org.alfresco.service.namespace.QName;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Handles trashcan / deleted nodes
+ *
+ * @author Gethin James
+ */
+public class DeletedNodesImpl implements DeletedNodes
+{
+    private NodeArchiveService nodeArchiveService;
+    private PersonService personService;
+    private NodeService nodeService;
+    private Nodes nodes;
+
+    public void setNodeArchiveService(NodeArchiveService nodeArchiveService)
+    {
+        this.nodeArchiveService = nodeArchiveService;
+    }
+
+    public void setPersonService(PersonService personService)
+    {
+        this.personService = personService;
+    }
+
+    public void setNodeService(NodeService nodeService)
+    {
+        this.nodeService = nodeService;
+    }
+
+    public void setNodes(Nodes nodes)
+    {
+        this.nodes = nodes;
+    }
+
+    /**
+     * Sets archived information on the Node
+     * @param aNode
+     * @param mapUserInfo
+     */
+    private void mapArchiveInfo(Node aNode, Map<String, UserInfo> mapUserInfo)
+    {
+        if (mapUserInfo == null) {
+            mapUserInfo = new HashMap<>();
+        }
+        Map<QName, Serializable> nodeProps = nodeService.getProperties(aNode.getNodeRef());
+        aNode.setArchivedAt((Date)nodeProps.get(ContentModel.PROP_ARCHIVED_DATE));
+        aNode.setArchivedByUser(aNode.lookupUserInfo((String)nodeProps.get(ContentModel.PROP_ARCHIVED_BY), mapUserInfo, personService));
+    }
+
+    @Override
+    public CollectionWithPagingInfo<Node> listDeleted(Parameters parameters)
+    {
+        PagingRequest pagingRequest = Util.getPagingRequest(parameters.getPaging());
+        NodeRef archiveStoreRootNodeRef = nodeService.getStoreArchiveNode(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE);
+
+        // Create canned query
+        ArchivedNodesCannedQueryBuilder queryBuilder = new ArchivedNodesCannedQueryBuilder.Builder(
+                archiveStoreRootNodeRef, pagingRequest).sortOrderAscending(false).build();
+
+        // Query the DB
+        PagingResults<NodeRef> result = nodeArchiveService.listArchivedNodes(queryBuilder);
+        List<Node> nodesFound = new ArrayList<Node>(result.getPage().size());
+        Map mapUserInfo = new HashMap<>();
+        for (NodeRef nRef:result.getPage())
+        {
+            Node foundNode = nodes.getFolderOrDocument(nRef, null, null, parameters.getInclude(), mapUserInfo);
+            mapArchiveInfo(foundNode,mapUserInfo);
+            nodesFound.add(foundNode);
+        }
+        return CollectionWithPagingInfo.asPaged(parameters.getPaging(), nodesFound);
+    }
+
+    @Override
+    public Node getDeletedNode(String originalId, Parameters parameters)
+    {
+        //First check the node is valid and has been archived.
+        NodeRef validatedNodeRef = nodes.validateNode(StoreRef.STORE_REF_ARCHIVE_SPACESSTORE, originalId);
+
+        //Now get the Node
+        NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, validatedNodeRef.getId());
+        NodeRef archivedNodeRef = nodeArchiveService.getArchivedNode(nodeRef);
+
+        //Turn it into a JSON Node (FULL version)
+        Node foundNode = nodes.getFolderOrDocumentFullInfo(archivedNodeRef, null, null, parameters, null);
+        if (foundNode != null) mapArchiveInfo(foundNode,null);
+        return foundNode;
+    }
+}

source/java/org/alfresco/rest/api/impl/NodesImpl.java

@@ -767,7 +767,8 @@ public class NodesImpl implements Nodes
         return getFolderOrDocumentFullInfo(nodeRef, parentNodeRef, nodeTypeQName, parameters, null);
     }
 
-    private Node getFolderOrDocumentFullInfo(NodeRef nodeRef, NodeRef parentNodeRef, QName nodeTypeQName, Parameters parameters, Map<String,UserInfo> mapUserInfo)
+    @Override
+    public Node getFolderOrDocumentFullInfo(NodeRef nodeRef, NodeRef parentNodeRef, QName nodeTypeQName, Parameters parameters, Map<String,UserInfo> mapUserInfo)
     {
         List<String> includeParam = new ArrayList<>();
         if (parameters != null)
@@ -782,7 +783,8 @@ public class NodesImpl implements Nodes
         return getFolderOrDocument(nodeRef, parentNodeRef, nodeTypeQName, includeParam, mapUserInfo);
     }
 
-    private Node getFolderOrDocument(final NodeRef nodeRef, NodeRef parentNodeRef, QName nodeTypeQName, List<String> includeParam, Map<String,UserInfo> mapUserInfo)
+    @Override
+    public Node getFolderOrDocument(final NodeRef nodeRef, NodeRef parentNodeRef, QName nodeTypeQName, List<String> includeParam, Map<String, UserInfo> mapUserInfo)
     {
         if (mapUserInfo == null)
         {

source/java/org/alfresco/rest/api/model/Node.java

@@ -56,6 +56,10 @@ public class Node implements Comparable<Node>
     protected UserInfo createdByUser;
     protected UserInfo modifiedByUser;
 
+    //Archived info, explicitly setting to NULL because NULLS don't get shown in the JSON.
+    protected Date archivedAt = null;
+    protected UserInfo archivedByUser = null;
+
     protected Boolean isFolder;
     protected Boolean isFile;
     protected Boolean isLink;
@@ -303,6 +307,26 @@ public class Node implements Comparable<Node>
         this.relativePath = relativePath;
     }
 
+    public Date getArchivedAt()
+    {
+        return archivedAt;
+    }
+
+    public void setArchivedAt(Date archivedAt)
+    {
+        this.archivedAt = archivedAt;
+    }
+
+    public UserInfo getArchivedByUser()
+    {
+        return archivedByUser;
+    }
+
+    public void setArchivedByUser(UserInfo archivedByUser)
+    {
+        this.archivedByUser = archivedByUser;
+    }
+
     public boolean equals(Object other)
     {
         if(this == other)
@@ -339,6 +363,14 @@ public class Node implements Comparable<Node>
         sb.append(", modifiedByUser=").append(getModifiedByUser());
         sb.append(", createdAt=").append(getCreatedAt());
         sb.append(", createdByUser=").append(getCreatedByUser());
+        if (getArchivedAt() != null)
+        {
+            sb.append(", archivedAt=").append(getArchivedAt());
+        }
+        if (getArchivedByUser() != null)
+        {
+            sb.append(", archivedByUser=").append(getArchivedByUser());
+        }
         if (getIsLink() != null)
         {
             sb.append(", isLink=").append(getIsLink()); // note: symbolic link (not shared link)

source/java/org/alfresco/rest/api/trashcan/TrashcanEntityResource.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) 2005-2016 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * 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/>.
+ */
+package org.alfresco.rest.api.trashcan;
+
+
+import org.alfresco.query.PagingRequest;
+import org.alfresco.query.PagingResults;
+import org.alfresco.repo.node.archive.ArchivedNodesCannedQueryBuilder;
+import org.alfresco.repo.node.archive.NodeArchiveService;
+import org.alfresco.rest.api.DeletedNodes;
+import org.alfresco.rest.api.Nodes;
+import org.alfresco.rest.api.impl.Util;
+import org.alfresco.rest.api.model.Node;
+import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
+import org.alfresco.rest.framework.resource.EntityResource;
+import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
+import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
+import org.alfresco.rest.framework.resource.parameters.Parameters;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.repository.StoreRef;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * An implementation of an Entity Resource for handling archived content
+ *
+ * @author Gethin James
+ */
+@EntityResource(name="deleted-nodes", title = "Deleted Nodes")
+public class TrashcanEntityResource implements
+        EntityResourceAction.ReadById<Node>, EntityResourceAction.Read<Node>
+{
+    private DeletedNodes deletedNodes;
+
+    public void setDeletedNodes(DeletedNodes deletedNodes)
+    {
+        this.deletedNodes = deletedNodes;
+    }
+
+    @Override
+    public CollectionWithPagingInfo<Node> readAll(Parameters params)
+    {
+        return deletedNodes.listDeleted(params);
+    }
+
+    @Override
+    public Node readById(String id, Parameters parameters) throws EntityNotFoundException
+    {
+        return deletedNodes.getDeletedNode(id, parameters);
+    }
+}

source/java/org/alfresco/rest/api/trashcan/package-info.java

@@ -0,0 +1,4 @@
+@WebApi(name="alfresco", scope=Api.SCOPE.PUBLIC, version=1)
+package org.alfresco.rest.api.trashcan;
+import org.alfresco.rest.framework.Api;
+import org.alfresco.rest.framework.WebApi;