diff --git a/src/main/java/org/alfresco/rest/api/DeletedNodes.java b/src/main/java/org/alfresco/rest/api/DeletedNodes.java index 96cca3fdd8..23f0665549 100644 --- a/src/main/java/org/alfresco/rest/api/DeletedNodes.java +++ b/src/main/java/org/alfresco/rest/api/DeletedNodes.java @@ -25,14 +25,15 @@ */ package org.alfresco.rest.api; -import org.alfresco.repo.node.archive.RestoreNodeReport; +import java.util.Map; + import org.alfresco.rest.api.model.Node; +import org.alfresco.rest.api.model.Rendition; import org.alfresco.rest.api.model.UserInfo; +import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException; +import org.alfresco.rest.framework.resource.content.BinaryResource; import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo; import org.alfresco.rest.framework.resource.parameters.Parameters; -import org.alfresco.service.cmr.repository.NodeRef; - -import java.util.Map; /** * Handles trashcan / deleted nodes @@ -70,4 +71,29 @@ public interface DeletedNodes * @param archivedId */ void purgeArchivedNode(String archivedId); + + /** + * Download file content (or rendition content) via archived node. + * + * @param archivedId + * @param renditionId + * - optional + * @param parameters + * {@link Parameters} + * @return + */ + BinaryResource getContent(String archivedId, String renditionId, Parameters parameters); + + /** + * @param archivedId + * @param renditionId + * @return + */ + Rendition getRendition(String archivedId, String renditionId, Parameters parameters); + + /** + * @param archivedId + * @return + */ + CollectionWithPagingInfo getRenditions(String archivedId, Parameters parameters); } diff --git a/src/main/java/org/alfresco/rest/api/Renditions.java b/src/main/java/org/alfresco/rest/api/Renditions.java index 2e4cb687fa..3a92e5e809 100644 --- a/src/main/java/org/alfresco/rest/api/Renditions.java +++ b/src/main/java/org/alfresco/rest/api/Renditions.java @@ -44,51 +44,41 @@ public interface Renditions /** * Lists all available renditions includes those that have been created and those that are yet to be created. * - * @param nodeId the source node id + * @param nodeRef * @param parameters the {@link Parameters} object to get the parameters passed into the request * @return the rendition results */ - CollectionWithPagingInfo getRenditions(String nodeId, Parameters parameters); + CollectionWithPagingInfo getRenditions(NodeRef nodeRef, Parameters parameters); /** * Gets information about a rendition of a node in the repository. * If there is no rendition, then returns the available/registered rendition. * - * @param nodeId the source node id + * @param nodeRef * @param renditionId the rendition id * @param parameters the {@link Parameters} object to get the parameters passed into the request * @return the {@link Rendition} object */ - Rendition getRendition(String nodeId, String renditionId, Parameters parameters); + Rendition getRendition(NodeRef nodeRef, String renditionId, Parameters parameters); /** * Creates a rendition for the given node asynchronously. * - * @param nodeId the source node id + * @param nodeRef * @param rendition the {@link Rendition} request * @param parameters the {@link Parameters} object to get the parameters passed into the request */ - void createRendition(String nodeId, Rendition rendition, Parameters parameters); + void createRendition(NodeRef nodeRef, Rendition rendition, Parameters parameters); /** * Creates a rendition for the given node - either async r sync - * - * @param nodeId + * + * @param nodeRef * @param rendition * @param executeAsync * @param parameters */ - void createRendition(String nodeId, Rendition rendition, boolean executeAsync, Parameters parameters); - - /** - * Downloads rendition. - * - * @param nodeId the source node id - * @param renditionId the rendition id - * @param parameters the {@link Parameters} object to get the parameters passed into the request - * @return the rendition stream - */ - BinaryResource getContent(String nodeId, String renditionId, Parameters parameters); + void createRendition(NodeRef nodeRef, Rendition rendition, boolean executeAsync, Parameters parameters); /** * Downloads rendition. @@ -99,5 +89,15 @@ public interface Renditions * @return the rendition stream */ BinaryResource getContent(NodeRef sourceNodeRef, String renditionId, Parameters parameters); + + /** + * Downloads rendition. + * + * @param sourceNodeRef the source nodeRef + * @param renditionId the rendition id + * @param parameters the {@link Parameters} object to get the parameters passed into the request + * @return the rendition stream + */ + BinaryResource getContentNoValidation(NodeRef sourceNodeRef, String renditionId, Parameters parameters); } diff --git a/src/main/java/org/alfresco/rest/api/impl/DeletedNodesImpl.java b/src/main/java/org/alfresco/rest/api/impl/DeletedNodesImpl.java index 7b35478019..9e226c1cfd 100644 --- a/src/main/java/org/alfresco/rest/api/impl/DeletedNodesImpl.java +++ b/src/main/java/org/alfresco/rest/api/impl/DeletedNodesImpl.java @@ -25,6 +25,13 @@ */ package org.alfresco.rest.api.impl; +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + import org.alfresco.model.ContentModel; import org.alfresco.query.PagingRequest; import org.alfresco.query.PagingResults; @@ -34,39 +41,38 @@ import org.alfresco.repo.node.archive.RestoreNodeReport; import org.alfresco.repo.node.integrity.IntegrityException; import org.alfresco.rest.api.DeletedNodes; import org.alfresco.rest.api.Nodes; +import org.alfresco.rest.api.Renditions; import org.alfresco.rest.api.model.Node; +import org.alfresco.rest.api.model.Rendition; import org.alfresco.rest.api.model.UserInfo; import org.alfresco.rest.framework.core.exceptions.ApiException; import org.alfresco.rest.framework.core.exceptions.ConstraintViolatedException; import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException; import org.alfresco.rest.framework.core.exceptions.NotFoundException; import org.alfresco.rest.framework.core.exceptions.PermissionDeniedException; +import org.alfresco.rest.framework.resource.content.BinaryResource; import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo; import org.alfresco.rest.framework.resource.parameters.Parameters; +import org.alfresco.rest.framework.tools.RecognizedParamsExtractor; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; 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 +public class DeletedNodesImpl implements DeletedNodes, RecognizedParamsExtractor { private NodeArchiveService nodeArchiveService; private PersonService personService; private NodeService nodeService; private Nodes nodes; + private Renditions renditions; public void setNodeArchiveService(NodeArchiveService nodeArchiveService) { @@ -88,6 +94,11 @@ public class DeletedNodesImpl implements DeletedNodes this.nodes = nodes; } + public void setRenditions(Renditions renditions) + { + this.renditions = renditions; + } + /** * Sets archived information on the Node * @param aNode @@ -165,20 +176,20 @@ public class DeletedNodesImpl implements DeletedNodes RestoreNodeReport restored = nodeArchiveService.restoreArchivedNode(validatedNodeRef); switch (restored.getStatus()) { - case SUCCESS: - return nodes.getFolderOrDocumentFullInfo(restored.getRestoredNodeRef(), null, null, null, null); - case FAILURE_PERMISSION: - throw new PermissionDeniedException(); - case FAILURE_INTEGRITY: - throw new IntegrityException("Restore failed due to an integrity error", null); - case FAILURE_DUPLICATE_CHILD_NODE_NAME: - throw new ConstraintViolatedException("Name already exists in target"); - case FAILURE_INVALID_ARCHIVE_NODE: - throw new EntityNotFoundException(archivedId); - case FAILURE_INVALID_PARENT: - throw new NotFoundException("Invalid parent id "+restored.getTargetParentNodeRef()); - default: - throw new ApiException("Unable to restore node "+archivedId); + case SUCCESS: + return nodes.getFolderOrDocumentFullInfo(restored.getRestoredNodeRef(), null, null, null, null); + case FAILURE_PERMISSION: + throw new PermissionDeniedException(); + case FAILURE_INTEGRITY: + throw new IntegrityException("Restore failed due to an integrity error", null); + case FAILURE_DUPLICATE_CHILD_NODE_NAME: + throw new ConstraintViolatedException("Name already exists in target"); + case FAILURE_INVALID_ARCHIVE_NODE: + throw new EntityNotFoundException(archivedId); + case FAILURE_INVALID_PARENT: + throw new NotFoundException("Invalid parent id "+restored.getTargetParentNodeRef()); + default: + throw new ApiException("Unable to restore node "+archivedId); } } @@ -189,4 +200,35 @@ public class DeletedNodesImpl implements DeletedNodes NodeRef validatedNodeRef = nodes.validateNode(StoreRef.STORE_REF_ARCHIVE_SPACESSTORE, archivedId); nodeArchiveService.purgeArchivedNode(validatedNodeRef); } + + @Override + public BinaryResource getContent(String archivedId, String renditionId, Parameters parameters) + { + // First check if the archived node is valid + NodeRef validatedNodeRef = nodes.validateNode(StoreRef.STORE_REF_ARCHIVE_SPACESSTORE, archivedId); + + if (renditionId != null) + { + return renditions.getContent(validatedNodeRef, renditionId, parameters); + } + else + { + return nodes.getContent(validatedNodeRef, parameters, false); + } + } + + @Override + public Rendition getRendition(String archivedId, String renditionId, Parameters parameters) + { + NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_ARCHIVE_SPACESSTORE, archivedId); + Rendition rendition = renditions.getRendition(nodeRef, renditionId, parameters); + return rendition; + } + + @Override + public CollectionWithPagingInfo getRenditions(String archivedId, Parameters parameters) + { + NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_ARCHIVE_SPACESSTORE, archivedId); + return renditions.getRenditions(nodeRef, parameters); + } } diff --git a/src/main/java/org/alfresco/rest/api/impl/PeopleImpl.java b/src/main/java/org/alfresco/rest/api/impl/PeopleImpl.java index 3dd8f92844..626f72a44b 100644 --- a/src/main/java/org/alfresco/rest/api/impl/PeopleImpl.java +++ b/src/main/java/org/alfresco/rest/api/impl/PeopleImpl.java @@ -325,7 +325,7 @@ public class PeopleImpl implements People NodeRef personNode = personService.getPerson(personId); NodeRef avatarNodeRef = getAvatarOriginal(personNode); - return renditions.getContent(avatarNodeRef, "avatar", parameters); + return renditions.getContentNoValidation(avatarNodeRef, "avatar", parameters); } @Override @@ -369,7 +369,7 @@ public class PeopleImpl implements People // create thumbnail synchronously Rendition avatarR = new Rendition(); avatarR.setId("avatar"); - renditions.createRendition(avatarOriginalNodeId, avatarR, false, parameters); + renditions.createRendition(avatar, avatarR, false, parameters); List include = Arrays.asList( PARAM_INCLUDE_ASPECTNAMES, diff --git a/src/main/java/org/alfresco/rest/api/impl/QuickShareLinksImpl.java b/src/main/java/org/alfresco/rest/api/impl/QuickShareLinksImpl.java index 1476fb4561..2331ab9eba 100644 --- a/src/main/java/org/alfresco/rest/api/impl/QuickShareLinksImpl.java +++ b/src/main/java/org/alfresco/rest/api/impl/QuickShareLinksImpl.java @@ -410,9 +410,8 @@ public class QuickShareLinksImpl implements QuickShareLinks, RecognizedParamsExt return TenantUtil.runAsSystemTenant(() -> { - String nodeId = nodeRef.getId(); Parameters params = getParamsWithCreatedStatus(); - return renditions.getRendition(nodeId, renditionId, params); + return renditions.getRendition(nodeRef, renditionId, params); }, networkTenantDomain); } @@ -443,9 +442,8 @@ public class QuickShareLinksImpl implements QuickShareLinks, RecognizedParamsExt return TenantUtil.runAsSystemTenant(() -> { - String nodeId = nodeRef.getId(); Parameters params = getParamsWithCreatedStatus(); - return renditions.getRenditions(nodeId, params); + return renditions.getRenditions(nodeRef, params); }, networkTenantDomain); } @@ -588,8 +586,8 @@ public class QuickShareLinksImpl implements QuickShareLinks, RecognizedParamsExt if (quickShareService.canDeleteSharedLink(nodeRef, sharedByUserId)) { // the allowable operations for the shared link - qs.setAllowableOperations(Collections.singletonList(Nodes.OP_DELETE)); - } + qs.setAllowableOperations(Collections.singletonList(Nodes.OP_DELETE)); + } Node doc = nodes.getFolderOrDocument(nodeRef, null, null, includeParam, null); List allowableOps = doc.getAllowableOperations(); diff --git a/src/main/java/org/alfresco/rest/api/impl/RenditionsImpl.java b/src/main/java/org/alfresco/rest/api/impl/RenditionsImpl.java index 8c804e913c..a238f42b0d 100644 --- a/src/main/java/org/alfresco/rest/api/impl/RenditionsImpl.java +++ b/src/main/java/org/alfresco/rest/api/impl/RenditionsImpl.java @@ -64,6 +64,7 @@ import org.alfresco.service.cmr.repository.ContentData; import org.alfresco.service.cmr.repository.MimetypeService; 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.thumbnail.ThumbnailService; import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.QName; @@ -153,10 +154,10 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware } @Override - public CollectionWithPagingInfo getRenditions(String nodeId, Parameters parameters) + public CollectionWithPagingInfo getRenditions(NodeRef nodeRef, Parameters parameters) { - final NodeRef nodeRef = validateSourceNode(nodeId); - String contentMimeType = getMimeType(nodeRef); + final NodeRef validatedNodeRef = validateNode(nodeRef.getStoreRef(), nodeRef.getId()); + String contentMimeType = getMimeType(validatedNodeRef); Query query = parameters.getQuery(); boolean includeCreated = true; @@ -179,7 +180,7 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware } } - List nodeRefRenditions = renditionService.getRenditions(nodeRef); + List nodeRefRenditions = renditionService.getRenditions(validatedNodeRef); if (!nodeRefRenditions.isEmpty()) { for (ChildAssociationRef childAssociationRef : nodeRefRenditions) @@ -208,10 +209,10 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware } @Override - public Rendition getRendition(String nodeId, String renditionId, Parameters parameters) + public Rendition getRendition(NodeRef nodeRef, String renditionId, Parameters parameters) { - final NodeRef nodeRef = validateSourceNode(nodeId); - NodeRef renditionNodeRef = getRenditionByName(nodeRef, renditionId, parameters); + final NodeRef validatedNodeRef = validateNode(nodeRef.getStoreRef(), nodeRef.getId()); + NodeRef renditionNodeRef = getRenditionByName(validatedNodeRef, renditionId, parameters); boolean includeNotCreated = true; String status = getStatus(parameters); if (status != null) @@ -229,7 +230,7 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware } else { - String contentMimeType = getMimeType(nodeRef); + String contentMimeType = getMimeType(validatedNodeRef); // List all available thumbnail definitions for the source node List thumbnailDefinitions = thumbnailService.getThumbnailRegistry().getThumbnailDefinitions(contentMimeType, -1); boolean found = false; @@ -259,13 +260,13 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware } @Override - public void createRendition(String nodeId, Rendition rendition, Parameters parameters) + public void createRendition(NodeRef nodeRef, Rendition rendition, Parameters parameters) { - createRendition(nodeId, rendition, true, parameters); + createRendition(nodeRef, rendition, true, parameters); } @Override - public void createRendition(String nodeId, Rendition rendition, boolean executeAsync, Parameters parameters) + public void createRendition(NodeRef nodeRef, Rendition rendition, boolean executeAsync, Parameters parameters) { // If thumbnail generation has been configured off, then don't bother. if (!thumbnailService.getThumbnailsEnabled()) @@ -273,7 +274,7 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware throw new DisabledServiceException("Thumbnail generation has been disabled."); } - final NodeRef sourceNodeRef = validateSourceNode(nodeId); + final NodeRef sourceNodeRef = validateNode(nodeRef.getStoreRef(), nodeRef.getId()); final NodeRef renditionNodeRef = getRenditionByName(sourceNodeRef, rendition.getId(), parameters); if (renditionNodeRef != null) { @@ -291,10 +292,10 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware ContentData contentData = getContentData(sourceNodeRef, true); // Check if anything is currently available to generate thumbnails for the specified mimeType if (!registry.isThumbnailDefinitionAvailable(contentData.getContentUrl(), contentData.getMimetype(), contentData.getSize(), sourceNodeRef, - thumbnailDefinition)) + thumbnailDefinition)) { throw new InvalidArgumentException("Unable to create thumbnail '" + thumbnailDefinition.getName() + "' for " + - contentData.getMimetype() + " as no transformer is currently available."); + contentData.getMimetype() + " as no transformer is currently available."); } Action action = ThumbnailHelper.createCreateThumbnailAction(thumbnailDefinition, serviceRegistry); @@ -304,14 +305,14 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware } @Override - public BinaryResource getContent(String nodeId, String renditionId, Parameters parameters) + public BinaryResource getContent(NodeRef nodeRef, String renditionId, Parameters parameters) { - final NodeRef sourceNodeRef = validateSourceNode(nodeId); - return getContent(sourceNodeRef, renditionId, parameters); + final NodeRef validatedNodeRef = validateNode(nodeRef.getStoreRef(), nodeRef.getId()); + return getContentNoValidation(validatedNodeRef, renditionId, parameters); } @Override - public BinaryResource getContent(NodeRef sourceNodeRef, String renditionId, Parameters parameters) + public BinaryResource getContentNoValidation(NodeRef sourceNodeRef, String renditionId, Parameters parameters) { NodeRef renditionNodeRef = getRenditionByName(sourceNodeRef, renditionId, parameters); @@ -391,12 +392,12 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware } // add cache settings CacheDirective cacheDirective = new CacheDirective.Builder() - .setNeverCache(false) - .setMustRevalidate(false) - .setLastModified(modified) - .setETag(modified != null ? Long.toString(modified.getTime()) : null) - .setMaxAge(Long.valueOf(31536000))// one year (in seconds) - .build(); + .setNeverCache(false) + .setMustRevalidate(false) + .setLastModified(modified) + .setETag(modified != null ? Long.toString(modified.getTime()) : null) + .setMaxAge(Long.valueOf(31536000))// one year (in seconds) + .build(); return new NodeBinaryResource(renditionNodeRef, ContentModel.PROP_CONTENT, contentInfo, attachFileName, cacheDirective); } @@ -436,9 +437,9 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware if (contentData != null) { contentInfo = new ContentInfo(contentData.getMimetype(), - getMimeTypeDisplayName(contentData.getMimetype()), - contentData.getSize(), - contentData.getEncoding()); + getMimeTypeDisplayName(contentData.getMimetype()), + contentData.getSize(), + contentData.getEncoding()); } apiRendition.setContent(contentInfo); apiRendition.setStatus(RenditionStatus.CREATED); @@ -449,7 +450,7 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware protected Rendition toApiRendition(ThumbnailDefinition thumbnailDefinition) { ContentInfo contentInfo = new ContentInfo(thumbnailDefinition.getMimetype(), - getMimeTypeDisplayName(thumbnailDefinition.getMimetype()), null, null); + getMimeTypeDisplayName(thumbnailDefinition.getMimetype()), null, null); Rendition apiRendition = new Rendition(); apiRendition.setId(thumbnailDefinition.getName()); apiRendition.setContent(contentInfo); @@ -458,14 +459,25 @@ public class RenditionsImpl implements Renditions, ResourceLoaderAware return apiRendition; } - protected NodeRef validateSourceNode(String nodeId) + public NodeRef validateNode(StoreRef storeRef, String nodeId) + { + if (nodeId == null) + { + throw new InvalidArgumentException("Missing nodeId"); + } + + final NodeRef nodeRef = nodes.validateNode(storeRef, nodeId); + // check if the node represents a file + isContentFile(nodeRef); + return nodeRef; + } + + private void isContentFile(NodeRef nodeRef) { - final NodeRef nodeRef = nodes.validateNode(nodeId); if (!nodes.isSubClass(nodeRef, ContentModel.PROP_CONTENT, false)) { - throw new InvalidArgumentException("Node id '" + nodeId + "' does not represent a file."); + throw new InvalidArgumentException("Node id '" + nodeRef.getId() + "' does not represent a file."); } - return nodeRef; } private String getMimeTypeDisplayName(String mimeType) diff --git a/src/main/java/org/alfresco/rest/api/nodes/NodeRenditionsRelation.java b/src/main/java/org/alfresco/rest/api/nodes/NodeRenditionsRelation.java index 7f4b002d19..6079312d32 100644 --- a/src/main/java/org/alfresco/rest/api/nodes/NodeRenditionsRelation.java +++ b/src/main/java/org/alfresco/rest/api/nodes/NodeRenditionsRelation.java @@ -37,6 +37,8 @@ import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResou import org.alfresco.rest.framework.resource.content.BinaryResource; 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.StoreRef; import org.alfresco.util.PropertyCheck; import org.springframework.beans.factory.InitializingBean; import org.springframework.extensions.webscripts.Status; @@ -50,10 +52,10 @@ import java.util.List; */ @RelationshipResource(name = "renditions", entityResource = NodesEntityResource.class, title = "Node renditions") public class NodeRenditionsRelation implements RelationshipResourceAction.Read, - RelationshipResourceAction.ReadById, - RelationshipResourceAction.Create, - RelationshipResourceBinaryAction.Read, - InitializingBean + RelationshipResourceAction.ReadById, + RelationshipResourceAction.Create, + RelationshipResourceBinaryAction.Read, + InitializingBean { private Renditions renditions; @@ -72,19 +74,22 @@ public class NodeRenditionsRelation implements RelationshipResourceAction.Read readAll(String nodeId, Parameters parameters) { - return renditions.getRenditions(nodeId, parameters); + NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, nodeId); + return renditions.getRenditions(nodeRef, parameters); } @Override public Rendition readById(String nodeId, String renditionId, Parameters parameters) { - return renditions.getRendition(nodeId, renditionId, parameters); + NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, nodeId); + return renditions.getRendition(nodeRef, renditionId, parameters); } @WebApiDescription(title = "Create rendition", successStatus = Status.STATUS_ACCEPTED) @Override public List create(String nodeId, List entity, Parameters parameters) { + NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, nodeId); // Temporary - pending future improvements to thumbnail service to minimise chance of // missing/failed thumbnails (when requested/generated 'concurrently') if (entity.size() > 1) @@ -94,7 +99,7 @@ public class NodeRenditionsRelation implements RelationshipResourceAction.Read, EntityResourceAction.Read, EntityResourceAction.Delete + EntityResourceAction.ReadById, EntityResourceAction.Read, EntityResourceAction.Delete, BinaryResourceAction.Read { private DeletedNodes deletedNodes; @@ -87,6 +77,14 @@ public class TrashcanEntityResource implements return deletedNodes.restoreArchivedNode(nodeId); } + @Override + @WebApiDescription(title = "Download content", description = "Download content") + @BinaryProperties({ "content" }) + public BinaryResource readProperty(String nodeId, Parameters parameters) + { + return deletedNodes.getContent(nodeId, null, parameters); + } + @Override public void delete(String nodeId, Parameters parameters) { diff --git a/src/main/java/org/alfresco/rest/api/trashcan/TrashcanRenditionsRelation.java b/src/main/java/org/alfresco/rest/api/trashcan/TrashcanRenditionsRelation.java new file mode 100644 index 0000000000..72d427c3ae --- /dev/null +++ b/src/main/java/org/alfresco/rest/api/trashcan/TrashcanRenditionsRelation.java @@ -0,0 +1,82 @@ +/* + * #%L + * Alfresco Remote API + * %% + * Copyright (C) 2005 - 2016 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 . + * #L% + */ +package org.alfresco.rest.api.trashcan; + +import org.alfresco.rest.api.DeletedNodes; +import org.alfresco.rest.api.model.Rendition; +import org.alfresco.rest.framework.BinaryProperties; +import org.alfresco.rest.framework.WebApiDescription; +import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException; +import org.alfresco.rest.framework.core.exceptions.RelationshipResourceNotFoundException; +import org.alfresco.rest.framework.resource.RelationshipResource; +import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction; +import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceBinaryAction; +import org.alfresco.rest.framework.resource.content.BinaryResource; +import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo; +import org.alfresco.rest.framework.resource.parameters.Parameters; +import org.alfresco.util.ParameterCheck; +import org.springframework.beans.factory.InitializingBean; + +@RelationshipResource(name = "renditions", entityResource = TrashcanEntityResource.class, title = "Node renditions via archived node") +public class TrashcanRenditionsRelation + implements RelationshipResourceAction.Read, RelationshipResourceAction.ReadById, RelationshipResourceBinaryAction.Read, InitializingBean +{ + + private DeletedNodes deletedNodes; + + public void setDeletedNodes(DeletedNodes deletedNodes) + { + this.deletedNodes = deletedNodes; + } + + @WebApiDescription(title = "List renditions", description = "List available (created) renditions") + @Override + public CollectionWithPagingInfo readAll(String nodeId, Parameters parameters) + { + return deletedNodes.getRenditions(nodeId, parameters); + } + + @WebApiDescription(title = "Retrieve rendition information", description = "Retrieve (created) rendition information") + @Override + public Rendition readById(String nodeId, String renditionId, Parameters parameters) + { + return deletedNodes.getRendition(nodeId, renditionId, parameters); + } + + @WebApiDescription(title = "Download archived node rendition", description = "Download rendition for an archived node") + @BinaryProperties({ "content" }) + @Override + public BinaryResource readProperty(String nodeId, String renditionId, Parameters parameters) + { + return deletedNodes.getContent(nodeId, renditionId, parameters); + } + + @Override + public void afterPropertiesSet() throws Exception + { + ParameterCheck.mandatory("deletedNodes", this.deletedNodes); + } +} diff --git a/src/main/resources/alfresco/public-rest-context.xml b/src/main/resources/alfresco/public-rest-context.xml index 2c2cb8429a..8936d28ecb 100644 --- a/src/main/resources/alfresco/public-rest-context.xml +++ b/src/main/resources/alfresco/public-rest-context.xml @@ -1,118 +1,118 @@ - - true - alfresco/templates/publicapi - + + true + alfresco/templates/publicapi + - - - - - - - + + + + + + + - + - + - - - - - webscript.default - - + + + + + webscript.default + + - - + + - + - - - + + + - - - - - - - - + + + + + + + + - - Public Api - - - - - - - - - - - - - - - - - + + Public Api + + + + + + + + + + + + + + + + + - + - + - - - + + + - - - - - - - - - + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - - - - - + + + + + alfresco.messages.rest-framework-messages alfresco.messages.custommodel-restapi-messages - + - + @@ -129,12 +129,12 @@ - + - + @@ -177,10 +177,10 @@ + and CommonAnnotationBeanPostProcessor are both NOT included implicitly --> + /> --> @@ -200,47 +200,47 @@ - + - + - + - + - + - - - + + + - + + beans --> @@ -384,39 +384,39 @@ - - org.alfresco.rest.api.Activities - - - - - - - - - + + org.alfresco.rest.api.Activities + + + + + + + + + - - - - - {http://www.alfresco.org/model/content/1.0}folder - {http://www.alfresco.org/model/content/1.0}content - {http://www.alfresco.org/model/cmis/custom}* - - - - - {http://www.alfresco.org/model/forum/1.0}forums - {http://www.alfresco.org/model/forum/1.0}forum - {http://www.alfresco.org/model/forum/1.0}topic - {http://www.alfresco.org/model/forum/1.0}post - {http://www.alfresco.org/model/content/1.0}category - - - + + + + + {http://www.alfresco.org/model/content/1.0}folder + {http://www.alfresco.org/model/content/1.0}content + {http://www.alfresco.org/model/cmis/custom}* + + + + + {http://www.alfresco.org/model/forum/1.0}forums + {http://www.alfresco.org/model/forum/1.0}forum + {http://www.alfresco.org/model/forum/1.0}topic + {http://www.alfresco.org/model/forum/1.0}post + {http://www.alfresco.org/model/content/1.0}category + + + @@ -451,17 +451,17 @@ - - org.alfresco.rest.api.Comments - - - - - - - - - + + org.alfresco.rest.api.Comments + + + + + + + + + @@ -472,17 +472,17 @@ - - org.alfresco.rest.api.NodeRatings - - - - - - - - - + + org.alfresco.rest.api.NodeRatings + + + + + + + + + @@ -523,17 +523,17 @@ - - org.alfresco.rest.api.Nodes - - - - - - - - - + + org.alfresco.rest.api.Nodes + + + + + + + + + @@ -567,7 +567,7 @@ - + org.alfresco.rest.api.Downloads @@ -584,6 +584,7 @@ + @@ -653,17 +654,17 @@ - - org.alfresco.rest.api.Favourites - - - - - - - - - + + org.alfresco.rest.api.Favourites + + + + + + + + + @@ -676,17 +677,17 @@ - - org.alfresco.rest.api.SiteMembershipRequests - - - - - - - - - + + org.alfresco.rest.api.SiteMembershipRequests + + + + + + + + + @@ -705,17 +706,17 @@ - - org.alfresco.rest.api.People - - - - - - - - - + + org.alfresco.rest.api.People + + + + + + + + + @@ -724,17 +725,17 @@ - - org.alfresco.rest.api.Preferences - - - - - - - - - + + org.alfresco.rest.api.Preferences + + + + + + + + + @@ -756,17 +757,17 @@ - - org.alfresco.rest.api.Sites - - - - - - - - - + + org.alfresco.rest.api.Sites + + + + + + + + + @@ -776,17 +777,17 @@ - - org.alfresco.rest.api.Tags - - - - - - - - - + + org.alfresco.rest.api.Tags + + + + + + + + + @@ -795,17 +796,17 @@ - - org.alfresco.rest.api.Networks - - - - - - - - - + + org.alfresco.rest.api.Networks + + + + + + + + + @@ -847,7 +848,7 @@ - + @@ -871,21 +872,21 @@ - - - + + + - + - - - + + + @@ -903,13 +904,13 @@ - + - + - + - + @@ -919,7 +920,7 @@ - + @@ -971,13 +972,13 @@ + class="org.alfresco.rest.api.NetworksWebScriptGet" parent="apiWebScriptParent"> + class="org.alfresco.rest.api.NetworkWebScriptGet" parent="apiWebScriptParent"> @@ -1116,38 +1117,38 @@ - - - - - - - - - - - - - - - + + + + - - + + + + + + + + + + + + + - - org.alfresco.rest.workflow.api.Deployments - - - - - - - - - + + org.alfresco.rest.workflow.api.Deployments + + + + + + + + + @@ -1157,17 +1158,17 @@ - - org.alfresco.rest.workflow.api.ProcessDefinitions - - - - - - - - - + + org.alfresco.rest.workflow.api.ProcessDefinitions + + + + + + + + + @@ -1182,17 +1183,17 @@ - - org.alfresco.rest.workflow.api.Processes - - - - - - - - - + + org.alfresco.rest.workflow.api.Processes + + + + + + + + + @@ -1204,163 +1205,167 @@ - - org.alfresco.rest.workflow.api.Tasks - - - - - - - - - + + org.alfresco.rest.workflow.api.Tasks + + + + + + + + + - - org.alfresco.rest.workflow.api.Activities - - - - - - - - - + + org.alfresco.rest.workflow.api.Activities + + + + + + + + + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - + + + + + + + + + + + - - - org.alfresco.rest.api.CustomModels - - - - - - - - - - + + + org.alfresco.rest.api.CustomModels + + + + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - - - - - - - + + + + + + + + + + - - - org.alfresco.rest.api.Renditions - - - - - - - - - - + + + org.alfresco.rest.api.Renditions + + + + + + + + + + - - + + + + + + diff --git a/src/test/java/org/alfresco/rest/DeletedNodesTest.java b/src/test/java/org/alfresco/rest/DeletedNodesTest.java index b326249c25..8b7930d59f 100644 --- a/src/test/java/org/alfresco/rest/DeletedNodesTest.java +++ b/src/test/java/org/alfresco/rest/DeletedNodesTest.java @@ -25,27 +25,43 @@ */ package org.alfresco.rest; +import static org.junit.Assert.assertArrayEquals; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; +import java.io.File; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Collections; +import java.util.Date; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.UUID; + +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.rest.AbstractSingleNetworkSiteTest; import org.alfresco.rest.api.Nodes; import org.alfresco.rest.api.tests.client.HttpResponse; import org.alfresco.rest.api.tests.client.PublicApiClient; +import org.alfresco.rest.api.tests.client.data.ContentInfo; import org.alfresco.rest.api.tests.client.data.Document; import org.alfresco.rest.api.tests.client.data.Folder; import org.alfresco.rest.api.tests.client.data.Node; import org.alfresco.rest.api.tests.client.data.PathInfo; +import org.alfresco.rest.api.tests.client.data.Rendition; +import org.alfresco.rest.api.tests.util.MultiPartBuilder; import org.alfresco.rest.api.tests.util.RestApiUtil; +import org.alfresco.rest.api.trashcan.TrashcanEntityResource; import org.junit.After; import org.junit.Test; import org.springframework.extensions.webscripts.Status; -import java.util.Collections; -import java.util.Date; -import java.util.List; -import java.util.Map; +import com.google.common.collect.Ordering; /** * V1 REST API tests for managing the user's Trashcan (ie. "deleted nodes") @@ -58,7 +74,10 @@ public class DeletedNodesTest extends AbstractSingleNetworkSiteTest { protected static final String URL_DELETED_NODES = "deleted-nodes"; + private static final String URL_RENDITIONS = "renditions"; + private final static long DELAY_IN_MS = 500; + @Override public void setup() throws Exception { @@ -235,7 +254,7 @@ public class DeletedNodesTest extends AbstractSingleNetworkSiteTest public void testCreateAndPurge() throws Exception { setRequestContext(user1); - + Date now = new Date(); String folder1 = "folder" + now.getTime() + "_1"; Folder createdFolder = createFolder(tDocLibNodeId, folder1, null); @@ -263,6 +282,355 @@ public class DeletedNodesTest extends AbstractSingleNetworkSiteTest getSingle(URL_DELETED_NODES, createdFolder.getId(), 404); } + /** + * Tests download of file/content. + *

