. First cut of the Externalised UI Actions

- XML Config for UI actions: web-client-config-actions.xml
   - commented examples are included in the config, I will write up a Wiki page to document it properly :)
 - Named groups of actions can also be reused across screens (where as previously individual ActionLink components had to be coded up for each screen by hand in the JSP)
 - Individual Actions can be reused across action groups or defined against a specific action group
 - UI actions for Browse (Create, More, Document and Space actions), Document and Space details pages now externalised into config
 - Refactoring of other JSPs to use externalised config - big reduction in hand coded JSF tags and code duplication between pages
. Document Details and Space Details pages now have Actions panel on the right hand side instead of an Actions drop-down menu
. Several unreported minor bugs fixed where actions conditions or listeners were inconsistent between browse and details pages

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2553 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/action/ActionEvaluator.java

@@ -30,5 +30,13 @@ import org.alfresco.web.bean.repository.Node;
  */
 public interface ActionEvaluator
 {
+   /**
+    * The evaluator should decide if the action precondition is valid based on the appropriate
+    * logic and the properties etc. of the Node context and return the result.
+    * 
+    * @param node    Node context for the action
+    * 
+    * @return result of whether the action can proceed.
+    */
    public boolean evaluate(Node node);
 }

source/java/org/alfresco/web/action/evaluator/ApproveDocEvaluator.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - 'Approve' workflow step for document.
+ * 
+ * @author Kevin Roast
+ */
+public final class ApproveDocEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.getProperties().get("app:approveStep") != null &&
+              node.isLocked() == false &&
+              node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false);
+   }
+}
+/*
+<a:booleanEvaluator value='#{r["app:approveStep"] != null && r.workingCopy == false && r.locked == false}'>
+*/

source/java/org/alfresco/web/action/evaluator/CancelCheckoutDocEvaluator.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Cancel checkout document.
+ * 
+ * @author Kevin Roast
+ */
+public final class CancelCheckoutDocEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.hasPermission(PermissionService.CANCEL_CHECK_OUT) &&
+              node.hasAspect(ContentModel.ASPECT_WORKING_COPY));
+   }
+}
+/*
+<a:booleanEvaluator value="#{r.cancelCheckOut == true}">
+*/

source/java/org/alfresco/web/action/evaluator/CheckinDocEvaluator.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Checkin document.
+ * 
+ * @author Kevin Roast
+ */
+public final class CheckinDocEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.hasPermission(PermissionService.CHECK_IN) &&
+              node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == true);
+   }
+}
+/*
+<a:booleanEvaluator value="#{r.checkIn == true}">
+*/

source/java/org/alfresco/web/action/evaluator/CheckoutDocEvaluator.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Checkout document.
+ * 
+ * @author Kevin Roast
+ */
+public final class CheckoutDocEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.hasPermission(PermissionService.CHECK_OUT) &&
+              (node.isLocked() == false &&
+               node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false));
+   }
+}
+/*
+<a:booleanEvaluator value="#{r.locked == false && r.workingCopy == false}">
+*/

source/java/org/alfresco/web/action/evaluator/CreateForumNodeEvaluator.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.model.ForumModel;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Create a forum around a node.
+ * 
+ * @author Kevin Roast
+ */
+public final class CreateForumNodeEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.hasAspect(ForumModel.ASPECT_DISCUSSABLE) == false &&
+              node.isLocked() == false);
+   }
+}
+/*
+<a:booleanEvaluator value="#{r.beingDiscussed == false && r.locked == false}">
+*/

source/java/org/alfresco/web/action/evaluator/DeleteDocEvaluator.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Delete document.
+ * 
+ * @author Kevin Roast
+ */
+public final class DeleteDocEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.isLocked() == false &&
+              node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false);
+   }
+}
+/*
+<a:booleanEvaluator value="#{r.locked == false && r.workingCopy == false}">
+*/

source/java/org/alfresco/web/action/evaluator/DiscussNodeEvaluator.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.model.ForumModel;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Discuss a node.
+ * 
+ * @author Kevin Roast
+ */
+public final class DiscussNodeEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.hasAspect(ForumModel.ASPECT_DISCUSSABLE) == true);
+   }
+}
+/*
+<a:booleanEvaluator value="#{r.beingDiscussed == true}">
+*/

source/java/org/alfresco/web/action/evaluator/EditDocCIFSEvaluator.java

@@ -19,16 +19,16 @@ package org.alfresco.web.action.evaluator;
 import javax.faces.context.FacesContext;
 
 import org.alfresco.model.ContentModel;
-import org.alfresco.service.cmr.lock.LockService;
 import org.alfresco.web.action.ActionEvaluator;
 import org.alfresco.web.app.Application;
 import org.alfresco.web.bean.repository.Node;
-import org.alfresco.web.bean.repository.Repository;
 
 /**
+ * UI Action Evaluator - Edit document via CIFS.
+ * 
  * @author Kevin Roast
  */
