mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-07 18:25:23 +00:00
30084dde24
20069 Fix for unreported issue where the Rendition Service's JavaScript API cannot be used to execute ad hoc rendition definitions.
Rendition Definitions can be created and executed programmatically. This works fine via the Java Foundation API, but is broken in the JavaScript API.
The rendition nodes are not correctly created for ad hoc rendition definitions created in JavaScript.
Note that the built-in rendition definitions work fine in JavaScript.
This fix:
- ScriptRenditionDefinition now extends ScriptAction in order to reuse its parameter handling and execution code.
- ScriptRenditionDefinition now mimics ScriptAction so you can call
renditionDef.execute(testSourceNode); in JavaScript.
- more test coverage in the test_renditionService.js to reproduce the issue.
- adds debug logging in various places in the rendition service.
- changes ScriptAction to be a non-final class so that it can be extended by ScriptRenditionDefinition.
- fixes some fragile asserts in test code.
- changes a few fields to protected visibility and provides an extension point so that the rendition service can execute its "actions" as renditions rather than simple actions.
- trivial. tidied up some unused imports in ScriptNode.
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@20070 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
438 lines
18 KiB
Java
438 lines
18 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 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.repo.rendition;
|
|
|
|
import static org.alfresco.model.ContentModel.PROP_NODE_DBID;
|
|
import static org.alfresco.model.ContentModel.PROP_NODE_REF;
|
|
import static org.alfresco.model.ContentModel.PROP_NODE_UUID;
|
|
import static org.alfresco.model.ContentModel.PROP_STORE_IDENTIFIER;
|
|
import static org.alfresco.model.ContentModel.PROP_STORE_NAME;
|
|
import static org.alfresco.model.ContentModel.PROP_STORE_PROTOCOL;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.Arrays;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.error.AlfrescoRuntimeException;
|
|
import org.alfresco.model.ContentModel;
|
|
import org.alfresco.model.RenditionModel;
|
|
import org.alfresco.repo.action.ParameterDefinitionImpl;
|
|
import org.alfresco.repo.action.executer.ActionExecuter;
|
|
import org.alfresco.repo.action.executer.ActionExecuterAbstractBase;
|
|
import org.alfresco.repo.rendition.executer.AbstractRenderingEngine;
|
|
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
|
import org.alfresco.service.cmr.action.Action;
|
|
import org.alfresco.service.cmr.action.ActionService;
|
|
import org.alfresco.service.cmr.action.ParameterDefinition;
|
|
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
|
|
import org.alfresco.service.cmr.rendition.NodeLocator;
|
|
import org.alfresco.service.cmr.rendition.RenderCallback;
|
|
import org.alfresco.service.cmr.rendition.RenditionDefinition;
|
|
import org.alfresco.service.cmr.rendition.RenditionService;
|
|
import org.alfresco.service.cmr.rendition.RenditionServiceException;
|
|
import org.alfresco.service.cmr.repository.ChildAssociationRef;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.NodeService;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.apache.commons.logging.Log;
|
|
import org.apache.commons.logging.LogFactory;
|
|
import org.springframework.extensions.surf.util.ParameterCheck;
|
|
|
|
/*
|
|
* This class is the action executer for the perform-rendition action. All renditions are
|
|
* executed by this class as wrapping them all in a containing action facilitates
|
|
* asynchronous renditions.
|
|
* <P/>
|
|
* Some of the logic is executed directly by this class (handling of rendition-related
|
|
* aspects and associations) and the rest is executed by subordinate actions called
|
|
* from within this action (the actual rendering code). These subordinate actions are
|
|
* renditionDefinitions.
|
|
*
|
|
* @author Neil McErlean
|
|
* @since 3.3
|
|
*/
|
|
public class PerformRenditionActionExecuter extends ActionExecuterAbstractBase
|
|
{
|
|
private static final Log log = LogFactory.getLog(PerformRenditionActionExecuter.class);
|
|
|
|
/** Action name and parameters */
|
|
public static final String NAME = "perform-rendition";
|
|
public static final String PARAM_RENDITION_DEFINITION = "renditionDefinition";
|
|
|
|
private static final String DEFAULT_RUN_AS_NAME = AuthenticationUtil.getSystemUserName();
|
|
|
|
private static final List<QName> unchangedProperties = Arrays.asList(PROP_NODE_DBID, PROP_NODE_REF, PROP_NODE_UUID,
|
|
PROP_STORE_IDENTIFIER, PROP_STORE_NAME, PROP_STORE_PROTOCOL);
|
|
/**
|
|
* Default {@link NodeLocator} simply returns the source node.
|
|
*/
|
|
private final static NodeLocator defaultNodeLocator = new NodeLocator()
|
|
{
|
|
public NodeRef getNode(NodeRef sourceNode, Map<String, Serializable> params)
|
|
{
|
|
return sourceNode;
|
|
}
|
|
};
|
|
|
|
/*
|
|
* Injected beans
|
|
*/
|
|
private RenditionLocationResolver renditionLocationResolver;
|
|
private ActionService actionService;
|
|
private NodeService nodeService;
|
|
private RenditionService renditionService;
|
|
|
|
private final NodeLocator temporaryParentNodeLocator;
|
|
private final QName temporaryRenditionLinkType;
|
|
|
|
public PerformRenditionActionExecuter(NodeLocator temporaryParentNodeLocator, QName temporaryRenditionLinkType)
|
|
{
|
|
this.temporaryParentNodeLocator = temporaryParentNodeLocator != null ? temporaryParentNodeLocator
|
|
: defaultNodeLocator;
|
|
this.temporaryRenditionLinkType = temporaryRenditionLinkType != null ? temporaryRenditionLinkType
|
|
: RenditionModel.ASSOC_RENDITION;
|
|
}
|
|
|
|
public PerformRenditionActionExecuter()
|
|
{
|
|
this(null, null);
|
|
}
|
|
|
|
/**
|
|
* Injects the actionService bean.
|
|
*
|
|
* @param actionService
|
|
* the actionService.
|
|
*/
|
|
public void setActionService(ActionService actionService)
|
|
{
|
|
this.actionService = actionService;
|
|
}
|
|
|
|
/**
|
|
* Injects the nodeService bean.
|
|
*
|
|
* @param nodeService
|
|
* the nodeService.
|
|
*/
|
|
public void setNodeService(NodeService nodeService)
|
|
{
|
|
this.nodeService = nodeService;
|
|
}
|
|
|
|
/**
|
|
* Injects the renditionService bean.
|
|
*
|
|
* @param renditionService
|
|
*/
|
|
public void setRenditionService(RenditionService renditionService)
|
|
{
|
|
this.renditionService = renditionService;
|
|
}
|
|
|
|
public void setRenditionLocationResolver(RenditionLocationResolver renditionLocationResolver)
|
|
{
|
|
this.renditionLocationResolver = renditionLocationResolver;
|
|
}
|
|
|
|
@Override
|
|
protected void executeImpl(final Action containingAction, final NodeRef actionedUponNodeRef)
|
|
{
|
|
final RenditionDefinition renditionDefinition = getRenditionDefinition(containingAction);
|
|
if (log.isDebugEnabled())
|
|
{
|
|
StringBuilder msg = new StringBuilder();
|
|
msg.append("Rendering node ").append(actionedUponNodeRef).append(" with rendition definition ").append(
|
|
renditionDefinition.getRenditionName());
|
|
msg.append("\n").append(" parameters:").append("\n");
|
|
if (renditionDefinition.getParameterValues().isEmpty() == false)
|
|
{
|
|
for (String paramKey : renditionDefinition.getParameterValues().keySet())
|
|
{
|
|
msg.append(" ").append(paramKey).append("=").append(renditionDefinition.getParameterValue(paramKey)).append("\n");
|
|
}
|
|
}
|
|
else
|
|
{
|
|
msg.append(" [None]");
|
|
}
|
|
log.debug(msg.toString());
|
|
}
|
|
|
|
Serializable runAsParam = renditionDefinition.getParameterValue(AbstractRenderingEngine.PARAM_RUN_AS);
|
|
String runAsName = runAsParam == null ? DEFAULT_RUN_AS_NAME : (String) runAsParam;
|
|
|
|
// Renditions should all be created by system by default.
|
|
// When renditions are created by a user and are to be created under a
|
|
// node
|
|
// other than the source node, it is possible that the user will not
|
|
// have
|
|
// permissions to create content under that node.
|
|
// For that reason, we execute all perform-rendition actions as system
|
|
// by default.
|
|
AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork<Void>()
|
|
{
|
|
public Void doWork() throws Exception
|
|
{
|
|
ChildAssociationRef result = null;
|
|
try
|
|
{
|
|
setTemporaryRenditionProperties(actionedUponNodeRef, renditionDefinition);
|
|
|
|
// Adds the 'Renditioned' aspect to the source node if it
|
|
// doesn't exist.
|
|
if (!nodeService.hasAspect(actionedUponNodeRef, RenditionModel.ASPECT_RENDITIONED))
|
|
{
|
|
nodeService.addAspect(actionedUponNodeRef, RenditionModel.ASPECT_RENDITIONED, null);
|
|
}
|
|
ChildAssociationRef tempRendAssoc = executeRendition(actionedUponNodeRef, renditionDefinition);
|
|
result = createOrUpdateRendition(actionedUponNodeRef, tempRendAssoc, renditionDefinition);
|
|
containingAction.setParameterValue(PARAM_RESULT, result);
|
|
} catch (Throwable t)
|
|
{
|
|
notifyCallbackOfException(renditionDefinition, t);
|
|
throwWrappedException(t);
|
|
}
|
|
if (result != null)
|
|
{
|
|
notifyCallbackOfResult(renditionDefinition, result);
|
|
}
|
|
return null;
|
|
}
|
|
}, runAsName);
|
|
}
|
|
|
|
private RenditionDefinition getRenditionDefinition(final Action containingAction)
|
|
{
|
|
Serializable rendDefObj = containingAction.getParameterValue(PARAM_RENDITION_DEFINITION);
|
|
ParameterCheck.mandatory(PARAM_RENDITION_DEFINITION, rendDefObj);
|
|
return (RenditionDefinition) rendDefObj;
|
|
}
|
|
|
|
// Rendition has failed. If there is a callback, it needs to be notified
|
|
private void notifyCallbackOfException(RenditionDefinition renditionDefinition, Throwable t)
|
|
{
|
|
if (renditionDefinition != null)
|
|
{
|
|
RenderCallback callback = renditionDefinition.getCallback();
|
|
if (callback != null)
|
|
{
|
|
callback.handleFailedRendition(t);
|
|
}
|
|
}
|
|
}
|
|
|
|
// and rethrow Exception
|
|
private void throwWrappedException(Throwable t)
|
|
{
|
|
if (t instanceof AlfrescoRuntimeException)
|
|
{
|
|
throw (AlfrescoRuntimeException) t;
|
|
} else
|
|
{
|
|
throw new RenditionServiceException(t.getMessage(), t);
|
|
}
|
|
}
|
|
|
|
private void notifyCallbackOfResult(RenditionDefinition renditionDefinition, ChildAssociationRef result)
|
|
{
|
|
// Rendition was successful. Notify the callback object.
|
|
if (renditionDefinition != null)
|
|
{
|
|
RenderCallback callback = renditionDefinition.getCallback();
|
|
if (callback != null)
|
|
{
|
|
callback.handleSuccessfulRendition(result);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This method sets the renditionParent and rendition assocType.
|
|
*
|
|
* @param sourceNode
|
|
* @param definition
|
|
*/
|
|
private void setTemporaryRenditionProperties(NodeRef sourceNode, RenditionDefinition definition)
|
|
{
|
|
// Set the parent and assoc type for the temporary rendition to be
|
|
// created.
|
|
NodeRef parent = temporaryParentNodeLocator.getNode(sourceNode, definition.getParameterValues());
|
|
definition.setRenditionParent(parent);
|
|
definition.setRenditionAssociationType(temporaryRenditionLinkType);
|
|
}
|
|
|
|
/**
|
|
* @param sourceNode
|
|
* @param definition
|
|
* @return
|
|
*/
|
|
private ChildAssociationRef executeRendition(NodeRef sourceNode, RenditionDefinition definition)
|
|
{
|
|
actionService.executeAction(definition, sourceNode);
|
|
// Extract the result from the action
|
|
Serializable serializableResult = definition.getParameterValue(ActionExecuter.PARAM_RESULT);
|
|
return (ChildAssociationRef) serializableResult;
|
|
}
|
|
|
|
private ChildAssociationRef createOrUpdateRendition(NodeRef sourceNode, ChildAssociationRef tempRendition,
|
|
RenditionDefinition renditionDefinition)
|
|
{
|
|
NodeRef tempRenditionNode = tempRendition.getChildRef();
|
|
RenditionLocation location = getDestinationParentAssoc(sourceNode, renditionDefinition, tempRenditionNode);
|
|
QName renditionQName = renditionDefinition.getRenditionName();
|
|
if (log.isDebugEnabled())
|
|
{
|
|
final String lineBreak = System.getProperty("line.separator", "\n");
|
|
StringBuilder msg = new StringBuilder();
|
|
msg.append("Creating/updating rendition based on:").append(lineBreak).append(" sourceNode: ").append(
|
|
sourceNode).append(lineBreak).append(" tempRendition: ").append(tempRendition).append(
|
|
lineBreak).append(" parentNode: ").append(location.getParentRef()).append(lineBreak).append(
|
|
" childName: ").append(location.getChildName()).append(lineBreak).append(
|
|
" renditionDefinition.name: ").append(renditionQName);
|
|
log.debug(msg.toString());
|
|
}
|
|
NodeRef oldRendition=getOldRenditionIfExists(sourceNode, renditionDefinition);
|
|
RenditionNodeManager renditionNodeManager = new RenditionNodeManager(sourceNode, oldRendition, location, renditionDefinition, nodeService);
|
|
ChildAssociationRef primaryAssoc = renditionNodeManager.findOrCreateRenditionNode();
|
|
|
|
// Copy relevant properties from the temporary node to the new rendition
|
|
// node.
|
|
NodeRef renditionNode = primaryAssoc.getChildRef();
|
|
transferNodeProperties(tempRenditionNode, renditionNode);
|
|
|
|
// Set the name property on the rendition if it has not already been
|
|
// set.
|
|
String renditionName = getRenditionName(tempRenditionNode, location, renditionDefinition);
|
|
nodeService.setProperty(renditionNode, ContentModel.PROP_NAME, renditionName);
|
|
|
|
// Delete the temporary rendition.
|
|
nodeService.removeChildAssociation(tempRendition);
|
|
|
|
// Handle the rendition aspects
|
|
manageRenditionAspects(sourceNode, primaryAssoc);
|
|
ChildAssociationRef renditionAssoc = renditionService.getRenditionByName(sourceNode, renditionQName);
|
|
if (renditionAssoc == null)
|
|
{
|
|
String msg = "A rendition of type: " + renditionQName + " should have been created for source node: "
|
|
+ sourceNode;
|
|
throw new RenditionServiceException(msg);
|
|
}
|
|
return renditionAssoc;
|
|
}
|
|
|
|
private NodeRef getOldRenditionIfExists(NodeRef sourceNode, RenditionDefinition renditionDefinition)
|
|
{
|
|
QName renditionName=renditionDefinition.getRenditionName();
|
|
ChildAssociationRef renditionAssoc = renditionService.getRenditionByName(sourceNode, renditionName);
|
|
|
|
NodeRef result = (renditionAssoc == null) ? null : renditionAssoc.getChildRef();
|
|
if (log.isDebugEnabled())
|
|
{
|
|
StringBuilder msg = new StringBuilder();
|
|
msg.append("Existing rendition with name ")
|
|
.append(renditionName)
|
|
.append(": ")
|
|
.append(result);
|
|
log.debug(msg.toString());
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
private void manageRenditionAspects(NodeRef sourceNode, ChildAssociationRef renditionParentAssoc)
|
|
{
|
|
NodeRef renditionNode = renditionParentAssoc.getChildRef();
|
|
NodeRef primaryParent = renditionParentAssoc.getParentRef();
|
|
|
|
// If the rendition is located directly underneath its own source node
|
|
if (primaryParent.equals(sourceNode))
|
|
{
|
|
// It should be a 'hidden' rendition.
|
|
nodeService.addAspect(renditionNode, RenditionModel.ASPECT_HIDDEN_RENDITION, null);
|
|
nodeService.removeAspect(renditionNode, RenditionModel.ASPECT_VISIBLE_RENDITION);
|
|
// We remove the other aspect to cover the potential case where a
|
|
// rendition
|
|
// has been updated in a different location.
|
|
} else
|
|
{
|
|
// Renditions stored underneath any node other than their source are
|
|
// 'visible'.
|
|
nodeService.addAspect(renditionNode, RenditionModel.ASPECT_VISIBLE_RENDITION, null);
|
|
nodeService.removeAspect(renditionNode, RenditionModel.ASPECT_HIDDEN_RENDITION);
|
|
}
|
|
}
|
|
|
|
private String getRenditionName(NodeRef tempRenditionNode, RenditionLocation location,
|
|
RenditionDefinition renditionDefinition)
|
|
{
|
|
// If a location name is set then use it.
|
|
String locName = location.getChildName();
|
|
if (locName != null && locName.length() > 0)
|
|
{
|
|
return locName;
|
|
}
|
|
// Else if the temporary rendition specifies a name property use that.
|
|
Serializable tempName = nodeService.getProperty(tempRenditionNode, ContentModel.PROP_NAME);
|
|
if (tempName != null)
|
|
{
|
|
return (String) tempName;
|
|
}
|
|
// Otherwise use the rendition definition local name.
|
|
return renditionDefinition.getRenditionName().getLocalName();
|
|
}
|
|
|
|
private void transferNodeProperties(NodeRef sourceNode, NodeRef targetNode)
|
|
{
|
|
if (log.isDebugEnabled())
|
|
{
|
|
StringBuilder msg = new StringBuilder();
|
|
msg.append("Transferring some properties from ").append(sourceNode).append(" to ").append(targetNode);
|
|
log.debug(msg.toString());
|
|
}
|
|
|
|
QName type = nodeService.getType(sourceNode);
|
|
nodeService.setType(targetNode, type);
|
|
Map<QName, Serializable> newProps = nodeService.getProperties(sourceNode);
|
|
for (QName propKey : unchangedProperties)
|
|
{
|
|
newProps.remove(propKey);
|
|
}
|
|
nodeService.setProperties(targetNode, newProps);
|
|
}
|
|
|
|
private RenditionLocation getDestinationParentAssoc(NodeRef sourceNode, RenditionDefinition definition,
|
|
NodeRef tempRendition)
|
|
{
|
|
return renditionLocationResolver.getRenditionLocation(sourceNode, definition, tempRendition);
|
|
}
|
|
|
|
@Override
|
|
protected void addParameterDefinitions(List<ParameterDefinition> paramList)
|
|
{
|
|
paramList.add(new ParameterDefinitionImpl(PARAM_RENDITION_DEFINITION, DataTypeDefinition.ANY, true,
|
|
getParamDisplayLabel(PARAM_RENDITION_DEFINITION)));
|
|
|
|
paramList.add(new ParameterDefinitionImpl(PARAM_RESULT, DataTypeDefinition.CHILD_ASSOC_REF, false,
|
|
getParamDisplayLabel(PARAM_RESULT)));
|
|
}
|
|
}
|