Merged 5.2.N (5.2.1) to HEAD (5.2)

131775 rneamtu:       Reverse merged 5.2.N (5.2.1)
            131742 rneamtu: SHA-1629 : Creating a link to file in a different location
               - Added support for multiple files in doclink.post webscript


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@132299 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Alan Davis
2016-11-03 13:58:11 +00:00
parent 9cfd6462f1
commit 4618afdaa1
6 changed files with 621 additions and 776 deletions

View File

@@ -23,171 +23,122 @@
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.repo.web.scripts.doclink;
import java.io.StringWriter;
import java.util.Map;
import java.util.StringTokenizer;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.web.scripts.links.AbstractLinksWebScript;
import org.alfresco.service.cmr.activities.ActivityService;
import org.alfresco.service.cmr.links.LinkInfo;
import org.alfresco.service.cmr.repository.DocumentLinkService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.site.SiteInfo;
import org.alfresco.service.cmr.site.SiteService;
import org.alfresco.util.ParameterCheck;
import org.alfresco.util.PropertyCheck;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.json.JSONStringer;
import org.json.simple.JSONObject;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
import org.springframework.extensions.webscripts.json.JSONWriter;
/**
* This class contains common code for doclink webscripts controllers
*
* @author Ana Bozianu
* @since 5.1
*/
public abstract class AbstractDocLink extends DeclarativeWebScript
{
private static String PARAM_STORE_TYPE = "store_type";
private static String PARAM_STORE_ID = "store_id";
private static String PARAM_ID = "id";
private static String PARAM_SITE = "site";
private static String PARAM_CONTAINER = "container";
private static String PARAM_PATH = "path";
private static final String ACTIVITY_TOOL = "documentLinkService";
protected NodeService nodeService;
protected SiteService siteService;
protected DocumentLinkService documentLinkService;
protected ActivityService activityService;
private static Log logger = LogFactory.getLog(AbstractDocLink.class);
protected NodeRef parseNodeRefFromTemplateArgs(Map<String, String> templateVars)
{
if (templateVars == null)
{
return null;
}
String storeTypeArg = templateVars.get(PARAM_STORE_TYPE);
String storeIdArg = templateVars.get(PARAM_STORE_ID);
String idArg = templateVars.get(PARAM_ID);
if (storeTypeArg != null)
{
ParameterCheck.mandatoryString("storeTypeArg", storeTypeArg);
ParameterCheck.mandatoryString("storeIdArg", storeIdArg);
ParameterCheck.mandatoryString("idArg", idArg);
/*
* NodeRef based request
* <url>URL_BASE/{store_type}/{store_id}/{id}</url>
*/
return new NodeRef(storeTypeArg, storeIdArg, idArg);
}
else
{
String siteArg = templateVars.get(PARAM_SITE);
String containerArg = templateVars.get(PARAM_CONTAINER);
String pathArg = templateVars.get(PARAM_PATH);
if (siteArg != null)
{
ParameterCheck.mandatoryString("siteArg", siteArg);
ParameterCheck.mandatoryString("containerArg", containerArg);
/*
* Site based request <url>URL_BASE/{site}/{container}</url> or
* <url>URL_BASE/{site}/{container}/{path}</url>
*/
SiteInfo site = siteService.getSite(siteArg);
PropertyCheck.mandatory(this, "site", site);
NodeRef node = siteService.getContainer(site.getShortName(), containerArg);
if (node == null)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid 'container' variable");
}
if (pathArg != null)
{
// <url>URL_BASE/{site}/{container}/{path}</url>
StringTokenizer st = new StringTokenizer(pathArg, "/");
while (st.hasMoreTokens())
{
String childName = st.nextToken();
node = nodeService.getChildByName(node, ContentModel.ASSOC_CONTAINS, childName);
if (node == null)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid 'path' variable");
}
}
}
return node;
}
}
return null;
}
/**
* Generates an activity entry for the link
*/
protected void addActivityEntry(String activityType, String title, String nodeRef, String site)
{
try
{
StringWriter activityJson = new StringWriter();
JSONWriter activity = new JSONWriter(activityJson);
activity.startObject();
activity.writeValue("title", title);
activity.writeValue("nodeRef", nodeRef);
activity.writeValue("page", "document-details?nodeRef=" + nodeRef);
activity.endObject();
activityService.postActivity(
activityType,
site,
ACTIVITY_TOOL,
activityJson.toString());
}
catch (Exception e)
{
// Warn, but carry on
logger.warn("Error adding link event to activities feed", e);
}
}
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
public void setSiteService(SiteService siteService)
{
this.siteService = siteService;
}
public void setDocumentLinkService(DocumentLinkService documentLinkService)
{
this.documentLinkService = documentLinkService;
}
public void setActivityService(ActivityService activityService)
{
this.activityService = activityService;
}
}
package org.alfresco.repo.web.scripts.doclink;
import java.util.Map;
import java.util.StringTokenizer;
import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.repository.DocumentLinkService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.site.SiteInfo;
import org.alfresco.service.cmr.site.SiteService;
import org.alfresco.util.ParameterCheck;
import org.alfresco.util.PropertyCheck;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
/**
* This class contains common code for doclink webscripts controllers
*
* @author Ana Bozianu
* @since 5.1
*/
public abstract class AbstractDocLink extends DeclarativeWebScript
{
private static String PARAM_STORE_TYPE = "store_type";
private static String PARAM_STORE_ID = "store_id";
private static String PARAM_ID = "id";
private static String PARAM_SITE = "site";
private static String PARAM_CONTAINER = "container";
private static String PARAM_PATH = "path";
protected NodeService nodeService;
protected SiteService siteService;
protected DocumentLinkService documentLinkService;
protected NodeRef parseNodeRefFromTemplateArgs(Map<String, String> templateVars)
{
if (templateVars == null)
{
return null;
}
String storeTypeArg = templateVars.get(PARAM_STORE_TYPE);
String storeIdArg = templateVars.get(PARAM_STORE_ID);
String idArg = templateVars.get(PARAM_ID);
if (storeTypeArg != null)
{
ParameterCheck.mandatoryString("storeTypeArg", storeTypeArg);
ParameterCheck.mandatoryString("storeIdArg", storeIdArg);
ParameterCheck.mandatoryString("idArg", idArg);
/*
* NodeRef based request
* <url>URL_BASE/{store_type}/{store_id}/{id}</url>
*/
return new NodeRef(storeTypeArg, storeIdArg, idArg);
}
else
{
String siteArg = templateVars.get(PARAM_SITE);
String containerArg = templateVars.get(PARAM_CONTAINER);
String pathArg = templateVars.get(PARAM_PATH);
if (siteArg != null)
{
ParameterCheck.mandatoryString("siteArg", siteArg);
ParameterCheck.mandatoryString("containerArg", containerArg);
/*
* Site based request <url>URL_BASE/{site}/{container}</url> or
* <url>URL_BASE/{site}/{container}/{path}</url>
*/
SiteInfo site = siteService.getSite(siteArg);
PropertyCheck.mandatory(this, "site", site);
NodeRef node = siteService.getContainer(site.getShortName(), containerArg);
if (node == null)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid 'container' variable");
}
if (pathArg != null)
{
// <url>URL_BASE/{site}/{container}/{path}</url>
StringTokenizer st = new StringTokenizer(pathArg, "/");
while (st.hasMoreTokens())
{
String childName = st.nextToken();
node = nodeService.getChildByName(node, ContentModel.ASSOC_CONTAINS, childName);
if (node == null)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid 'path' variable");
}
}
}
return node;
}
}
return null;
}
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
public void setSiteService(SiteService siteService)
{
this.siteService = siteService;
}
public void setDocumentLinkService(DocumentLinkService documentLinkService)
{
this.documentLinkService = documentLinkService;
}
}