-public class EditDocCIFSEvaluator implements ActionEvaluator
+public final class EditDocCIFSEvaluator implements ActionEvaluator
 {
    /**
     * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
@@ -41,11 +41,8 @@ public class EditDocCIFSEvaluator implements ActionEvaluator
       if (node.hasAspect(ContentModel.ASPECT_INLINEEDITABLE) == false &&
           "webdav".equals(Application.getClientConfig(fc).getEditLinkType()))
       {
-         LockService lockService =
-            Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getLockService();
-         
-         if (Repository.isNodeOwner(node, lockService) == true ||
-             (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY)))
+         if (node.isWorkingCopyOwner() == true ||
+             (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false))
          {
             return true;
          }

source/java/org/alfresco/web/action/evaluator/EditDocHttpEvaluator.java

@@ -19,16 +19,16 @@ package org.alfresco.web.action.evaluator;
 import javax.faces.context.FacesContext;
 
 import org.alfresco.model.ContentModel;
-import org.alfresco.service.cmr.lock.LockService;
 import org.alfresco.web.action.ActionEvaluator;
 import org.alfresco.web.app.Application;
 import org.alfresco.web.bean.repository.Node;
-import org.alfresco.web.bean.repository.Repository;
 
 /**
+ * UI Action Evaluator - Edit document via HTTP or inline edit.
+ * 
  * @author Kevin Roast
  */
-public class EditDocHttpEvaluator implements ActionEvaluator
+public final class EditDocHttpEvaluator implements ActionEvaluator
 {
    /**
     * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
@@ -42,11 +42,8 @@ public class EditDocHttpEvaluator implements ActionEvaluator
       if (node.hasAspect(ContentModel.ASPECT_INLINEEDITABLE) == true ||
           "http".equals(Application.getClientConfig(fc).getEditLinkType()))
       {
-         LockService lockService =
-            Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getLockService();
-         
-         if (Repository.isNodeOwner(node, lockService) == true ||
-             (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY)))
+         if (node.isWorkingCopyOwner() == true ||
+             (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false))
          {
             return true;
          }

source/java/org/alfresco/web/action/evaluator/EditDocWebDavEvaluator.java

@@ -19,16 +19,16 @@ package org.alfresco.web.action.evaluator;
 import javax.faces.context.FacesContext;
 
 import org.alfresco.model.ContentModel;
-import org.alfresco.service.cmr.lock.LockService;
 import org.alfresco.web.action.ActionEvaluator;
 import org.alfresco.web.app.Application;
 import org.alfresco.web.bean.repository.Node;
-import org.alfresco.web.bean.repository.Repository;
 
 /**
+ * UI Action Evaluator - Edit document via Webdav.
+ * 
  * @author Kevin Roast
  */
-public class EditDocWebDavEvaluator implements ActionEvaluator
+public final class EditDocWebDavEvaluator implements ActionEvaluator
 {
    /**
     * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
@@ -41,11 +41,8 @@ public class EditDocWebDavEvaluator implements ActionEvaluator
       if (node.hasAspect(ContentModel.ASPECT_INLINEEDITABLE) == false &&
           "cifs".equals(Application.getClientConfig(fc).getEditLinkType()))
       {
-         LockService lockService =
-            Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getLockService();
-         
-         if (Repository.isNodeOwner(node, lockService) == true ||
-             (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY)))
+         if (node.isWorkingCopyOwner() == true ||
+             (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false))
          {
             return true;
          }

source/java/org/alfresco/web/action/evaluator/RejectDocEvaluator.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - 'Reject' workflow step for document.
+ * 
+ * @author Kevin Roast
+ */
+public final class RejectDocEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.getProperties().get("app:rejectStep") != null &&
+              node.isLocked() == false &&
+              node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false);
+   }
+}
+/*
+<a:booleanEvaluator value='#{r["app:rejectStep"] != null && r.workingCopy == false && r.locked == false}'>
+*/

source/java/org/alfresco/web/action/evaluator/ShortcutNodeEvaluator.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import javax.faces.context.FacesContext;
+
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.app.servlet.FacesHelper;
+import org.alfresco.web.bean.NavigationBean;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Create a shortcut to a node.
+ * 
+ * @author Kevin Roast
+ */
+public final class ShortcutNodeEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      NavigationBean nav =
+         (NavigationBean)FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "NavigationBean");
+      return (nav.getIsGuest() == false);
+   }
+}
+/*
+rendered="#{NavigationBean.isGuest == false}"
+*/

source/java/org/alfresco/web/action/evaluator/UpdateDocEvaluator.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.action.evaluator;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.web.action.ActionEvaluator;
+import org.alfresco.web.bean.repository.Node;
+
+/**
+ * UI Action Evaluator - Update document content.
+ * 
+ * @author Kevin Roast
+ */
+public final class UpdateDocEvaluator implements ActionEvaluator
+{
+   /**
+    * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node)
+    */
+   public boolean evaluate(Node node)
+   {
+      return (node.isWorkingCopyOwner() == true ||
+              (node.isLocked() == false &&
+               node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false));
+   }
+}
+/*
+<a:booleanEvaluator value="#{(r.locked == false && r.workingCopy == false) || r.owner == true}">
+*/