GET:

+ * {@literal :/alfresco/api/-default-/public/alfresco/versions/1/deleted-nodes//content} + */ + @Test + public void testDownloadFileContent() throws Exception + { + setRequestContext(user1); + + // Use existing test file + String fileName = "quick-1.txt"; + File file = getResourceFile(fileName); + + MultiPartBuilder multiPartBuilder = MultiPartBuilder.create().setFileData(new MultiPartBuilder.FileData(fileName, file)); + MultiPartBuilder.MultiPartRequest reqBody = multiPartBuilder.build(); + + // Upload text content + HttpResponse response = post(getNodeChildrenUrl(Nodes.PATH_MY), reqBody.getBody(), null, reqBody.getContentType(), 201); + Document document = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class); + + String contentNodeId = document.getId(); + + // Check the upload response + assertEquals(fileName, document.getName()); + ContentInfo contentInfo = document.getContent(); + assertNotNull(contentInfo); + assertEquals(MimetypeMap.MIMETYPE_TEXT_PLAIN, contentInfo.getMimeType()); + + // move the node to Trashcan + deleteNode(document.getId()); + + // Download text content - by default with Content-Disposition header + response = getSingle(TrashcanEntityResource.class, contentNodeId + "/content", null, 200); + + String textContent = response.getResponse(); + assertEquals("The quick brown fox jumps over the lazy dog", textContent); + Map responseHeaders = response.getHeaders(); + assertNotNull(responseHeaders); + assertEquals("attachment; filename=\"quick-1.txt\"; filename*=UTF-8''quick-1.txt", responseHeaders.get("Content-Disposition")); + String cacheControl = responseHeaders.get("Cache-Control"); + assertNotNull(cacheControl); + assertTrue(cacheControl.contains("must-revalidate")); + assertTrue(cacheControl.contains("max-age=0")); + assertNotNull(responseHeaders.get("Expires")); + String lastModifiedHeader = responseHeaders.get(LAST_MODIFIED_HEADER); + assertNotNull(lastModifiedHeader); + Map headers = Collections.singletonMap(IF_MODIFIED_SINCE_HEADER, lastModifiedHeader); + // Test 304 response + getSingle(URL_DELETED_NODES + "/" + contentNodeId + "/content", null, null, headers, 304); + + // Use existing pdf test file + fileName = "quick.pdf"; + file = getResourceFile(fileName); + byte[] originalBytes = Files.readAllBytes(Paths.get(file.getAbsolutePath())); + + multiPartBuilder = MultiPartBuilder.create().setFileData(new MultiPartBuilder.FileData(fileName, file)); + reqBody = multiPartBuilder.build(); + + // Upload binary content + response = post(getNodeChildrenUrl(Nodes.PATH_MY), reqBody.getBody(), null, reqBody.getContentType(), 201); + document = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class); + + // move the node to Trashcan + deleteNode(document.getId()); + contentNodeId = document.getId(); + + // Check the upload response + assertEquals(fileName, document.getName()); + contentInfo = document.getContent(); + assertNotNull(contentInfo); + assertEquals(MimetypeMap.MIMETYPE_PDF, contentInfo.getMimeType()); + + // Download binary content (as bytes) - without Content-Disposition + // header (attachment=false) + Map params = new LinkedHashMap<>(); + params.put("attachment", "false"); + + response = getSingle(TrashcanEntityResource.class, contentNodeId + "/content", params, 200); + byte[] bytes = response.getResponseAsBytes(); + assertArrayEquals(originalBytes, bytes); + + responseHeaders = response.getHeaders(); + assertNotNull(responseHeaders); + assertNull(responseHeaders.get("Content-Disposition")); + assertNotNull(responseHeaders.get("Cache-Control")); + assertNotNull(responseHeaders.get("Expires")); + lastModifiedHeader = responseHeaders.get(LAST_MODIFIED_HEADER); + assertNotNull(lastModifiedHeader); + headers = Collections.singletonMap(IF_MODIFIED_SINCE_HEADER, lastModifiedHeader); + // Test 304 response + getSingle(URL_DELETED_NODES + "/" + contentNodeId + "/content", null, null, headers, 304); + + // -ve - nodeId in the path parameter does not exist + getSingle(TrashcanEntityResource.class, UUID.randomUUID().toString() + "/content", params, 404); + + // -ve test - Authentication failed + setRequestContext(null); + getSingle(TrashcanEntityResource.class, contentNodeId + "/content", params, 401); + + // -ve - Current user does not have permission for nodeId + setRequestContext(user2); + getSingle(TrashcanEntityResource.class, contentNodeId + "/content", params, 403); + } + + /** + * Test retrieve renditions for deleted nodes + *

post:

+ * {@literal :/alfresco/api/-default-/public/alfresco/versions/1/deleted-nodes//renditions} + * {@literal :/alfresco/api/-default-/public/alfresco/versions/1/deleted-nodes//rendition/} + */ + @Test + public void testListRenditions() throws Exception + { + setRequestContext(user1); + + Date now = new Date(); + String folder1 = "folder" + now.getTime() + "_1"; + Folder createdFolder = createFolder(tDocLibNodeId, folder1, null); + assertNotNull(createdFolder); + String f1Id = createdFolder.getId(); + + // Create multipart request + String fileName = "quick.pdf"; + File file = getResourceFile(fileName); + MultiPartBuilder multiPartBuilder = MultiPartBuilder.create().setFileData(new MultiPartBuilder.FileData(fileName, file)); + MultiPartBuilder.MultiPartRequest reqBody = multiPartBuilder.build(); + + // Upload quick.pdf file into the folder previously created + HttpResponse response = post(getNodeChildrenUrl(f1Id), reqBody.getBody(), null, reqBody.getContentType(), 201); + Document document = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class); + String contentNodeId = document.getId(); + + // create doclib rendition and move node to trashcan + createAndGetRendition(contentNodeId, "doclib"); + deleteNode(contentNodeId); + + // List all renditions and check for results + PublicApiClient.Paging paging = getPaging(0, 50); + response = getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, 200); + List renditions = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), Rendition.class); + assertTrue(renditions.size() >= 3); + + // +ve test - get previously created 'doclib' rendition + response = getSingle(getDeletedNodeRenditionsUrl(contentNodeId), "doclib", 200); + Rendition doclibRendition = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Rendition.class); + + assertNotNull(doclibRendition); + assertEquals(Rendition.RenditionStatus.CREATED, doclibRendition.getStatus()); + ContentInfo contentInfo = doclibRendition.getContent(); + assertNotNull(contentInfo); + assertEquals(MimetypeMap.MIMETYPE_IMAGE_PNG, contentInfo.getMimeType()); + assertEquals("PNG Image", contentInfo.getMimeTypeName()); + assertNotNull(contentInfo.getEncoding()); + assertTrue(contentInfo.getSizeInBytes() > 0); + + // +ve test - Add a filter on rendition 'status' and list only 'NOT_CREATED' renditions + Map params = new HashMap<>(1); + params.put("where", "(status='NOT_CREATED')"); + response = getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 200); + renditions = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), Rendition.class); + assertTrue(renditions.size() >= 2); + + // +ve test - Add a filter on rendition 'status' and list only the CREATED renditions + params.put("where", "(status='CREATED')"); + response = getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 200); + renditions = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), Rendition.class); + assertEquals("Only 'doclib' rendition should be returned.", 1, renditions.size()); + + // SkipCount=0,MaxItems=2 + paging = getPaging(0, 2); + // List all available renditions + response = getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, 200); + renditions = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), Rendition.class); + assertEquals(2, renditions.size()); + PublicApiClient.ExpectedPaging expectedPaging = RestApiUtil.parsePaging(response.getJsonResponse()); + assertEquals(2, expectedPaging.getCount().intValue()); + assertEquals(0, expectedPaging.getSkipCount().intValue()); + assertEquals(2, expectedPaging.getMaxItems().intValue()); + assertTrue(expectedPaging.getTotalItems() >= 3); + assertTrue(expectedPaging.getHasMoreItems()); + + // SkipCount=1,MaxItems=3 + paging = getPaging(1, 3); + // List all available renditions + response = getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, 200); + renditions = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), Rendition.class); + assertEquals(2, renditions.size()); + expectedPaging = RestApiUtil.parsePaging(response.getJsonResponse()); + assertEquals(2, expectedPaging.getCount().intValue()); + assertEquals(1, expectedPaging.getSkipCount().intValue()); + assertEquals(3, expectedPaging.getMaxItems().intValue()); + assertTrue(expectedPaging.getTotalItems() >= 3); + + // +ve test - Test returned renditions are ordered (natural sort order) + response = getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 200); + renditions = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), Rendition.class); + assertTrue(Ordering.natural().isOrdered(renditions)); + // Check again to make sure the ordering wasn't coincidental + response = getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 200); + renditions = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), Rendition.class); + assertTrue(Ordering.natural().isOrdered(renditions)); + + // -ve - nodeId in the path parameter does not exist + getAll(getDeletedNodeRenditionsUrl(UUID.randomUUID().toString()), paging, params, 404); + + // -ve test - Create an empty text file + Document emptyDoc = createEmptyTextFile(f1Id, "d1.txt"); + getAll(getDeletedNodeRenditionsUrl(emptyDoc.getId()), paging, params, 404); + + // -ve - nodeId in the path parameter does not represent a file + deleteNode(f1Id); + getAll(getDeletedNodeRenditionsUrl(f1Id), paging, params, 400); + + // -ve - Invalid status value + params.put("where", "(status='WRONG')"); + getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 400); + + // -ve - Invalid filter (only 'status' is supported) + params.put("where", "(id='doclib')"); + getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 400); + + // -ve test - Authentication failed + setRequestContext(null); + getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 401); + + // -ve - Current user does not have permission for nodeId + setRequestContext(user2); + getAll(getDeletedNodeRenditionsUrl(contentNodeId), paging, params, 403); + + // Test get single node rendition + setRequestContext(user1); + // -ve - nodeId in the path parameter does not exist + getSingle(getDeletedNodeRenditionsUrl(UUID.randomUUID().toString()), "doclib", 404); + + // -ve - renditionId in the path parameter is not registered/available + getSingle(getNodeRenditionsUrl(contentNodeId), ("renditionId" + System.currentTimeMillis()), 404); + + // -ve - nodeId in the path parameter does not represent a file + getSingle(getDeletedNodeRenditionsUrl(f1Id), "doclib", 400); + + // -ve test - Authentication failed + setRequestContext(null); + getSingle(getDeletedNodeRenditionsUrl(contentNodeId), "doclib", 401); + + // -ve - Current user does not have permission for nodeId + setRequestContext(user2); + getSingle(getDeletedNodeRenditionsUrl(contentNodeId), "doclib", 403); + } + + /** + * Tests download rendition. + *

GET:

+ * {@literal :/alfresco/api//public/alfresco/versions/1/deleted-nodes//renditions//content} + */ + @Test + public void testDownloadRendition() throws Exception + { + setRequestContext(user1); + + // Create a folder within the site document's library + Date now = new Date(); + String folder1 = "folder" + now.getTime() + "_1"; + Folder createdFolder = createFolder(tDocLibNodeId, folder1, null); + assertNotNull(createdFolder); + String f1Id = createdFolder.getId(); + + // Create multipart request using an existing file + String fileName = "quick.pdf"; + File file = getResourceFile(fileName); + MultiPartBuilder multiPartBuilder = MultiPartBuilder.create().setFileData(new MultiPartBuilder.FileData(fileName, file)); + MultiPartBuilder.MultiPartRequest reqBody = multiPartBuilder.build(); + + // Upload quick.pdf file into 'folder' + HttpResponse response = post(getNodeChildrenUrl(f1Id), reqBody.getBody(), null, reqBody.getContentType(), 201); + Document document = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class); + String contentNodeId = document.getId(); + + Rendition rendition = createAndGetRendition(contentNodeId, "doclib"); + assertNotNull(rendition); + assertEquals(Rendition.RenditionStatus.CREATED, rendition.getStatus()); + deleteNode(contentNodeId); + + // Download rendition - by default with Content-Disposition header + response = getSingle(getDeletedNodeRenditionsUrl(contentNodeId), "doclib/content", 200); + assertNotNull(response.getResponseAsBytes()); + Map responseHeaders = response.getHeaders(); + assertNotNull(responseHeaders); + String contentDisposition = responseHeaders.get("Content-Disposition"); + assertNotNull(contentDisposition); + assertTrue(contentDisposition.contains("filename=\"doclib\"")); + String contentType = responseHeaders.get("Content-Type"); + assertNotNull(contentType); + assertTrue(contentType.startsWith(MimetypeMap.MIMETYPE_IMAGE_PNG)); + + // Download rendition - without Content-Disposition header + // (attachment=false) + Map params = new HashMap<>(); + params = Collections.singletonMap("attachment", "false"); + response = getSingle(getDeletedNodeRenditionsUrl(contentNodeId), "doclib/content", params, 200); + assertNotNull(response.getResponseAsBytes()); + responseHeaders = response.getHeaders(); + assertNotNull(responseHeaders); + assertNull(responseHeaders.get("Content-Disposition")); + contentType = responseHeaders.get("Content-Type"); + assertNotNull(contentType); + assertTrue(contentType.startsWith(MimetypeMap.MIMETYPE_IMAGE_PNG)); + + // Download rendition - with Content-Disposition header + // (attachment=true) same as default + params = Collections.singletonMap("attachment", "true"); + response = getSingle(getDeletedNodeRenditionsUrl(contentNodeId), "doclib/content", params, 200); + assertNotNull(response.getResponseAsBytes()); + responseHeaders = response.getHeaders(); + assertNotNull(responseHeaders); + String cacheControl = responseHeaders.get("Cache-Control"); + assertNotNull(cacheControl); + assertFalse(cacheControl.contains("must-revalidate")); + assertTrue(cacheControl.contains("max-age=31536000")); + contentDisposition = responseHeaders.get("Content-Disposition"); + assertNotNull(contentDisposition); + assertTrue(contentDisposition.contains("filename=\"doclib\"")); + contentType = responseHeaders.get("Content-Type"); + assertNotNull(contentType); + assertTrue(contentType.startsWith(MimetypeMap.MIMETYPE_IMAGE_PNG)); + + // Test 304 response - doclib rendition (attachment=true) + String lastModifiedHeader = responseHeaders.get(LAST_MODIFIED_HEADER); + assertNotNull(lastModifiedHeader); + Map headers = Collections.singletonMap(IF_MODIFIED_SINCE_HEADER, lastModifiedHeader); + getSingle(getDeletedNodeRenditionsUrl(contentNodeId), "doclib/content", params, headers, 304); + + // -ve tests + // nodeId in the path parameter does not represent a file + deleteNode(f1Id); + getSingle(getDeletedNodeRenditionsUrl(f1Id), "doclib/content", 400); + + // nodeId in the path parameter does not exist + getSingle(getDeletedNodeRenditionsUrl(UUID.randomUUID().toString()), "doclib/content", 404); + + // renditionId in the path parameter is not registered/available + getSingle(getDeletedNodeRenditionsUrl(contentNodeId), ("renditionId" + System.currentTimeMillis() + "/content"), 404); + + // The rendition does not exist, a placeholder is not available and the + // placeholder parameter has a value of "true" + params = Collections.singletonMap("placeholder", "true"); + getSingle(getDeletedNodeRenditionsUrl(contentNodeId), ("renditionId" + System.currentTimeMillis() + "/content"), params, 404); + } + /** * Checks the deleted nodes are in the correct order. */ @@ -291,4 +659,9 @@ public class DeletedNodesTest extends AbstractSingleNetworkSiteTest assertNull("We don't show the parent id for a deleted node",aNode.getParentId()); } + private String getDeletedNodeRenditionsUrl(String nodeId) + { + return URL_DELETED_NODES + "/" + nodeId + "/" + URL_RENDITIONS; + } + } diff --git a/src/test/java/org/alfresco/rest/api/tests/ApiTest.java b/src/test/java/org/alfresco/rest/api/tests/ApiTest.java index c6a54fec53..a9a30c5020 100644 --- a/src/test/java/org/alfresco/rest/api/tests/ApiTest.java +++ b/src/test/java/org/alfresco/rest/api/tests/ApiTest.java @@ -25,6 +25,7 @@ */ package org.alfresco.rest.api.tests; + import org.alfresco.rest.DeletedNodesTest; import org.alfresco.rest.api.search.BasicSearchApiIntegrationTest; import org.junit.AfterClass; diff --git a/src/test/java/org/alfresco/rest/api/tests/TestPeople.java b/src/test/java/org/alfresco/rest/api/tests/TestPeople.java index 2e2394125c..4c1fc09e25 100644 --- a/src/test/java/org/alfresco/rest/api/tests/TestPeople.java +++ b/src/test/java/org/alfresco/rest/api/tests/TestPeople.java @@ -53,6 +53,7 @@ import org.alfresco.service.cmr.repository.ContentService; import org.alfresco.service.cmr.repository.ContentWriter; 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.MutableAuthenticationService; import org.alfresco.service.cmr.security.PersonService; import org.alfresco.service.cmr.thumbnail.ThumbnailService; @@ -327,7 +328,7 @@ public class TestPeople extends AbstractBaseApiTest for (char invalidCharacter : invalidCharacters) { person.setUserName("myUser" + invalidCharacter + "Name@" + account1.getId()); - people.create(person, 400); + people.create(person, 400); } } @@ -529,11 +530,11 @@ public class TestPeople extends AbstractBaseApiTest { String json = "{\n" + - " \"id\": \"" + username + "\",\n" + - " \"firstName\": \"Joe\",\n" + - " \"lastName\": \"Bloggs\",\n" + - badField + - "}"; + " \"id\": \"" + username + "\",\n" + + " \"firstName\": \"Joe\",\n" + + " \"lastName\": \"Bloggs\",\n" + + badField + + "}"; people.create("people", null, null, null, json, "Illegal field test:"+badField, 400); } } @@ -782,10 +783,10 @@ public class TestPeople extends AbstractBaseApiTest assertFalse(person.getAspectNames().contains("papi:lunchable")); String json = qjson( "{" + - " `properties`: {" + - " `papi:lunch`: `Tomato soup`" + - " }" + - "}" + " `properties`: {" + + " `papi:lunch`: `Tomato soup`" + + " }" + + "}" ); person = people.update(person.getId(), json, 200); @@ -876,14 +877,14 @@ public class TestPeople extends AbstractBaseApiTest // but explicitly add the papi:lunchable aspect. String json = qjson( "{" + - " `aspectNames`: [ " + - " `papi:lunchable` " + - " ], " + - " `properties`: { " + - " `papi:jabber`: `another@jabber.example.com`, " + - " `papi:lunch`: `sandwich` " + - " }" + - "}" + " `aspectNames`: [ " + + " `papi:lunchable` " + + " ], " + + " `properties`: { " + + " `papi:jabber`: `another@jabber.example.com`, " + + " `papi:lunch`: `sandwich` " + + " }" + + "}" ); person = people.update(person.getId(), json, 200); @@ -1801,9 +1802,9 @@ public class TestPeople extends AbstractBaseApiTest // Un-authenticated APIs as we are still using the 'setRequestContext(account1.getId(), null, null)' set above. // Reset the password PasswordReset passwordReset = new PasswordReset() - .setPassword("changed") - .setId(pair.getFirst()) - .setKey(pair.getSecond()); + .setPassword("changed") + .setId(pair.getFirst()) + .setKey(pair.getSecond()); post(getResetPasswordUrl(person.getUserName()), RestApiUtil.toJsonAsString(passwordReset), 202); assertEquals("A reset password confirmation email should have been sent.", 1, emailUtil.getSentCount()); msg = emailUtil.getLastEmail(); @@ -1883,44 +1884,44 @@ public class TestPeople extends AbstractBaseApiTest emailUtil.reset(); // Invalid request - password is not provided PasswordReset passwordResetInvalid = new PasswordReset() - .setId(pair.getFirst()) - .setKey(pair.getSecond()); + .setId(pair.getFirst()) + .setKey(pair.getSecond()); post(getResetPasswordUrl(person.getUserName()), RestApiUtil.toJsonAsString(passwordResetInvalid), 400); // Invalid request - workflow id is not provided passwordResetInvalid.setPassword("changedAgain") - .setId(null); + .setId(null); post(getResetPasswordUrl(person.getUserName()), RestApiUtil.toJsonAsString(passwordResetInvalid), 400); // Invalid request - workflow key is not provided passwordResetInvalid.setId(pair.getFirst()) - .setKey(null); + .setKey(null); post(getResetPasswordUrl(person.getUserName()), RestApiUtil.toJsonAsString(passwordResetInvalid), 400); // Invalid request - Invalid workflow id // Note: we still return 202 response for security reasons passwordResetInvalid = new PasswordReset() - .setPassword("changedAgain") - .setId("activiti$" + System.currentTimeMillis()) // Invalid Id - .setKey(pair.getSecond()); + .setPassword("changedAgain") + .setId("activiti$" + System.currentTimeMillis()) // Invalid Id + .setKey(pair.getSecond()); post(getResetPasswordUrl(person.getUserName()), RestApiUtil.toJsonAsString(passwordResetInvalid), 202); assertEquals("No email should have been sent.", 0, emailUtil.getSentCount()); // Invalid request - Invalid workflow key // Note: we still return 202 response for security reasons passwordResetInvalid = new PasswordReset() - .setPassword("changedAgain") - .setId(pair.getFirst()) - .setKey(GUID.generate()); // Invalid Key + .setPassword("changedAgain") + .setId(pair.getFirst()) + .setKey(GUID.generate()); // Invalid Key post(getResetPasswordUrl(person.getUserName()), RestApiUtil.toJsonAsString(passwordResetInvalid), 202); assertEquals("No email should have been sent.", 0, emailUtil.getSentCount()); // Invalid request (not the same user) - The given user id 'user1' does not match the person's user id who requested the password reset. // Note: we still return 202 response for security reasons passwordResetInvalid = new PasswordReset() - .setPassword("changedAgain") - .setId(pair.getFirst()) - .setKey(pair.getSecond()); + .setPassword("changedAgain") + .setId(pair.getFirst()) + .setKey(pair.getSecond()); post(getResetPasswordUrl(user1), RestApiUtil.toJsonAsString(passwordResetInvalid), 202); assertEquals("No email should have been sent.", 0, emailUtil.getSentCount()); } @@ -2114,7 +2115,7 @@ public class TestPeople extends AbstractBaseApiTest Rendition avatarR = new Rendition(); avatarR.setId("avatar"); Renditions renditions = applicationContext.getBean("Renditions", Renditions.class); - renditions.createRendition(avatarRef.getId(), avatarR, false, null); + renditions.createRendition(avatarRef, avatarR, false, null); return avatarRef; }