View File

@@ -23,177 +23,95 @@
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.repo.web.scripts.doclink;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.activities.ActivityType;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.security.permissions.AccessDeniedException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.util.ParameterCheck;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.JSONValue;
import org.json.simple.parser.ParseException;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* This class is the controller for the doclink.post webscript doclink.post is a
* webscript for creating a link of a document within a target destination
*
* @author Ana Bozianu
* @since 5.1
*/
public class DocLinkPost extends AbstractDocLink
{
private static final String PARAM_DESTINATION_NODE = "destinationNodeRef";
private static final String PARAM_MULTIPLE_FILES = "multipleFiles";
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{
NodeRef sourceNodeRef = null;
NodeRef destinationNodeRef = null;
/* Parse the template vars */
Map<String, String> templateVars = req.getServiceMatch().getTemplateVars();
sourceNodeRef = parseNodeRefFromTemplateArgs(templateVars);
/* Parse the JSON content */
JSONObject json = null;
String contentType = req.getContentType();
if (contentType != null && contentType.indexOf(';') != -1)
{
contentType = contentType.substring(0, contentType.indexOf(';'));
}
if (MimetypeMap.MIMETYPE_JSON.equals(contentType))
{
try
{
json = (JSONObject) JSONValue.parseWithException(req.getContent().getContent());
}
catch (IOException io)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid JSON: " + io.getMessage());
}
catch (ParseException pe)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid JSON: " + pe.getMessage());
}
}
else
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "invalid request content type");
}
/* Parse the destination NodeRef parameter */
String destinationNodeParam = (String) json.get(PARAM_DESTINATION_NODE);
ParameterCheck.mandatoryString("destinationNodeParam", destinationNodeParam);
destinationNodeRef = new NodeRef(destinationNodeParam);
List<NodeRef> nodeRefs = new ArrayList<NodeRef>();
if (json.containsKey(PARAM_MULTIPLE_FILES))
{
JSONArray multipleFiles = (JSONArray) json.get(PARAM_MULTIPLE_FILES);
for (int i = 0; i < multipleFiles.size(); i++)
{
String nodeRefString = (String) multipleFiles.get(i);
if (nodeRefString != null)
{
try
{
NodeRef nodeRefToCreateLink = new NodeRef(nodeRefString);
nodeRefs.add(nodeRefToCreateLink);
}
catch (AlfrescoRuntimeException ex)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid Arguments: " + ex.getMessage());
}
}
}
}
else
{
nodeRefs.add(sourceNodeRef);
}
// getSite for destination folder
String siteName = siteService.getSiteShortName(destinationNodeRef);
ArrayList<Object> linksResults = new ArrayList<Object>();
Map<String, Object> linkResult = new HashMap<String, Object>();
NodeRef linkNodeRef = null;
int successCount = 0;
int failureCount = 0;
if (nodeRefs != null && nodeRefs.size() > 0)
{
for (NodeRef sourceNode : nodeRefs)
{
/* Create link */
linkNodeRef = createLink(destinationNodeRef, sourceNode);
if (linkNodeRef != null)
{
String sourceName = (String) nodeService.getProperty(sourceNode, ContentModel.PROP_NAME);
if (siteName != null)
{
addActivityEntry(ActivityType.DOCLINK_CREATED, sourceName, sourceNode.toString(), siteName);
}
linkResult.put("nodeRef", linkNodeRef.toString());
linksResults.add(linkResult);
successCount++;
}
}
}
failureCount = nodeRefs.size() - successCount;
Map<String, Object> model = new HashMap<String, Object>();
model.put("results", linksResults);
model.put("successCount", successCount);
model.put("failureCount", failureCount);
model.put("overallSuccess", failureCount == 0);
return model;
}
/**
* Create link for sourceNodeRef in destinationNodeRef location
*
* @param destinationNodeRef
* @param sourceNodeRef
* @return
*/
private NodeRef createLink(NodeRef destinationNodeRef, NodeRef sourceNodeRef)
{
NodeRef linkNodeRef = null;
try
{
linkNodeRef = documentLinkService.createDocumentLink(sourceNodeRef, destinationNodeRef);
}
catch (IllegalArgumentException ex)
{
if (ex.getMessage().contains("filelink") || ex.getMessage().contains("folderLink"))
{
return null;
}
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid Arguments: " + ex.getMessage());
}
catch (AccessDeniedException e)
{
throw new WebScriptException(Status.STATUS_FORBIDDEN, "You don't have permission to perform this operation");
}
return linkNodeRef;
}
}
package org.alfresco.repo.web.scripts.doclink;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.security.permissions.AccessDeniedException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.util.ParameterCheck;
import org.json.simple.JSONObject;
import org.json.simple.JSONValue;
import org.json.simple.parser.ParseException;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* This class is the controller for the doclink.post webscript doclink.post is a
* webscript for creating a link of a document within a target destination
*
* @author Ana Bozianu
* @since 5.1
*/
public class DocLinkPost extends AbstractDocLink
{
private static String PARAM_DESTINATION_NODE = "destinationNodeRef";
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{
NodeRef sourceNodeRef = null;
NodeRef destinationNodeRef = null;
/* Parse the template vars */
Map<String, String> templateVars = req.getServiceMatch().getTemplateVars();
sourceNodeRef = parseNodeRefFromTemplateArgs(templateVars);
/* Parse the JSON content */
JSONObject json = null;
String contentType = req.getContentType();
if (contentType != null && contentType.indexOf(';') != -1)
{
contentType = contentType.substring(0, contentType.indexOf(';'));
}
if (MimetypeMap.MIMETYPE_JSON.equals(contentType))
{
try
{
json = (JSONObject) JSONValue.parseWithException(req.getContent().getContent());
}
catch (IOException io)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid JSON: " + io.getMessage());
}
catch (ParseException pe)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid JSON: " + pe.getMessage());
}
}
else
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "invalid request content type");
}
/* Parse the destination NodeRef parameter */
String destinationNodeParam = (String) json.get(PARAM_DESTINATION_NODE);
ParameterCheck.mandatoryString("destinationNodeParam", destinationNodeParam);
destinationNodeRef = new NodeRef(destinationNodeParam);
/* Create link */
NodeRef linkNodeRef = null;
try
{
linkNodeRef = documentLinkService.createDocumentLink(sourceNodeRef, destinationNodeRef);
}
catch (IllegalArgumentException ex)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Invalid Arguments: " + ex.getMessage());
}
catch (AccessDeniedException e)
{
throw new WebScriptException(Status.STATUS_FORBIDDEN, "You don't have permission to perform this operation");
}
/* Build response */
Map<String, Object> model = new HashMap<String, Object>();
model.put("linkNodeRef", linkNodeRef.toString());
return model;
}
}