inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-24 17:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor of template and script services to allow easy addition of further template and script processors.

Browse Source 
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
This commit is contained in:
Roy Wetherall
2007-04-20 17:13:34 +00:00
parent 03c56f4c90
commit 5401499003
44 changed files with 1392 additions and 713 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
source/java/org/alfresco/repo/action/executer/ScriptActionExecuter.java
View File

@@ -29,7 +29,6 @@ import java.util.Map;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.ParameterDefinitionImpl;
import org.alfresco.repo.jscript.RhinoScriptService;
import org.alfresco.repo.jscript.ScriptAction;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.action.Action;
@@ -129,8 +128,7 @@ public class ScriptActionExecuter extends ActionExecuterAbstractBase
// the default scripting model provides access to well known objects and searching
// facilities - it also provides basic create/update/delete/copy/move services
Map<String, Object> model = RhinoScriptService.buildDefaultModel(
this.serviceRegistry,
Map<String, Object> model = this.serviceRegistry.getScriptService().buildDefaultModel(
personRef,
getCompanyHome(),
homeSpaceRef,

6
source/java/org/alfresco/repo/action/scheduled/TemplateActionModelFactory.java
View File

@@ -24,6 +24,8 @@
*/
package org.alfresco.repo.action.scheduled;
import java.util.Map;
import org.alfresco.service.cmr.repository.NodeRef;
/**
@@ -46,7 +48,7 @@ public interface TemplateActionModelFactory
*
* @return - the model for the template engine.
*/
public Object getModel();
public Map<String, Object> getModel();
/**
* Build a model with a default node context.
@@ -54,5 +56,5 @@ public interface TemplateActionModelFactory
* @param nodeRef
* @return - the model (with nodeRef as its context).
*/
public Object getModel(NodeRef nodeRef);
public Map<String, Object> getModel(NodeRef nodeRef);
}

2
source/java/org/alfresco/repo/jscript/AVM.java
View File

@@ -34,7 +34,7 @@ import org.alfresco.service.cmr.avm.AVMNodeDescriptor;
*
* @author Kevin Roast
*/
public final class AVM extends BaseScopableScriptImplementation
public final class AVM extends BaseScopableProcessorExtension
{
/** Repository Service Registry */
private ServiceRegistry services;

2
source/java/org/alfresco/repo/jscript/Actions.java
View File

@@ -36,7 +36,7 @@ import org.alfresco.service.cmr.action.ActionService;
*
* @author davidc
*/
public final class Actions extends BaseScopableScriptImplementation
public final class Actions extends BaseScopableProcessorExtension
{
/** Repository Service Registry */
private ServiceRegistry services;

7
source/java/org/alfresco/repo/jscript/BaseScopableScriptImplementation.java → source/java/org/alfresco/repo/jscript/BaseScopableProcessorExtension.java
View File

@@ -16,6 +16,7 @@
*/
package org.alfresco.repo.jscript;
import org.alfresco.repo.processor.BaseProcessorExtension;
import org.mozilla.javascript.Scriptable;
/**
@@ -25,7 +26,7 @@ import org.mozilla.javascript.Scriptable;
*
* @author Kevin Roast
*/
public class BaseScopableScriptImplementation extends BaseScriptImplementation implements Scopeable
public class BaseScopableProcessorExtension extends BaseProcessorExtension implements Scopeable
{
private static ThreadLocal<Scriptable> scope = new ThreadLocal<Scriptable>();
@@ -36,7 +37,7 @@ public class BaseScopableScriptImplementation extends BaseScriptImplementation i
*/
public void setScope(Scriptable scope)
{
this.scope.set(scope);
BaseScopableProcessorExtension.scope.set(scope);
}
/**
@@ -44,6 +45,6 @@ public class BaseScopableScriptImplementation extends BaseScriptImplementation i
*/
public Scriptable getScope()
{
return this.scope.get();
return BaseScopableProcessorExtension.scope.get();
}
}

2
source/java/org/alfresco/repo/jscript/Classification.java
View File

@@ -37,7 +37,7 @@ import org.alfresco.service.namespace.QName;
*
* @author Andy Hind
*/
public final class Classification extends BaseScopableScriptImplementation
public final class Classification extends BaseScopableProcessorExtension
{
private ServiceRegistry services;

2
source/java/org/alfresco/repo/jscript/CrossRepositoryCopy.java
View File

@@ -37,7 +37,7 @@ import org.mozilla.javascript.Scriptable;
*
* @author Kevin Roast
*/
public final class CrossRepositoryCopy extends BaseScopableScriptImplementation
public final class CrossRepositoryCopy extends BaseScopableProcessorExtension
{
public final static String BEAN_NAME = "crossCopyScript";

11
source/java/org/alfresco/repo/jscript/Node.java
View File

@@ -39,8 +39,6 @@ import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.executer.TransformActionExecuter;
import org.alfresco.repo.content.transform.magick.ImageMagickContentTransformer;
import org.alfresco.repo.search.QueryParameterDefImpl;
import org.alfresco.repo.template.FreeMarkerProcessor;
import org.alfresco.repo.template.TemplateNode;
import org.alfresco.repo.version.VersionModel;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
@@ -1739,8 +1737,7 @@ public class Node implements Serializable, Scopeable
private String processTemplate(String template, NodeRef templateRef, ScriptableObject args)
{
// build default model for the template processing
Map<String, Object> model = FreeMarkerProcessor.buildDefaultModel(
services,
Map<String, Object> model = this.services.getTemplateService().buildDefaultModel(
((Node)((Wrapper)scope.get("person", scope)).unwrap()).getNodeRef(),
((Node)((Wrapper)scope.get("companyhome", scope)).unwrap()).getNodeRef(),
((Node)((Wrapper)scope.get("userhome", scope)).unwrap()).getNodeRef(),
@@ -1750,12 +1747,12 @@ public class Node implements Serializable, Scopeable
// add the current node as either the document/space as appropriate
if (this.getIsDocument())
{
model.put("document", new TemplateNode(this.nodeRef, this.services, null));
model.put("space", new TemplateNode(getPrimaryParentAssoc().getParentRef(), this.services, null));
model.put("document", this.nodeRef);
model.put("space", getPrimaryParentAssoc().getParentRef());
}
else
{
model.put("space", new TemplateNode(this.nodeRef, this.services, null));
model.put("space", this.nodeRef);
}
// add the supplied args to the 'args' root object

2
source/java/org/alfresco/repo/jscript/People.java
View File

@@ -40,7 +40,7 @@ import org.alfresco.util.ParameterCheck;
*
* @author davidc
*/
public final class People extends BaseScopableScriptImplementation
public final class People extends BaseScopableProcessorExtension
{
/** Repository Service Registry */
private ServiceRegistry services;

261
source/java/org/alfresco/repo/jscript/RhinoScriptService.java → source/java/org/alfresco/repo/jscript/RhinoScriptProcessor.java
View File

@@ -36,19 +36,18 @@ import java.util.StringTokenizer;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.repo.processor.BaseProcessor;
import org.alfresco.service.cmr.model.FileInfo;
import org.alfresco.service.cmr.model.FileNotFoundException;
import org.alfresco.service.cmr.repository.ContentIOException;
import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.ProcessorExtension;
import org.alfresco.service.cmr.repository.ScriptException;
import org.alfresco.service.cmr.repository.ScriptImplementation;
import org.alfresco.service.cmr.repository.ScriptLocation;
import org.alfresco.service.cmr.repository.ScriptService;
import org.alfresco.service.cmr.repository.ScriptProcessor;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.ParameterCheck;
import org.apache.log4j.Logger;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.NativeArray;
@@ -58,41 +57,25 @@ import org.mozilla.javascript.Wrapper;
import org.springframework.util.FileCopyUtils;
/**
* Implementation of the ScriptService using the Rhino JavaScript engine.
* Implementation of the ScriptEninge using the Rhino JavaScript engine.
*
* @author Kevin Roast
*/
public class RhinoScriptService implements ScriptService
public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcessor
{
private static final Logger logger = Logger.getLogger(RhinoScriptService.class);
private static final Logger logger = Logger.getLogger(RhinoScriptProcessor.class);
private static final String IMPORT_PREFIX = "<import";
private static final String IMPORT_RESOURCE = "resource=\"";
private static final String PATH_CLASSPATH = "classpath:";
private static final String SCRIPT_ROOT = "_root";
/** Repository Service Registry */
private ServiceRegistry services;
/** Store into which to resolve cm:name based script paths */
private StoreRef storeRef;
/** Store root path to resolve cm:name based scripts path from */
private String storePath;
/** List of global scripts */
private List<ScriptImplementation> globalScripts = new ArrayList<ScriptImplementation>();
/**
* Set the Service Registry
*
* @param service registry
*/
public void setServiceRegistry(ServiceRegistry services)
{
this.services = services;
}
/**
* Set the default store reference
*
@@ -112,102 +95,10 @@ public class RhinoScriptService implements ScriptService
}
/**
* @see org.alfresco.service.cmr.repository.ScriptService#registerScript(java.lang.Object)
* @see org.alfresco.service.cmr.repository.ScriptProcessor#execute(org.alfresco.service.cmr.repository.ScriptLocation, java.util.Map)
*/
public void registerScript(ScriptImplementation script)
public Object execute(ScriptLocation location, Map<String, Object> model)
{
this.globalScripts.add(script);
}
/**
* @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
{
InputStream stream = getClass().getClassLoader().getResourceAsStream(scriptClasspath);
if (stream == null)
{
throw new AlfrescoRuntimeException("Unable to load classpath resource: " + scriptClasspath);
}
ByteArrayOutputStream os = new ByteArrayOutputStream();
FileCopyUtils.copy(stream, os); // both streams are closed
byte[] bytes = os.toByteArray();
return executeScriptImpl(resolveScriptImports(new String(bytes)), 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
{
if (this.services.getNodeService().exists(scriptRef) == false)
{
throw new AlfrescoRuntimeException("Script Node does not exist: " + scriptRef);
}
if (contentProp == null)
{
contentProp = ContentModel.PROP_CONTENT;
}
ContentReader cr = this.services.getContentService().getReader(scriptRef, contentProp);
if (cr == null || cr.exists() == false)
{
throw new AlfrescoRuntimeException("Script Node content not found: " + scriptRef);
}
return executeScriptImpl(resolveScriptImports(cr.getContentString()), 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
{
ByteArrayOutputStream os = new ByteArrayOutputStream();
@@ -221,23 +112,66 @@ public class RhinoScriptService implements ScriptService
throw new ScriptException("Failed to execute script '" + location.toString() + "': " + err.getMessage(), err);
}
}
/**
* @see org.alfresco.service.cmr.repository.ScriptProcessor#execute(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.util.Map)
*/
public Object execute(NodeRef nodeRef, QName contentProp, Map<String, Object> model)
{
try
{
if (this.services.getNodeService().exists(nodeRef) == false)
{
throw new AlfrescoRuntimeException("Script Node does not exist: " + nodeRef);
}
if (contentProp == null)
{
contentProp = ContentModel.PROP_CONTENT;
}
ContentReader cr = this.services.getContentService().getReader(nodeRef, contentProp);
if (cr == null || cr.exists() == false)
{
throw new AlfrescoRuntimeException("Script Node content not found: " + nodeRef);
}
return executeScriptImpl(resolveScriptImports(cr.getContentString()), model);
}
catch (Throwable err)
{
throw new ScriptException("Failed to execute script '" + nodeRef.toString() + "': " + err.getMessage(), err);
}
}
/**
* @see org.alfresco.service.cmr.repository.ScriptService#executeScriptString(java.lang.String, java.util.Map)
* @see org.alfresco.service.cmr.repository.ScriptProcessor#execute(java.lang.String, java.util.Map)
*/
public Object executeScriptString(String script, Map<String, Object> model)
throws ScriptException
public Object execute(String location, Map<String, Object> model)
{
try
{
InputStream stream = getClass().getClassLoader().getResourceAsStream(location);
if (stream == null)
{
throw new AlfrescoRuntimeException("Unable to load classpath resource: " + location);
}
ByteArrayOutputStream os = new ByteArrayOutputStream();
FileCopyUtils.copy(stream, os); // both streams are closed
byte[] bytes = os.toByteArray();
return executeScriptImpl(resolveScriptImports(new String(bytes)), model);
}
catch (Throwable err)
{
throw new ScriptException("Failed to execute script '" + location + "': " + err.getMessage(), err);
}
}
/**
* @see org.alfresco.service.cmr.repository.ScriptProcessor#executeString(java.lang.String, java.util.Map)
*/
public Object executeString(String script, Map<String, Object> model)
{
if (script == null || script.length() == 0)
{
throw new IllegalArgumentException("Script argument is mandatory.");
}
if (logger.isDebugEnabled())
{
logger.debug("Executing script:\n" + script);
}
try
{
return executeScriptImpl(resolveScriptImports(script), model);
@@ -247,6 +181,7 @@ public class RhinoScriptService implements ScriptService
throw new ScriptException("Failed to execute supplied script: " + err.getMessage(), err);
}
}
/**
* Resolve the imports in the specified script. Include directives are of the following form:
@@ -453,7 +388,7 @@ public class RhinoScriptService implements ScriptService
if (resource.startsWith("/"))
{
// resolve from default SpacesStore as cm:name based path
// we have to assume "/Company Home" as the root for now
// TODO: remove this once FFS correctly allows name path resolving from store root!
NodeRef rootNodeRef = this.services.getNodeService().getRootNode(this.storeRef);
List<NodeRef> nodes = this.services.getSearchService().selectNodes(
rootNodeRef, this.storePath, null, this.services.getNamespaceService(), false);
@@ -516,7 +451,7 @@ public class RhinoScriptService implements ScriptService
*
* @throws AlfrescoRuntimeException
*/
private Object executeScriptImpl(String script, Map<String, Object> model)
private Object executeScriptImpl(String script, Map<String, Object> origModel)
throws AlfrescoRuntimeException
{
long startTime = 0;
@@ -525,6 +460,9 @@ public class RhinoScriptService implements ScriptService
startTime = System.currentTimeMillis();
}
// Convert the model
Map<String, Object> model = convertToRhinoModel(origModel);
// check that rhino script engine is available
Context cx = Context.enter();
try
@@ -541,9 +479,9 @@ public class RhinoScriptService implements ScriptService
}
// add the global scripts
for (ScriptImplementation ex : this.globalScripts)
for (ProcessorExtension ex : this.processExtensions.values())
{
model.put(ex.getScriptName(), ex);
model.put(ex.getExtensionName(), ex);
}
// insert supplied object model into root of the default scope
@@ -596,50 +534,25 @@ public class RhinoScriptService implements ScriptService
}
/**
* Create the default data-model available to scripts as global scope level objects:
* <p>
* 'companyhome' - the Company Home node<br>
* 'userhome' - the current user home space node<br>
* 'person' - the node representing the current user Person<br>
* 'script' - the node representing the script itself (may not be available)<br>
* 'document' - document context node (may not be available)<br>
* 'space' - space context node (may not be available)
* Converts the passed model into a Rhino model
*
* @param services ServiceRegistry
* @param person The current user Person Node
* @param companyHome The CompanyHome ref
* @param userHome The User home space ref
* @param script Optional ref to the script itself
* @param document Optional ref to a document Node
* @param space Optional ref to a space Node
* @param resolver Image resolver to resolve icon images etc.
*
* @return A Map of global scope scriptable Node objects
* @param model the model
* @return Map<String, Object> the converted model
*/
public static Map<String, Object> buildDefaultModel(
ServiceRegistry services,
NodeRef person, NodeRef companyHome, NodeRef userHome,
NodeRef script, NodeRef document, NodeRef space)
private Map<String, Object> convertToRhinoModel(Map<String, Object> model)
{
Map<String, Object> model = new HashMap<String, Object>();
// add the well known node wrapper objects
model.put("companyhome", new Node(companyHome, services));
model.put("userhome", new Node(userHome, services));
model.put("person", new Node(person, services));
if (script != null)
Map<String, Object> newModel = new HashMap<String, Object>(model.size());
for (Map.Entry<String, Object> entry : model.entrySet())
{
model.put("script", new Node(script, services));
if (entry.getValue() instanceof NodeRef)
{
newModel.put(entry.getKey(), new Node((NodeRef)entry.getValue(), this.services));
}
else
{
newModel.put(entry.getKey(), entry.getValue());
}
}
if (document != null)
{
model.put("document", new Node(document, services));
}
if (space != null)
{
model.put("space", new Node(space, services));
}
return model;
return newModel;
}
}

2
source/java/org/alfresco/repo/jscript/RhinoScriptTest.java
View File

@@ -260,7 +260,7 @@ public class RhinoScriptTest extends TestCase
scriptService.executeScript(contentNodeRef, BaseNodeServiceTest.PROP_QNAME_TEST_CONTENT, model);
// test executing a script directly as a String
scriptService.executeScriptString(TESTSCRIPT1, model);
scriptService.executeScriptString("javascript", TESTSCRIPT1, model);
}
catch (Throwable err)
{

3
source/java/org/alfresco/repo/jscript/ScriptLogger.java
View File

@@ -24,12 +24,13 @@
*/
package org.alfresco.repo.jscript;
import org.alfresco.repo.processor.BaseProcessorExtension;
import org.apache.log4j.Logger;
/**
* @author Kevin Roast
*/
public final class ScriptLogger extends BaseScriptImplementation
public final class ScriptLogger extends BaseProcessorExtension
{
private static final Logger logger = Logger.getLogger(ScriptLogger.class);

2
source/java/org/alfresco/repo/jscript/ScriptUtils.java
View File

@@ -32,7 +32,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
*
* @author Kevin Roast
*/
public final class ScriptUtils extends BaseScopableScriptImplementation
public final class ScriptUtils extends BaseScopableProcessorExtension
{
/** Services */
private ServiceRegistry services;

2
source/java/org/alfresco/repo/jscript/Search.java
View File

@@ -54,7 +54,7 @@ import org.dom4j.io.SAXReader;
*
* @author Kevin Roast
*/
public final class Search extends BaseScopableScriptImplementation
public final class Search extends BaseScopableProcessorExtension
{
/** Service registry */
private ServiceRegistry services;

3
source/java/org/alfresco/repo/jscript/Session.java
View File

@@ -24,6 +24,7 @@
*/
package org.alfresco.repo.jscript;
import org.alfresco.repo.processor.BaseProcessorExtension;
import org.alfresco.service.ServiceRegistry;
/**
@@ -33,7 +34,7 @@ import org.alfresco.service.ServiceRegistry;
*
* @author Andy Hind
*/
public class Session extends BaseScriptImplementation
public class Session extends BaseProcessorExtension
{
/** Service registry */
private ServiceRegistry services;

3
source/java/org/alfresco/repo/module/tool/default-file-mapping.properties
View File

@@ -5,4 +5,5 @@
/web/jsp=/jsp
/web/css=/css
/web/images=/images
/web/scripts=/scripts
/web/scripts=/scripts
/web/php=/php

158
source/java/org/alfresco/repo/processor/BaseProcessor.java Normal file
View File

@@ -0,0 +1,158 @@
/*
* 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.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.Processor;
import org.alfresco.service.cmr.repository.ProcessorExtension;
import org.alfresco.service.cmr.repository.ScriptProcessor;
import org.alfresco.service.cmr.repository.ScriptService;
import org.alfresco.service.cmr.repository.TemplateProcessor;
import org.alfresco.service.cmr.repository.TemplateService;
/**
* Base class of a processor, encapsulates the implementation reguarding the registration of the processor
* with the relevant services and the handling of processor extensions.
*
* @author Roy Wetherall
*/
public abstract class BaseProcessor implements Processor
{
/** The name of the processor */
protected String name;
/** The file extension that this processor understands */
protected String extension;
/** The script service */
protected ScriptService scriptService;
/** The template service */
protected TemplateService templateService;
/** The service registry */
protected ServiceRegistry services;
/** A map containing all the processor extenstions */
protected Map<String, ProcessorExtension> processExtensions = new HashMap<String, ProcessorExtension>(10);
/**
* Registers this processor with the relevant services
*/
public void register()
{
if (this instanceof ScriptProcessor)
{
scriptService.registerScriptProcessor((ScriptProcessor)this);
}
if (this instanceof TemplateProcessor)
{
templateService.registerTemplateProcessor((TemplateProcessor)this);
}
}
/**
* Sets the script service
*
* @param scriptService the script service
*/
public void setScriptService(ScriptService scriptService)
{
this.scriptService = scriptService;
}
/**
* Sets the template service
*
* @param templateService the template service
*/
public void setTemplateService(TemplateService templateService)
{
this.templateService = templateService;
}
/**
* Sets the service registry
*
* @param serviceRegistry the service registry
*/
public void setServiceRegistry(ServiceRegistry serviceRegistry)
{
this.services = serviceRegistry;
}
/**
* Get the name of the processor
*
* @return String the name of the processor
*/
public String getName()
{
return name;
}
/**
* Sets the name of the processor
*
* @param name the name of the processor
*/
public void setName(String name)
{
this.name = name;
}
/**
* Gets the extension that the processor understands
*
* @return String the extension
*/
public String getExtension()
{
return extension;
}
/**
* Sets the extenstion that the processor understands
*
* @param extension the extension
*/
public void setExtension(String extension)
{
this.extension = extension;
}
/**
* Registers a processor extension with the processor
*
* @param processorExtension the processor extension
*/
public void registerProcessorExtension(ProcessorExtension processorExtension)
{
this.processExtensions.put(processorExtension.getExtensionName(), processorExtension);
}
}

42
source/java/org/alfresco/repo/jscript/BaseScriptImplementation.java → source/java/org/alfresco/repo/processor/BaseProcessorExtension.java
View File

@@ -22,32 +22,32 @@
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.repo.jscript;
package org.alfresco.repo.processor;
import org.alfresco.service.cmr.repository.ScriptImplementation;
import org.alfresco.service.cmr.repository.ScriptService;
import org.alfresco.service.cmr.repository.Processor;
import org.alfresco.service.cmr.repository.ProcessorExtension;
/**
* Abstract base class for a script implementation
* Abstract base class for a processor extension
*
* @author Roy Wetherall
*/
public abstract class BaseScriptImplementation implements ScriptImplementation
public abstract class BaseProcessorExtension implements ProcessorExtension
{
/** The script service */
private ScriptService scriptService;
/** The processor */
private Processor processor;
/** The name of the script */
private String scriptName;
/** The name of the extension */
private String extensionName;
/**
* Sets the script service
* Sets the processor
*
* @param scriptService the script service
* @param scriptProcessor the processor
*/
public void setScriptService(ScriptService scriptService)
public void setProcessor(Processor processor)
{
this.scriptService = scriptService;
this.processor = processor;
}
/**
@@ -55,24 +55,24 @@ public abstract class BaseScriptImplementation implements ScriptImplementation
*/
public void register()
{
this.scriptService.registerScript(this);
this.processor.registerProcessorExtension(this);
}
/**
* Sets the script name
* Sets the extension name
*
* @param scriptName the script name
* @param extensionName the extension name
*/
public void setScriptName(String scriptName)
public void setExtensionName(String extension)
{
this.scriptName = scriptName;
this.extensionName = extension;
}
/**
* @see org.alfresco.service.cmr.repository.ScriptImplementation#getScriptName()
* @see org.alfresco.service.cmr.repository.ProcessorExtension#getExtensionName()
*/
public String getScriptName()
public String getExtensionName()
{
return this.scriptName;
return this.extensionName;
}
}

403
source/java/org/alfresco/repo/processor/ScriptServiceImpl.java Normal file
View File

@@ -0,0 +1,403 @@
/*
* 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;
}
}

262
source/java/org/alfresco/repo/processor/TemplateServiceImpl.java Normal file
View File

@@ -0,0 +1,262 @@
/*
* 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.io.StringWriter;
import java.io.Writer;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.error.AlfrescoRuntimeException;
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.TemplateException;
import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.cmr.repository.TemplateProcessor;
import org.alfresco.service.cmr.repository.TemplateService;
/**
* Implementation of the TemplateService using Spring configured script engines.
*
* @author Kevin Roast
*/
public class TemplateServiceImpl implements TemplateService
{
/** Default Template processor engine to use */
private String defaultTemplateEngine;
/** List of available template processors */
private Map<String, TemplateProcessor> processors = new HashMap<String, TemplateProcessor>(5);
private Map<String, String> processorNamesByExtension = new HashMap<String, String>(5);
/** The node service */
private NodeService nodeService;
/**
* @param defaultTemplateEngine The default Template Engine name to set.
*/
public void setDefaultTemplateEngine(String defaultTemplateEngine)
{
this.defaultTemplateEngine = defaultTemplateEngine;
}
/**
* Set the node service
*
* @param nodeService the node service
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#getTemplateProcessor(java.lang.String)
*/
public TemplateProcessor getTemplateProcessor(String engine)
{
return this.processors.get(engine);
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#registerTemplateProcessor(org.alfresco.service.cmr.repository.TemplateProcessor)
*/
public void registerTemplateProcessor(TemplateProcessor templateProcessor)
{
this.processors.put(templateProcessor.getName(), templateProcessor);
this.processorNamesByExtension.put(templateProcessor.getExtension(), templateProcessor.getName());
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplate(java.lang.String, java.lang.Object)
*/
public String processTemplate(String template, Object model) throws TemplateException
{
return processTemplate(getTemplateProcessorName(template), template, model);
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplate(java.lang.String, java.lang.Object, java.io.Writer)
*/
public void processTemplate(String template, Object model, Writer out) throws TemplateException
{
processTemplate(getTemplateProcessorName(template), template, model, out);
}
/**
* Gets the template processor name from the template string
*
* @param template the template string location
* @return the template processor string
*/
private String getTemplateProcessorName(String template)
{
String engine = null;
try
{
// Try and create the nodeRef
NodeRef templateNodeRef = new NodeRef(template);
String templateName = (String)this.nodeService.getProperty(templateNodeRef, ContentModel.PROP_NAME);
String extension = getFileExtension(templateName);
if (extension != null)
{
engine = this.processorNamesByExtension.get(extension);
}
}
catch (AlfrescoRuntimeException exception)
{
// Presume that the provided template is a classpath
String extension = getFileExtension(template);
if (extension != null)
{
engine = this.processorNamesByExtension.get(extension);
}
}
// Set the default engine if none found
if (engine == null)
{
engine = this.defaultTemplateEngine;
}
return 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.TemplateService#processTemplate(java.lang.String, java.lang.String, java.lang.Object, java.io.Writer)
*/
public void processTemplate(String engine, String template, Object model, Writer out)
throws TemplateException
{
try
{
// execute template processor
TemplateProcessor processor = getTemplateProcessor(engine);
processor.process(template, model, out);
}
catch (TemplateException terr)
{
throw terr;
}
catch (Throwable err)
{
throw new TemplateException(err.getMessage(), err);
}
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplate(java.lang.String, java.lang.String, java.lang.Object)
*/
public String processTemplate(String engine, String template, Object model)
throws TemplateException
{
Writer out = new StringWriter(1024);
processTemplate(engine, template, model, out);
return out.toString();
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplateString(java.lang.String, java.lang.String, java.lang.Object, java.io.Writer)
*/
public void processTemplateString(String engine, String template, Object model, Writer out)
throws TemplateException
{
try
{
// execute template processor
TemplateProcessor processor = getTemplateProcessor(engine);
processor.processString(template, model, out);
}
catch (TemplateException terr)
{
throw terr;
}
catch (Throwable err)
{
throw new TemplateException(err.getMessage(), err);
}
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplateString(java.lang.String, java.lang.String, java.lang.Object)
*/
public String processTemplateString(String engine, String template, Object model)
throws TemplateException
{
Writer out = new StringWriter(1024);
processTemplateString(engine, template, model, out);
return out.toString();
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#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.TemplateImageResolver)
*/
public Map<String, Object> buildDefaultModel(NodeRef person, NodeRef companyHome, NodeRef userHome, NodeRef template, TemplateImageResolver imageResolver)
{
Map<String, Object> model = new HashMap<String, Object>(16, 1.0f);
// Place the image resolver into the model
if (imageResolver != null)
{
model.put(KEY_IMAGE_RESOLVER, imageResolver);
}
// Put the common node reference into the model
model.put(KEY_COMPANY_HOME, companyHome);
model.put(KEY_USER_HOME, userHome);
model.put(KEY_PERSON, person);
// add the template itself as "template" if it comes from content on a node
if (template != null)
{
model.put(KEY_TEMPLATE, template);
}
// current date/time is useful to have and isn't supplied by FreeMarker by default
model.put(KEY_DATE, new Date());
return model;
}
}

2
source/java/org/alfresco/repo/template/AVM.java
View File

@@ -34,7 +34,7 @@ import org.alfresco.service.cmr.avm.AVMStoreDescriptor;
*
* @author Kevin Roast
*/
public class AVM extends BaseTemplateExtensionImplementation
public class AVM extends BaseTemplateProcessorExtension
{
private ServiceRegistry services;

53
source/java/org/alfresco/repo/template/BaseTemplateExtensionImplementation.java → source/java/org/alfresco/repo/template/BaseTemplateProcessorExtension.java
View File

@@ -24,37 +24,22 @@
*/
package org.alfresco.repo.template;
import org.alfresco.service.cmr.repository.TemplateExtensionImplementation;
import org.alfresco.repo.processor.BaseProcessorExtension;
import org.alfresco.service.cmr.repository.TemplateProcessorExtension;
import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.cmr.repository.TemplateService;
/**
* Abstract base class for a template extension implementation
*
* @author Kevin Roast
*/
public abstract class BaseTemplateExtensionImplementation implements TemplateExtensionImplementation
{
/** The template service instance */
private TemplateService templateService;
/** The name of the template extension */
private String extensionName;
public abstract class BaseTemplateProcessorExtension extends BaseProcessorExtension implements TemplateProcessorExtension
{
/** The TemplateImageResolver for the current template execution thread */
private ThreadLocal<TemplateImageResolver> resolver = new ThreadLocal<TemplateImageResolver>();
/**
* @param templateService The TemplateService to set.
*/
public void setTemplateService(TemplateService templateService)
{
this.templateService = templateService;
}
/**
* @see org.alfresco.service.cmr.repository.TemplateExtensionImplementation#setTemplateImageResolver(org.alfresco.service.cmr.repository.TemplateImageResolver)
* @see org.alfresco.service.cmr.repository.TemplateProcessorExtension#setTemplateImageResolver(org.alfresco.service.cmr.repository.TemplateImageResolver)
*/
public void setTemplateImageResolver(TemplateImageResolver resolver)
{
@@ -62,36 +47,10 @@ public abstract class BaseTemplateExtensionImplementation implements TemplateExt
}
/**
* @see org.alfresco.service.cmr.repository.TemplateExtensionImplementation#getTemplateImageResolver()
* @see org.alfresco.service.cmr.repository.TemplateProcessorExtension#getTemplateImageResolver()
*/
public TemplateImageResolver getTemplateImageResolver()
{
return this.resolver.get();
}
/**
* Registers this template extension with the Template Service
*/
public void register()
{
this.templateService.registerExtension(this);
}
/**
* Returns the name of the template extension
*
* @return the name of the template extension
*/
public String getExtensionName()
{
return extensionName;
}
/**
* @param extensionName The template extension name.
*/
public void setExtensionName(String extensionName)
{
this.extensionName = extensionName;
}
}

2
source/java/org/alfresco/repo/template/Classification.java
View File

@@ -40,7 +40,7 @@ import org.alfresco.service.namespace.QName;
*
* @author Andy Hind
*/
public class Classification extends BaseTemplateExtensionImplementation
public class Classification extends BaseTemplateProcessorExtension
{
private ServiceRegistry services;
private StoreRef storeRef;

2
source/java/org/alfresco/repo/template/DateCompareMethod.java
View File

@@ -43,7 +43,7 @@ import freemarker.template.TemplateNumberModel;
* dateCompare(dateA, dateB) - 1 if dateA if greater than dateB
* dateCompare(dateA, dateB, millis) - 1 if dateA is greater than dateB by at least millis, else 0
*/
public class DateCompareMethod extends BaseTemplateExtensionImplementation implements TemplateMethodModelEx
public class DateCompareMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
{
/**
* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

2
source/java/org/alfresco/repo/template/DateIncrementMethod.java
View File

@@ -35,7 +35,7 @@ import freemarker.template.TemplateNumberModel;
/**
* @author Roy Wetherall
*/
public class DateIncrementMethod extends BaseTemplateExtensionImplementation implements TemplateMethodModelEx
public class DateIncrementMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
{
/**
* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

137
source/java/org/alfresco/repo/template/FreeMarkerProcessor.java
View File

@@ -26,18 +26,17 @@ package org.alfresco.repo.template;
import java.io.IOException;
import java.io.Writer;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.repo.processor.BaseProcessor;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.ProcessorExtension;
import org.alfresco.service.cmr.repository.TemplateException;
import org.alfresco.service.cmr.repository.TemplateExtensionImplementation;
import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.cmr.repository.TemplateProcessor;
import org.alfresco.service.cmr.repository.TemplateProcessorExtension;
import org.alfresco.service.cmr.repository.TemplateService;
import org.apache.log4j.Logger;
import freemarker.cache.MruCacheStorage;
@@ -61,7 +60,7 @@ import freemarker.template.TemplateExceptionHandler;
*
* @author Kevin Roast
*/
public class FreeMarkerProcessor implements TemplateProcessor
public class FreeMarkerProcessor extends BaseProcessor implements TemplateProcessor
{
private final static String MSG_ERROR_NO_TEMPLATE = "error_no_template";
private final static String MSG_ERROR_TEMPLATE_FAIL = "error_template_fail";
@@ -72,35 +71,9 @@ public class FreeMarkerProcessor implements TemplateProcessor
/** Pseudo path to String based template */
private static final String PATH = "string://fixed";
/** The permission-safe node service */
private NodeService nodeService;
/** The Content Service to use */
private ContentService contentService;
/** Template encoding */
private String defaultEncoding;
/**
* Set the node service
*
* @param nodeService The permission-safe node service
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* Set the content service
*
* @param contentService The ContentService to use
*/
public void setContentService(ContentService contentService)
{
this.contentService = contentService;
}
/**
* Set the default template encoding
*
@@ -124,7 +97,7 @@ public class FreeMarkerProcessor implements TemplateProcessor
config.setCacheStorage(new MruCacheStorage(2, 0));
// use our custom loader to find templates on the ClassPath
config.setTemplateLoader(new ClassPathRepoTemplateLoader(nodeService, contentService));
config.setTemplateLoader(new ClassPathRepoTemplateLoader(this.services.getNodeService(), this.services.getContentService()));
// use our custom object wrapper that can deal with QNameMap objects directly
config.setObjectWrapper(new QNameAwareObjectWrapper());
@@ -213,7 +186,8 @@ public class FreeMarkerProcessor implements TemplateProcessor
try
{
// perform the template processing against supplied data model
t.process(model, out);
Object freeMarkerModel = convertToFreeMarkerModel(model);
t.process(freeMarkerModel, out);
}
catch (Throwable err)
{
@@ -270,7 +244,8 @@ public class FreeMarkerProcessor implements TemplateProcessor
try
{
// perform the template processing against supplied data model
t.process(model, out);
Object freeMarkerModel = convertToFreeMarkerModel(model);
t.process(freeMarkerModel, out);
if (logger.isDebugEnabled())
{
@@ -294,58 +269,52 @@ public class FreeMarkerProcessor implements TemplateProcessor
}
}
/**
* Create the default data-model available to templates as global objects.
* <p>
* 'companyhome' - the Company Home node<br>
* 'userhome' - the current user home space node<br>
* 'person' - the node representing the current user Person<br>
* 'template' - the node representing the template itself (may not be available)
* <p>
* Also adds various helper util objects and methods.
*
* @param services ServiceRegistry
* @param person The current user Person Node
* @param companyHome The CompanyHome ref
* @param userHome The User home space ref
* @param template Optional ref to the template itself
* @param resolver Image resolver to resolve icon images etc.
*
* @return A Map of Templatable Node objects and util objects.
*/
public static Map<String, Object> buildDefaultModel(
ServiceRegistry services,
NodeRef person, NodeRef companyHome, NodeRef userHome, NodeRef template,
TemplateImageResolver imageResolver)
private Object convertToFreeMarkerModel(Object model)
{
Map<String, Object> model = new HashMap<String, Object>(16, 1.0f);
// supply the Company Home space as "companyhome"
model.put("companyhome", new TemplateNode(companyHome, services, imageResolver));
// supply the users Home Space as "userhome"
model.put("userhome", new TemplateNode(userHome, services, imageResolver));
// supply the current user Node as "person"
model.put("person", new TemplateNode(person, services, imageResolver));
// add the template itself as "template" if it comes from content on a node
if (template != null)
{
model.put("template", new TemplateNode(template, services, imageResolver));
// If we dont have a map in our hand we just return the passes model
if (model instanceof Map)
{
Map<String, Object> freeMarkerModel = new HashMap<String, Object>(((Map)model).size());
// Look for the image resolver in the model
TemplateImageResolver imageResolver = (TemplateImageResolver)((Map)model).get(TemplateService.KEY_IMAGE_RESOLVER);
for (Object objKey : ((Map)model).keySet())
{
String key = (String)objKey;
if (key.equals(TemplateService.KEY_IMAGE_RESOLVER) == false)
{
Object value = ((Map)model).get(key);
if (value instanceof NodeRef)
{
// Concer the node reference to a template node
freeMarkerModel.put(key, new TemplateNode((NodeRef)value, this.services, imageResolver));
}
else
{
// Just add the objec to the free marker model
freeMarkerModel.put(key, ((Map)model).get(key));
}
}
}
// add the template extensions to the model
// the extensions include custom root helper objects and custom template method objects
for (ProcessorExtension ext : this.processExtensions.values())
{
if (ext instanceof TemplateProcessorExtension)
{
((TemplateProcessorExtension)ext).setTemplateImageResolver(imageResolver);
}
freeMarkerModel.put(ext.getExtensionName(), ext);
}
return freeMarkerModel;
}
// current date/time is useful to have and isn't supplied by FreeMarker by default
model.put("date", new Date());
// add the template extensions to the model
// the extensions include custom root helper objects and custom template method objects
for (TemplateExtensionImplementation ext : services.getTemplateService().getExtensions())
else
{
ext.setTemplateImageResolver(imageResolver);
model.put(ext.getExtensionName(), ext);
return model;
}
return model;
}
}

2
source/java/org/alfresco/repo/template/HasAspectMethod.java
View File

@@ -42,7 +42,7 @@ import freemarker.template.TemplateScalarModel;
* <p>
* Usage: hasAspect(TemplateNode node, String aspect) - 1 on true, 0 on false
*/
public class HasAspectMethod extends BaseTemplateExtensionImplementation implements TemplateMethodModelEx
public class HasAspectMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
{
/**
* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

2
source/java/org/alfresco/repo/template/HasPermissionMethod.java
View File

@@ -41,7 +41,7 @@ import freemarker.template.TemplateScalarModel;
* <p>
* Usage: hasPermission(TemplateNode node, String permission) - 1 on true, 0 on false
*/
public class HasPermissionMethod extends BaseTemplateExtensionImplementation implements TemplateMethodModelEx
public class HasPermissionMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
{
/**
* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

2
source/java/org/alfresco/repo/template/I18NMessageMethod.java
View File

@@ -41,7 +41,7 @@ import freemarker.template.TemplateScalarModel;
* <p>
* Usage: message(String id)
*/
public class I18NMessageMethod extends BaseTemplateExtensionImplementation implements TemplateMethodModelEx
public class I18NMessageMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
{
/**
* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

2
source/java/org/alfresco/repo/template/ISO8601DateFormatMethod.java
View File

@@ -41,7 +41,7 @@ import freemarker.template.TemplateModelException;
* <p>
* Usage: xmldate(Date date)
*/
public class ISO8601DateFormatMethod extends BaseTemplateExtensionImplementation implements TemplateMethodModelEx
public class ISO8601DateFormatMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
{
/**
* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

2
source/java/org/alfresco/repo/template/Session.java
View File

@@ -32,7 +32,7 @@ import org.alfresco.service.cmr.repository.TemplateImageResolver;
*
* @author Andy Hind
*/
public class Session extends BaseTemplateExtensionImplementation
public class Session extends BaseTemplateProcessorExtension
{
private ServiceRegistry services;

271
source/java/org/alfresco/repo/template/TemplateServiceImpl.java
View File

@@ -1,271 +0,0 @@
/*
* 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.template;
import java.io.StringWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.service.cmr.repository.ScriptImplementation;
import org.alfresco.service.cmr.repository.TemplateException;
import org.alfresco.service.cmr.repository.TemplateExtensionImplementation;
import org.alfresco.service.cmr.repository.TemplateProcessor;
import org.alfresco.service.cmr.repository.TemplateService;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
/**
* Implementation of the TemplateService using Spring configured template engines.
*
* @author Kevin Roast
*/
public class TemplateServiceImpl implements TemplateService, ApplicationContextAware
{
private static Log logger = LogFactory.getLog(TemplateService.class);
/** Spring ApplicationContext for bean lookup by ID */
private ApplicationContext applicationContext;
/** Default Template processor engine to use */
private String defaultTemplateEngine;
/** Available template engine names to impl class names */
private Map<String, String> templateEngines;
/** Threadlocal instance for template processor cache */
private static ThreadLocal<Map<String, TemplateProcessor>> processors = new ThreadLocal<Map<String, TemplateProcessor>>();
/** List of global template extensions */
private List<TemplateExtensionImplementation> globalExtensions = new ArrayList<TemplateExtensionImplementation>();
/**
* Set the application context
*
* @param applicationContext the application context
*/
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
{
this.applicationContext = applicationContext;
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#registerExtension(org.alfresco.service.cmr.repository.TemplateExtensionImplementation)
*/
public void registerExtension(TemplateExtensionImplementation extension)
{
this.globalExtensions.add(extension);
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#getExtensions()
*/
public List<TemplateExtensionImplementation> getExtensions()
{
return this.globalExtensions;
}
/**
* @param defaultTemplateEngine The default Template Engine name to set.
*/
public void setDefaultTemplateEngine(String defaultTemplateEngine)
{
this.defaultTemplateEngine = defaultTemplateEngine;
}
/**
* @param templateEngines The Map of template engine name to impl class name to set.
*/
public void setTemplateEngines(Map<String, String> templateEngines)
{
this.templateEngines = templateEngines;
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#getTemplateProcessor(java.lang.String)
*/
public TemplateProcessor getTemplateProcessor(String engine)
{
try
{
return getTemplateProcessorImpl(engine);
}
catch (Throwable err)
{
if (logger.isDebugEnabled())
logger.debug("Unable to load template processor.", err);
return null;
}
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplate(java.lang.String, java.lang.String, java.lang.Object, java.io.Writer)
*/
public void processTemplate(String engine, String template, Object model, Writer out)
throws TemplateException
{
try
{
// execute template processor
TemplateProcessor processor = getTemplateProcessorImpl(engine);
processor.process(template, model, out);
}
catch (TemplateException terr)
{
throw terr;
}
catch (Throwable err)
{
throw new TemplateException(err.getMessage(), err);
}
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplate(java.lang.String, java.lang.String, java.lang.Object)
*/
public String processTemplate(String engine, String template, Object model)
throws TemplateException
{
Writer out = new StringWriter(1024);
processTemplate(engine, template, model, out);
return out.toString();
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplateString(java.lang.String, java.lang.String, java.lang.Object, java.io.Writer)
*/
public void processTemplateString(String engine, String template, Object model, Writer out)
throws TemplateException
{
try
{
// execute template processor
TemplateProcessor processor = getTemplateProcessorImpl(engine);
processor.processString(template, model, out);
}
catch (TemplateException terr)
{
throw terr;
}
catch (Throwable err)
{
throw new TemplateException(err.getMessage(), err);
}
}
/**
* @see org.alfresco.service.cmr.repository.TemplateService#processTemplateString(java.lang.String, java.lang.String, java.lang.Object)
*/
public String processTemplateString(String engine, String template, Object model)
throws TemplateException
{
Writer out = new StringWriter(1024);
processTemplateString(engine, template, model, out);
return out.toString();
}
/**
* Return the TemplateProcessor implementation for the named template engine
*
* @param name Template Engine name
*
* @return TemplateProcessor
*/
private TemplateProcessor getTemplateProcessorImpl(String name)
{
// use the ThreadLocal map to find the processors instance
// create the cache map for this thread if required
Map<String, TemplateProcessor> procMap = processors.get();
if (procMap == null)
{
procMap = new HashMap<String, TemplateProcessor>(2, 1.0f);
processors.set(procMap);
}
if (name == null)
{
name = defaultTemplateEngine;
}
// find the impl for the named processor
TemplateProcessor processor = procMap.get(name);
if (processor == null)
{
String className = templateEngines.get(name);
if (className == null)
{
throw new AlfrescoRuntimeException("Unable to find configured ClassName for template engine: " + name);
}
try
{
Object obj;
try
{
obj = this.applicationContext.getBean(className);
}
catch (BeansException err)
{
// instantiate the processor class directory if not a Spring bean
obj = Class.forName(className).newInstance();
}
if (obj instanceof TemplateProcessor)
{
processor = (TemplateProcessor)obj;
}
else
{
throw new AlfrescoRuntimeException("Supplied template processors does not implement TemplateProcessor: " + className);
}
}
catch (ClassNotFoundException err1)
{
// if the bean is not a classname, then it may be a spring bean Id
throw new AlfrescoRuntimeException("Unable to load class for supplied template processors: " + className, err1);
}
catch (IllegalAccessException err2)
{
throw new AlfrescoRuntimeException("Unable to load class for supplied template processors: " + className, err2);
}
catch (InstantiationException err3)
{
throw new AlfrescoRuntimeException("Unable to instantiate class for supplied template processors: " + className, err3);
}
// cache for later
procMap.put(name, processor);
}
return processor;
}
}

2
source/java/org/alfresco/repo/template/UrlEncodeMethod.java
View File

@@ -41,7 +41,7 @@ import freemarker.template.TemplateScalarModel;
* <p>
* Usage: urlencode(String url)
*/
public class UrlEncodeMethod extends BaseTemplateExtensionImplementation implements TemplateMethodModelEx
public class UrlEncodeMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
{
/**
* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

55
source/java/org/alfresco/service/cmr/repository/Processor.java Normal file
View File

@@ -0,0 +1,55 @@
/*
* 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.service.cmr.repository;
/**
* Processor interface.
*
* @author Roy Wetherall
*/
public interface Processor
{
/**
* Get the name of the processor
*
* @return the name of the processor
*/
public String getName();
/**
* The file extension that the processor is associated with, null if none.
*
* @return the extension
*/
public String getExtension();
/**
* Registers a processor extension with the processor
*
* @param processorExtension the process extension
*/
public void registerProcessorExtension(ProcessorExtension processorExtension);
}

8
source/java/org/alfresco/service/cmr/repository/ScriptImplementation.java → source/java/org/alfresco/service/cmr/repository/ProcessorExtension.java
View File

@@ -29,12 +29,12 @@ package org.alfresco.service.cmr.repository;
*
* @author Roy Wetherall
*/
public interface ScriptImplementation
public interface ProcessorExtension
{
/**
* Returns the name of the script
* Returns the name of the extension
*
* @return the name of the script
* @return the name of the extension
*/
String getScriptName();
String getExtensionName();
}

2
source/java/org/alfresco/service/cmr/repository/ScriptException.java
View File

@@ -31,6 +31,8 @@ import org.alfresco.error.AlfrescoRuntimeException;
*/
public class ScriptException extends AlfrescoRuntimeException
{
private static final long serialVersionUID = 1739480648583299623L;
/**
* @param msgId
*/

75
source/java/org/alfresco/service/cmr/repository/ScriptProcessor.java Normal file
View File

@@ -0,0 +1,75 @@
/*
* 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.service.cmr.repository;
import java.util.Map;
import org.alfresco.service.namespace.QName;
/**
* Script processor interface
*
* @author Roy Wetherall
*/
public interface ScriptProcessor extends Processor
{
/**
* Execute script
*
* @param location the location of the script
* @param model context model
* @return Object the result of the script
*/
public Object execute(ScriptLocation location, Map<String, Object> model);
/**
* Execute script
*
* @param nodeRef the script node reference
* @param contentProp the content property of the script
* @param model the context model
* @return Object the result of the script
*/
public Object execute(NodeRef nodeRef, QName contentProp, Map<String, Object> model);
/**
* Execute script
*
* @param location the classpath string locating the script
* @param model the context model
* @return Object the result of the script
*/
public Object execute(String location, Map<String, Object> model);
/**
* Execute script string
*
* @param script the script string
* @param model the context model
* @return Obejct the result of the script
*/
public Object executeString(String script, Map<String, Object> model);
}

107
source/java/org/alfresco/service/cmr/repository/ScriptService.java
View File

@@ -49,7 +49,9 @@ import org.alfresco.service.namespace.QName;
public interface ScriptService
{
/**
* Process a script against the supplied data model.
* Process a script against the supplied data model.
*
* Uses the most approparite script engine or the default if none found.
*
* @param scriptClasspath Script location as qualified classpath name
* @param model Object model to process script against
@@ -61,10 +63,28 @@ public interface ScriptService
@Auditable(parameters = {"scriptClasspath", "model"})
public Object executeScript(String scriptClasspath, Map<String, Object> model)
throws ScriptException;
/**
* Process a script against the supplied data model.
*
* Use the
*
* @param engine the script engine to use
* @param scriptClasspath Script location as qualified classpath name
* @param model Object model to process script against
*
* @return output of the script (may be null or any valid wrapped JavaScript object)
*
* @throws ScriptException
*/
@Auditable(parameters = {"engine", "scriptClasspath", "model"})
public Object executeScript(String engine, String scriptClasspath, Map<String, Object> model)
throws ScriptException;
/**
* Process a script against the supplied data model.
*
* Uses the most approparite script engine or the default if none found.
*
* @param scriptRef Script NodeRef location
* @param contentProp QName of the property on the node that contains the content, null can
* be passed to indicate the default property of 'cm:content'
@@ -81,6 +101,25 @@ public interface ScriptService
/**
* Process a script against the supplied data model.
*
* @param engine the script engine to use
* @param scriptRef Script NodeRef location
* @param contentProp QName of the property on the node that contains the content, null can
* be passed to indicate the default property of 'cm:content'
* @param model Object model to process script against
*
* @return output of the script (may be null or any valid wrapped JavaScript object)
*
* @throws ScriptException
*/
@Auditable(key = Auditable.Key.ARG_1, parameters = {"engine", "scriptRef", "contentProp", "model"})
public Object executeScript(String engine, NodeRef scriptRef, QName contentProp, Map<String, Object> model)
throws ScriptException;
/**
* Process a script against the supplied data model
*
* Uses the most approparite script engine or the default if none found.
*
* @param scriptLocation object representing the script location
* @param model Object model to process script against
*
@@ -95,6 +134,21 @@ public interface ScriptService
/**
* Process a script against the supplied data model.
*
* @param engine the script engine to use
* @param scriptLocation object representing the script location
* @param model Object model to process script against
*
* @return output of the script (may be null or any other valid wrapped JavaScript object)
*
* @throws ScriptException
*/
@Auditable(parameters = {"engine", "scriptLocation", "model"})
public Object executeScript(String engine, ScriptLocation scriptLocation, Map<String, Object> model)
throws ScriptException;
/**
* Process a script against the supplied data model. Uses the default script engine.
*
* @param script Script content as a String.
* @param model Object model to process script against
*
@@ -107,10 +161,53 @@ public interface ScriptService
throws ScriptException;
/**
* Registers a script implementation with the script service
* Process a script against the supplied data model.
*
* @param script the script implementation
* @param engine the script engine to use
* @param script Script content as a String.
* @param model Object model to process script against
*
* @return output of the script (may be null or any valid wrapped JavaScript object)
*
* @throws ScriptException
*/
@Auditable(parameters = {"script"})
public void registerScript(ScriptImplementation script);
@Auditable(parameters = {"engine", "script", "model"})
public Object executeScriptString(String engine, String script, Map<String, Object> model)
throws ScriptException;
/**
* Registers a script processor with the script service
*
* @param scriptProcessor
*/
@Auditable(parameters = {"scriptProcessot"})
public void registerScriptProcessor(ScriptProcessor scriptProcessor);
/**
* Create the default data-model available to scripts as global scope level objects:
* <p>
* 'companyhome' - the Company Home node<br>
* 'userhome' - the current user home space node<br>
* 'person' - the node representing the current user Person<br>
* 'script' - the node representing the script itself (may not be available)<br>
* 'document' - document context node (may not be available)<br>
* 'space' - space context node (may not be available)
*
* @param person The current user Person Node
* @param companyHome The CompanyHome ref
* @param userHome The User home space ref
* @param script Optional ref to the script itself
* @param document Optional ref to a document Node
* @param space Optional ref to a space Node
* @param resolver Image resolver to resolve icon images etc.
*
* @return A Map of global scope scriptable Node objects
*/
public Map<String, Object> buildDefaultModel(
NodeRef person,
NodeRef companyHome,
NodeRef userHome,
NodeRef script,
NodeRef document,
NodeRef space);
}

2
source/java/org/alfresco/service/cmr/repository/TemplateException.java
View File

@@ -31,6 +31,8 @@ import org.alfresco.error.AlfrescoRuntimeException;
*/
public class TemplateException extends AlfrescoRuntimeException
{
private static final long serialVersionUID = 2863142603098852564L;
/**
* @param msgId
*/

4
source/java/org/alfresco/service/cmr/repository/TemplateProcessor.java
View File

@@ -33,8 +33,8 @@ import java.io.Writer;
*
* @author Kevin Roast
*/
public interface TemplateProcessor
{
public interface TemplateProcessor extends Processor
{
/**
* Process a template against the supplied data model and write to the out.
*

11
source/java/org/alfresco/service/cmr/repository/TemplateExtensionImplementation.java → source/java/org/alfresco/service/cmr/repository/TemplateProcessorExtension.java
View File

@@ -29,15 +29,8 @@ package org.alfresco.service.cmr.repository;
*
* @author Kevin Roast
*/
public interface TemplateExtensionImplementation
{
/**
* Returns the name of the template extension
*
* @return the name of the template extension
*/
String getExtensionName();
public interface TemplateProcessorExtension extends ProcessorExtension
{
/**
* Set the template image resolver for this extension
*

68
source/java/org/alfresco/service/cmr/repository/TemplateService.java
View File

@@ -25,7 +25,7 @@
package org.alfresco.service.cmr.repository;
import java.io.Writer;
import java.util.List;
import java.util.Map;
import org.alfresco.service.Auditable;
import org.alfresco.service.PublicService;
@@ -47,6 +47,44 @@ import org.alfresco.service.PublicService;
@PublicService
public interface TemplateService
{
/** Keys for default model values */
public static final String KEY_IMAGE_RESOLVER = "imageresolver";
public static final String KEY_COMPANY_HOME = "companyhome";
public static final String KEY_USER_HOME = "userhome";
public static final String KEY_PERSON = "person";
public static final String KEY_TEMPLATE = "template";
public static final String KEY_DATE = "date";
/**
* Process a template against the upplied data model and return the result as
* a string.
*
* The template engine used will be determined by the extension of the template.
*
* @param template Template (qualified classpath name or noderef)
* @param model Object model to process template against
*
* @return output of the template process as a String
* @throws TemplateException
*/
@Auditable(parameters = {"template", "model"})
public String processTemplate(String template, Object model)
throws TemplateException;
/**
* Process a template against the supplied data model and write to the out.
*
* The template engine used will be determined by the extension of the template.
*
* @param engine Name of the template engine to use
* @param template Template (qualified classpath name or noderef)
* @param model Object model to process template against
* @param out Writer object to send output too
*/
@Auditable(parameters = {"template", "model", "out"})
public void processTemplate(String template, Object model, Writer out)
throws TemplateException;
/**
* Process a template against the supplied data model and write to the out.
*
@@ -101,7 +139,7 @@ public interface TemplateService
@Auditable(parameters = {"engine", "template", "model", "out"})
public void processTemplateString(String engine, String template, Object model, Writer out)
throws TemplateException;
/**
* Return a TemplateProcessor instance for the specified engine name.
* Note that the processor instance is NOT thread safe!
@@ -114,18 +152,28 @@ public interface TemplateService
public TemplateProcessor getTemplateProcessor(String engine);
/**
* Registers a template extension implementation with the Template service
* Registers a new template processor with the template service
*
* @param extension the template extension implementation
* @param templateProcessor the template processor to register
*/
@Auditable(parameters = {"extension"})
public void registerExtension(TemplateExtensionImplementation extension);
@Auditable(parameters = {"templateProcessor"})
public void registerTemplateProcessor(TemplateProcessor templateProcessor);
/**
* Returns a list of the Template Extension objects configured for this service
* Helper method to build a default model
*
* @return list of the Template Extension objects configured for this service
* @param person the person node reference
* @param companyHome the company home node refereence
* @param userHome the user home node reference
* @param template the node ref for the template (optional)
* @param imageResolver the image resolver (optional)
* @return
*/
@Auditable(warn = true, recordReturnedObject = false)
public List<TemplateExtensionImplementation> getExtensions();
@Auditable(parameters = {"person", "compantHome", "userHome", "template", "imageResolver"})
public Map<String, Object> buildDefaultModel(
NodeRef person,
NodeRef companyHome,
NodeRef userHome,
NodeRef template,
TemplateImageResolver imageResolver);
}