Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ALFREDAPI-568 Separated upload to native Alfresco webscript as a workaround to broken multipart upload with Alfresco MVC #238

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

### Fixed
* [ALFREDAPI-563](https://xenitsupport.jira.com/browse/ALFREDAPI-563) Fix @GetMapping(value = "/v1/nodes/{space}/{store}/{guid}/content") Content-Type
* [ALFREDAPI-568](https://xenitsupport.jira.com/browse/ALFREDAPI-568) Separated upload to native Alfresco webscript as a workaround to broken multipart upload with Alfresco MVC

### Removed

Expand Down
11 changes: 10 additions & 1 deletion alfred-api-docker/231/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,13 @@ dependencies {

dockerAlfresco {
baseImage = 'private.docker.xenit.eu/alfresco-enterprise/alfresco-repository-enterprise:23.1.0.1'
}
}

// -- Add your local image to test Share with reproduce ALFREDAPI-568
//buildDockerImage {
// pull = false
//}
//
//dockerAlfresco {
// baseImage = 'b433a1095ccd'
//}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package eu.xenit.alfred.api.rest.v1.tests.temp;
package eu.xenit.alfred.api.rest.v1.tests;

import static org.junit.Assert.assertEquals;

import eu.xenit.alfred.api.data.NodeRef;
import eu.xenit.alfred.api.rest.v1.tests.RestV1BaseTest;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
Expand All @@ -21,6 +21,7 @@
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.json.JSONException;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
Expand All @@ -41,6 +42,29 @@ public void setup() {
this.parentNodeRef = initNodeRefArray.get(RestV1BaseTest.TESTFOLDER_NAME);
}

/**
* DOCKER-462
* ALFREDAPI-568
*
* Ensure the standard Alfresco upload api keeps working.
*/
@Test
public void testUploadFileThroughAlfresco() throws IOException {
String testFile = "alfresco.txt";
String url = "http://admin:admin@localhost:8080/alfresco/s/api/upload";
HttpEntity entity = MultipartEntityBuilder.create()
.addTextBody("destination", parentNodeRef.toString())
.addTextBody("filename", testFile)
.addBinaryBody("filedata", createTestFile(testFile))
.build();

try (CloseableHttpResponse response = doPost(url, entity)) {
String resultString = EntityUtils.toString(response.getEntity());
logger.debug(" resultString: " + resultString);
assertEquals(200, response.getStatusLine().getStatusCode());
}
}

@Test
public void testUploadFile() throws IOException {
String url = createUrl(null, null);
Expand Down Expand Up @@ -127,8 +151,7 @@ private CloseableHttpResponse doPost(String url, HttpEntity entity) throws IOExc
private File createTestFile(String pathName) throws IOException {
File result = new File(pathName);

Boolean newFileCreated;
newFileCreated = result.createNewFile();
boolean newFileCreated = result.createNewFile();
if (newFileCreated) {
logger.debug(" Created new file. ");
} else {
Expand All @@ -140,4 +163,9 @@ private File createTestFile(String pathName) throws IOException {
writer.close();
return result;
}

@After
public void cleanUp() {
this.removeMainTestFolder();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,4 @@ public boolean isMultipart(HttpServletRequest request) {
}
};
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
package eu.xenit.alfred.api.rest.jackson;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import eu.xenit.alfred.api.search.json.SearchNodeJsonParser;
import org.alfresco.rest.framework.jacksonextensions.RestJsonModule;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.List;
import java.util.TimeZone;

public class ObjectMapperFactory {
public static ObjectMapper getNewObjectMapper(RestJsonModule alfrescoRestJsonModule) {
ObjectMapper om = new SearchNodeJsonParser().getObjectMapper();

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe move configureObjectMapper from SearchNodeJsonParser to this class and call ObjectMapperFactory from SearchNodeJsonParser instead?

om.setSerializationInclusion(JsonInclude.Include.NON_NULL);
jackson2ObjectMapperBuilder(alfrescoRestJsonModule).configure(om);
return om;
}

private static Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder(RestJsonModule alfrescoRestJsonModule) {
Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.json().failOnEmptyBeans(false)
.failOnUnknownProperties(false).dateFormat(dateFormat())
.serializers(customJsonSerilizers().toArray(new JsonSerializer[0]))
.deserializers(customJsonDeserializers().toArray(new JsonDeserializer[0]))
.featuresToEnable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY)
.findModulesViaServiceLoader(true);

if (alfrescoRestJsonModule != null) {
builder.modulesToInstall(alfrescoRestJsonModule);
}

return builder;
}

private static DateFormat dateFormat() {
DateFormat dateFormatIso8601 = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
dateFormatIso8601.setTimeZone(TimeZone.getTimeZone("UTC"));
return dateFormatIso8601;
}

private static List<JsonDeserializer<?>> customJsonDeserializers() {
return Arrays.asList(
new Jackson2AlfredApiNodeRefDeserializer(),
new Jackson2AlfredApiQnameDeserializer()
);
}

private static List<JsonSerializer<?>> customJsonSerilizers() {
return Arrays.asList(
new Jackson2AlfredApiNodeRefSerializer(),
new Jackson2AlfredApiQnameSerializer()
);
}
}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package eu.xenit.alfred.api.rest.v1;


import eu.xenit.alfred.api.filefolder.NodePath;
import eu.xenit.alfred.api.data.NodeRef;
import eu.xenit.alfred.api.filefolder.IFileFolderService;
import eu.xenit.alfred.api.filefolder.NodePath;
import eu.xenit.alfred.api.node.ChildParentAssociation;
import eu.xenit.alfred.api.node.INodeService;
import eu.xenit.alfred.api.node.NodeAssociation;
Expand All @@ -13,14 +13,14 @@
import eu.xenit.alfred.api.permissions.PermissionValue;
import eu.xenit.alfred.api.rest.v1.nodes.NodeInfo;
import eu.xenit.alfred.api.rest.v1.nodes.NodeInfoRequest;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.ResponseEntity;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class AlfredApiV1Webscript {

private static final Logger logger = LoggerFactory.getLogger(AlfredApiV1Webscript.class);
Expand All @@ -33,13 +33,13 @@ protected NodeRef createNodeRef(String space, String store, String guid) {
return new NodeRef(space, store, guid);
}

protected List<NodeInfo> nodeRefToNodeInfo(NodeInfoRequest nodeInfoRequest,
public static List<NodeInfo> nodeRefToNodeInfo(NodeInfoRequest nodeInfoRequest,
IFileFolderService fileFolderService,
INodeService nodeService,
IPermissionService permissionService
) {
List<NodeInfo> nodeInfoList = new ArrayList<>();
List<NodeRef> nodeRefs = nodeInfoRequest.getNoderefs().stream().map(NodeRef::new).collect(Collectors.toList());
List<NodeRef> nodeRefs = nodeInfoRequest.getNoderefs().stream().map(NodeRef::new).toList();
for (NodeRef nodeRef : nodeRefs) {
NodeInfo nodeInfo = nodeRefToNodeInfo(nodeRef,
fileFolderService,
Expand All @@ -63,14 +63,14 @@ protected List<NodeInfo> nodeRefToNodeInfo(NodeInfoRequest nodeInfoRequest,
return nodeInfoList;
}

protected NodeInfo nodeRefToNodeInfo(NodeRef nodeRef, IFileFolderService fileFolderService,
public static NodeInfo nodeRefToNodeInfo(NodeRef nodeRef, IFileFolderService fileFolderService,
INodeService nodeService, IPermissionService permissionService) {
return nodeRefToNodeInfo(nodeRef, fileFolderService, nodeService, permissionService,
true, true, true, true,
true, true, true, true);
}

protected NodeInfo nodeRefToNodeInfo(NodeRef nodeRef,
public static NodeInfo nodeRefToNodeInfo(NodeRef nodeRef,
IFileFolderService fileFolderService,
INodeService nodeService,
IPermissionService permissionService,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ public ResponseEntity<Object> getAllInfoOfNode(@PathVariable String space, @Path
@PathVariable String guid) {
try {
// This method will return a null result if user has insufficient permissions
NodeInfo nodeInfo = this.nodeRefToNodeInfo(
NodeInfo nodeInfo = AlfredApiV1Webscript.nodeRefToNodeInfo(
this.createNodeRef(space, store, guid),
this.fileFolderService, this.nodeService, this.permissionService
);
Expand All @@ -312,7 +312,7 @@ public ResponseEntity<Object> getAllInfoOfNode(@PathVariable String space, @Path
@AlfrescoTransaction
@PostMapping(value = "/v1/nodes/nodeInfo")
public ResponseEntity<Object> getAllInfoOfNodes(@RequestBody final NodeInfoRequest nodeInfoRequest) {
List<NodeInfo> nodeInfoList = this.nodeRefToNodeInfo(nodeInfoRequest,
List<NodeInfo> nodeInfoList = AlfredApiV1Webscript.nodeRefToNodeInfo(nodeInfoRequest,
this.fileFolderService,
this.nodeService,
this.permissionService
Expand Down Expand Up @@ -397,7 +397,7 @@ public ResponseEntity<NodeInfo> createNode(@RequestBody final CreateNodeOptions
}
NodeRef resultRef = new NodeRef(resultObject.toString());

NodeInfo nodeInfo = this
NodeInfo nodeInfo = AlfredApiV1Webscript
.nodeRefToNodeInfo(resultRef, this.fileFolderService, this.nodeService, this.permissionService);

return writeJsonResponse(nodeInfo);
Expand Down Expand Up @@ -513,22 +513,6 @@ public ResponseEntity<?> getContent(@PathVariable String space, @PathVariable St
.body(new InputStreamResource(contentInputStream.getInputStream()));
}

@AlfrescoTransaction
@PutMapping(value = "/v1/nodes/{space}/{store}/{guid}/content")
public ResponseEntity<Void> setContent(@PathVariable String space, @PathVariable String store,
@PathVariable String guid, @RequestPart final MultipartFile file) {

final NodeRef finalDestination = this.createNodeRef(space, store, guid);
RetryingTransactionHelper transactionHelper = serviceRegistry.getRetryingTransactionHelper();
transactionHelper.doInTransaction(() -> {
nodeService
.setContent(finalDestination, file != null ? file.getInputStream() : null,
file != null ? file.getOriginalFilename() : null);
return null;
}, false, true);
return ResponseEntity.ok().build();
}

@AlfrescoTransaction
@DeleteMapping(value = "/v1/nodes/{space}/{store}/{guid}/content")
public ResponseEntity<Void> deleteContent(@PathVariable String space, @PathVariable String store,
Expand All @@ -553,50 +537,51 @@ public ResponseEntity<Boolean> exists(@PathVariable String space, @PathVariable
);
}

@AlfrescoTransaction
@PostMapping(value = "/v1/nodes/upload")
public ResponseEntity<NodeInfo> uploadNode(
@RequestParam(required = false) String type,
@RequestParam(required = false) String parent,
@RequestParam(required = false) Boolean extractMetadata,
@RequestPart(required = false) MetadataChanges metadata,
@RequestPart final MultipartFile file) {
RetryingTransactionHelper transactionHelper = serviceRegistry.getRetryingTransactionHelper();

// Note the difference between:
// * metadata = The metadata the user annotates the file with.
// * extractMetadata = Whether the users wants metadata automatically extracted from the file.
// Both setting metadata and extracting metadata are optional.
// They can happen (or not) independently from each other.
type = type == null ? ContentModel.TYPE_CONTENT.toString() : type;
extractMetadata = Boolean.TRUE.equals(extractMetadata);

if (file == null) {
throw new IllegalArgumentException("Content must be supplied as a multipart 'file' field");
}
if (parent == null) {
throw new IllegalArgumentException("Must supply a 'parent' field");
}

final String finalParent = parent;
final String finalType = type;
final MetadataChanges finalMetadata = metadata;
final Boolean finalExtractMetadata = extractMetadata;
NodeRef resultRef;
try {
resultRef = transactionHelper
.doInTransaction(() -> createNodeForUpload(finalParent, file, finalType, finalMetadata,
finalExtractMetadata), false, true);
} catch (org.alfresco.service.cmr.model.FileExistsException fileExistsException) {
throw new FileExistsException(
null,
new NodeRef(fileExistsException.getParentNodeRef().toString()),
fileExistsException.getName());
}
NodeInfo nodeInfo = this
.nodeRefToNodeInfo(resultRef, fileFolderService, nodeService, permissionService);
return writeJsonResponse(nodeInfo);
}
//// Does not work under Alfresco MVC!
// @AlfrescoTransaction
// @PostMapping(value = "/v1/nodes/upload")
// public ResponseEntity<NodeInfo> uploadNode(
// @RequestParam(required = false) String type,
// @RequestParam(required = false) String parent,
// @RequestParam(required = false) Boolean extractMetadata,
// @RequestPart(required = false) MetadataChanges metadata,
// @RequestPart final MultipartFile file) {
// RetryingTransactionHelper transactionHelper = serviceRegistry.getRetryingTransactionHelper();
//
// // Note the difference between:
// // * metadata = The metadata the user annotates the file with.
// // * extractMetadata = Whether the users wants metadata automatically extracted from the file.
// // Both setting metadata and extracting metadata are optional.
// // They can happen (or not) independently from each other.
// type = type == null ? ContentModel.TYPE_CONTENT.toString() : type;
// extractMetadata = Boolean.TRUE.equals(extractMetadata);
//
// if (file == null) {
// throw new IllegalArgumentException("Content must be supplied as a multipart 'file' field");
// }
// if (parent == null) {
// throw new IllegalArgumentException("Must supply a 'parent' field");
// }
//
// final String finalParent = parent;
// final String finalType = type;
// final MetadataChanges finalMetadata = metadata;
// final Boolean finalExtractMetadata = extractMetadata;
// NodeRef resultRef;
// try {
// resultRef = transactionHelper
// .doInTransaction(() -> createNodeForUpload(finalParent, file, finalType, finalMetadata,
// finalExtractMetadata), false, true);
// } catch (org.alfresco.service.cmr.model.FileExistsException fileExistsException) {
// throw new FileExistsException(
// null,
// new NodeRef(fileExistsException.getParentNodeRef().toString()),
// fileExistsException.getName());
// }
// NodeInfo nodeInfo = AlfredApiV1Webscript
// .nodeRefToNodeInfo(resultRef, fileFolderService, nodeService, permissionService);
// return writeJsonResponse(nodeInfo);
// }

public NodeRef createNodeForUpload(String finalParent,
MultipartFile file,
Expand Down
Loading
Loading