From 884b4920c3ec89be9f63f594576fb41571e47af5 Mon Sep 17 00:00:00 2001
From: Kevin Roast <kevin.roast@alfresco.com>
Date: Tue, 24 Apr 2007 13:14:02 +0000
Subject: [PATCH] Workflow helper object added to Template API, for use in new
 2.1 Portlets.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5538 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
---
 config/alfresco/template-services-context.xml |  29 ++-
 .../repo/template/DateCompareMethod.java      |  73 +++++-
 .../org/alfresco/repo/template/Workflow.java  | 229 ++++++++++++++++++
 3 files changed, 315 insertions(+), 16 deletions(-)
 create mode 100644 source/java/org/alfresco/repo/template/Workflow.java

diff --git a/config/alfresco/template-services-context.xml b/config/alfresco/template-services-context.xml
index bc287173d5..10d4da7175 100644
--- a/config/alfresco/template-services-context.xml
+++ b/config/alfresco/template-services-context.xml
@@ -7,28 +7,28 @@
         <property name="defaultTemplateEngine">
             <value>freemarker</value>
         </property>
-    	<property name="nodeService">
+        <property name="nodeService">
             <ref bean="NodeService"/>
         </property>
     </bean>
     
     <bean id="baseTemplateProcessor" abstract="true" init-method="register">
-    	<property name="templateService">
+        <property name="templateService">
             <ref bean="templateService"/>
-        </property>    	
+        </property>     
         <property name="serviceRegistry">
             <ref bean="ServiceRegistry"/>
-        </property>	
+        </property>  
     </bean>
     
     <!-- The beans are not thread safe and therefore we create one per request -->
     <bean id="freeMarkerProcessor" parent="baseTemplateProcessor" class="org.alfresco.repo.template.FreeMarkerProcessor">
-		<property name="name">
-			<value>freemarker</value>
-		</property>
-		<property name="extension">
-			<value>ftl</value>
-		</property>
+        <property name="name">
+            <value>freemarker</value>
+        </property>
+        <property name="extension">
+            <value>ftl</value>
+        </property>
     </bean>
     
     <!-- base config implementation that template extension beans extend from - for auto registration
@@ -69,6 +69,15 @@
         </property>
     </bean>
     
+    <bean id="workflowTemplateExtension" parent="baseTemplateImplementation" class="org.alfresco.repo.template.Workflow">
+        <property name="extensionName">
+            <value>workflow</value>
+        </property>
+        <property name="serviceRegistry">
+            <ref bean="ServiceRegistry"/>
+        </property>
+    </bean>
+    
     <bean id="hasAspectTemplateExtension" parent="baseTemplateImplementation" class="org.alfresco.repo.template.HasAspectMethod">
         <property name="extensionName">
             <value>hasAspect</value>
diff --git a/source/java/org/alfresco/repo/template/DateCompareMethod.java b/source/java/org/alfresco/repo/template/DateCompareMethod.java
index 7ae84c1da8..31567b9f9b 100644
--- a/source/java/org/alfresco/repo/template/DateCompareMethod.java
+++ b/source/java/org/alfresco/repo/template/DateCompareMethod.java
@@ -31,17 +31,20 @@ import freemarker.template.TemplateDateModel;
 import freemarker.template.TemplateMethodModelEx;
 import freemarker.template.TemplateModelException;
 import freemarker.template.TemplateNumberModel;
+import freemarker.template.TemplateScalarModel;
 
 /**
  * @author Kevin Roast
  * 
  * Custom FreeMarker Template language method.
  * <p>
- * Compare two dates to see if they differ by the specified number of miliseconds
+ * Perform a test to see how two dates compare, optionally offset by a specified number of milliseconds.
  * <p>
  * Usage: 
  *    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 
+ *    dateCompare(dateA, dateB, millis) - 1 if dateA is greater than dateB by at least millis, else 0
+ *    dateCompare(dateA, dateB, millis, test) - same as above, but the 'test' variable is one of the
+ *          following strings ">", "<", "==" - greater than, less than or equal - as the test to perform.
  */
 public class DateCompareMethod extends BaseTemplateProcessorExtension implements TemplateMethodModelEx
 {
@@ -66,13 +69,71 @@ public class DateCompareMethod extends BaseTemplateProcessorExtension implements
                   diff = number.longValue();
                }
             }
