Merging DEV_TEMPORARY to HEAD (RenditionService)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@19103 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-08-07 17:49:17 +00:00 · 2010-03-05 20:02:52 +00:00
parent ad84497735
commit bce28a5599
80 changed files with 10611 additions and 1815 deletions
--- a/source/java/org/alfresco/repo/rendition/executer/TemplateModelHelper.java
+++ b/source/java/org/alfresco/repo/rendition/executer/TemplateModelHelper.java
@@ -0,0 +1,113 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.alfresco.repo.rendition.executer;
+
+import java.io.Serializable;
+import java.util.Map;
+
+import org.alfresco.repo.model.Repository;
+import org.alfresco.repo.security.authentication.AuthenticationUtil;
+import org.alfresco.repo.template.TemplateNode;
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.TemplateImageResolver;
+import org.alfresco.service.cmr.repository.TemplateService;
+
+/**
+ * @author Nick Smith
+ */
+public class TemplateModelHelper
+{
+    public static final String KEY_NODE = "node";
+
+    private final Repository repository;
+    private final ServiceRegistry serviceRegistry;
+    private final TemplateService templateService;
+
+    /**
+     * @param templateService
+     * @param repository
+     * @param serviceRegistry
+     */
+    public TemplateModelHelper(TemplateService templateService, Repository repository, ServiceRegistry serviceRegistry)
+    {
+        super();
+        this.templateService = templateService;
+        this.repository = repository;
+        this.serviceRegistry = serviceRegistry;
+    }
+
+    /**
+     * Builds up the model map used by the {@link TemplateService} to process
+     * FreeMarker templates.
+     * 
+     * @param sourceNode the node containing the content to be processed by the
+     *            template.
+     * @param templateNode the node containing the template. Can be
+     *            <code>null</code>.
+     * @param imgResolver the image resolver used to process images. Can be
+     *            <code>null</code>.
+     * @param paramMap a map of parameters to add to the model. Can be
+     *            <code>null</code>.
+     * @return the populated model {@link Map}.
+     */
+    public Map<String, Object> buildModelMap(NodeRef sourceNode,//
+                NodeRef templateNode,//
+                TemplateImageResolver imgResolver,//
+                Map<String, Serializable> paramMap)
+    {
+        Map<String, Object> model = buildDefaultModel(templateNode, imgResolver);
+        TemplateNode sourceTemplateNode = new TemplateNode(sourceNode, serviceRegistry, null);
+        // TODO Add xml dom here.
+        // model.put("xml", NodeModel.wrap(null));
+        model.put(KEY_NODE, sourceTemplateNode);
+        if (paramMap != null)
+            model.putAll(paramMap);
+        return model;
+    }
+
+    /**
+     * Builds the default model populated with the current user, company home
+     * and user home.
+     * 
+     * @param templateNode the node containing the template. Can be
+     *            <code>null</code>.
+     * @param imgResolver the image resolver used to process images. Can be
+     *            <code>null</code>.
+     * @return the default model {@link Map}.
+     */
+    public Map<String, Object> buildDefaultModel(NodeRef templateNode, TemplateImageResolver imgResolver)
+    {
+        // The templateNode can be null.
+        NodeRef companyHome = repository.getCompanyHome();
+        
+        // The fully authenticated user below is the username of the person who logged in and
+        // who requested the execution of the current rendition. This will not be the
+        // same person as the current user as renditions are executed by the system user.
+        String fullyAuthenticatedUser = AuthenticationUtil.getFullyAuthenticatedUser();
+        NodeRef person = serviceRegistry.getPersonService().getPerson(fullyAuthenticatedUser);
+        
+        NodeRef userHome = repository.getUserHome(person);
+        Map<String, Object> model = templateService.buildDefaultModel(person, companyHome, userHome, templateNode,
+                    imgResolver);
+        return model;
+    }
+
+}