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

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)