mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
.externalToolBuilders
config
source
cpp
java
org
alfresco
example
filesys
jcr
linkvalidation
model
repo
action
admin
attributes
audit
avm
cache
clt
coci
configuration
content
copy
deploy
descriptor
dictionary
domain
exporter
forum
importer
jscript
lock
model
module
node
ownable
policy
processor
BaseProcessor.java
BaseProcessorExtension.java
ScriptServiceImpl.java
TemplateServiceImpl.java
remote
rule
search
security
service
template
transaction
version
workflow
sandbox
service
tools
util
apache
queryRegister.dtd
meta-inf
test-resources
web
.classpath
.project
build.xml
5401499003
Hightlights of check-in include: - Introduction of script processor - Neutralisation of script and template models - The notion of a processor extension introduced - Extensions applied to processor implementation rather than the services - Auto selection of processor based on file extension of template or script git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5519 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
404 lines
14 KiB
Java
404 lines
14 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.processor;
|
|
|
|
import java.util.HashMap;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.model.ContentModel;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.NodeService;
|
|
import org.alfresco.service.cmr.repository.ScriptException;
|
|
import org.alfresco.service.cmr.repository.ScriptLocation;
|
|
import org.alfresco.service.cmr.repository.ScriptProcessor;
|
|
import org.alfresco.service.cmr.repository.ScriptService;
|
|
import org.alfresco.service.cmr.repository.StoreRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.alfresco.util.ParameterCheck;
|
|
import org.apache.log4j.Logger;
|
|
|
|
/**
|
|
* Script service implementation
|
|
*
|
|
* @author Kevin Roast
|
|
* @author Roy Wetherall
|
|
*/
|
|
public class ScriptServiceImpl implements ScriptService
|
|
{
|
|
/** Logger */
|
|
private static final Logger logger = Logger.getLogger(ScriptServiceImpl.class);
|
|
|
|
/** The name of the default script processor */
|
|
private String defaultScriptProcessor;
|
|
|
|
/** Maps containing the script processors */
|
|
private Map<String, ScriptProcessor> scriptProcessors = new HashMap<String, ScriptProcessor>(5);
|
|
private Map<String, String> scriptProcessorNamesByExtension = new HashMap<String, String>(5);
|
|
|
|
/** The node service */
|
|
private NodeService nodeService;
|
|
|
|
/**
|
|
* Sets the name of the default script processor
|
|
*
|
|
* @param defaultScriptProcessor the name of the default script processor
|
|
*/
|
|
public void setDefaultScriptProcessor(String defaultScriptProcessor)
|
|
{
|
|
this.defaultScriptProcessor = defaultScriptProcessor;
|
|
}
|
|
|
|
/**
|
|
* Set the node service
|
|
*
|
|
* @param nodeService the node service
|
|
*/
|
|
public void setNodeService(NodeService nodeService)
|
|
{
|
|
this.nodeService = nodeService;
|
|
}
|
|
|
|
/**
|
|
* Register a script processor
|
|
*
|
|
* @param scriptProcessor the script processor to register with the script service
|
|
*/
|
|
public void registerScriptProcessor(ScriptProcessor scriptProcessor)
|
|
{
|
|
this.scriptProcessors.put(scriptProcessor.getName(), scriptProcessor);
|
|
this.scriptProcessorNamesByExtension.put(scriptProcessor.getExtension(), scriptProcessor.getName());
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScript(java.lang.String, java.util.Map)
|
|
*/
|
|
public Object executeScript(String scriptClasspath, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
if (scriptClasspath == null)
|
|
{
|
|
throw new IllegalArgumentException("Script ClassPath is mandatory.");
|
|
}
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Executing script: " + scriptClasspath);
|
|
}
|
|
|
|
try
|
|
{
|
|
ScriptProcessor scriptProcessor = getScriptProcessor(scriptClasspath);
|
|
return scriptProcessor.execute(scriptClasspath, model);
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
throw new ScriptException("Failed to execute script '" + scriptClasspath + "': " + err.getMessage(), err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScript(java.lang.String, java.lang.String, java.util.Map)
|
|
*/
|
|
public Object executeScript(String engine, String scriptClasspath, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
if (scriptClasspath == null)
|
|
{
|
|
throw new IllegalArgumentException("Script ClassPath is mandatory.");
|
|
}
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Executing script: " + scriptClasspath);
|
|
}
|
|
|
|
try
|
|
{
|
|
ScriptProcessor scriptProcessor = lookupScriptProcessor(engine);
|
|
return scriptProcessor.execute(scriptClasspath, model);
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
throw new ScriptException("Failed to execute script '" + scriptClasspath + "': " + err.getMessage(), err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScript(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.util.Map)
|
|
*/
|
|
public Object executeScript(NodeRef scriptRef, QName contentProp, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
if (scriptRef == null)
|
|
{
|
|
throw new IllegalArgumentException("Script NodeRef is mandatory.");
|
|
}
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Executing script: " + scriptRef.toString());
|
|
}
|
|
|
|
try
|
|
{
|
|
ScriptProcessor scriptProcessor = getScriptProcessor(scriptRef);
|
|
return scriptProcessor.execute(scriptRef, contentProp, model);
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
throw new ScriptException("Failed to execute script '" + scriptRef.toString() + "': " + err.getMessage(), err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScript(java.lang.String, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.util.Map)
|
|
*/
|
|
public Object executeScript(String engine, NodeRef scriptRef, QName contentProp, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
if (scriptRef == null)
|
|
{
|
|
throw new IllegalArgumentException("Script NodeRef is mandatory.");
|
|
}
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Executing script: " + scriptRef.toString());
|
|
}
|
|
|
|
try
|
|
{
|
|
ScriptProcessor scriptProcessor = lookupScriptProcessor(engine);
|
|
return scriptProcessor.execute(scriptRef, contentProp, model);
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
throw new ScriptException("Failed to execute script '" + scriptRef.toString() + "': " + err.getMessage(), err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScript(org.alfresco.service.cmr.repository.ScriptLocation, java.util.Map)
|
|
*/
|
|
public Object executeScript(ScriptLocation location, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
ParameterCheck.mandatory("Location", location);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Executing script: " + location.toString());
|
|
}
|
|
|
|
try
|
|
{
|
|
ScriptProcessor scriptProcessor = getScriptProcessor(location.toString());
|
|
return scriptProcessor.execute(location, model);
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
throw new ScriptException("Failed to execute script '" + location.toString() + "': " + err.getMessage(), err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScript(java.lang.String, org.alfresco.service.cmr.repository.ScriptLocation, java.util.Map)
|
|
*/
|
|
public Object executeScript(String engine, ScriptLocation location, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
ParameterCheck.mandatory("Location", location);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Executing script: " + location.toString());
|
|
}
|
|
|
|
try
|
|
{
|
|
ScriptProcessor scriptProcessor = lookupScriptProcessor(engine);
|
|
return scriptProcessor.execute(location, model);
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
throw new ScriptException("Failed to execute script '" + location.toString() + "': " + err.getMessage(), err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScriptString(java.lang.String, java.util.Map)
|
|
*/
|
|
public Object executeScriptString(String script, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
return executeScriptString(this.defaultScriptProcessor, script, model);
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#executeScriptString(java.lang.String, java.util.Map)
|
|
*/
|
|
public Object executeScriptString(String engine, String script, Map<String, Object> model)
|
|
throws ScriptException
|
|
{
|
|
if (script == null || script.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Script argument is mandatory.");
|
|
}
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Executing script:\n" + script);
|
|
}
|
|
|
|
try
|
|
{
|
|
ScriptProcessor scriptProcessor = lookupScriptProcessor(engine);
|
|
return scriptProcessor.executeString(script, model);
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
throw new ScriptException("Failed to execute supplied script: " + err.getMessage(), err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper method to lookup the script proecessor based on a name
|
|
*
|
|
* @param name the name of the script processor
|
|
* @return ScriptProcessor the script processor, default processor if no match found
|
|
*/
|
|
protected ScriptProcessor lookupScriptProcessor(String name)
|
|
{
|
|
ScriptProcessor scriptProcessor = this.scriptProcessors.get(name);
|
|
if (scriptProcessor == null)
|
|
{
|
|
scriptProcessor = this.scriptProcessors.get(this.defaultScriptProcessor);
|
|
}
|
|
return scriptProcessor;
|
|
}
|
|
|
|
/**
|
|
* Gets a scipt processor based on the node reference of a script
|
|
*
|
|
* @param scriptNode the node reference of the script
|
|
* @return ScriptProcessor the script processor
|
|
*/
|
|
protected ScriptProcessor getScriptProcessor(NodeRef scriptNode)
|
|
{
|
|
String scriptName = (String)this.nodeService.getProperty(scriptNode, ContentModel.PROP_NAME);
|
|
return getScriptProcessorImpl(scriptName);
|
|
}
|
|
|
|
/**
|
|
* Gets a script processor based on the script location string
|
|
*
|
|
* @param scriptLocation the script location
|
|
* @return ScriptProcessor the script processor
|
|
*/
|
|
protected ScriptProcessor getScriptProcessor(String scriptLocation)
|
|
{
|
|
if (scriptLocation.indexOf(StoreRef.URI_FILLER) != -1)
|
|
{
|
|
// Try and create the nodeRef
|
|
NodeRef nodeRef = new NodeRef(scriptLocation);
|
|
scriptLocation = (String)this.nodeService.getProperty(nodeRef, ContentModel.PROP_NAME);
|
|
}
|
|
|
|
return getScriptProcessorImpl(scriptLocation);
|
|
}
|
|
|
|
/**
|
|
* Gets a script processor based on the scripts file name
|
|
*
|
|
* @param scriptFileName the scripts file name
|
|
* @return ScriptProcessor the matching script processor
|
|
*/
|
|
protected ScriptProcessor getScriptProcessorImpl(String scriptFileName)
|
|
{
|
|
String engine = null;
|
|
|
|
if (scriptFileName != null)
|
|
{
|
|
String extension = getFileExtension(scriptFileName);
|
|
if (extension != null)
|
|
{
|
|
engine = this.scriptProcessorNamesByExtension.get(extension);
|
|
}
|
|
}
|
|
|
|
return lookupScriptProcessor(engine);
|
|
}
|
|
|
|
/**
|
|
* Gets the file extension of a file
|
|
*
|
|
* @param fileName the file name
|
|
* @return the file extension
|
|
*/
|
|
private String getFileExtension(String fileName)
|
|
{
|
|
String extension = null;
|
|
int index = fileName.lastIndexOf('.');
|
|
if (index > -1 && (index < fileName.length() - 1))
|
|
{
|
|
extension = fileName.substring(index + 1);
|
|
}
|
|
return extension;
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.repository.ScriptService#buildDefaultModel(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef)
|
|
*/
|
|
public Map<String, Object> buildDefaultModel(
|
|
NodeRef person,
|
|
NodeRef companyHome,
|
|
NodeRef userHome,
|
|
NodeRef script,
|
|
NodeRef document,
|
|
NodeRef space)
|
|
{
|
|
Map<String, Object> model = new HashMap<String, Object>();
|
|
|
|
// add the well known node wrapper objects
|
|
model.put("companyhome", companyHome);
|
|
model.put("userhome", userHome);
|
|
model.put("person", person);
|
|
if (script != null)
|
|
{
|
|
model.put("script", script);
|
|
}
|
|
if (document != null)
|
|
{
|
|
model.put("document", document);
|
|
}
|
|
if (space != null)
|
|
{
|
|
model.put("space", space);
|
|
}
|
|
|
|
return model;
|
|
}
|
|
}
|