+            String test = null;
+            if (args.size() == 4)
+            {
+                Object arg3 = args.get(3);
+                if (arg3 instanceof TemplateScalarModel)
+                {
+                    test = ((TemplateScalarModel)arg3).getAsString();
+                }
+            }
             if (arg0 instanceof TemplateDateModel && arg1 instanceof TemplateDateModel)
             {
-                Date dateA = (Date)((TemplateDateModel)arg0).getAsDate();
-                Date dateB = (Date)((TemplateDateModel)arg1).getAsDate();
-                if (dateA.getTime() > (dateB.getTime() - diff)) 
+                Date dateA = (Date)(((TemplateDateModel)arg0).getAsDate()).clone();
+                Date dateB = (Date)(((TemplateDateModel)arg1).getAsDate()).clone();
+                switch (((TemplateDateModel)arg0).getDateType())
                 {
-                   result = 1;
+                    case TemplateDateModel.DATE:
+                        // clear time part
+                        dateA.setHours(0);
+                        dateA.setMinutes(0);
+                        dateA.setSeconds(0);
+                        dateA = new Date(dateA.getTime() / 1000L * 1000L);
+                        break;
+                    case TemplateDateModel.TIME:
+                        // clear date part
+                        dateA.setDate(1);
+                        dateA.setMonth(0);
+                        dateA.setYear(0);
+                        break;
+                }
+                switch (((TemplateDateModel)arg1).getDateType())
+                {
+                    case TemplateDateModel.DATE:
+                        // clear time part
+                        dateB.setHours(0);
+                        dateB.setMinutes(0);
+                        dateB.setSeconds(0);
+                        dateB = new Date(dateB.getTime() / 1000L * 1000L);
+                        break;
+                    case TemplateDateModel.TIME:
+                        // clear date part
+                        dateB.setDate(1);
+                        dateB.setMonth(0);
+                        dateB.setYear(0);
+                        break;
+                }
+                if (test == null || test.equals(">"))
+                {
+                    if (dateA.getTime() > (dateB.getTime() - diff)) 
+                    {
+                       result = 1;
+                    }
+                }
+                else if (test.equals("<"))
+                {
+                    if (dateA.getTime() < (dateB.getTime() - diff)) 
+                    {
+                       result = 1;
+                    }
+                }
+                else if (test.equals("=="))
+                {
+                    if (dateA.getTime() == (dateB.getTime() - diff)) 
+                    {
+                       result = 1;
+                    }
                 }
             }
         }
diff --git a/source/java/org/alfresco/repo/template/Workflow.java b/source/java/org/alfresco/repo/template/Workflow.java
new file mode 100644
index 0000000000..07af3f5321
--- /dev/null
+++ b/source/java/org/alfresco/repo/template/Workflow.java
@@ -0,0 +1,229 @@
+/*
+ * 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.Serializable;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.repo.workflow.WorkflowModel;
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.workflow.WorkflowService;
+import org.alfresco.service.cmr.workflow.WorkflowTask;
+import org.alfresco.service.cmr.workflow.WorkflowTaskState;
+import org.alfresco.service.cmr.workflow.WorkflowTransition;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.service.namespace.QNameMap;
+
+/**
+ * Workflow and task support in FreeMarker templates.
+ * 
+ * @author Kevin Roast
+ */
+public class Workflow extends BaseTemplateProcessorExtension
+{
+    private ServiceRegistry services;
+
+    /**
+     * Sets the service registry
+     * 
+     * @param services  the service registry
+     */
+    public void setServiceRegistry(ServiceRegistry services)
+    {
+        this.services = services;
+    }
+    
+    /**
+     * Return a list of objects representing the assigned tasks for the current user
+     * 
+     * @return list of WorkflowTaskItem bean objects {@link WorkflowTaskItem}
+     */
+    public List<WorkflowTaskItem> getAssignedTasks()
+    {
+        // get the "in progress" tasks for the current user
+        List<WorkflowTask> tasks = getWorkflowService().getAssignedTasks(
+              this.services.getAuthenticationService().getCurrentUserName(),
+              WorkflowTaskState.IN_PROGRESS);
+        
+        return convertTasks(tasks);
+    }
+    
+    /**
+     * Return a list of objects representing the pooled tasks for the current user
+     * 
+     * @return list of WorkflowTaskItem bean objects {@link WorkflowTaskItem}
+     */
+    public List<WorkflowTaskItem> getPooledTasks()
+    {
+        // get the "pooled" tasks for the current user
+        List<WorkflowTask> tasks = getWorkflowService().getPooledTasks(
+              this.services.getAuthenticationService().getCurrentUserName());
+        
+        return convertTasks(tasks);
+    }
+    
+    /**
+     * Return a list of objects representing the completed tasks for the current user
+     * 
+     * @return list of WorkflowTaskItem bean objects {@link WorkflowTaskItem}
+     */
+    public List<WorkflowTaskItem> getCompletedTasks()
+    {
+        // get the "completed" tasks for the current user
+        List<WorkflowTask> tasks = getWorkflowService().getAssignedTasks(
+              this.services.getAuthenticationService().getCurrentUserName(),
+              WorkflowTaskState.COMPLETED);
+        
+        return convertTasks(tasks);
+    }
+    
+    private List<WorkflowTaskItem> convertTasks(List<WorkflowTask> tasks)
+    {
+        List<WorkflowTaskItem> items = new ArrayList<WorkflowTaskItem>(tasks.size());
+        for (WorkflowTask task : tasks)
+        {
+            items.add(new WorkflowTaskItem(task));
+        }
+        
+        return items;
+    }
+    
+    private WorkflowService getWorkflowService()
+    {
+        return this.services.getWorkflowService();
+    }
+    
+    
+    /**
+     * Simple bean wrapper around a WorkflowTask item 
+     */
+    public class WorkflowTaskItem
+    {
+        private WorkflowTask task;
+        private QNameMap<String, Serializable> properties = null;
+        
+        WorkflowTaskItem(WorkflowTask task)
+        {
+            this.task = task;
+        }
+        
+        public String getType()
+        {
+            return this.task.title;
+        }
+        
+        public String getName()
+        {
+            return this.task.description;
+        }
+        
+        public String getDescription()
+        {
+            return this.task.path.instance.description;
+        }
+        
+        public String getId()
+        {
+            return this.task.id;
+        }
+        
+        public boolean getIsCompleted()
+        {
+            return (this.task.state == WorkflowTaskState.COMPLETED);
+        }
+        
+        public Date getStartDate()
+        {
+            return this.task.path.instance.startDate;
+        }
+        
+        /**
+         * @return A TemplateNode representing the initiator (person) of the workflow
+         */
+        public TemplateNode getInitiator()
+        {
+            return new TemplateNode(this.task.path.instance.initiator, services, getTemplateImageResolver());
+        }
+        
+        /**
+         * @return A TemplateNode representing the workflow package object
+         */
+        public TemplateNode getPackage()
+        {
+            NodeRef packageRef = (NodeRef)this.task.properties.get(WorkflowModel.ASSOC_PACKAGE);
+            return new TemplateNode(packageRef, services, getTemplateImageResolver());
+        }
+        
+        /**
+         * @return the 'outcome' label from a completed task
+         */
+        public String getOutcome()
+        {
+            String outcome = null;
+            if (task.state.equals(WorkflowTaskState.COMPLETED))
+            {
+                // add the outcome label for any completed task
+                String transition = (String)task.properties.get(WorkflowModel.PROP_OUTCOME);
+                if (transition != null)
+                {
+                    WorkflowTransition[] transitions = task.definition.node.transitions;
+                    for (WorkflowTransition trans : transitions)
+                    {
+                        if (trans.id.equals(transition))
+                        {
+                            outcome = trans.title;
+                            break;
+                        }
+                    }
+                }
+            }
+            return outcome;
+        }
+        
+        /**
+         * @return A map of properties for the workflow task, includes all appropriate bpm model properties.
+         */
+        public Map<String, Serializable> getProperties()
+        {
+            if (this.properties == null)
+            {
+                // convert properties to a QName accessable Map with TemplateNode objects as required
+                PropertyConverter converter = new PropertyConverter();
+                this.properties = new QNameMap<String, Serializable>(services.getNamespaceService());
+                for (QName qname : this.task.properties.keySet())
+                {
+                    Serializable value = converter.convertProperty(
+                        this.task.properties.get(qname), qname, services, getTemplateImageResolver());
+                    this.properties.put(qname.toString(), value);
+                }
+            }
+            return this.properties;
+        }
+    }
+}