diff --git a/source/java/org/alfresco/web/action/ActionEvaluator.java b/source/java/org/alfresco/web/action/ActionEvaluator.java index fc80f8acff..f27c177ca2 100644 --- a/source/java/org/alfresco/web/action/ActionEvaluator.java +++ b/source/java/org/alfresco/web/action/ActionEvaluator.java @@ -1,38 +1,38 @@ -package org.alfresco.web.action; - -import java.io.Serializable; - -import org.alfresco.web.bean.repository.Node; - -/** - * Contract supported by all classes that provide dynamic evaluation for a UI action. - *

- * Evaluators are supplied with a Node instance context object. - *

- * 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. - * - * @author Kevin Roast - */ -public interface ActionEvaluator extends Serializable -{ - /** - * 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); - - /** - * The evaluator should decide if the action precondition is valid based on the appropriate - * logic and the state etc. of the given object and return the result. - * - * @param obj The object the action is for - * - * @return result of whether the action can proceed. - */ - public boolean evaluate(Object obj); -} +package org.alfresco.web.action; + +import java.io.Serializable; + +import org.alfresco.web.bean.repository.Node; + +/** + * Contract supported by all classes that provide dynamic evaluation for a UI action. + *

+ * Evaluators are supplied with a Node instance context object. + *

+ * 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. + * + * @author Kevin Roast + */ +public interface ActionEvaluator extends Serializable +{ + /** + * 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); + + /** + * The evaluator should decide if the action precondition is valid based on the appropriate + * logic and the state etc. of the given object and return the result. + * + * @param obj The object the action is for + * + * @return result of whether the action can proceed. + */ + public boolean evaluate(Object obj); +} diff --git a/source/java/org/alfresco/web/action/evaluator/ApproveDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/ApproveDocEvaluator.java index e540efeb87..d6986bd950 100644 --- a/source/java/org/alfresco/web/action/evaluator/ApproveDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/ApproveDocEvaluator.java @@ -1,34 +1,34 @@ -package org.alfresco.web.action.evaluator; - -import java.util.Map; - -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - 'Approve' workflow step for document or space. - * - * @author Kevin Roast - */ -public class ApproveDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 2958297435415449179L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - Map properties = node.getProperties(); - - Boolean approveMove = (Boolean) properties.get("app:approveMove"); - boolean isMove = approveMove == null ? false : approveMove; - - boolean canProceed = (properties.get("app:approveStep") != null) && !node.isLocked(); - //If this approval is going to result in a move of the node then we check whether the user - //has permission. The delete permission is required in order to move a node (odd, perhaps, but true). - canProceed &= (!isMove || node.hasPermission(PermissionService.DELETE)); - - return canProceed; - } -} +package org.alfresco.web.action.evaluator; + +import java.util.Map; + +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - 'Approve' workflow step for document or space. + * + * @author Kevin Roast + */ +public class ApproveDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 2958297435415449179L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + Map properties = node.getProperties(); + + Boolean approveMove = (Boolean) properties.get("app:approveMove"); + boolean isMove = approveMove == null ? false : approveMove; + + boolean canProceed = (properties.get("app:approveStep") != null) && !node.isLocked(); + //If this approval is going to result in a move of the node then we check whether the user + //has permission. The delete permission is required in order to move a node (odd, perhaps, but true). + canProceed &= (!isMove || node.hasPermission(PermissionService.DELETE)); + + return canProceed; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/CancelCheckoutDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/CancelCheckoutDocEvaluator.java index d4fb452893..fc7636128c 100644 --- a/source/java/org/alfresco/web/action/evaluator/CancelCheckoutDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/CancelCheckoutDocEvaluator.java @@ -1,25 +1,25 @@ -package org.alfresco.web.action.evaluator; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - Cancel checkout document. - * - * @author Kevin Roast - */ -public class CancelCheckoutDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = -9015403093449070254L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - return (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && - node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) == null && - node.hasPermission(PermissionService.CANCEL_CHECK_OUT)); - } +package org.alfresco.web.action.evaluator; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - Cancel checkout document. + * + * @author Kevin Roast + */ +public class CancelCheckoutDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = -9015403093449070254L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + return (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && + node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) == null && + node.hasPermission(PermissionService.CANCEL_CHECK_OUT)); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/action/evaluator/CancelWorkflowEvaluator.java b/source/java/org/alfresco/web/action/evaluator/CancelWorkflowEvaluator.java index d1aba4f675..fb3bcace31 100644 --- a/source/java/org/alfresco/web/action/evaluator/CancelWorkflowEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/CancelWorkflowEvaluator.java @@ -1,59 +1,59 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.User; - -/** - * UI Action Evaluator for cancel workflow action. The action - * is only allowed if the workflow the task belongs to was - * started by the current user. - * - * @author gavinc - */ -public class CancelWorkflowEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 7663087149225546333L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - boolean result = false; - FacesContext context = FacesContext.getCurrentInstance(); - - // get the task from the node - WorkflowTask task = (WorkflowTask)node.getProperties().get("workflowTask"); - if (task != null) - { - NodeRef initiator = task.path.instance.initiator; - if (initiator != null) - { - // find the current username - User user = Application.getCurrentUser(context); - String currentUserName = user.getUserName(); - - // get the username of the initiator - NodeService nodeSvc = Repository.getServiceRegistry( - context).getNodeService(); - String userName = (String)nodeSvc.getProperty(initiator, ContentModel.PROP_USERNAME); - - // if the current user started the workflow allow the cancel action - if (currentUserName.equals(userName)) - { - result = true; - } - } - } - - return result; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.User; + +/** + * UI Action Evaluator for cancel workflow action. The action + * is only allowed if the workflow the task belongs to was + * started by the current user. + * + * @author gavinc + */ +public class CancelWorkflowEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 7663087149225546333L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + boolean result = false; + FacesContext context = FacesContext.getCurrentInstance(); + + // get the task from the node + WorkflowTask task = (WorkflowTask)node.getProperties().get("workflowTask"); + if (task != null) + { + NodeRef initiator = task.path.instance.initiator; + if (initiator != null) + { + // find the current username + User user = Application.getCurrentUser(context); + String currentUserName = user.getUserName(); + + // get the username of the initiator + NodeService nodeSvc = Repository.getServiceRegistry( + context).getNodeService(); + String userName = (String)nodeSvc.getProperty(initiator, ContentModel.PROP_USERNAME); + + // if the current user started the workflow allow the cancel action + if (currentUserName.equals(userName)) + { + result = true; + } + } + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/CheckinDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/CheckinDocEvaluator.java index 565c6f0852..8099a07e3a 100644 --- a/source/java/org/alfresco/web/action/evaluator/CheckinDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/CheckinDocEvaluator.java @@ -1,25 +1,25 @@ -package org.alfresco.web.action.evaluator; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - Checkin document. - * - * @author Kevin Roast - */ -public class CheckinDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 5398249535631219663L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - return (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && - node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) == null && - node.hasPermission(PermissionService.CHECK_IN)); - } +package org.alfresco.web.action.evaluator; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - Checkin document. + * + * @author Kevin Roast + */ +public class CheckinDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 5398249535631219663L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + return (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && + node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) == null && + node.hasPermission(PermissionService.CHECK_IN)); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/action/evaluator/CheckoutDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/CheckoutDocEvaluator.java index b624a4f6f0..282027b133 100644 --- a/source/java/org/alfresco/web/action/evaluator/CheckoutDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/CheckoutDocEvaluator.java @@ -1,34 +1,34 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -/** - * UI Action Evaluator - Checkout document. - * - * @author Kevin Roast - */ -public class CheckoutDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 5510366635124591353L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - DictionaryService dd = Repository.getServiceRegistry( - FacesContext.getCurrentInstance()).getDictionaryService(); - - return dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT) && - ((node.hasPermission(PermissionService.CHECK_OUT) && - (node.isLocked() == false && - node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false) && - node.hasAspect(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION) == false)); - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +/** + * UI Action Evaluator - Checkout document. + * + * @author Kevin Roast + */ +public class CheckoutDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 5510366635124591353L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + DictionaryService dd = Repository.getServiceRegistry( + FacesContext.getCurrentInstance()).getDictionaryService(); + + return dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT) && + ((node.hasPermission(PermissionService.CHECK_OUT) && + (node.isLocked() == false && + node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false) && + node.hasAspect(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION) == false)); + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/CreateForumNodeEvaluator.java b/source/java/org/alfresco/web/action/evaluator/CreateForumNodeEvaluator.java index 2cfbe36258..e7073e490c 100644 --- a/source/java/org/alfresco/web/action/evaluator/CreateForumNodeEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/CreateForumNodeEvaluator.java @@ -1,23 +1,23 @@ -package org.alfresco.web.action.evaluator; - -import org.alfresco.model.ForumModel; -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - Create a forum around a node. - * - * @author Kevin Roast - */ -public class CreateForumNodeEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = -5132048668011887505L; - - /** - * @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); - } -} +package org.alfresco.web.action.evaluator; + +import org.alfresco.model.ForumModel; +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - Create a forum around a node. + * + * @author Kevin Roast + */ +public class CreateForumNodeEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = -5132048668011887505L; + + /** + * @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); + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/DeleteDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/DeleteDocEvaluator.java index 14d7d8f262..8c63969675 100644 --- a/source/java/org/alfresco/web/action/evaluator/DeleteDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/DeleteDocEvaluator.java @@ -1,59 +1,59 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.ml.MultilingualContentService; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.ml.MultilingualUtils; -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - Delete document. - * - * @author Kevin Roast - */ -public class DeleteDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 5742287199692844685L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - FacesContext fc = FacesContext.getCurrentInstance(); - - // the node to delete is a ml container, test if the user has enought right on each translation - if(node.getType().equals(ContentModel.TYPE_MULTILINGUAL_CONTAINER)) - { - return MultilingualUtils.canDeleteEachTranslation(node, fc); - } - - boolean isPivot = false; - - // special case for multilingual documents - if (node.getAspects().contains(ContentModel.ASPECT_MULTILINGUAL_DOCUMENT)) - { - MultilingualContentService mlservice = - (MultilingualContentService) FacesHelper.getManagedBean(fc, "MultilingualContentService"); - - // if the translation is the last translation, user can delete it - if (mlservice.getTranslations(node.getNodeRef()).size() == 1) - { - isPivot = false; - } - // Else if the node is the pivot language, user can't delete it - else if (mlservice.getPivotTranslation(node.getNodeRef()).getId() - .equalsIgnoreCase(node.getNodeRef().getId())) - { - isPivot = true; - } - // finally, the node is not the pivot translation, user can delete it - } - - return (node.isLocked() == false && - node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false && - isPivot == false); - } +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.ml.MultilingualContentService; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.ml.MultilingualUtils; +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - Delete document. + * + * @author Kevin Roast + */ +public class DeleteDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 5742287199692844685L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + FacesContext fc = FacesContext.getCurrentInstance(); + + // the node to delete is a ml container, test if the user has enought right on each translation + if(node.getType().equals(ContentModel.TYPE_MULTILINGUAL_CONTAINER)) + { + return MultilingualUtils.canDeleteEachTranslation(node, fc); + } + + boolean isPivot = false; + + // special case for multilingual documents + if (node.getAspects().contains(ContentModel.ASPECT_MULTILINGUAL_DOCUMENT)) + { + MultilingualContentService mlservice = + (MultilingualContentService) FacesHelper.getManagedBean(fc, "MultilingualContentService"); + + // if the translation is the last translation, user can delete it + if (mlservice.getTranslations(node.getNodeRef()).size() == 1) + { + isPivot = false; + } + // Else if the node is the pivot language, user can't delete it + else if (mlservice.getPivotTranslation(node.getNodeRef()).getId() + .equalsIgnoreCase(node.getNodeRef().getId())) + { + isPivot = true; + } + // finally, the node is not the pivot translation, user can delete it + } + + return (node.isLocked() == false && + node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false && + isPivot == false); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/action/evaluator/DiscussNodeEvaluator.java b/source/java/org/alfresco/web/action/evaluator/DiscussNodeEvaluator.java index 10ef567b75..d241c796eb 100644 --- a/source/java/org/alfresco/web/action/evaluator/DiscussNodeEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/DiscussNodeEvaluator.java @@ -1,47 +1,47 @@ -package org.alfresco.web.action.evaluator; - -import java.util.List; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.namespace.RegexQNamePattern; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -/** - * UI Action Evaluator - Discuss a node. - * - * @author Kevin Roast - */ -public class DiscussNodeEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 8754174908349998903L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - boolean result = false; - - if (node.hasAspect(ForumModel.ASPECT_DISCUSSABLE)) - { - NodeService nodeService = Repository.getServiceRegistry( - FacesContext.getCurrentInstance()).getNodeService(); - List children = nodeService.getChildAssocs( - node.getNodeRef(), ForumModel.ASSOC_DISCUSSION, - RegexQNamePattern.MATCH_ALL); - - // make sure there is one visible child association for the node - if (children.size() == 1) - { - result = true; - } - } - - return result; - } -} +package org.alfresco.web.action.evaluator; + +import java.util.List; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.namespace.RegexQNamePattern; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +/** + * UI Action Evaluator - Discuss a node. + * + * @author Kevin Roast + */ +public class DiscussNodeEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 8754174908349998903L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + boolean result = false; + + if (node.hasAspect(ForumModel.ASPECT_DISCUSSABLE)) + { + NodeService nodeService = Repository.getServiceRegistry( + FacesContext.getCurrentInstance()).getNodeService(); + List children = nodeService.getChildAssocs( + node.getNodeRef(), ForumModel.ASSOC_DISCUSSION, + RegexQNamePattern.MATCH_ALL); + + // make sure there is one visible child association for the node + if (children.size() == 1) + { + result = true; + } + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/DiscussionCopyEvaluator.java b/source/java/org/alfresco/web/action/evaluator/DiscussionCopyEvaluator.java index 368f01f1cf..48c32fdfcd 100644 --- a/source/java/org/alfresco/web/action/evaluator/DiscussionCopyEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/DiscussionCopyEvaluator.java @@ -1,59 +1,59 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -/** - * Evaluates whether the copy action should be visible. - * - * If the node is a discussion don't allow the action. - * - * @author gavinc - */ -public class DiscussionCopyEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = -4080878553011296677L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - boolean result = true; - - // if the node in question is a forum... - if (node.getType().equals(ForumModel.TYPE_FORUM)) - { - // get the association type - FacesContext context = FacesContext.getCurrentInstance(); - NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); - - ChildAssociationRef parentAssoc = nodeService.getPrimaryParent(node.getNodeRef()); - QName assocType = parentAssoc.getTypeQName(); - - // only allow the action if the association type is not the discussion assoc - result = (assocType.equals(ForumModel.ASSOC_DISCUSSION) == false); - } - - // impossible to copy a translation without content. - if (result && node.getAspects().contains(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) - { - result = false; - } - - if (!node.hasPermission(PermissionService.READ)) - { - result = false; - } - - return result; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +/** + * Evaluates whether the copy action should be visible. + * + * If the node is a discussion don't allow the action. + * + * @author gavinc + */ +public class DiscussionCopyEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = -4080878553011296677L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + boolean result = true; + + // if the node in question is a forum... + if (node.getType().equals(ForumModel.TYPE_FORUM)) + { + // get the association type + FacesContext context = FacesContext.getCurrentInstance(); + NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); + + ChildAssociationRef parentAssoc = nodeService.getPrimaryParent(node.getNodeRef()); + QName assocType = parentAssoc.getTypeQName(); + + // only allow the action if the association type is not the discussion assoc + result = (assocType.equals(ForumModel.ASSOC_DISCUSSION) == false); + } + + // impossible to copy a translation without content. + if (result && node.getAspects().contains(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) + { + result = false; + } + + if (!node.hasPermission(PermissionService.READ)) + { + result = false; + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/DiscussionCutEvaluator.java b/source/java/org/alfresco/web/action/evaluator/DiscussionCutEvaluator.java index c1ec34da15..6fe73b6fce 100644 --- a/source/java/org/alfresco/web/action/evaluator/DiscussionCutEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/DiscussionCutEvaluator.java @@ -1,46 +1,46 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -/** - * Evaluates whether the cut action should be visible. - * - * If the node is a discussion don't allow the action. - * - * @author gavinc - */ -public class DiscussionCutEvaluator extends CutNodeEvaluator -{ - private static final long serialVersionUID = 7260556874788184200L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - boolean result = super.evaluate(node); - - // if the node in question is a forum... - if (result && node.getType().equals(ForumModel.TYPE_FORUM)) - { - // get the association type - FacesContext context = FacesContext.getCurrentInstance(); - NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); - - ChildAssociationRef parentAssoc = nodeService.getPrimaryParent(node.getNodeRef()); - QName assocType = parentAssoc.getTypeQName(); - - // only allow the action if the association type is not the discussion assoc - result = (assocType.equals(ForumModel.ASSOC_DISCUSSION) == false); - } - - return result; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +/** + * Evaluates whether the cut action should be visible. + * + * If the node is a discussion don't allow the action. + * + * @author gavinc + */ +public class DiscussionCutEvaluator extends CutNodeEvaluator +{ + private static final long serialVersionUID = 7260556874788184200L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + boolean result = super.evaluate(node); + + // if the node in question is a forum... + if (result && node.getType().equals(ForumModel.TYPE_FORUM)) + { + // get the association type + FacesContext context = FacesContext.getCurrentInstance(); + NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); + + ChildAssociationRef parentAssoc = nodeService.getPrimaryParent(node.getNodeRef()); + QName assocType = parentAssoc.getTypeQName(); + + // only allow the action if the association type is not the discussion assoc + result = (assocType.equals(ForumModel.ASSOC_DISCUSSION) == false); + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/EditDocCIFSEvaluator.java b/source/java/org/alfresco/web/action/evaluator/EditDocCIFSEvaluator.java index 1d5ac7a01f..5e2daa28c0 100644 --- a/source/java/org/alfresco/web/action/evaluator/EditDocCIFSEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/EditDocCIFSEvaluator.java @@ -1,51 +1,51 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.coci.EditOnlineDialog; -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 extends BaseActionEvaluator -{ - private static final long serialVersionUID = -8988276140748731926L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - FacesContext fc = FacesContext.getCurrentInstance(); - DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); - - boolean result = false; - - // if the node is inline editable, the default http behaviour should always be used - if (dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT)) - { - if (node.hasAspect(ApplicationModel.ASPECT_INLINEEDITABLE) == false && - "cifs".equals(Application.getClientConfig(fc).getEditLinkType())) - { - if ((node.isWorkingCopyOwner() == true && node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) != null && - node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE).equals(EditOnlineDialog.ONLINE_EDITING))|| - (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && node.hasPermission(PermissionService.WRITE)) || - (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false)) - { - result = true; - } - } - } - - return result; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.coci.EditOnlineDialog; +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 extends BaseActionEvaluator +{ + private static final long serialVersionUID = -8988276140748731926L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + FacesContext fc = FacesContext.getCurrentInstance(); + DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); + + boolean result = false; + + // if the node is inline editable, the default http behaviour should always be used + if (dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT)) + { + if (node.hasAspect(ApplicationModel.ASPECT_INLINEEDITABLE) == false && + "cifs".equals(Application.getClientConfig(fc).getEditLinkType())) + { + if ((node.isWorkingCopyOwner() == true && node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) != null && + node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE).equals(EditOnlineDialog.ONLINE_EDITING))|| + (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && node.hasPermission(PermissionService.WRITE)) || + (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false)) + { + result = true; + } + } + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/EditDocHttpEvaluator.java b/source/java/org/alfresco/web/action/evaluator/EditDocHttpEvaluator.java index be1e7c5b2e..9c4d6f7f62 100644 --- a/source/java/org/alfresco/web/action/evaluator/EditDocHttpEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/EditDocHttpEvaluator.java @@ -1,59 +1,59 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.coci.EditOnlineDialog; -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 extends BaseActionEvaluator -{ - private static final long serialVersionUID = -3694679925715830430L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - FacesContext fc = FacesContext.getCurrentInstance(); - DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); - - boolean result = false; - - // Since the reader returned of an empty translation is the reader of it's pivot translation, it makes - // no sens to edit it on-line. - if(node.getAspects().contains(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) - { - //result = false - } - // if the node is inline editable, the default http behaviour should - // always be used otherwise the configured approach is used - else if (dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT)) - { - if (node.hasAspect(ApplicationModel.ASPECT_INLINEEDITABLE) == true && - node.getProperties().get(ApplicationModel.PROP_EDITINLINE) != null && - ((Boolean)node.getProperties().get(ApplicationModel.PROP_EDITINLINE)).booleanValue() == true) - { - if ((node.isWorkingCopyOwner() == true && node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) != null && - node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE).equals(EditOnlineDialog.ONLINE_EDITING)) || - (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && node.hasPermission(PermissionService.WRITE)) || - (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false)) - { - result = true; - } - } - } - - return result; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.coci.EditOnlineDialog; +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 extends BaseActionEvaluator +{ + private static final long serialVersionUID = -3694679925715830430L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + FacesContext fc = FacesContext.getCurrentInstance(); + DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); + + boolean result = false; + + // Since the reader returned of an empty translation is the reader of it's pivot translation, it makes + // no sens to edit it on-line. + if(node.getAspects().contains(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) + { + //result = false + } + // if the node is inline editable, the default http behaviour should + // always be used otherwise the configured approach is used + else if (dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT)) + { + if (node.hasAspect(ApplicationModel.ASPECT_INLINEEDITABLE) == true && + node.getProperties().get(ApplicationModel.PROP_EDITINLINE) != null && + ((Boolean)node.getProperties().get(ApplicationModel.PROP_EDITINLINE)).booleanValue() == true) + { + if ((node.isWorkingCopyOwner() == true && node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) != null && + node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE).equals(EditOnlineDialog.ONLINE_EDITING)) || + (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && node.hasPermission(PermissionService.WRITE)) || + (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false)) + { + result = true; + } + } + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/EditDocWebDavEvaluator.java b/source/java/org/alfresco/web/action/evaluator/EditDocWebDavEvaluator.java index a36f0801c9..b18fef01a3 100644 --- a/source/java/org/alfresco/web/action/evaluator/EditDocWebDavEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/EditDocWebDavEvaluator.java @@ -1,50 +1,50 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.coci.EditOnlineDialog; -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 extends BaseActionEvaluator -{ - private static final long serialVersionUID = 293342561997588700L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - FacesContext fc = FacesContext.getCurrentInstance(); - DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); - - boolean result = false; - - // if the node is inline editable, the default http behaviour should always be used - if (dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT)) - { - if (node.hasAspect(ApplicationModel.ASPECT_INLINEEDITABLE) == false && - "webdav".equals(Application.getClientConfig(fc).getEditLinkType())) - { - if ((node.isWorkingCopyOwner() == true && node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE).equals(EditOnlineDialog.ONLINE_EDITING)) || - (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && node.hasPermission(PermissionService.WRITE)) || - (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false)) - { - result = true; - } - } - } - - return result; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.coci.EditOnlineDialog; +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 extends BaseActionEvaluator +{ + private static final long serialVersionUID = 293342561997588700L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + FacesContext fc = FacesContext.getCurrentInstance(); + DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); + + boolean result = false; + + // if the node is inline editable, the default http behaviour should always be used + if (dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT)) + { + if (node.hasAspect(ApplicationModel.ASPECT_INLINEEDITABLE) == false && + "webdav".equals(Application.getClientConfig(fc).getEditLinkType())) + { + if ((node.isWorkingCopyOwner() == true && node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE).equals(EditOnlineDialog.ONLINE_EDITING)) || + (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && node.hasPermission(PermissionService.WRITE)) || + (node.isLocked() == false && node.hasAspect(ContentModel.ASPECT_WORKING_COPY) == false)) + { + result = true; + } + } + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/ForumsCheckinDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/ForumsCheckinDocEvaluator.java index db04da226b..13cad8c286 100644 --- a/source/java/org/alfresco/web/action/evaluator/ForumsCheckinDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/ForumsCheckinDocEvaluator.java @@ -1,54 +1,54 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.coci.CheckOutCheckInService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -/** - * UI Action Evaluator - Checkin a document with potentially a Forum attached. - * - * @author Kevin Roast - */ -public class ForumsCheckinDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = -924897450989526336L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - boolean allow = false; - - if (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && - node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) == null) - { - if (node.hasAspect(ForumModel.ASPECT_DISCUSSABLE)) - { - CheckOutCheckInService checkOutCheckInService = - Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCheckOutCheckInService(); - // get the original locked node (via the copiedfrom aspect) - NodeRef lockedNodeRef = checkOutCheckInService.getCheckedOut(node.getNodeRef()); - if (lockedNodeRef != null) - { - Node lockedNode = new Node(lockedNodeRef); - allow = (node.hasPermission(PermissionService.CHECK_IN) && - lockedNode.hasPermission(PermissionService.CONTRIBUTOR)); - } - } - else - { - // there is no discussion so just check they have checkin permission for the node - allow = node.hasPermission(PermissionService.CHECK_IN); - } - } - - return allow; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.coci.CheckOutCheckInService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +/** + * UI Action Evaluator - Checkin a document with potentially a Forum attached. + * + * @author Kevin Roast + */ +public class ForumsCheckinDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = -924897450989526336L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + boolean allow = false; + + if (node.hasAspect(ContentModel.ASPECT_WORKING_COPY) && + node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE) == null) + { + if (node.hasAspect(ForumModel.ASPECT_DISCUSSABLE)) + { + CheckOutCheckInService checkOutCheckInService = + Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCheckOutCheckInService(); + // get the original locked node (via the copiedfrom aspect) + NodeRef lockedNodeRef = checkOutCheckInService.getCheckedOut(node.getNodeRef()); + if (lockedNodeRef != null) + { + Node lockedNode = new Node(lockedNodeRef); + allow = (node.hasPermission(PermissionService.CHECK_IN) && + lockedNode.hasPermission(PermissionService.CONTRIBUTOR)); + } + } + else + { + // there is no discussion so just check they have checkin permission for the node + allow = node.hasPermission(PermissionService.CHECK_IN); + } + } + + return allow; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/RejectDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/RejectDocEvaluator.java index 2e3f4f8a1a..965a1c4804 100644 --- a/source/java/org/alfresco/web/action/evaluator/RejectDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/RejectDocEvaluator.java @@ -1,22 +1,22 @@ -package org.alfresco.web.action.evaluator; - -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - 'Reject' workflow step for document or space. - * - * @author Kevin Roast - */ -public class RejectDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = -7733947744617999298L; - - /** - * @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); - } -} +package org.alfresco.web.action.evaluator; + +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - 'Reject' workflow step for document or space. + * + * @author Kevin Roast + */ +public class RejectDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = -7733947744617999298L; + + /** + * @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); + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/ShortcutNodeEvaluator.java b/source/java/org/alfresco/web/action/evaluator/ShortcutNodeEvaluator.java index 8cd8732b06..f2c8d4e491 100644 --- a/source/java/org/alfresco/web/action/evaluator/ShortcutNodeEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/ShortcutNodeEvaluator.java @@ -1,27 +1,27 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -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 class ShortcutNodeEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 8768692540125721144L; - - /** - * @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.BEAN_NAME); - return (nav.getIsGuest() == false); - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +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 class ShortcutNodeEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 8768692540125721144L; + + /** + * @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.BEAN_NAME); + return (nav.getIsGuest() == false); + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/StartWorkflowEvaluator.java b/source/java/org/alfresco/web/action/evaluator/StartWorkflowEvaluator.java index f24ee88a41..c68c266117 100644 --- a/source/java/org/alfresco/web/action/evaluator/StartWorkflowEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/StartWorkflowEvaluator.java @@ -1,45 +1,45 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.workflow.BPMEngineRegistry; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.repository.Node; -import org.springframework.web.context.WebApplicationContext; -import org.springframework.web.jsf.FacesContextUtils; - -/** - * UI Action Evaluator - Start workflow on a node. - * - * @author gavinc - */ -public class StartWorkflowEvaluator extends BaseActionEvaluator -{ - private static final String BPM_ENGINE_BEAN_NAME = "bpm_engineRegistry"; - private static final long serialVersionUID = 3110333488835027710L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - FacesContext facesContext = FacesContext.getCurrentInstance(); - NavigationBean nav = - (NavigationBean)FacesHelper.getManagedBean(facesContext, NavigationBean.BEAN_NAME); - - // determine whether the workflow services are active - boolean workflowPresent = false; - WebApplicationContext springContext = FacesContextUtils.getRequiredWebApplicationContext(facesContext); - BPMEngineRegistry bpmReg = (BPMEngineRegistry)springContext.getBean(BPM_ENGINE_BEAN_NAME); - if (bpmReg != null) - { - String[] components = bpmReg.getWorkflowComponents(); - workflowPresent = (components != null && components.length > 0); - } - - return (workflowPresent && nav.getIsGuest() == false && - node.hasAspect(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION) == false); - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.workflow.BPMEngineRegistry; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.repository.Node; +import org.springframework.web.context.WebApplicationContext; +import org.springframework.web.jsf.FacesContextUtils; + +/** + * UI Action Evaluator - Start workflow on a node. + * + * @author gavinc + */ +public class StartWorkflowEvaluator extends BaseActionEvaluator +{ + private static final String BPM_ENGINE_BEAN_NAME = "bpm_engineRegistry"; + private static final long serialVersionUID = 3110333488835027710L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + FacesContext facesContext = FacesContext.getCurrentInstance(); + NavigationBean nav = + (NavigationBean)FacesHelper.getManagedBean(facesContext, NavigationBean.BEAN_NAME); + + // determine whether the workflow services are active + boolean workflowPresent = false; + WebApplicationContext springContext = FacesContextUtils.getRequiredWebApplicationContext(facesContext); + BPMEngineRegistry bpmReg = (BPMEngineRegistry)springContext.getBean(BPM_ENGINE_BEAN_NAME); + if (bpmReg != null) + { + String[] components = bpmReg.getWorkflowComponents(); + workflowPresent = (components != null && components.length > 0); + } + + return (workflowPresent && nav.getIsGuest() == false && + node.hasAspect(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION) == false); + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/TakeOwnershipDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/TakeOwnershipDocEvaluator.java index 4bb37c06de..c03a0e006e 100644 --- a/source/java/org/alfresco/web/action/evaluator/TakeOwnershipDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/TakeOwnershipDocEvaluator.java @@ -1,21 +1,21 @@ -package org.alfresco.web.action.evaluator; - -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - Take ownership of a document. - * - * @author Kevin Roast - */ -public class TakeOwnershipDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 3966463533922521230L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - return (node.isLocked() == false); - } -} +package org.alfresco.web.action.evaluator; + +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - Take ownership of a document. + * + * @author Kevin Roast + */ +public class TakeOwnershipDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 3966463533922521230L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + return (node.isLocked() == false); + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/UnlockDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/UnlockDocEvaluator.java index 5ce15b3e4c..7de2279d8c 100644 --- a/source/java/org/alfresco/web/action/evaluator/UnlockDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/UnlockDocEvaluator.java @@ -1,35 +1,35 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.coci.CheckOutCheckInService; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - Unlock a locked document. - * - * @author Kevin Roast - */ -public class UnlockDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = -7056759932698306087L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - if (node.isLocked()) - { - FacesContext fc = FacesContext.getCurrentInstance(); - CheckOutCheckInService checkOutCheckInService = (CheckOutCheckInService) FacesHelper.getManagedBean(fc, "CheckoutCheckinService"); - if (checkOutCheckInService.getWorkingCopy(node.getNodeRef()) == null) - { - return true; - } - } - - return false; - } -} +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.coci.CheckOutCheckInService; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - Unlock a locked document. + * + * @author Kevin Roast + */ +public class UnlockDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = -7056759932698306087L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + if (node.isLocked()) + { + FacesContext fc = FacesContext.getCurrentInstance(); + CheckOutCheckInService checkOutCheckInService = (CheckOutCheckInService) FacesHelper.getManagedBean(fc, "CheckoutCheckinService"); + if (checkOutCheckInService.getWorkingCopy(node.getNodeRef()) == null) + { + return true; + } + } + + return false; + } +} diff --git a/source/java/org/alfresco/web/action/evaluator/UnlockedDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/UnlockedDocEvaluator.java index 00bbbd6c1b..1812a02b46 100644 --- a/source/java/org/alfresco/web/action/evaluator/UnlockedDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/UnlockedDocEvaluator.java @@ -1,21 +1,21 @@ -package org.alfresco.web.action.evaluator; - -import org.alfresco.web.bean.repository.Node; - -/** - * UI Action Evaluator - Proceed if the document is not locked. - * - * @author Kevin Roast - */ -public class UnlockedDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = -3216759932698306123L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - return (node.isLocked() == false); - } +package org.alfresco.web.action.evaluator; + +import org.alfresco.web.bean.repository.Node; + +/** + * UI Action Evaluator - Proceed if the document is not locked. + * + * @author Kevin Roast + */ +public class UnlockedDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = -3216759932698306123L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + return (node.isLocked() == false); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/action/evaluator/UpdateDocEvaluator.java b/source/java/org/alfresco/web/action/evaluator/UpdateDocEvaluator.java index 3313eb6cd6..07f781fec3 100644 --- a/source/java/org/alfresco/web/action/evaluator/UpdateDocEvaluator.java +++ b/source/java/org/alfresco/web/action/evaluator/UpdateDocEvaluator.java @@ -1,35 +1,35 @@ -package org.alfresco.web.action.evaluator; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.web.bean.coci.EditOfflineDialog; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -/** - * UI Action Evaluator - Update document content. - * - * @author Kevin Roast - */ -public class UpdateDocEvaluator extends BaseActionEvaluator -{ - private static final long serialVersionUID = 6030963610213633893L; - - /** - * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) - */ - public boolean evaluate(Node node) - { - DictionaryService dd = Repository.getServiceRegistry( - FacesContext.getCurrentInstance()).getDictionaryService(); - - boolean isOfflineEditing = - (EditOfflineDialog.OFFLINE_EDITING.equals(node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE))); - - return dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT) && - ((node.isWorkingCopyOwner() && !isOfflineEditing) || - (!node.isLocked() && !node.hasAspect(ContentModel.ASPECT_WORKING_COPY))); - } +package org.alfresco.web.action.evaluator; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.web.bean.coci.EditOfflineDialog; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +/** + * UI Action Evaluator - Update document content. + * + * @author Kevin Roast + */ +public class UpdateDocEvaluator extends BaseActionEvaluator +{ + private static final long serialVersionUID = 6030963610213633893L; + + /** + * @see org.alfresco.web.action.ActionEvaluator#evaluate(org.alfresco.web.bean.repository.Node) + */ + public boolean evaluate(Node node) + { + DictionaryService dd = Repository.getServiceRegistry( + FacesContext.getCurrentInstance()).getDictionaryService(); + + boolean isOfflineEditing = + (EditOfflineDialog.OFFLINE_EDITING.equals(node.getProperties().get(ContentModel.PROP_WORKING_COPY_MODE))); + + return dd.isSubClass(node.getType(), ContentModel.TYPE_CONTENT) && + ((node.isWorkingCopyOwner() && !isOfflineEditing) || + (!node.isLocked() && !node.hasAspect(ContentModel.ASPECT_WORKING_COPY))); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/app/AlfrescoNavigationHandler.java b/source/java/org/alfresco/web/app/AlfrescoNavigationHandler.java index 40b308df20..d78842dbe3 100644 --- a/source/java/org/alfresco/web/app/AlfrescoNavigationHandler.java +++ b/source/java/org/alfresco/web/app/AlfrescoNavigationHandler.java @@ -1,977 +1,977 @@ -package org.alfresco.web.app; - -import java.util.Stack; - -import javax.faces.application.NavigationHandler; -import javax.faces.application.ViewHandler; -import javax.faces.component.UIViewRoot; -import javax.faces.context.FacesContext; - -import org.springframework.extensions.config.Config; -import org.springframework.extensions.config.ConfigService; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.dialog.DialogManager; -import org.alfresco.web.bean.dialog.DialogState; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.wizard.WizardManager; -import org.alfresco.web.bean.wizard.WizardState; -import org.alfresco.web.config.DialogsConfigElement; -import org.alfresco.web.config.NavigationConfigElement; -import org.alfresco.web.config.NavigationElementReader; -import org.alfresco.web.config.NavigationResult; -import org.alfresco.web.config.WizardsConfigElement; -import org.alfresco.web.config.DialogsConfigElement.DialogConfig; -import org.alfresco.web.config.WizardsConfigElement.WizardConfig; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * @author gavinc - */ -public class AlfrescoNavigationHandler extends NavigationHandler -{ - public final static String OUTCOME_SEPARATOR = ":"; - public final static String OUTCOME_BROWSE = "browse"; - public final static String DIALOG_PREFIX = "dialog" + OUTCOME_SEPARATOR; - public final static String WIZARD_PREFIX = "wizard" + OUTCOME_SEPARATOR; - public final static String CLOSE_DIALOG_OUTCOME = DIALOG_PREFIX + "close"; - public final static String CLOSE_WIZARD_OUTCOME = WIZARD_PREFIX + "close"; - public final static String CLOSE_MULTIPLE_START = "["; - public final static String CLOSE_MULTIPLE_END = "]"; - public final static String EXTERNAL_CONTAINER_SESSION = "externalDialogContainer"; - - protected String dialogContainer = null; - protected String wizardContainer = null; - protected String plainDialogContainer = null; - protected String plainWizardContainer = null; - - private final static Log logger = LogFactory.getLog(AlfrescoNavigationHandler.class); - private final static String VIEW_STACK = "_alfViewStack"; - - // The original navigation handler - private NavigationHandler origHandler; - - /** - * Default constructor - * - * @param origHandler The original navigation handler - */ - public AlfrescoNavigationHandler(NavigationHandler origHandler) - { - super(); - this.origHandler = origHandler; - } - - /** - * @see javax.faces.application.NavigationHandler#handleNavigation(javax.faces.context.FacesContext, java.lang.String, java.lang.String) - */ - @Override - @SuppressWarnings("unchecked") - public void handleNavigation(FacesContext context, String fromAction, String outcome) - { - if (logger.isDebugEnabled()) - { - logger.debug("handleNavigation (fromAction=" + fromAction + ", outcome=" + outcome + ")"); - logger.debug("Current view id: " + context.getViewRoot().getViewId()); - } - - boolean isDialog = isDialog(outcome); - if (isDialog || isWizard(outcome)) - { - boolean dialogWizardClosing = isDialogOrWizardClosing(outcome); - outcome = stripPrefix(outcome); - - if (dialogWizardClosing) - { - handleDialogOrWizardClose(context, fromAction, outcome, isDialog); - } - else - { - if (isDialog) - { - handleDialogOpen(context, fromAction, outcome); - } - else - { - handleWizardOpen(context, fromAction, outcome); - } - } - } - else - { - if (isWizardStep(fromAction)) - { - goToView(context, getWizardContainer(context)); - } - else - { - handleDispatch(context, fromAction, outcome); - } - } - - // reset the dispatch context - Object bean = FacesHelper.getManagedBean(context, NavigationBean.BEAN_NAME); - if (bean instanceof NavigationBean) - { - ((NavigationBean)bean).resetDispatchContext(); - } - - if (logger.isDebugEnabled()) - logger.debug("view stack: " + getViewStack(context)); - } - - /** - * Determines whether the given outcome is dialog related - * - * @param outcome The outcome to test - * @return true if outcome is dialog related i.e. starts with dialog: - */ - protected boolean isDialog(String outcome) - { - boolean dialog = false; - - if (outcome != null && outcome.startsWith(DIALOG_PREFIX)) - { - dialog = true; - } - - return dialog; - } - - /** - * Determines whether the given outcome is wizard related - * - * @param outcome The outcome to test - * @return true if outcome is wizard related - * i.e. starts with create-wizard: or edit-wizard: - */ - protected boolean isWizard(String outcome) - { - boolean wizard = false; - - if (outcome != null && outcome.startsWith(WIZARD_PREFIX)) - { - wizard = true; - } - - return wizard; - } - - /** - * Determines whether the given outcome represents a dialog or wizard closing - * - * @param outcome The outcome to test - * @return true if the outcome represents a closing dialog or wizard - */ - protected boolean isDialogOrWizardClosing(String outcome) - { - boolean closing = false; - - if (outcome != null && - (outcome.startsWith(CLOSE_DIALOG_OUTCOME) || - outcome.startsWith(CLOSE_WIZARD_OUTCOME))) - { - closing = true; - } - - return closing; - } - - protected int getNumberToClose(String outcome) - { - int toClose = 1; - - int idxStart = outcome.indexOf(CLOSE_MULTIPLE_START); - if (outcome != null && idxStart != -1) - { - int idxEnd = outcome.indexOf(CLOSE_MULTIPLE_END); - if (idxEnd != -1) - { - String closeNum = outcome.substring(idxStart+1, idxEnd); - try - { - toClose = Integer.parseInt(closeNum); - } - catch (NumberFormatException nfe) - { - if (logger.isWarnEnabled()) - logger.warn("Could not determine number of containers to close, defaulting to 1"); - } - } - - if (logger.isDebugEnabled()) - logger.debug("Closing " + toClose + " levels of container"); - } - - return toClose; - } - - /** - * Determines whether the given fromAction represents a step in the wizard - * i.e. next or back - * - * @param fromAction The fromAction - * @return true if the from action represents a wizard step - */ - protected boolean isWizardStep(String fromAction) - { - boolean wizardStep = false; - - if (fromAction != null && - (fromAction.equals("#{WizardManager.next}") || fromAction.equals("#{WizardManager.back}"))) - { - wizardStep = true; - } - - return wizardStep; - } - - /** - * Removes the dialog or wizard prefix from the given outcome - * - * @param outcome The outcome to remove the prefix from - * @return The remaining outcome - */ - protected String stripPrefix(String outcome) - { - String newOutcome = outcome; - - if (outcome != null) - { - int idx = outcome.indexOf(OUTCOME_SEPARATOR); - if (idx != -1) - { - newOutcome = outcome.substring(idx+1); - } - } - - return newOutcome; - } - - /** - * Returns the overridden outcome. - * Used by dialogs and wizards to go to a particular page after it closes - * rather than back to the page it was launched from. - * - * @param outcome The current outcome - * @return The overridden outcome or null if there isn't an override - */ - protected String getOutcomeOverride(String outcome) - { - String override = null; - - if (outcome != null) - { - int idx = outcome.indexOf(OUTCOME_SEPARATOR); - if (idx != -1) - { - override = outcome.substring(idx+1); - } - } - - return override; - } - - /** - * Returns the dialog configuration object for the given dialog name. - * If there is a node in the dispatch context a lookup is performed using - * the node otherwise the global config section is used. - * - * - * @param name The name of dialog being launched - * @param dispatchContext The node being acted upon - * @return The DialogConfig for the dialog or null if no config could be found - */ - protected DialogConfig getDialogConfig(FacesContext context, String name, Node dispatchContext) - { - DialogConfig dialogConfig = null; - ConfigService configSvc = Application.getConfigService(context); - - Config config = null; - - if (dispatchContext != null) - { - if (logger.isDebugEnabled()) - logger.debug("Using dispatch context for dialog lookup: " + - dispatchContext.getType().toString()); - - // use the node to perform the lookup (this will include the global section) - config = configSvc.getConfig(dispatchContext); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("Looking up dialog in global config"); - - // just use the global - config = configSvc.getGlobalConfig(); - } - - if (config != null) - { - DialogsConfigElement dialogsCfg = (DialogsConfigElement)config.getConfigElement( - DialogsConfigElement.CONFIG_ELEMENT_ID); - if (dialogsCfg != null) - { - dialogConfig = dialogsCfg.getDialog(name); - } - } - - return dialogConfig; - } - - /** - * Returns the wizard configuration object for the given wizard name. - * If there is a node in the dispatch context a lookup is performed using - * the node otherwise the global config section is used. - * - * @param name The name of wizard being launched - * @param dispatchContext The node being acted upon - * @return The WizardConfig for the wizard or null if no config could be found - */ - protected WizardConfig getWizardConfig(FacesContext context, String name, Node dispatchContext) - { - WizardConfig wizardConfig = null; - ConfigService configSvc = Application.getConfigService(context); - - Config config = null; - - if (dispatchContext != null) - { - if (logger.isDebugEnabled()) - logger.debug("Using dispatch context for wizard lookup: " + - dispatchContext.getType().toString()); - - // use the node to perform the lookup (this will include the global section) - config = configSvc.getConfig(dispatchContext); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("Looking up wizard in global config"); - - // just use the global - config = configSvc.getGlobalConfig(); - } - - if (config != null) - { - WizardsConfigElement wizardsCfg = (WizardsConfigElement)config.getConfigElement( - WizardsConfigElement.CONFIG_ELEMENT_ID); - if (wizardsCfg != null) - { - wizardConfig = wizardsCfg.getWizard(name); - } - } - - return wizardConfig; - } - - /** - * Retrieves the configured dialog container page - * - * @param context FacesContext - * @return The container page - */ - protected String getDialogContainer(FacesContext context) - { - String container; - - // determine which kind of container we need to return, if the - // external session flag is set then use the plain container - Object obj = context.getExternalContext().getSessionMap().get(EXTERNAL_CONTAINER_SESSION); - - if (obj != null && obj instanceof Boolean && ((Boolean)obj).booleanValue()) - { - if ((this.plainDialogContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - ConfigService configSvc = Application.getConfigService(context); - Config globalConfig = configSvc.getGlobalConfig(); - - if (globalConfig != null) - { - this.plainDialogContainer = globalConfig.getConfigElement("plain-dialog-container").getValue(); - } - } - - container = this.plainDialogContainer; - } - else - { - if ((this.dialogContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - ConfigService configSvc = Application.getConfigService(context); - Config globalConfig = configSvc.getGlobalConfig(); - - if (globalConfig != null) - { - this.dialogContainer = globalConfig.getConfigElement("dialog-container").getValue(); - } - } - - container = this.dialogContainer; - } - - if (logger.isDebugEnabled()) - logger.debug("Using dialog container: " + container); - - return container; - } - - /** - * Retrieves the configured wizard container page - * - * @param context FacesContext - * @return The container page - */ - protected String getWizardContainer(FacesContext context) - { - String container; - - // determine which kind of container we need to return, if the - // external session flag is set then use the plain container - Object obj = context.getExternalContext().getSessionMap().get(EXTERNAL_CONTAINER_SESSION); - - if (obj != null && obj instanceof Boolean && ((Boolean)obj).booleanValue()) - { - if ((this.plainWizardContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - ConfigService configSvc = Application.getConfigService(context); - Config globalConfig = configSvc.getGlobalConfig(); - - if (globalConfig != null) - { - this.plainWizardContainer = globalConfig.getConfigElement("plain-wizard-container").getValue(); - } - } - - container = this.plainWizardContainer; - } - else - { - if ((this.wizardContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - ConfigService configSvc = Application.getConfigService(context); - Config globalConfig = configSvc.getGlobalConfig(); - - if (globalConfig != null) - { - this.wizardContainer = globalConfig.getConfigElement("wizard-container").getValue(); - } - } - - container = this.wizardContainer; - } - - if (logger.isDebugEnabled()) - logger.debug("Using wizard container: " + container); - - return container; - } - - /** - * Returns the node currently in the dispatch context - * - * @return The node currently in the dispatch context or null if - * the dispatch context is empty - */ - protected Node getDispatchContextNode(FacesContext context) - { - Node dispatchNode = null; - - NavigationBean navBean = (NavigationBean)context.getExternalContext(). - getSessionMap().get(NavigationBean.BEAN_NAME); - - if (navBean != null) - { - dispatchNode = navBean.getDispatchContextNode(); - } - - return dispatchNode; - } - - protected void handleBrowseDispatch(FacesContext context, String fromAction, String outcome) - { - Node dispatchNode = null; - - NavigationBean navBean = (NavigationBean) context.getExternalContext().getSessionMap() - .get(NavigationBean.BEAN_NAME); - - if (navBean != null) - { - dispatchNode = navBean.getCurrentNode(); - } - - handleDispatch(context, fromAction, outcome, dispatchNode); - } - - /** - * Processes any dispatching that may need to occur - * - * @param context Faces context - * @param fromAction The from action - * @param outcome The outcome - */ - protected void handleDispatch(FacesContext context, String fromAction, String outcome) - { - Node dispatchNode = getDispatchContextNode(context); - handleDispatch(context, fromAction, outcome, dispatchNode); - } - - private void handleDispatch(FacesContext context, String fromAction, String outcome, Node dispatchNode) - { - if (dispatchNode != null) - { - if (logger.isDebugEnabled()) - logger.debug("Found node with type '" + dispatchNode.getType().toString() + - "' in dispatch context"); - - // get the current view id - String viewId = context.getViewRoot().getViewId(); - - // see if there is any navigation config for the node type - ConfigService configSvc = Application.getConfigService(context); - NavigationConfigElement navigationCfg = null; - try - { - Config nodeConfig = configSvc.getConfig(dispatchNode); - navigationCfg = (NavigationConfigElement)nodeConfig. - getConfigElement(NavigationElementReader.ELEMENT_NAVIGATION); - } - catch (InvalidNodeRefException e) - { - if (logger.isDebugEnabled()) logger.debug("Invalid node reference: " + dispatchNode); - } - - if (navigationCfg != null) - { - // see if there is config for the current view state - NavigationResult navResult = navigationCfg.getOverride(viewId, outcome); - - if (navResult != null) - { - if (logger.isDebugEnabled()) - logger.debug("Found navigation config: " + navResult); - - if (navResult.isOutcome()) - { - navigate(context, fromAction, navResult.getResult()); - } - else - { - String newViewId = navResult.getResult(); - - if (newViewId.equals(viewId) == false) - { - if (logger.isDebugEnabled()) - logger.debug("Dispatching to new view id: " + newViewId); - - goToView(context, newViewId); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("New view id is the same as the current one so setting outcome to null"); - - navigate(context, fromAction, null); - } - } - } - else - { - if (logger.isDebugEnabled()) - logger.debug("No override configuration found for current view or outcome"); - - navigate(context, fromAction, outcome); - } - } - else - { - if (logger.isDebugEnabled()) - logger.debug("No navigation configuration found for node"); - - navigate(context, fromAction, outcome); - } - - // reset the dispatch context - ((NavigationBean)context.getExternalContext().getSessionMap(). - get(NavigationBean.BEAN_NAME)).resetDispatchContext(); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("No dispatch context found"); - - // pass off to the original handler - navigate(context, fromAction, outcome); - } - } - - /** - * Opens a dialog - * - * @param context FacesContext - * @param fromAction The fromAction - * @param name The name of the dialog to open - */ - protected void handleDialogOpen(FacesContext context, String fromAction, String name) - { - if (logger.isDebugEnabled()) - logger.debug("Opening dialog '" + name + "'"); - - // firstly add the current view to the stack so we know where to go back to - addCurrentViewToStack(context); - - DialogConfig config = getDialogConfig(context, name, getDispatchContextNode(context)); - if (config != null) - { - if (logger.isDebugEnabled()) - logger.debug("Found config for dialog '" + name + "': " + config); - - // set the dialog manager up with the retrieved config - DialogManager dialogManager = Application.getDialogManager(); - dialogManager.setCurrentDialog(config); - - // retrieve the container page and navigate to it - goToView(context, getDialogContainer(context)); - } - else - { - //logger.warn("Failed to find configuration for dialog '" + name + "'"); - - // send the dialog name as the outcome to the original handler - handleDispatch(context, fromAction, name); - } - } - - /** - * Opens a wizard - * - * @param context FacesContext - * @param fromAction The fromAction - * @param name The name of the wizard to open - */ - protected void handleWizardOpen(FacesContext context, String fromAction, String name) - { - if (logger.isDebugEnabled()) - logger.debug("Opening wizard '" + name + "'"); - - // firstly add the current view to the stack so we know where to go back to - addCurrentViewToStack(context); - - WizardConfig wizard = getWizardConfig(context, name, getDispatchContextNode(context)); - if (wizard != null) - { - if (logger.isDebugEnabled()) - logger.debug("Found config for wizard '" + name + "': " + wizard); - - // set the wizard manager up with the retrieved config - WizardManager wizardManager = Application.getWizardManager(); - wizardManager.setCurrentWizard(wizard); - - // retrieve the container page and navigate to it - goToView(context, getWizardContainer(context)); - } - else - { - //logger.warn("Failed to find configuration for wizard '" + name + "'"); - - // send the dialog name as the outcome to the original handler - handleDispatch(context, fromAction, name); - } - } - - /** - * Closes the current dialog or wizard - * - * @param context FacesContext - * @param fromAction The fromAction - * @param outcome The outcome - * @param dialog true if a dialog is being closed, false if a wizard is being closed - */ - protected void handleDialogOrWizardClose(FacesContext context, String fromAction, String outcome, boolean dialog) - { - String closingItem = dialog ? "dialog" : "wizard"; - - // if we are closing a wizard or dialog take the view off the - // top of the stack then decide whether to use the view - // or any overridden outcome that may be present - if (getViewStack(context).empty() == false) - { - // is there an overidden outcome? - String overriddenOutcome = getOutcomeOverride(outcome); - if (overriddenOutcome == null) - { - // there isn't an overidden outcome so go back to the previous view - if (logger.isDebugEnabled()) - logger.debug("Closing " + closingItem); - - // determine how many levels of dialog we need to close - int numberToClose = getNumberToClose(outcome); - - Object stackObject = null; - if (numberToClose == 1) - { - // just closing one dialog so get the item from the top of the stack - stackObject = getViewStack(context).pop(); - - if (logger.isDebugEnabled()) - logger.debug("Popped item from the top of the view stack: " + stackObject); - } - else - { - // check there are enough items on the stack, if there - // isn't just get the last one (effectively going back - // to the beginning) - Stack viewStack = getViewStack(context); - int itemsOnStack = viewStack.size(); - if (itemsOnStack < numberToClose) - { - if (logger.isDebugEnabled()) - logger.debug("Returning to first item on the view stack as there aren't " + - numberToClose + " containers to close!"); - - numberToClose = itemsOnStack; - } - - // pop the right object from the stack - for (int x = 1; x <= numberToClose; x++) - { - stackObject = viewStack.pop(); - } - - if (logger.isDebugEnabled()) - logger.debug("Popped item from the stack: " + stackObject); - } - - // get the appropriate view id for the stack object - String newViewId = getViewIdFromStackObject(context, stackObject); - - // go to the appropraite page - goToView(context, newViewId); - } - else - { - // we also need to empty the dialog stack if we have been given - // an overidden outcome as we could be going anywhere in the app. - // grab the current top item first though in case we need to open - // another dialog or wizard - if (OUTCOME_BROWSE.equals(overriddenOutcome) == false) - { - String previousViewId = getViewIdFromStackObject(context, getViewStack(context).peek()); - getViewStack(context).clear(); - - if (logger.isDebugEnabled()) - logger.debug("Closing " + closingItem + " with an overridden outcome of '" + overriddenOutcome + "'"); - - // if the override is calling another dialog or wizard come back through - // the navigation handler from the beginning - if (isDialog(overriddenOutcome) || isWizard(overriddenOutcome)) - { - // set the view id to the page at the top of the stack so when - // the new dialog or wizard closes it goes back to the correct page - context.getViewRoot().setViewId(previousViewId); - - if (logger.isDebugEnabled()) - { - logger.debug("view stack: " + getViewStack(context)); - logger.debug("Opening '" + overriddenOutcome + "' after " + closingItem + - " close using view id: " + previousViewId); - } - - this.handleNavigation(context, fromAction, overriddenOutcome); - } - else - { - navigate(context, fromAction, overriddenOutcome); - } - } - else - { - handleBrowseDispatch(context, fromAction, overriddenOutcome); - - // ALF-6661, always clear the view stack with an overridden outcome - getViewStack(context).clear(); - } - } - } - else - { - // we are trying to close a dialog when one hasn't been opened! - // return to the main page of the app (print warning if debug is enabled) - if (logger.isDebugEnabled()) - { - logger.debug("Attempting to close a " + closingItem + " with an empty view stack, returning 'browse' outcome"); - } - - navigate(context, fromAction, OUTCOME_BROWSE); - } - } - - /** - * Returns the view id of the given item retrieved from the view stack. - * - * @param context FacesContext - * @param topOfStack The object retrieved from the view stack - * @return The view id - */ - protected String getViewIdFromStackObject(FacesContext context, Object topOfStack) - { - String viewId = null; - - // if the top of the stack is not a dialog or wizard just get the - // view id and navigate back to it. - - // if the top of the stack is a dialog or wizard retrieve the state - // and setup the appropriate manager with that state, then get the - // appropriate container page and navigate to it. - - if (topOfStack instanceof String) - { - viewId = (String)topOfStack; - } - else if (topOfStack instanceof DialogState) - { - // restore the dialog state and get the dialog container viewId - Application.getDialogManager().restoreState((DialogState)topOfStack); - viewId = getDialogContainer(context); - } - else if (topOfStack instanceof WizardState) - { - // restore the wizard state and get the wizard container viewId - Application.getWizardManager().restoreState((WizardState)topOfStack); - viewId = getWizardContainer(context); - } - else - { - if (logger.isWarnEnabled()) - logger.warn("Invalid object found on view stack: " + topOfStack); - } - - return viewId; - } - - /** - * Adds the current view to the stack (if required). - * If the current view is already the top of the stack it is not added again - * to stop the stack from growing and growing. - * - * @param context FacesContext - */ - @SuppressWarnings("unchecked") - protected void addCurrentViewToStack(FacesContext context) - { - // if the current viewId is either the dialog or wizard container page - // we need to save the state of the current dialog or wizard to the stack - - // If the current view is a normal page and it is not the same as the - // view currently at the top of the stack (you can't launch a dialog from - // the same page 2 times in a row so it must mean the user navigated away - // from the first dialog) just add the viewId to the stack - - // work out what to add to the stack - String viewId = context.getViewRoot().getViewId(); - String dialogContainer = getDialogContainer(context); - String wizardContainer = getWizardContainer(context); - Object objectForStack = null; - if (viewId.equals(dialogContainer)) - { - DialogManager dlgMgr = Application.getDialogManager(); - objectForStack = dlgMgr.getState(); - } - else if (viewId.equals(wizardContainer)) - { - WizardManager wizMgr = Application.getWizardManager(); - objectForStack = wizMgr.getState(); - } - else - { - objectForStack = viewId; - } - - // if the stack is currently empty add the item - Stack stack = getViewStack(context); - if (stack.empty()) - { - stack.push(objectForStack); - - if (logger.isDebugEnabled()) - logger.debug("Pushed item to view stack: " + objectForStack); - } - else - { - // if the item to go on to the stack and the top of - // stack are both Strings and equals to each other - // don't add anything to the stack to stop it - // growing unecessarily - Object topOfStack = stack.peek(); - if (objectForStack instanceof String && - topOfStack instanceof String && - topOfStack.equals(objectForStack)) - { - if (logger.isDebugEnabled()) - logger.debug("current view is already top of the view stack!"); - } - else - { - stack.push(objectForStack); - - if (logger.isDebugEnabled()) - logger.debug("Pushed item to view stack: " + objectForStack); - } - } - } - - /** - * Navigates to the appropriate page using the original navigation handler - * - * @param context FacesContext - * @param fromAction The fromAction - * @param outcome The outcome - */ - private void navigate(FacesContext context, String fromAction, String outcome) - { - if (logger.isDebugEnabled()) - logger.debug("Passing outcome '" + outcome + "' to original navigation handler"); - - this.origHandler.handleNavigation(context, fromAction, outcome); - } - - /** - * Dispatches to the given view id - * - * @param context Faces context - * @param viewId The view id to go to - */ - private void goToView(FacesContext context, String viewId) - { - ViewHandler viewHandler = context.getApplication().getViewHandler(); - UIViewRoot viewRoot = viewHandler.createView(context, viewId); - viewRoot.setViewId(viewId); - context.setViewRoot(viewRoot); - context.renderResponse(); - } - - /** - * Returns the view stack for the current user. - * - * @param context FacesContext - * @return A Stack representing the views that have launched dialogs in - * the users session, will never be null - */ - @SuppressWarnings("unchecked") - private Stack getViewStack(FacesContext context) - { - Stack viewStack = (Stack)context.getExternalContext().getSessionMap().get(VIEW_STACK); - - if (viewStack == null) - { - viewStack = new Stack(); - context.getExternalContext().getSessionMap().put(VIEW_STACK, viewStack); - } - - return viewStack; - } -} +package org.alfresco.web.app; + +import java.util.Stack; + +import javax.faces.application.NavigationHandler; +import javax.faces.application.ViewHandler; +import javax.faces.component.UIViewRoot; +import javax.faces.context.FacesContext; + +import org.springframework.extensions.config.Config; +import org.springframework.extensions.config.ConfigService; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.dialog.DialogManager; +import org.alfresco.web.bean.dialog.DialogState; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.wizard.WizardManager; +import org.alfresco.web.bean.wizard.WizardState; +import org.alfresco.web.config.DialogsConfigElement; +import org.alfresco.web.config.NavigationConfigElement; +import org.alfresco.web.config.NavigationElementReader; +import org.alfresco.web.config.NavigationResult; +import org.alfresco.web.config.WizardsConfigElement; +import org.alfresco.web.config.DialogsConfigElement.DialogConfig; +import org.alfresco.web.config.WizardsConfigElement.WizardConfig; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * @author gavinc + */ +public class AlfrescoNavigationHandler extends NavigationHandler +{ + public final static String OUTCOME_SEPARATOR = ":"; + public final static String OUTCOME_BROWSE = "browse"; + public final static String DIALOG_PREFIX = "dialog" + OUTCOME_SEPARATOR; + public final static String WIZARD_PREFIX = "wizard" + OUTCOME_SEPARATOR; + public final static String CLOSE_DIALOG_OUTCOME = DIALOG_PREFIX + "close"; + public final static String CLOSE_WIZARD_OUTCOME = WIZARD_PREFIX + "close"; + public final static String CLOSE_MULTIPLE_START = "["; + public final static String CLOSE_MULTIPLE_END = "]"; + public final static String EXTERNAL_CONTAINER_SESSION = "externalDialogContainer"; + + protected String dialogContainer = null; + protected String wizardContainer = null; + protected String plainDialogContainer = null; + protected String plainWizardContainer = null; + + private final static Log logger = LogFactory.getLog(AlfrescoNavigationHandler.class); + private final static String VIEW_STACK = "_alfViewStack"; + + // The original navigation handler + private NavigationHandler origHandler; + + /** + * Default constructor + * + * @param origHandler The original navigation handler + */ + public AlfrescoNavigationHandler(NavigationHandler origHandler) + { + super(); + this.origHandler = origHandler; + } + + /** + * @see javax.faces.application.NavigationHandler#handleNavigation(javax.faces.context.FacesContext, java.lang.String, java.lang.String) + */ + @Override + @SuppressWarnings("unchecked") + public void handleNavigation(FacesContext context, String fromAction, String outcome) + { + if (logger.isDebugEnabled()) + { + logger.debug("handleNavigation (fromAction=" + fromAction + ", outcome=" + outcome + ")"); + logger.debug("Current view id: " + context.getViewRoot().getViewId()); + } + + boolean isDialog = isDialog(outcome); + if (isDialog || isWizard(outcome)) + { + boolean dialogWizardClosing = isDialogOrWizardClosing(outcome); + outcome = stripPrefix(outcome); + + if (dialogWizardClosing) + { + handleDialogOrWizardClose(context, fromAction, outcome, isDialog); + } + else + { + if (isDialog) + { + handleDialogOpen(context, fromAction, outcome); + } + else + { + handleWizardOpen(context, fromAction, outcome); + } + } + } + else + { + if (isWizardStep(fromAction)) + { + goToView(context, getWizardContainer(context)); + } + else + { + handleDispatch(context, fromAction, outcome); + } + } + + // reset the dispatch context + Object bean = FacesHelper.getManagedBean(context, NavigationBean.BEAN_NAME); + if (bean instanceof NavigationBean) + { + ((NavigationBean)bean).resetDispatchContext(); + } + + if (logger.isDebugEnabled()) + logger.debug("view stack: " + getViewStack(context)); + } + + /** + * Determines whether the given outcome is dialog related + * + * @param outcome The outcome to test + * @return true if outcome is dialog related i.e. starts with dialog: + */ + protected boolean isDialog(String outcome) + { + boolean dialog = false; + + if (outcome != null && outcome.startsWith(DIALOG_PREFIX)) + { + dialog = true; + } + + return dialog; + } + + /** + * Determines whether the given outcome is wizard related + * + * @param outcome The outcome to test + * @return true if outcome is wizard related + * i.e. starts with create-wizard: or edit-wizard: + */ + protected boolean isWizard(String outcome) + { + boolean wizard = false; + + if (outcome != null && outcome.startsWith(WIZARD_PREFIX)) + { + wizard = true; + } + + return wizard; + } + + /** + * Determines whether the given outcome represents a dialog or wizard closing + * + * @param outcome The outcome to test + * @return true if the outcome represents a closing dialog or wizard + */ + protected boolean isDialogOrWizardClosing(String outcome) + { + boolean closing = false; + + if (outcome != null && + (outcome.startsWith(CLOSE_DIALOG_OUTCOME) || + outcome.startsWith(CLOSE_WIZARD_OUTCOME))) + { + closing = true; + } + + return closing; + } + + protected int getNumberToClose(String outcome) + { + int toClose = 1; + + int idxStart = outcome.indexOf(CLOSE_MULTIPLE_START); + if (outcome != null && idxStart != -1) + { + int idxEnd = outcome.indexOf(CLOSE_MULTIPLE_END); + if (idxEnd != -1) + { + String closeNum = outcome.substring(idxStart+1, idxEnd); + try + { + toClose = Integer.parseInt(closeNum); + } + catch (NumberFormatException nfe) + { + if (logger.isWarnEnabled()) + logger.warn("Could not determine number of containers to close, defaulting to 1"); + } + } + + if (logger.isDebugEnabled()) + logger.debug("Closing " + toClose + " levels of container"); + } + + return toClose; + } + + /** + * Determines whether the given fromAction represents a step in the wizard + * i.e. next or back + * + * @param fromAction The fromAction + * @return true if the from action represents a wizard step + */ + protected boolean isWizardStep(String fromAction) + { + boolean wizardStep = false; + + if (fromAction != null && + (fromAction.equals("#{WizardManager.next}") || fromAction.equals("#{WizardManager.back}"))) + { + wizardStep = true; + } + + return wizardStep; + } + + /** + * Removes the dialog or wizard prefix from the given outcome + * + * @param outcome The outcome to remove the prefix from + * @return The remaining outcome + */ + protected String stripPrefix(String outcome) + { + String newOutcome = outcome; + + if (outcome != null) + { + int idx = outcome.indexOf(OUTCOME_SEPARATOR); + if (idx != -1) + { + newOutcome = outcome.substring(idx+1); + } + } + + return newOutcome; + } + + /** + * Returns the overridden outcome. + * Used by dialogs and wizards to go to a particular page after it closes + * rather than back to the page it was launched from. + * + * @param outcome The current outcome + * @return The overridden outcome or null if there isn't an override + */ + protected String getOutcomeOverride(String outcome) + { + String override = null; + + if (outcome != null) + { + int idx = outcome.indexOf(OUTCOME_SEPARATOR); + if (idx != -1) + { + override = outcome.substring(idx+1); + } + } + + return override; + } + + /** + * Returns the dialog configuration object for the given dialog name. + * If there is a node in the dispatch context a lookup is performed using + * the node otherwise the global config section is used. + * + * + * @param name The name of dialog being launched + * @param dispatchContext The node being acted upon + * @return The DialogConfig for the dialog or null if no config could be found + */ + protected DialogConfig getDialogConfig(FacesContext context, String name, Node dispatchContext) + { + DialogConfig dialogConfig = null; + ConfigService configSvc = Application.getConfigService(context); + + Config config = null; + + if (dispatchContext != null) + { + if (logger.isDebugEnabled()) + logger.debug("Using dispatch context for dialog lookup: " + + dispatchContext.getType().toString()); + + // use the node to perform the lookup (this will include the global section) + config = configSvc.getConfig(dispatchContext); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("Looking up dialog in global config"); + + // just use the global + config = configSvc.getGlobalConfig(); + } + + if (config != null) + { + DialogsConfigElement dialogsCfg = (DialogsConfigElement)config.getConfigElement( + DialogsConfigElement.CONFIG_ELEMENT_ID); + if (dialogsCfg != null) + { + dialogConfig = dialogsCfg.getDialog(name); + } + } + + return dialogConfig; + } + + /** + * Returns the wizard configuration object for the given wizard name. + * If there is a node in the dispatch context a lookup is performed using + * the node otherwise the global config section is used. + * + * @param name The name of wizard being launched + * @param dispatchContext The node being acted upon + * @return The WizardConfig for the wizard or null if no config could be found + */ + protected WizardConfig getWizardConfig(FacesContext context, String name, Node dispatchContext) + { + WizardConfig wizardConfig = null; + ConfigService configSvc = Application.getConfigService(context); + + Config config = null; + + if (dispatchContext != null) + { + if (logger.isDebugEnabled()) + logger.debug("Using dispatch context for wizard lookup: " + + dispatchContext.getType().toString()); + + // use the node to perform the lookup (this will include the global section) + config = configSvc.getConfig(dispatchContext); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("Looking up wizard in global config"); + + // just use the global + config = configSvc.getGlobalConfig(); + } + + if (config != null) + { + WizardsConfigElement wizardsCfg = (WizardsConfigElement)config.getConfigElement( + WizardsConfigElement.CONFIG_ELEMENT_ID); + if (wizardsCfg != null) + { + wizardConfig = wizardsCfg.getWizard(name); + } + } + + return wizardConfig; + } + + /** + * Retrieves the configured dialog container page + * + * @param context FacesContext + * @return The container page + */ + protected String getDialogContainer(FacesContext context) + { + String container; + + // determine which kind of container we need to return, if the + // external session flag is set then use the plain container + Object obj = context.getExternalContext().getSessionMap().get(EXTERNAL_CONTAINER_SESSION); + + if (obj != null && obj instanceof Boolean && ((Boolean)obj).booleanValue()) + { + if ((this.plainDialogContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + ConfigService configSvc = Application.getConfigService(context); + Config globalConfig = configSvc.getGlobalConfig(); + + if (globalConfig != null) + { + this.plainDialogContainer = globalConfig.getConfigElement("plain-dialog-container").getValue(); + } + } + + container = this.plainDialogContainer; + } + else + { + if ((this.dialogContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + ConfigService configSvc = Application.getConfigService(context); + Config globalConfig = configSvc.getGlobalConfig(); + + if (globalConfig != null) + { + this.dialogContainer = globalConfig.getConfigElement("dialog-container").getValue(); + } + } + + container = this.dialogContainer; + } + + if (logger.isDebugEnabled()) + logger.debug("Using dialog container: " + container); + + return container; + } + + /** + * Retrieves the configured wizard container page + * + * @param context FacesContext + * @return The container page + */ + protected String getWizardContainer(FacesContext context) + { + String container; + + // determine which kind of container we need to return, if the + // external session flag is set then use the plain container + Object obj = context.getExternalContext().getSessionMap().get(EXTERNAL_CONTAINER_SESSION); + + if (obj != null && obj instanceof Boolean && ((Boolean)obj).booleanValue()) + { + if ((this.plainWizardContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + ConfigService configSvc = Application.getConfigService(context); + Config globalConfig = configSvc.getGlobalConfig(); + + if (globalConfig != null) + { + this.plainWizardContainer = globalConfig.getConfigElement("plain-wizard-container").getValue(); + } + } + + container = this.plainWizardContainer; + } + else + { + if ((this.wizardContainer == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + ConfigService configSvc = Application.getConfigService(context); + Config globalConfig = configSvc.getGlobalConfig(); + + if (globalConfig != null) + { + this.wizardContainer = globalConfig.getConfigElement("wizard-container").getValue(); + } + } + + container = this.wizardContainer; + } + + if (logger.isDebugEnabled()) + logger.debug("Using wizard container: " + container); + + return container; + } + + /** + * Returns the node currently in the dispatch context + * + * @return The node currently in the dispatch context or null if + * the dispatch context is empty + */ + protected Node getDispatchContextNode(FacesContext context) + { + Node dispatchNode = null; + + NavigationBean navBean = (NavigationBean)context.getExternalContext(). + getSessionMap().get(NavigationBean.BEAN_NAME); + + if (navBean != null) + { + dispatchNode = navBean.getDispatchContextNode(); + } + + return dispatchNode; + } + + protected void handleBrowseDispatch(FacesContext context, String fromAction, String outcome) + { + Node dispatchNode = null; + + NavigationBean navBean = (NavigationBean) context.getExternalContext().getSessionMap() + .get(NavigationBean.BEAN_NAME); + + if (navBean != null) + { + dispatchNode = navBean.getCurrentNode(); + } + + handleDispatch(context, fromAction, outcome, dispatchNode); + } + + /** + * Processes any dispatching that may need to occur + * + * @param context Faces context + * @param fromAction The from action + * @param outcome The outcome + */ + protected void handleDispatch(FacesContext context, String fromAction, String outcome) + { + Node dispatchNode = getDispatchContextNode(context); + handleDispatch(context, fromAction, outcome, dispatchNode); + } + + private void handleDispatch(FacesContext context, String fromAction, String outcome, Node dispatchNode) + { + if (dispatchNode != null) + { + if (logger.isDebugEnabled()) + logger.debug("Found node with type '" + dispatchNode.getType().toString() + + "' in dispatch context"); + + // get the current view id + String viewId = context.getViewRoot().getViewId(); + + // see if there is any navigation config for the node type + ConfigService configSvc = Application.getConfigService(context); + NavigationConfigElement navigationCfg = null; + try + { + Config nodeConfig = configSvc.getConfig(dispatchNode); + navigationCfg = (NavigationConfigElement)nodeConfig. + getConfigElement(NavigationElementReader.ELEMENT_NAVIGATION); + } + catch (InvalidNodeRefException e) + { + if (logger.isDebugEnabled()) logger.debug("Invalid node reference: " + dispatchNode); + } + + if (navigationCfg != null) + { + // see if there is config for the current view state + NavigationResult navResult = navigationCfg.getOverride(viewId, outcome); + + if (navResult != null) + { + if (logger.isDebugEnabled()) + logger.debug("Found navigation config: " + navResult); + + if (navResult.isOutcome()) + { + navigate(context, fromAction, navResult.getResult()); + } + else + { + String newViewId = navResult.getResult(); + + if (newViewId.equals(viewId) == false) + { + if (logger.isDebugEnabled()) + logger.debug("Dispatching to new view id: " + newViewId); + + goToView(context, newViewId); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("New view id is the same as the current one so setting outcome to null"); + + navigate(context, fromAction, null); + } + } + } + else + { + if (logger.isDebugEnabled()) + logger.debug("No override configuration found for current view or outcome"); + + navigate(context, fromAction, outcome); + } + } + else + { + if (logger.isDebugEnabled()) + logger.debug("No navigation configuration found for node"); + + navigate(context, fromAction, outcome); + } + + // reset the dispatch context + ((NavigationBean)context.getExternalContext().getSessionMap(). + get(NavigationBean.BEAN_NAME)).resetDispatchContext(); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("No dispatch context found"); + + // pass off to the original handler + navigate(context, fromAction, outcome); + } + } + + /** + * Opens a dialog + * + * @param context FacesContext + * @param fromAction The fromAction + * @param name The name of the dialog to open + */ + protected void handleDialogOpen(FacesContext context, String fromAction, String name) + { + if (logger.isDebugEnabled()) + logger.debug("Opening dialog '" + name + "'"); + + // firstly add the current view to the stack so we know where to go back to + addCurrentViewToStack(context); + + DialogConfig config = getDialogConfig(context, name, getDispatchContextNode(context)); + if (config != null) + { + if (logger.isDebugEnabled()) + logger.debug("Found config for dialog '" + name + "': " + config); + + // set the dialog manager up with the retrieved config + DialogManager dialogManager = Application.getDialogManager(); + dialogManager.setCurrentDialog(config); + + // retrieve the container page and navigate to it + goToView(context, getDialogContainer(context)); + } + else + { + //logger.warn("Failed to find configuration for dialog '" + name + "'"); + + // send the dialog name as the outcome to the original handler + handleDispatch(context, fromAction, name); + } + } + + /** + * Opens a wizard + * + * @param context FacesContext + * @param fromAction The fromAction + * @param name The name of the wizard to open + */ + protected void handleWizardOpen(FacesContext context, String fromAction, String name) + { + if (logger.isDebugEnabled()) + logger.debug("Opening wizard '" + name + "'"); + + // firstly add the current view to the stack so we know where to go back to + addCurrentViewToStack(context); + + WizardConfig wizard = getWizardConfig(context, name, getDispatchContextNode(context)); + if (wizard != null) + { + if (logger.isDebugEnabled()) + logger.debug("Found config for wizard '" + name + "': " + wizard); + + // set the wizard manager up with the retrieved config + WizardManager wizardManager = Application.getWizardManager(); + wizardManager.setCurrentWizard(wizard); + + // retrieve the container page and navigate to it + goToView(context, getWizardContainer(context)); + } + else + { + //logger.warn("Failed to find configuration for wizard '" + name + "'"); + + // send the dialog name as the outcome to the original handler + handleDispatch(context, fromAction, name); + } + } + + /** + * Closes the current dialog or wizard + * + * @param context FacesContext + * @param fromAction The fromAction + * @param outcome The outcome + * @param dialog true if a dialog is being closed, false if a wizard is being closed + */ + protected void handleDialogOrWizardClose(FacesContext context, String fromAction, String outcome, boolean dialog) + { + String closingItem = dialog ? "dialog" : "wizard"; + + // if we are closing a wizard or dialog take the view off the + // top of the stack then decide whether to use the view + // or any overridden outcome that may be present + if (getViewStack(context).empty() == false) + { + // is there an overidden outcome? + String overriddenOutcome = getOutcomeOverride(outcome); + if (overriddenOutcome == null) + { + // there isn't an overidden outcome so go back to the previous view + if (logger.isDebugEnabled()) + logger.debug("Closing " + closingItem); + + // determine how many levels of dialog we need to close + int numberToClose = getNumberToClose(outcome); + + Object stackObject = null; + if (numberToClose == 1) + { + // just closing one dialog so get the item from the top of the stack + stackObject = getViewStack(context).pop(); + + if (logger.isDebugEnabled()) + logger.debug("Popped item from the top of the view stack: " + stackObject); + } + else + { + // check there are enough items on the stack, if there + // isn't just get the last one (effectively going back + // to the beginning) + Stack viewStack = getViewStack(context); + int itemsOnStack = viewStack.size(); + if (itemsOnStack < numberToClose) + { + if (logger.isDebugEnabled()) + logger.debug("Returning to first item on the view stack as there aren't " + + numberToClose + " containers to close!"); + + numberToClose = itemsOnStack; + } + + // pop the right object from the stack + for (int x = 1; x <= numberToClose; x++) + { + stackObject = viewStack.pop(); + } + + if (logger.isDebugEnabled()) + logger.debug("Popped item from the stack: " + stackObject); + } + + // get the appropriate view id for the stack object + String newViewId = getViewIdFromStackObject(context, stackObject); + + // go to the appropraite page + goToView(context, newViewId); + } + else + { + // we also need to empty the dialog stack if we have been given + // an overidden outcome as we could be going anywhere in the app. + // grab the current top item first though in case we need to open + // another dialog or wizard + if (OUTCOME_BROWSE.equals(overriddenOutcome) == false) + { + String previousViewId = getViewIdFromStackObject(context, getViewStack(context).peek()); + getViewStack(context).clear(); + + if (logger.isDebugEnabled()) + logger.debug("Closing " + closingItem + " with an overridden outcome of '" + overriddenOutcome + "'"); + + // if the override is calling another dialog or wizard come back through + // the navigation handler from the beginning + if (isDialog(overriddenOutcome) || isWizard(overriddenOutcome)) + { + // set the view id to the page at the top of the stack so when + // the new dialog or wizard closes it goes back to the correct page + context.getViewRoot().setViewId(previousViewId); + + if (logger.isDebugEnabled()) + { + logger.debug("view stack: " + getViewStack(context)); + logger.debug("Opening '" + overriddenOutcome + "' after " + closingItem + + " close using view id: " + previousViewId); + } + + this.handleNavigation(context, fromAction, overriddenOutcome); + } + else + { + navigate(context, fromAction, overriddenOutcome); + } + } + else + { + handleBrowseDispatch(context, fromAction, overriddenOutcome); + + // ALF-6661, always clear the view stack with an overridden outcome + getViewStack(context).clear(); + } + } + } + else + { + // we are trying to close a dialog when one hasn't been opened! + // return to the main page of the app (print warning if debug is enabled) + if (logger.isDebugEnabled()) + { + logger.debug("Attempting to close a " + closingItem + " with an empty view stack, returning 'browse' outcome"); + } + + navigate(context, fromAction, OUTCOME_BROWSE); + } + } + + /** + * Returns the view id of the given item retrieved from the view stack. + * + * @param context FacesContext + * @param topOfStack The object retrieved from the view stack + * @return The view id + */ + protected String getViewIdFromStackObject(FacesContext context, Object topOfStack) + { + String viewId = null; + + // if the top of the stack is not a dialog or wizard just get the + // view id and navigate back to it. + + // if the top of the stack is a dialog or wizard retrieve the state + // and setup the appropriate manager with that state, then get the + // appropriate container page and navigate to it. + + if (topOfStack instanceof String) + { + viewId = (String)topOfStack; + } + else if (topOfStack instanceof DialogState) + { + // restore the dialog state and get the dialog container viewId + Application.getDialogManager().restoreState((DialogState)topOfStack); + viewId = getDialogContainer(context); + } + else if (topOfStack instanceof WizardState) + { + // restore the wizard state and get the wizard container viewId + Application.getWizardManager().restoreState((WizardState)topOfStack); + viewId = getWizardContainer(context); + } + else + { + if (logger.isWarnEnabled()) + logger.warn("Invalid object found on view stack: " + topOfStack); + } + + return viewId; + } + + /** + * Adds the current view to the stack (if required). + * If the current view is already the top of the stack it is not added again + * to stop the stack from growing and growing. + * + * @param context FacesContext + */ + @SuppressWarnings("unchecked") + protected void addCurrentViewToStack(FacesContext context) + { + // if the current viewId is either the dialog or wizard container page + // we need to save the state of the current dialog or wizard to the stack + + // If the current view is a normal page and it is not the same as the + // view currently at the top of the stack (you can't launch a dialog from + // the same page 2 times in a row so it must mean the user navigated away + // from the first dialog) just add the viewId to the stack + + // work out what to add to the stack + String viewId = context.getViewRoot().getViewId(); + String dialogContainer = getDialogContainer(context); + String wizardContainer = getWizardContainer(context); + Object objectForStack = null; + if (viewId.equals(dialogContainer)) + { + DialogManager dlgMgr = Application.getDialogManager(); + objectForStack = dlgMgr.getState(); + } + else if (viewId.equals(wizardContainer)) + { + WizardManager wizMgr = Application.getWizardManager(); + objectForStack = wizMgr.getState(); + } + else + { + objectForStack = viewId; + } + + // if the stack is currently empty add the item + Stack stack = getViewStack(context); + if (stack.empty()) + { + stack.push(objectForStack); + + if (logger.isDebugEnabled()) + logger.debug("Pushed item to view stack: " + objectForStack); + } + else + { + // if the item to go on to the stack and the top of + // stack are both Strings and equals to each other + // don't add anything to the stack to stop it + // growing unecessarily + Object topOfStack = stack.peek(); + if (objectForStack instanceof String && + topOfStack instanceof String && + topOfStack.equals(objectForStack)) + { + if (logger.isDebugEnabled()) + logger.debug("current view is already top of the view stack!"); + } + else + { + stack.push(objectForStack); + + if (logger.isDebugEnabled()) + logger.debug("Pushed item to view stack: " + objectForStack); + } + } + } + + /** + * Navigates to the appropriate page using the original navigation handler + * + * @param context FacesContext + * @param fromAction The fromAction + * @param outcome The outcome + */ + private void navigate(FacesContext context, String fromAction, String outcome) + { + if (logger.isDebugEnabled()) + logger.debug("Passing outcome '" + outcome + "' to original navigation handler"); + + this.origHandler.handleNavigation(context, fromAction, outcome); + } + + /** + * Dispatches to the given view id + * + * @param context Faces context + * @param viewId The view id to go to + */ + private void goToView(FacesContext context, String viewId) + { + ViewHandler viewHandler = context.getApplication().getViewHandler(); + UIViewRoot viewRoot = viewHandler.createView(context, viewId); + viewRoot.setViewId(viewId); + context.setViewRoot(viewRoot); + context.renderResponse(); + } + + /** + * Returns the view stack for the current user. + * + * @param context FacesContext + * @return A Stack representing the views that have launched dialogs in + * the users session, will never be null + */ + @SuppressWarnings("unchecked") + private Stack getViewStack(FacesContext context) + { + Stack viewStack = (Stack)context.getExternalContext().getSessionMap().get(VIEW_STACK); + + if (viewStack == null) + { + viewStack = new Stack(); + context.getExternalContext().getSessionMap().put(VIEW_STACK, viewStack); + } + + return viewStack; + } +} diff --git a/source/java/org/alfresco/web/app/AlfrescoVariableResolver.java b/source/java/org/alfresco/web/app/AlfrescoVariableResolver.java index c67dbb7b7f..b9c4488132 100644 --- a/source/java/org/alfresco/web/app/AlfrescoVariableResolver.java +++ b/source/java/org/alfresco/web/app/AlfrescoVariableResolver.java @@ -1,152 +1,152 @@ -package org.alfresco.web.app; - -import java.util.ArrayList; -import java.util.List; - -import javax.faces.context.FacesContext; -import javax.faces.el.EvaluationException; -import javax.faces.el.VariableResolver; - -import org.springframework.extensions.config.Config; -import org.springframework.extensions.config.ConfigService; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.web.jsf.DelegatingVariableResolver; - -/** - * JSF VariableResolver that first delegates to the Spring JSF variable - * resolver. The sole purpose of this variable resolver is to look out - * for the Container variable. If this variable is encountered - * the current viewId is examined. If the current viewId matches a - * configured dialog or wizard container the appropriate manager object is - * returned i.e. DialogManager or WizardManager. - * - *

Configure this resolver in your faces-config.xml file as follows: - * - * 

- * <application>
- *   ...
- *   <variable-resolver>org.alfresco.web.app.AlfrescoVariableResolver</variable-resolver>
- * </application>
- * - * @see org.alfresco.web.bean.dialog.DialogManager - * @see org.alfresco.web.bean.wizard.WizardManager - * @author gavinc - */ -public class AlfrescoVariableResolver extends DelegatingVariableResolver -{ - protected List dialogContainers = null; - protected List wizardContainers = null; - - private static final String CONTAINER = "Container"; - - private static final Log logger = LogFactory.getLog(AlfrescoVariableResolver.class); - - /** - * Creates a new VariableResolver. - * - * @param originalVariableResolver The original variable resolver - */ - public AlfrescoVariableResolver(VariableResolver originalVariableResolver) - { - super(originalVariableResolver); - } - - /** - * Resolves the variable with the given name. - *

- * This implementation will first delegate to the Spring variable resolver. - * If the variable is not found by the Spring resolver and the variable name - * is Container the current viewId is examined. - * If the current viewId matches a configured dialog or wizard container - * the appropriate manager object is returned i.e. DialogManager or WizardManager. - * - * @param context FacesContext - * @param name The name of the variable to resolve - */ - public Object resolveVariable(FacesContext context, String name) - throws EvaluationException - { - Object variable = super.resolveVariable(context, name); - - if (variable == null) - { - // if the variable was not resolved see if the name is "Container" - if (name.equals(CONTAINER)) - { - // get the current view id and the configured dialog and wizard - // container pages - String viewId = context.getViewRoot().getViewId(); - List dialogContainers = getDialogContainers(context); - List wizardContainers = getWizardContainers(context); - - // see if we are currently in a wizard or a dialog - if (dialogContainers.contains(viewId)) - { - variable = Application.getDialogManager(); - } - else if (wizardContainers.contains(viewId)) - { - variable = Application.getWizardManager(); - } - - if (variable != null && logger.isDebugEnabled()) - { - logger.debug("Resolved 'Container' variable to: " + variable); - } - } - } - - return variable; - } - - /** - * Retrieves the list of configured dialog container pages - * - * @param context FacesContext - * @return The container pages - */ - protected List getDialogContainers(FacesContext context) - { - if ((this.dialogContainers == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - this.dialogContainers = new ArrayList(2); - - ConfigService configSvc = Application.getConfigService(context); - Config globalConfig = configSvc.getGlobalConfig(); - - if (globalConfig != null) - { - this.dialogContainers.add(globalConfig.getConfigElement("dialog-container").getValue()); - this.dialogContainers.add(globalConfig.getConfigElement("plain-dialog-container").getValue()); - } - } - - return this.dialogContainers; - } - - /** - * Retrieves the list of configured wizard container pages - * - * @param context FacesContext - * @return The container page - */ - protected List getWizardContainers(FacesContext context) - { - if ((this.wizardContainers == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - this.wizardContainers = new ArrayList(2); - - ConfigService configSvc = Application.getConfigService(context); - Config globalConfig = configSvc.getGlobalConfig(); - - if (globalConfig != null) - { - this.wizardContainers.add(globalConfig.getConfigElement("wizard-container").getValue()); - this.wizardContainers.add(globalConfig.getConfigElement("plain-wizard-container").getValue()); - } - } - - return this.wizardContainers; - } -} +package org.alfresco.web.app; + +import java.util.ArrayList; +import java.util.List; + +import javax.faces.context.FacesContext; +import javax.faces.el.EvaluationException; +import javax.faces.el.VariableResolver; + +import org.springframework.extensions.config.Config; +import org.springframework.extensions.config.ConfigService; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.web.jsf.DelegatingVariableResolver; + +/** + * JSF VariableResolver that first delegates to the Spring JSF variable + * resolver. The sole purpose of this variable resolver is to look out + * for the Container variable. If this variable is encountered + * the current viewId is examined. If the current viewId matches a + * configured dialog or wizard container the appropriate manager object is + * returned i.e. DialogManager or WizardManager. + * + *

Configure this resolver in your faces-config.xml file as follows: + * + * 

+ * <application>
+ *   ...
+ *   <variable-resolver>org.alfresco.web.app.AlfrescoVariableResolver</variable-resolver>
+ * </application>
+ * + * @see org.alfresco.web.bean.dialog.DialogManager + * @see org.alfresco.web.bean.wizard.WizardManager + * @author gavinc + */ +public class AlfrescoVariableResolver extends DelegatingVariableResolver +{ + protected List dialogContainers = null; + protected List wizardContainers = null; + + private static final String CONTAINER = "Container"; + + private static final Log logger = LogFactory.getLog(AlfrescoVariableResolver.class); + + /** + * Creates a new VariableResolver. + * + * @param originalVariableResolver The original variable resolver + */ + public AlfrescoVariableResolver(VariableResolver originalVariableResolver) + { + super(originalVariableResolver); + } + + /** + * Resolves the variable with the given name. + *

+ * This implementation will first delegate to the Spring variable resolver. + * If the variable is not found by the Spring resolver and the variable name + * is Container the current viewId is examined. + * If the current viewId matches a configured dialog or wizard container + * the appropriate manager object is returned i.e. DialogManager or WizardManager. + * + * @param context FacesContext + * @param name The name of the variable to resolve + */ + public Object resolveVariable(FacesContext context, String name) + throws EvaluationException + { + Object variable = super.resolveVariable(context, name); + + if (variable == null) + { + // if the variable was not resolved see if the name is "Container" + if (name.equals(CONTAINER)) + { + // get the current view id and the configured dialog and wizard + // container pages + String viewId = context.getViewRoot().getViewId(); + List dialogContainers = getDialogContainers(context); + List wizardContainers = getWizardContainers(context); + + // see if we are currently in a wizard or a dialog + if (dialogContainers.contains(viewId)) + { + variable = Application.getDialogManager(); + } + else if (wizardContainers.contains(viewId)) + { + variable = Application.getWizardManager(); + } + + if (variable != null && logger.isDebugEnabled()) + { + logger.debug("Resolved 'Container' variable to: " + variable); + } + } + } + + return variable; + } + + /** + * Retrieves the list of configured dialog container pages + * + * @param context FacesContext + * @return The container pages + */ + protected List getDialogContainers(FacesContext context) + { + if ((this.dialogContainers == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + this.dialogContainers = new ArrayList(2); + + ConfigService configSvc = Application.getConfigService(context); + Config globalConfig = configSvc.getGlobalConfig(); + + if (globalConfig != null) + { + this.dialogContainers.add(globalConfig.getConfigElement("dialog-container").getValue()); + this.dialogContainers.add(globalConfig.getConfigElement("plain-dialog-container").getValue()); + } + } + + return this.dialogContainers; + } + + /** + * Retrieves the list of configured wizard container pages + * + * @param context FacesContext + * @return The container page + */ + protected List getWizardContainers(FacesContext context) + { + if ((this.wizardContainers == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + this.wizardContainers = new ArrayList(2); + + ConfigService configSvc = Application.getConfigService(context); + Config globalConfig = configSvc.getGlobalConfig(); + + if (globalConfig != null) + { + this.wizardContainers.add(globalConfig.getConfigElement("wizard-container").getValue()); + this.wizardContainers.add(globalConfig.getConfigElement("plain-wizard-container").getValue()); + } + } + + return this.wizardContainers; + } +} diff --git a/source/java/org/alfresco/web/app/DebugPhaseListener.java b/source/java/org/alfresco/web/app/DebugPhaseListener.java index 599127005b..6e41fb0764 100644 --- a/source/java/org/alfresco/web/app/DebugPhaseListener.java +++ b/source/java/org/alfresco/web/app/DebugPhaseListener.java @@ -1,99 +1,99 @@ -package org.alfresco.web.app; - -import java.util.ArrayList; -import java.util.List; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.event.PhaseEvent; -import javax.faces.event.PhaseId; -import javax.faces.event.PhaseListener; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Debug phase listener that simply logs when each phase is entered and exited. - * - * @author gavinc - */ -public class DebugPhaseListener implements PhaseListener -{ - private static final Log logger = LogFactory.getLog(DebugPhaseListener.class); - - public int indent = 0; - public static final String INDENT = " "; - - /** - * @see javax.faces.event.PhaseListener#afterPhase(javax.faces.event.PhaseEvent) - */ - public void afterPhase(PhaseEvent event) - { - if (logger.isDebugEnabled()) - { - if (event.getPhaseId() == PhaseId.RENDER_RESPONSE) - { - printComponentTree(FacesContext.getCurrentInstance().getViewRoot()); - } - - logger.debug("********** Exiting phase: " + event.getPhaseId().toString()); - } - } - - /** - * @see javax.faces.event.PhaseListener#beforePhase(javax.faces.event.PhaseEvent) - */ - public void beforePhase(PhaseEvent event) - { - if (logger.isDebugEnabled()) - logger.debug("********** Entering phase: " + event.getPhaseId().toString()); - } - - /** - * @see javax.faces.event.PhaseListener#getPhaseId() - */ - public PhaseId getPhaseId() - { - return PhaseId.ANY_PHASE; - } - - public void printComponentTree(UIComponent comp) - { - printComponentInfo(comp); - - List complist = comp.getChildren(); - if (complist.size()>0) - indent++; - for (int i = 0; i < complist.size(); i++) - { - UIComponent uicom = (UIComponent) complist.get(i); - printComponentTree(uicom); - if (i+1 == complist.size()) - indent--; - } - } - - public void printComponentInfo(UIComponent comp) - { - if (comp.getId() == null) - { - logger.debug("UIViewRoot" + " " + "(" + comp.getClass().getName() + ")"); - } - else - { - logger.debug(getIndent() + "|"); - logger.debug(getIndent() + comp.getId() + " " + "(" + comp.getClass().getName() + ")"); - } - } - - public String getIndent() - { - String indent = ""; - for (int i=0; i0) + indent++; + for (int i = 0; i < complist.size(); i++) + { + UIComponent uicom = (UIComponent) complist.get(i); + printComponentTree(uicom); + if (i+1 == complist.size()) + indent--; + } + } + + public void printComponentInfo(UIComponent comp) + { + if (comp.getId() == null) + { + logger.debug("UIViewRoot" + " " + "(" + comp.getClass().getName() + ")"); + } + else + { + logger.debug(getIndent() + "|"); + logger.debug(getIndent() + comp.getId() + " " + "(" + comp.getClass().getName() + ")"); + } + } + + public String getIndent() + { + String indent = ""; + for (int i=0; i - * This will show all debug entries from this class as though they - * came from the subclass. - * - * @return The logger - */ - protected abstract Log getLogger(); - - /** - * Processes the download request using the current context i.e. no authentication checks are made, it is presumed - * they have already been done. - * - * @param req - * The HTTP request - * @param res - * The HTTP response - * @param allowLogIn - * Indicates whether guest users without access to the content should be redirected to the log in page. If - * false, a status 403 forbidden page is displayed instead. - */ - protected void processDownloadRequest(HttpServletRequest req, HttpServletResponse res, - boolean allowLogIn, boolean transmitContent) - throws ServletException, IOException - { - Log logger = getLogger(); - String uri = req.getRequestURI(); - - if (logger.isDebugEnabled()) - { - String queryString = req.getQueryString(); - logger.debug("Processing URL: " + uri + - ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); - } - - uri = uri.substring(req.getContextPath().length()); - StringTokenizer t = new StringTokenizer(uri, "/"); - int tokenCount = t.countTokens(); - - t.nextToken(); // skip servlet name - - // attachment mode (either 'attach' or 'direct') - String attachToken = t.nextToken(); - boolean attachment = URL_ATTACH.equals(attachToken) || URL_ATTACH_LONG.equals(attachToken); - - ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); - - // get or calculate the noderef and filename to download as - NodeRef nodeRef; - String filename; - - // do we have a path parameter instead of a NodeRef? - String path = req.getParameter(ARG_PATH); - if (path != null && path.length() != 0) - { - // process the name based path to resolve the NodeRef and the Filename element - try - { - PathRefInfo pathInfo = resolveNamePath(getServletContext(), path); - nodeRef = pathInfo.NodeRef; - filename = pathInfo.Filename; - } - catch (IllegalArgumentException e) - { - Application.handleSystemError(getServletContext(), req, res, MSG_ERROR_NOT_FOUND, - HttpServletResponse.SC_NOT_FOUND, logger); - return; - } - } - else - { - // a NodeRef must have been specified if no path has been found - if (tokenCount < 6) - { - throw new IllegalArgumentException("Download URL did not contain all required args: " + uri); - } - - // assume 'workspace' or other NodeRef based protocol for remaining URL elements - StoreRef storeRef = new StoreRef(URLDecoder.decode(t.nextToken()), URLDecoder.decode(t.nextToken())); - String id = URLDecoder.decode(t.nextToken()); - - // build noderef from the appropriate URL elements - nodeRef = new NodeRef(storeRef, id); - - if (tokenCount > 6) - { - // found additional relative path elements i.e. noderefid/images/file.txt - // this allows a url to reference siblings nodes via a cm:name based relative path - // solves the issue with opening HTML content containing relative URLs in HREF or IMG tags etc. - List paths = new ArrayList(tokenCount - 5); - while (t.hasMoreTokens()) - { - paths.add(URLDecoder.decode(t.nextToken())); - } - filename = paths.get(paths.size() - 1); - - try - { - NodeRef parentRef = serviceRegistry.getNodeService().getPrimaryParent(nodeRef).getParentRef(); - FileInfo fileInfo = serviceRegistry.getFileFolderService().resolveNamePath(parentRef, paths); - nodeRef = fileInfo.getNodeRef(); - } - catch (FileNotFoundException e) - { - Application.handleSystemError(getServletContext(), req, res, MSG_ERROR_NOT_FOUND, - HttpServletResponse.SC_NOT_FOUND, logger); - return; - } - } - else - { - // filename is last remaining token - filename = t.nextToken(); - } - } - - // get qualified of the property to get content from - default to ContentModel.PROP_CONTENT - QName propertyQName = ContentModel.PROP_CONTENT; - String property = req.getParameter(ARG_PROPERTY); - if (property != null && property.length() != 0) - { - propertyQName = QName.createQName(property); - } - - if (logger.isDebugEnabled()) - { - logger.debug("Found NodeRef: " + nodeRef); - logger.debug("Will use filename: " + filename); - logger.debug("For property: " + propertyQName); - logger.debug("With attachment mode: " + attachment); - } - - // get the services we need to retrieve the content - NodeService nodeService = serviceRegistry.getNodeService(); - ContentService contentService = serviceRegistry.getContentService(); - - // Check that the node still exists - if (!nodeService.exists(nodeRef)) - { - Application.handleSystemError(getServletContext(), req, res, MSG_ERROR_NOT_FOUND, - HttpServletResponse.SC_NOT_FOUND, logger); - return; - } - - try - { - // check that the user has at least READ_CONTENT access - else redirect to an error or login page - if (!checkAccess(req, res, nodeRef, PermissionService.READ_CONTENT, allowLogIn)) - { - return; - } - - // check If-Modified-Since header and set Last-Modified header as appropriate - Date modified = (Date)nodeService.getProperty(nodeRef, ContentModel.PROP_MODIFIED); - if (modified != null) - { - long modifiedSince = req.getDateHeader(HEADER_IF_MODIFIED_SINCE); - if (modifiedSince > 0L) - { - // round the date to the ignore millisecond value which is not supplied by header - long modDate = (modified.getTime() / 1000L) * 1000L; - if (modDate <= modifiedSince) - { - if (logger.isDebugEnabled()) - logger.debug("Returning 304 Not Modified."); - res.setStatus(HttpServletResponse.SC_NOT_MODIFIED); - return; - } - } - res.setDateHeader(HEADER_LAST_MODIFIED, modified.getTime()); - res.setHeader(HEADER_CACHE_CONTROL, "must-revalidate, max-age=0"); - res.setHeader(HEADER_ETAG, "\"" + Long.toString(modified.getTime()) + "\""); - } - - if (attachment == true) - { - setHeaderContentDisposition(req, res, filename); - } - - // get the content reader - ContentReader reader = contentService.getReader(nodeRef, propertyQName); - // ensure that it is safe to use - reader = FileContentReader.getSafeContentReader( - reader, - Application.getMessage(req.getSession(), MSG_ERROR_CONTENT_MISSING), - nodeRef, reader); - - String mimetype = reader.getMimetype(); - // fall back if unable to resolve mimetype property - if (mimetype == null || mimetype.length() == 0) - { - MimetypeService mimetypeMap = serviceRegistry.getMimetypeService(); - mimetype = MIMETYPE_OCTET_STREAM; - int extIndex = filename.lastIndexOf('.'); - if (extIndex != -1) - { - String ext = filename.substring(extIndex + 1); - mimetype = mimetypeMap.getMimetype(ext); - } - } - - // explicitly set the content disposition header if the content is powerpoint - if (!attachment && (mimetype.equals(POWER_POINT_2007_DOCUMENT_MIMETYPE) || - mimetype.equals(POWER_POINT_DOCUMENT_MIMETYPE))) - { - setHeaderContentDisposition(req, res, filename); - } - - // get the content and stream directly to the response output stream - // assuming the repo is capable of streaming in chunks, this should allow large files - // to be streamed directly to the browser response stream. - res.setHeader(HEADER_ACCEPT_RANGES, "bytes"); - - // for a GET request, transmit the content else just the headers are sent - if (transmitContent) - { - try - { - boolean processedRange = false; - String range = req.getHeader(HEADER_CONTENT_RANGE); - if (range == null) - { - range = req.getHeader(HEADER_RANGE); - } - if (range != null) - { - if (logger.isDebugEnabled()) - logger.debug("Found content range header: " + range); - - // ensure the range header is starts with "bytes=" and process the range(s) - if (range.length() > 6) - { - HttpRangeProcessor rangeProcessor = new HttpRangeProcessor(contentService); - processedRange = rangeProcessor.processRange( - res, reader, range.substring(6), nodeRef, propertyQName, - mimetype, req.getHeader(HEADER_USER_AGENT)); - } - } - if (processedRange == false) - { - if (logger.isDebugEnabled()) - logger.debug("Sending complete file content..."); - - // set mimetype for the content and the character encoding for the stream - res.setContentType(mimetype); - res.setCharacterEncoding(reader.getEncoding()); - - // MNT-10642 Alfresco Explorer has javascript vulnerability opening HTML files - if (req.getRequestURI().contains("/d/d/") && (mimetype.equals("text/html") || mimetype.equals("application/xhtml+xml") || mimetype.equals("text/xml"))) - { - String content = reader.getContentString(); - - if (mimetype.equals("text/html") || mimetype.equals("application/xhtml+xml")) - { - // process with HTML stripper - content = StringUtils.stripUnsafeHTMLTags(content, false); - } - else if (mimetype.equals("text/xml") && mimetype.equals("text/x-component")) - { - // IE supports "behaviour" which means that css can load a .htc file that could - // contain XSS code in the form of jscript, vbscript etc, to stop it form being - // evaluated we set the contient type to text/plain - res.setContentType("text/plain"); - } - - String encoding = reader.getEncoding(); - byte[] bytes = encoding != null ? content.getBytes(encoding) : content.getBytes(); - res.setContentLength(bytes.length); - res.getOutputStream().write(bytes); - - return; - } - - // return the complete entity range - long size = reader.getSize(); - res.setHeader(HEADER_CONTENT_RANGE, "bytes 0-" + Long.toString(size-1L) + "/" + Long.toString(size)); - res.setHeader(HEADER_CONTENT_LENGTH, Long.toString(size)); - reader.getContent( res.getOutputStream() ); - } - } - catch (SocketException e1) - { - // the client cut the connection - our mission was accomplished apart from a little error message - if (logger.isDebugEnabled()) - logger.debug("Client aborted stream read:\n\tnode: " + nodeRef + "\n\tcontent: " + reader); - } - catch (ContentIOException e2) - { - if (logger.isInfoEnabled()) - logger.info("Failed stream read:\n\tnode: " + nodeRef + " due to: " + e2.getMessage()); - } - catch (Throwable err) - { - if (err.getCause() instanceof SocketException) - { - // the client cut the connection - our mission was accomplished apart from a little error message - if (logger.isDebugEnabled()) - logger.debug("Client aborted stream read:\n\tnode: " + nodeRef + "\n\tcontent: " + reader); - } - else throw err; - } - } - else - { - if (logger.isDebugEnabled()) - logger.debug("HEAD request processed - no content sent."); - res.getOutputStream().close(); - } - } - catch (Throwable err) - { - throw new AlfrescoRuntimeException("Error during download content servlet processing: " + err.getMessage(), err); - } - } - - private void setHeaderContentDisposition(HttpServletRequest req, HttpServletResponse res, String filename) - { - // set header based on filename - will force a Save As from the browse if it doesn't recognise it - // this is better than the default response of the browser trying to display the contents - - // IE requires that "Content-Disposition" header in case of "attachment" type should include - // "filename" part. See MNT-9900 - String userAgent = req.getHeader(HEADER_USER_AGENT); - if (userAgent != null && (userAgent.toLowerCase().contains("firefox") || userAgent.toLowerCase().contains("safari"))) - { - res.setHeader(HEADER_CONTENT_DISPOSITION, "attachment; filename=\"" + URLDecoder.decode(filename) + "\""); - } - else - { - res.setHeader(HEADER_CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\""); - } - - } - - /** - * Helper to generate a URL to a content node for downloading content from the server. - * - * @param pattern The pattern to use for the URL - * @param ref NodeRef of the content node to generate URL for (cannot be null) - * @param name File name to return in the URL (cannot be null) - * - * @return URL to download the content from the specified node - */ - protected final static String generateUrl(String pattern, NodeRef ref, String name) - { - return MessageFormat.format(pattern, new Object[] { - ref.getStoreRef().getProtocol(), - ref.getStoreRef().getIdentifier(), - ref.getId(), - URLEncoder.encode(name) } ); - } -} +package org.alfresco.web.app.servlet; + +import java.io.IOException; +import java.net.SocketException; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; +import java.util.StringTokenizer; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.filestore.FileContentReader; +import org.alfresco.repo.web.util.HttpRangeProcessor; +import org.alfresco.service.ServiceRegistry; +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.ContentService; +import org.alfresco.service.cmr.repository.MimetypeService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.repository.StoreRef; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.apache.commons.logging.Log; +import org.springframework.extensions.surf.util.URLDecoder; +import org.springframework.extensions.surf.util.URLEncoder; +import org.springframework.extensions.webscripts.ui.common.StringUtils; + +/** + * Base class for the download content servlets. Provides common + * processing for the request. + * + * @see org.alfresco.web.app.servlet.DownloadContentServlet + * @see org.alfresco.web.app.servlet.GuestDownloadContentServlet + * + * @author Kevin Roast + * @author gavinc + */ +public abstract class BaseDownloadContentServlet extends BaseServlet +{ + private static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since"; + + private static final long serialVersionUID = -4558907921887235967L; + + private static final String POWER_POINT_DOCUMENT_MIMETYPE = "application/vnd.ms-powerpoint"; + private static final String POWER_POINT_2007_DOCUMENT_MIMETYPE = "application/vnd.openxmlformats-officedocument.presentationml.presentation"; + + private static final String HEADER_CONTENT_RANGE = "Content-Range"; + private static final String HEADER_CONTENT_LENGTH = "Content-Length"; + private static final String HEADER_ACCEPT_RANGES = "Accept-Ranges"; + private static final String HEADER_RANGE = "Range"; + private static final String HEADER_ETAG = "ETag"; + private static final String HEADER_CACHE_CONTROL = "Cache-Control"; + private static final String HEADER_LAST_MODIFIED = "Last-Modified"; + private static final String HEADER_USER_AGENT = "User-Agent"; + private static final String HEADER_CONTENT_DISPOSITION = "Content-Disposition"; + + protected static final String MIMETYPE_OCTET_STREAM = "application/octet-stream"; + + protected static final String MSG_ERROR_CONTENT_MISSING = "error_content_missing"; + protected static final String MSG_ERROR_NOT_FOUND = "error_not_found"; + + protected static final String URL_DIRECT = "d"; + protected static final String URL_DIRECT_LONG = "direct"; + protected static final String URL_ATTACH = "a"; + protected static final String URL_ATTACH_LONG = "attach"; + protected static final String ARG_PROPERTY = "property"; + protected static final String ARG_PATH = "path"; + + /** + * Gets the logger to use for this request. + *

+ * This will show all debug entries from this class as though they + * came from the subclass. + * + * @return The logger + */ + protected abstract Log getLogger(); + + /** + * Processes the download request using the current context i.e. no authentication checks are made, it is presumed + * they have already been done. + * + * @param req + * The HTTP request + * @param res + * The HTTP response + * @param allowLogIn + * Indicates whether guest users without access to the content should be redirected to the log in page. If + * false, a status 403 forbidden page is displayed instead. + */ + protected void processDownloadRequest(HttpServletRequest req, HttpServletResponse res, + boolean allowLogIn, boolean transmitContent) + throws ServletException, IOException + { + Log logger = getLogger(); + String uri = req.getRequestURI(); + + if (logger.isDebugEnabled()) + { + String queryString = req.getQueryString(); + logger.debug("Processing URL: " + uri + + ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); + } + + uri = uri.substring(req.getContextPath().length()); + StringTokenizer t = new StringTokenizer(uri, "/"); + int tokenCount = t.countTokens(); + + t.nextToken(); // skip servlet name + + // attachment mode (either 'attach' or 'direct') + String attachToken = t.nextToken(); + boolean attachment = URL_ATTACH.equals(attachToken) || URL_ATTACH_LONG.equals(attachToken); + + ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); + + // get or calculate the noderef and filename to download as + NodeRef nodeRef; + String filename; + + // do we have a path parameter instead of a NodeRef? + String path = req.getParameter(ARG_PATH); + if (path != null && path.length() != 0) + { + // process the name based path to resolve the NodeRef and the Filename element + try + { + PathRefInfo pathInfo = resolveNamePath(getServletContext(), path); + nodeRef = pathInfo.NodeRef; + filename = pathInfo.Filename; + } + catch (IllegalArgumentException e) + { + Application.handleSystemError(getServletContext(), req, res, MSG_ERROR_NOT_FOUND, + HttpServletResponse.SC_NOT_FOUND, logger); + return; + } + } + else + { + // a NodeRef must have been specified if no path has been found + if (tokenCount < 6) + { + throw new IllegalArgumentException("Download URL did not contain all required args: " + uri); + } + + // assume 'workspace' or other NodeRef based protocol for remaining URL elements + StoreRef storeRef = new StoreRef(URLDecoder.decode(t.nextToken()), URLDecoder.decode(t.nextToken())); + String id = URLDecoder.decode(t.nextToken()); + + // build noderef from the appropriate URL elements + nodeRef = new NodeRef(storeRef, id); + + if (tokenCount > 6) + { + // found additional relative path elements i.e. noderefid/images/file.txt + // this allows a url to reference siblings nodes via a cm:name based relative path + // solves the issue with opening HTML content containing relative URLs in HREF or IMG tags etc. + List paths = new ArrayList(tokenCount - 5); + while (t.hasMoreTokens()) + { + paths.add(URLDecoder.decode(t.nextToken())); + } + filename = paths.get(paths.size() - 1); + + try + { + NodeRef parentRef = serviceRegistry.getNodeService().getPrimaryParent(nodeRef).getParentRef(); + FileInfo fileInfo = serviceRegistry.getFileFolderService().resolveNamePath(parentRef, paths); + nodeRef = fileInfo.getNodeRef(); + } + catch (FileNotFoundException e) + { + Application.handleSystemError(getServletContext(), req, res, MSG_ERROR_NOT_FOUND, + HttpServletResponse.SC_NOT_FOUND, logger); + return; + } + } + else + { + // filename is last remaining token + filename = t.nextToken(); + } + } + + // get qualified of the property to get content from - default to ContentModel.PROP_CONTENT + QName propertyQName = ContentModel.PROP_CONTENT; + String property = req.getParameter(ARG_PROPERTY); + if (property != null && property.length() != 0) + { + propertyQName = QName.createQName(property); + } + + if (logger.isDebugEnabled()) + { + logger.debug("Found NodeRef: " + nodeRef); + logger.debug("Will use filename: " + filename); + logger.debug("For property: " + propertyQName); + logger.debug("With attachment mode: " + attachment); + } + + // get the services we need to retrieve the content + NodeService nodeService = serviceRegistry.getNodeService(); + ContentService contentService = serviceRegistry.getContentService(); + + // Check that the node still exists + if (!nodeService.exists(nodeRef)) + { + Application.handleSystemError(getServletContext(), req, res, MSG_ERROR_NOT_FOUND, + HttpServletResponse.SC_NOT_FOUND, logger); + return; + } + + try + { + // check that the user has at least READ_CONTENT access - else redirect to an error or login page + if (!checkAccess(req, res, nodeRef, PermissionService.READ_CONTENT, allowLogIn)) + { + return; + } + + // check If-Modified-Since header and set Last-Modified header as appropriate + Date modified = (Date)nodeService.getProperty(nodeRef, ContentModel.PROP_MODIFIED); + if (modified != null) + { + long modifiedSince = req.getDateHeader(HEADER_IF_MODIFIED_SINCE); + if (modifiedSince > 0L) + { + // round the date to the ignore millisecond value which is not supplied by header + long modDate = (modified.getTime() / 1000L) * 1000L; + if (modDate <= modifiedSince) + { + if (logger.isDebugEnabled()) + logger.debug("Returning 304 Not Modified."); + res.setStatus(HttpServletResponse.SC_NOT_MODIFIED); + return; + } + } + res.setDateHeader(HEADER_LAST_MODIFIED, modified.getTime()); + res.setHeader(HEADER_CACHE_CONTROL, "must-revalidate, max-age=0"); + res.setHeader(HEADER_ETAG, "\"" + Long.toString(modified.getTime()) + "\""); + } + + if (attachment == true) + { + setHeaderContentDisposition(req, res, filename); + } + + // get the content reader + ContentReader reader = contentService.getReader(nodeRef, propertyQName); + // ensure that it is safe to use + reader = FileContentReader.getSafeContentReader( + reader, + Application.getMessage(req.getSession(), MSG_ERROR_CONTENT_MISSING), + nodeRef, reader); + + String mimetype = reader.getMimetype(); + // fall back if unable to resolve mimetype property + if (mimetype == null || mimetype.length() == 0) + { + MimetypeService mimetypeMap = serviceRegistry.getMimetypeService(); + mimetype = MIMETYPE_OCTET_STREAM; + int extIndex = filename.lastIndexOf('.'); + if (extIndex != -1) + { + String ext = filename.substring(extIndex + 1); + mimetype = mimetypeMap.getMimetype(ext); + } + } + + // explicitly set the content disposition header if the content is powerpoint + if (!attachment && (mimetype.equals(POWER_POINT_2007_DOCUMENT_MIMETYPE) || + mimetype.equals(POWER_POINT_DOCUMENT_MIMETYPE))) + { + setHeaderContentDisposition(req, res, filename); + } + + // get the content and stream directly to the response output stream + // assuming the repo is capable of streaming in chunks, this should allow large files + // to be streamed directly to the browser response stream. + res.setHeader(HEADER_ACCEPT_RANGES, "bytes"); + + // for a GET request, transmit the content else just the headers are sent + if (transmitContent) + { + try + { + boolean processedRange = false; + String range = req.getHeader(HEADER_CONTENT_RANGE); + if (range == null) + { + range = req.getHeader(HEADER_RANGE); + } + if (range != null) + { + if (logger.isDebugEnabled()) + logger.debug("Found content range header: " + range); + + // ensure the range header is starts with "bytes=" and process the range(s) + if (range.length() > 6) + { + HttpRangeProcessor rangeProcessor = new HttpRangeProcessor(contentService); + processedRange = rangeProcessor.processRange( + res, reader, range.substring(6), nodeRef, propertyQName, + mimetype, req.getHeader(HEADER_USER_AGENT)); + } + } + if (processedRange == false) + { + if (logger.isDebugEnabled()) + logger.debug("Sending complete file content..."); + + // set mimetype for the content and the character encoding for the stream + res.setContentType(mimetype); + res.setCharacterEncoding(reader.getEncoding()); + + // MNT-10642 Alfresco Explorer has javascript vulnerability opening HTML files + if (req.getRequestURI().contains("/d/d/") && (mimetype.equals("text/html") || mimetype.equals("application/xhtml+xml") || mimetype.equals("text/xml"))) + { + String content = reader.getContentString(); + + if (mimetype.equals("text/html") || mimetype.equals("application/xhtml+xml")) + { + // process with HTML stripper + content = StringUtils.stripUnsafeHTMLTags(content, false); + } + else if (mimetype.equals("text/xml") && mimetype.equals("text/x-component")) + { + // IE supports "behaviour" which means that css can load a .htc file that could + // contain XSS code in the form of jscript, vbscript etc, to stop it form being + // evaluated we set the contient type to text/plain + res.setContentType("text/plain"); + } + + String encoding = reader.getEncoding(); + byte[] bytes = encoding != null ? content.getBytes(encoding) : content.getBytes(); + res.setContentLength(bytes.length); + res.getOutputStream().write(bytes); + + return; + } + + // return the complete entity range + long size = reader.getSize(); + res.setHeader(HEADER_CONTENT_RANGE, "bytes 0-" + Long.toString(size-1L) + "/" + Long.toString(size)); + res.setHeader(HEADER_CONTENT_LENGTH, Long.toString(size)); + reader.getContent( res.getOutputStream() ); + } + } + catch (SocketException e1) + { + // the client cut the connection - our mission was accomplished apart from a little error message + if (logger.isDebugEnabled()) + logger.debug("Client aborted stream read:\n\tnode: " + nodeRef + "\n\tcontent: " + reader); + } + catch (ContentIOException e2) + { + if (logger.isInfoEnabled()) + logger.info("Failed stream read:\n\tnode: " + nodeRef + " due to: " + e2.getMessage()); + } + catch (Throwable err) + { + if (err.getCause() instanceof SocketException) + { + // the client cut the connection - our mission was accomplished apart from a little error message + if (logger.isDebugEnabled()) + logger.debug("Client aborted stream read:\n\tnode: " + nodeRef + "\n\tcontent: " + reader); + } + else throw err; + } + } + else + { + if (logger.isDebugEnabled()) + logger.debug("HEAD request processed - no content sent."); + res.getOutputStream().close(); + } + } + catch (Throwable err) + { + throw new AlfrescoRuntimeException("Error during download content servlet processing: " + err.getMessage(), err); + } + } + + private void setHeaderContentDisposition(HttpServletRequest req, HttpServletResponse res, String filename) + { + // set header based on filename - will force a Save As from the browse if it doesn't recognise it + // this is better than the default response of the browser trying to display the contents + + // IE requires that "Content-Disposition" header in case of "attachment" type should include + // "filename" part. See MNT-9900 + String userAgent = req.getHeader(HEADER_USER_AGENT); + if (userAgent != null && (userAgent.toLowerCase().contains("firefox") || userAgent.toLowerCase().contains("safari"))) + { + res.setHeader(HEADER_CONTENT_DISPOSITION, "attachment; filename=\"" + URLDecoder.decode(filename) + "\""); + } + else + { + res.setHeader(HEADER_CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\""); + } + + } + + /** + * Helper to generate a URL to a content node for downloading content from the server. + * + * @param pattern The pattern to use for the URL + * @param ref NodeRef of the content node to generate URL for (cannot be null) + * @param name File name to return in the URL (cannot be null) + * + * @return URL to download the content from the specified node + */ + protected final static String generateUrl(String pattern, NodeRef ref, String name) + { + return MessageFormat.format(pattern, new Object[] { + ref.getStoreRef().getProtocol(), + ref.getStoreRef().getIdentifier(), + ref.getId(), + URLEncoder.encode(name) } ); + } +} diff --git a/source/java/org/alfresco/web/app/servlet/BaseServlet.java b/source/java/org/alfresco/web/app/servlet/BaseServlet.java index b27587bc7a..e2a693d08e 100644 --- a/source/java/org/alfresco/web/app/servlet/BaseServlet.java +++ b/source/java/org/alfresco/web/app/servlet/BaseServlet.java @@ -1,481 +1,481 @@ -package org.alfresco.web.app.servlet; - -import java.io.IOException; -import java.io.PrintWriter; -import java.net.URLEncoder; -import java.util.ArrayList; -import java.util.HashSet; -import java.util.List; -import java.util.Set; -import java.util.StringTokenizer; - -import javax.faces.context.FacesContext; -import javax.servlet.ServletContext; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.repo.security.authentication.AuthenticationUtil; -import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; -import org.alfresco.repo.tenant.TenantService; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.model.FileFolderService; -import org.alfresco.service.cmr.model.FileInfo; -import org.alfresco.service.cmr.model.FileNotFoundException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.search.SearchService; -import org.alfresco.service.cmr.security.AccessStatus; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.LoginOutcomeBean; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.extensions.surf.util.URLDecoder; -import org.springframework.web.context.WebApplicationContext; -import org.springframework.web.context.support.WebApplicationContextUtils; -import org.springframework.web.jsf.FacesContextUtils; - - -/** - * Base servlet class containing useful constant values and common methods for Alfresco servlets. - * - * @author Kevin Roast - */ -public abstract class BaseServlet extends HttpServlet -{ - private static final long serialVersionUID = -826295358696861789L; - - public static final String FACES_SERVLET = "/faces"; - public static final String KEY_STORE = "store"; - public static final String KEY_ROOT_PATH = "rootPath"; - - /** an existing Ticket can be passed to most servlet for non-session based authentication */ - private static final String ARG_TICKET = "ticket"; - - /** forcing guess access is available on most servlets */ - private static final String ARG_GUEST = "guest"; - - private static final String MSG_ERROR_PERMISSIONS = "error_permissions"; - - /** list of valid JSPs for redirect after a clean login */ - // TODO: make this list configurable - private static Set validRedirectJSPs = new HashSet(); - static - { - validRedirectJSPs.add("/jsp/browse/browse.jsp"); - validRedirectJSPs.add("/jsp/admin/admin-console.jsp"); - validRedirectJSPs.add("/jsp/admin/avm-console.jsp"); - validRedirectJSPs.add("/jsp/admin/node-browser.jsp"); - validRedirectJSPs.add("/jsp/admin/store-browser.jsp"); - validRedirectJSPs.add("/jsp/users/user-console.jsp"); - validRedirectJSPs.add("/jsp/categories/categories.jsp"); - validRedirectJSPs.add("/jsp/dialog/about.jsp"); - validRedirectJSPs.add("/jsp/search/advanced-search.jsp"); - validRedirectJSPs.add("/jsp/admin/system-info.jsp"); - validRedirectJSPs.add("/jsp/forums/forums.jsp"); - validRedirectJSPs.add("/jsp/users/users.jsp"); - validRedirectJSPs.add("/jsp/trashcan/trash-list.jsp"); - } - - private static Log logger = LogFactory.getLog(BaseServlet.class); - - - /** - * Return the ServiceRegistry helper instance - * - * @param sc ServletContext - * - * @return ServiceRegistry - */ - public static ServiceRegistry getServiceRegistry(ServletContext sc) - { - WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(sc); - return (ServiceRegistry)wc.getBean(ServiceRegistry.SERVICE_REGISTRY); - } - - /** - * Perform an authentication for the servlet request URI. Processing any "ticket" or - * "guest" URL arguments. - * - * @return AuthenticationStatus - * - * @throws IOException - */ - public AuthenticationStatus servletAuthenticate(HttpServletRequest req, HttpServletResponse res) - throws IOException - { - return servletAuthenticate(req, res, true); - } - - /** - * Perform an authentication for the servlet request URI. Processing any "ticket" or - * "guest" URL arguments. - * - * @return AuthenticationStatus - * - * @throws IOException - */ - public AuthenticationStatus servletAuthenticate(HttpServletRequest req, HttpServletResponse res, - boolean redirectToLoginPage) throws IOException - { - AuthenticationStatus status; - - // see if a ticket or a force Guest parameter has been supplied - String ticket = req.getParameter(ARG_TICKET); - if (ticket != null && ticket.length() != 0) - { - status = AuthenticationHelper.authenticate(getServletContext(), req, res, ticket); - } - else - { - boolean forceGuest = false; - String guest = req.getParameter(ARG_GUEST); - if (guest != null) - { - forceGuest = Boolean.parseBoolean(guest); - } - status = AuthenticationHelper.authenticate(getServletContext(), req, res, forceGuest); - } - if (status == AuthenticationStatus.Failure && redirectToLoginPage) - { - // authentication failed - now need to display the login page to the user, if asked to - redirectToLoginPage(req, res, getServletContext()); - } - - return status; - } - - /** - * Check the user has the given permission on the given node. If they do not either force a log on if this is a guest - * user or forward to an error page. - * - * @param req - * the request - * @param res - * the response - * @param nodeRef - * the node in question - * @param allowLogIn - * Indicates whether guest users without access to the node should be redirected to the log in page. If - * false, a status 403 forbidden page is displayed instead. - * @return true, if the user has access - * @throws IOException - * Signals that an I/O exception has occurred. - * @throws ServletException - * On other errors - */ - public boolean checkAccess(HttpServletRequest req, HttpServletResponse res, NodeRef nodeRef, String permission, - boolean allowLogIn) throws IOException, ServletException - { - ServletContext sc = getServletContext(); - ServiceRegistry serviceRegistry = getServiceRegistry(sc); - PermissionService permissionService = serviceRegistry.getPermissionService(); - - // check that the user has the permission - if (permissionService.hasPermission(nodeRef, permission) == AccessStatus.DENIED) - { - if (logger.isDebugEnabled()) - logger.debug("User does not have " + permission + " permission for NodeRef: " + nodeRef.toString()); - - if (allowLogIn && serviceRegistry.getAuthorityService().hasGuestAuthority()) - { - if (logger.isDebugEnabled()) - logger.debug("Redirecting to login page..."); - redirectToLoginPage(req, res, sc); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("Forwarding to error page..."); - Application - .handleSystemError(sc, req, res, MSG_ERROR_PERMISSIONS, HttpServletResponse.SC_FORBIDDEN, logger); - } - return false; - } - return true; - } - - /** - * Redirect to the Login page - saving the current URL which can be redirected back later - * once the user has successfully completed the authentication process. - */ - public static void redirectToLoginPage(HttpServletRequest req, HttpServletResponse res, ServletContext sc) - throws IOException - { - redirectToLoginPage(req, res, sc, AuthenticationHelper.getRemoteUserMapper(sc) == null); - } - - /** - * Redirect to the Login page - saving the current URL which can be redirected back later - * once the user has successfully completed the authentication process. - * @param sendRedirect allow a redirect status code to be set? If false redirect - * will be via markup rather than status code (to allow the status code to be used for handshake - * responses etc. - */ - public static void redirectToLoginPage(HttpServletRequest req, HttpServletResponse res, ServletContext sc, boolean sendRedirect) - throws IOException - { - // Pass the full requested URL as a parameter so the login page knows where to redirect to later - final String uri = req.getRequestURI(); - String redirectURL = uri; - - // authentication failed - so end servlet execution and redirect to login page - if (WebApplicationContextUtils.getRequiredWebApplicationContext(sc).containsBean(Application.BEAN_CONFIG_SERVICE)) - { - StringBuilder redirect = new StringBuilder(128) - .append(req.getContextPath()).append(FACES_SERVLET).append(Application.getLoginPage(sc)); - - // if we find a JSF servlet reference in the URI then we need to check if the rest of the - // JSP specified is valid for a redirect operation after Login has occured. - int jspIndex; - if (uri.indexOf(req.getContextPath() + FACES_SERVLET) == -1 - || uri.length() > (jspIndex = uri.indexOf(BaseServlet.FACES_SERVLET) + BaseServlet.FACES_SERVLET.length()) - && BaseServlet.validRedirectJSP(uri.substring(jspIndex))) - { - if (redirect.indexOf("?") == -1) - { - redirect.append('?'); - } - else - { - redirect.append('&'); - } - redirect.append(LoginOutcomeBean.PARAM_REDIRECT_URL); - redirect.append('='); - String url = uri; - - // Append the query string if necessary - String queryString = req.getQueryString(); - if (queryString != null) - { - // Strip out leading ticket arguments - queryString = queryString.replaceAll("(?<=^|&)" + ARG_TICKET + "(=[^&=]*)?&", ""); - // Strip out trailing ticket arguments - queryString = queryString.replaceAll("(^|&)" + ARG_TICKET + "(=[^&=]*)?(?=&|$)", ""); - if (queryString.length() != 0) - { - url += "?" + queryString; - } - } - redirect.append(URLEncoder.encode(url, "UTF-8")); - } - redirectURL = redirect.toString(); - } - // If external authentication isn't in use (e.g. proxied share authentication), it's safe to return a redirect to the client - if (sendRedirect) - { - res.sendRedirect(redirectURL); - } - // Otherwise, we must signal to the client with an unauthorized status code and rely on a browser refresh to do - // the redirect for failover login (as we do with NTLM, Kerberos) - else - { - res.setContentType("text/html; charset=UTF-8"); - res.setStatus(HttpServletResponse.SC_UNAUTHORIZED); - - final PrintWriter out = res.getWriter(); - out.println(""); - out.println(""); - out.println("

Please log in.

"); - out.println(""); - out.close(); - } - } - - /** - * Apply the headers required to disallow caching of the response in the browser - */ - public static void setNoCacheHeaders(HttpServletResponse res) - { - res.setHeader("Cache-Control", "no-cache"); - res.setHeader("Pragma", "no-cache"); - } - - /** - * Returns true if the specified JSP file is valid for a redirect after login. - * Only a specific sub-set of the available JSPs are valid to jump directly too after a - * clean login attempt - e.g. those that do not require JSF bean context setup. This is - * a limitation of the JSP architecture. The ExternalAccessServlet provides a mechanism to - * setup the JSF bean context directly for some specific cases. - * - * @param jsp Filename of JSP to check, for example "/jsp/browse/browse.jsp" - * - * @return true if the JSP is in the list of valid direct URLs, false otherwise - */ - public static boolean validRedirectJSP(String jsp) - { - return validRedirectJSPs.contains(jsp); - } - - /** - * Resolves the given path elements to a NodeRef in the current repository - * - * @param context Faces context - * @param args The elements of the path to lookup - */ - public static NodeRef resolveWebDAVPath(FacesContext context, String[] args) - { - WebApplicationContext wc = FacesContextUtils.getRequiredWebApplicationContext(context); - return resolveWebDAVPath(wc, args, true); - } - - /** - * Resolves the given path elements to a NodeRef in the current repository - * - * @param context Faces context - * @param args The elements of the path to lookup - * @param decode True to decode the arg from UTF-8 format, false for no decoding - */ - public static NodeRef resolveWebDAVPath(FacesContext context, String[] args, boolean decode) - { - WebApplicationContext wc = FacesContextUtils.getRequiredWebApplicationContext(context); - return resolveWebDAVPath(wc, args, decode); - } - - /** - * Resolves the given path elements to a NodeRef in the current repository - * - * @param context ServletContext context - * @param args The elements of the path to lookup - */ - public static NodeRef resolveWebDAVPath(ServletContext context, String[] args) - { - WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(context); - return resolveWebDAVPath(wc, args, true); - } - - /** - * Resolves the given path elements to a NodeRef in the current repository - * - * @param context ServletContext context - * @param args The elements of the path to lookup - * @param decode True to decode the arg from UTF-8 format, false for no decoding - */ - public static NodeRef resolveWebDAVPath(ServletContext context, String[] args, boolean decode) - { - WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(context); - return resolveWebDAVPath(wc, args, decode); - } - - /** - * Resolves the given path elements to a NodeRef in the current repository - * - * @param wc WebApplicationContext Context - * @param args The elements of the path to lookup - * @param decode True to decode the arg from UTF-8 format, false for no decoding - */ - private static NodeRef resolveWebDAVPath(final WebApplicationContext wc, final String[] args, final boolean decode) - { - return AuthenticationUtil.runAs(new RunAsWork() - { - public NodeRef doWork() throws Exception - { - NodeRef nodeRef = null; - - List paths = new ArrayList(args.length - 1); - - FileInfo file = null; - try - { - // create a list of path elements (decode the URL as we go) - for (int x = 1; x < args.length; x++) - { - paths.add(decode ? URLDecoder.decode(args[x]) : args[x]); - } - - if (logger.isDebugEnabled()) - logger.debug("Attempting to resolve webdav path: " + paths); - - // get the company home node to start the search from - nodeRef = new NodeRef(Repository.getStoreRef(), Application.getCompanyRootId()); - - TenantService tenantService = (TenantService)wc.getBean("tenantService"); - if (tenantService != null && tenantService.isEnabled()) - { - if (logger.isDebugEnabled()) - logger.debug("MT is enabled."); - - NodeService nodeService = (NodeService) wc.getBean("NodeService"); - SearchService searchService = (SearchService) wc.getBean("SearchService"); - NamespaceService namespaceService = (NamespaceService) wc.getBean("NamespaceService"); - - // TODO: since these constants are used more widely than just the WebDAVServlet, - // they should be defined somewhere other than in that servlet - String rootPath = wc.getServletContext().getInitParameter(BaseServlet.KEY_ROOT_PATH); - - // note: rootNodeRef is required (for storeRef part) - nodeRef = tenantService.getRootNode(nodeService, searchService, namespaceService, rootPath, nodeRef); - } - - if (paths.size() != 0) - { - FileFolderService ffs = (FileFolderService)wc.getBean("FileFolderService"); - file = ffs.resolveNamePath(nodeRef, paths); - nodeRef = file.getNodeRef(); - } - - if (logger.isDebugEnabled()) - logger.debug("Resolved webdav path to NodeRef: " + nodeRef); - } - catch (FileNotFoundException fne) - { - if (logger.isWarnEnabled()) - logger.warn("Failed to resolve webdav path", fne); - - nodeRef = null; - } - return nodeRef; - } - }, AuthenticationUtil.getSystemUserName()); - } - - /** - * Resolve a name based into a NodeRef and Filename string - * - * @param sc ServletContext - * @param path 'cm:name' based path using the '/' character as a separator - * - * @return PathRefInfo structure containing the resolved NodeRef and filename - * - * @throws IllegalArgumentException - */ - public final static PathRefInfo resolveNamePath(ServletContext sc, String path) - { - StringTokenizer t = new StringTokenizer(path, "/"); - int tokenCount = t.countTokens(); - String[] elements = new String[tokenCount]; - for (int i=0; i validRedirectJSPs = new HashSet(); + static + { + validRedirectJSPs.add("/jsp/browse/browse.jsp"); + validRedirectJSPs.add("/jsp/admin/admin-console.jsp"); + validRedirectJSPs.add("/jsp/admin/avm-console.jsp"); + validRedirectJSPs.add("/jsp/admin/node-browser.jsp"); + validRedirectJSPs.add("/jsp/admin/store-browser.jsp"); + validRedirectJSPs.add("/jsp/users/user-console.jsp"); + validRedirectJSPs.add("/jsp/categories/categories.jsp"); + validRedirectJSPs.add("/jsp/dialog/about.jsp"); + validRedirectJSPs.add("/jsp/search/advanced-search.jsp"); + validRedirectJSPs.add("/jsp/admin/system-info.jsp"); + validRedirectJSPs.add("/jsp/forums/forums.jsp"); + validRedirectJSPs.add("/jsp/users/users.jsp"); + validRedirectJSPs.add("/jsp/trashcan/trash-list.jsp"); + } + + private static Log logger = LogFactory.getLog(BaseServlet.class); + + + /** + * Return the ServiceRegistry helper instance + * + * @param sc ServletContext + * + * @return ServiceRegistry + */ + public static ServiceRegistry getServiceRegistry(ServletContext sc) + { + WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(sc); + return (ServiceRegistry)wc.getBean(ServiceRegistry.SERVICE_REGISTRY); + } + + /** + * Perform an authentication for the servlet request URI. Processing any "ticket" or + * "guest" URL arguments. + * + * @return AuthenticationStatus + * + * @throws IOException + */ + public AuthenticationStatus servletAuthenticate(HttpServletRequest req, HttpServletResponse res) + throws IOException + { + return servletAuthenticate(req, res, true); + } + + /** + * Perform an authentication for the servlet request URI. Processing any "ticket" or + * "guest" URL arguments. + * + * @return AuthenticationStatus + * + * @throws IOException + */ + public AuthenticationStatus servletAuthenticate(HttpServletRequest req, HttpServletResponse res, + boolean redirectToLoginPage) throws IOException + { + AuthenticationStatus status; + + // see if a ticket or a force Guest parameter has been supplied + String ticket = req.getParameter(ARG_TICKET); + if (ticket != null && ticket.length() != 0) + { + status = AuthenticationHelper.authenticate(getServletContext(), req, res, ticket); + } + else + { + boolean forceGuest = false; + String guest = req.getParameter(ARG_GUEST); + if (guest != null) + { + forceGuest = Boolean.parseBoolean(guest); + } + status = AuthenticationHelper.authenticate(getServletContext(), req, res, forceGuest); + } + if (status == AuthenticationStatus.Failure && redirectToLoginPage) + { + // authentication failed - now need to display the login page to the user, if asked to + redirectToLoginPage(req, res, getServletContext()); + } + + return status; + } + + /** + * Check the user has the given permission on the given node. If they do not either force a log on if this is a guest + * user or forward to an error page. + * + * @param req + * the request + * @param res + * the response + * @param nodeRef + * the node in question + * @param allowLogIn + * Indicates whether guest users without access to the node should be redirected to the log in page. If + * false, a status 403 forbidden page is displayed instead. + * @return true, if the user has access + * @throws IOException + * Signals that an I/O exception has occurred. + * @throws ServletException + * On other errors + */ + public boolean checkAccess(HttpServletRequest req, HttpServletResponse res, NodeRef nodeRef, String permission, + boolean allowLogIn) throws IOException, ServletException + { + ServletContext sc = getServletContext(); + ServiceRegistry serviceRegistry = getServiceRegistry(sc); + PermissionService permissionService = serviceRegistry.getPermissionService(); + + // check that the user has the permission + if (permissionService.hasPermission(nodeRef, permission) == AccessStatus.DENIED) + { + if (logger.isDebugEnabled()) + logger.debug("User does not have " + permission + " permission for NodeRef: " + nodeRef.toString()); + + if (allowLogIn && serviceRegistry.getAuthorityService().hasGuestAuthority()) + { + if (logger.isDebugEnabled()) + logger.debug("Redirecting to login page..."); + redirectToLoginPage(req, res, sc); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("Forwarding to error page..."); + Application + .handleSystemError(sc, req, res, MSG_ERROR_PERMISSIONS, HttpServletResponse.SC_FORBIDDEN, logger); + } + return false; + } + return true; + } + + /** + * Redirect to the Login page - saving the current URL which can be redirected back later + * once the user has successfully completed the authentication process. + */ + public static void redirectToLoginPage(HttpServletRequest req, HttpServletResponse res, ServletContext sc) + throws IOException + { + redirectToLoginPage(req, res, sc, AuthenticationHelper.getRemoteUserMapper(sc) == null); + } + + /** + * Redirect to the Login page - saving the current URL which can be redirected back later + * once the user has successfully completed the authentication process. + * @param sendRedirect allow a redirect status code to be set? If false redirect + * will be via markup rather than status code (to allow the status code to be used for handshake + * responses etc. + */ + public static void redirectToLoginPage(HttpServletRequest req, HttpServletResponse res, ServletContext sc, boolean sendRedirect) + throws IOException + { + // Pass the full requested URL as a parameter so the login page knows where to redirect to later + final String uri = req.getRequestURI(); + String redirectURL = uri; + + // authentication failed - so end servlet execution and redirect to login page + if (WebApplicationContextUtils.getRequiredWebApplicationContext(sc).containsBean(Application.BEAN_CONFIG_SERVICE)) + { + StringBuilder redirect = new StringBuilder(128) + .append(req.getContextPath()).append(FACES_SERVLET).append(Application.getLoginPage(sc)); + + // if we find a JSF servlet reference in the URI then we need to check if the rest of the + // JSP specified is valid for a redirect operation after Login has occured. + int jspIndex; + if (uri.indexOf(req.getContextPath() + FACES_SERVLET) == -1 + || uri.length() > (jspIndex = uri.indexOf(BaseServlet.FACES_SERVLET) + BaseServlet.FACES_SERVLET.length()) + && BaseServlet.validRedirectJSP(uri.substring(jspIndex))) + { + if (redirect.indexOf("?") == -1) + { + redirect.append('?'); + } + else + { + redirect.append('&'); + } + redirect.append(LoginOutcomeBean.PARAM_REDIRECT_URL); + redirect.append('='); + String url = uri; + + // Append the query string if necessary + String queryString = req.getQueryString(); + if (queryString != null) + { + // Strip out leading ticket arguments + queryString = queryString.replaceAll("(?<=^|&)" + ARG_TICKET + "(=[^&=]*)?&", ""); + // Strip out trailing ticket arguments + queryString = queryString.replaceAll("(^|&)" + ARG_TICKET + "(=[^&=]*)?(?=&|$)", ""); + if (queryString.length() != 0) + { + url += "?" + queryString; + } + } + redirect.append(URLEncoder.encode(url, "UTF-8")); + } + redirectURL = redirect.toString(); + } + // If external authentication isn't in use (e.g. proxied share authentication), it's safe to return a redirect to the client + if (sendRedirect) + { + res.sendRedirect(redirectURL); + } + // Otherwise, we must signal to the client with an unauthorized status code and rely on a browser refresh to do + // the redirect for failover login (as we do with NTLM, Kerberos) + else + { + res.setContentType("text/html; charset=UTF-8"); + res.setStatus(HttpServletResponse.SC_UNAUTHORIZED); + + final PrintWriter out = res.getWriter(); + out.println(""); + out.println(""); + out.println("

Please log in.

"); + out.println(""); + out.close(); + } + } + + /** + * Apply the headers required to disallow caching of the response in the browser + */ + public static void setNoCacheHeaders(HttpServletResponse res) + { + res.setHeader("Cache-Control", "no-cache"); + res.setHeader("Pragma", "no-cache"); + } + + /** + * Returns true if the specified JSP file is valid for a redirect after login. + * Only a specific sub-set of the available JSPs are valid to jump directly too after a + * clean login attempt - e.g. those that do not require JSF bean context setup. This is + * a limitation of the JSP architecture. The ExternalAccessServlet provides a mechanism to + * setup the JSF bean context directly for some specific cases. + * + * @param jsp Filename of JSP to check, for example "/jsp/browse/browse.jsp" + * + * @return true if the JSP is in the list of valid direct URLs, false otherwise + */ + public static boolean validRedirectJSP(String jsp) + { + return validRedirectJSPs.contains(jsp); + } + + /** + * Resolves the given path elements to a NodeRef in the current repository + * + * @param context Faces context + * @param args The elements of the path to lookup + */ + public static NodeRef resolveWebDAVPath(FacesContext context, String[] args) + { + WebApplicationContext wc = FacesContextUtils.getRequiredWebApplicationContext(context); + return resolveWebDAVPath(wc, args, true); + } + + /** + * Resolves the given path elements to a NodeRef in the current repository + * + * @param context Faces context + * @param args The elements of the path to lookup + * @param decode True to decode the arg from UTF-8 format, false for no decoding + */ + public static NodeRef resolveWebDAVPath(FacesContext context, String[] args, boolean decode) + { + WebApplicationContext wc = FacesContextUtils.getRequiredWebApplicationContext(context); + return resolveWebDAVPath(wc, args, decode); + } + + /** + * Resolves the given path elements to a NodeRef in the current repository + * + * @param context ServletContext context + * @param args The elements of the path to lookup + */ + public static NodeRef resolveWebDAVPath(ServletContext context, String[] args) + { + WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(context); + return resolveWebDAVPath(wc, args, true); + } + + /** + * Resolves the given path elements to a NodeRef in the current repository + * + * @param context ServletContext context + * @param args The elements of the path to lookup + * @param decode True to decode the arg from UTF-8 format, false for no decoding + */ + public static NodeRef resolveWebDAVPath(ServletContext context, String[] args, boolean decode) + { + WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(context); + return resolveWebDAVPath(wc, args, decode); + } + + /** + * Resolves the given path elements to a NodeRef in the current repository + * + * @param wc WebApplicationContext Context + * @param args The elements of the path to lookup + * @param decode True to decode the arg from UTF-8 format, false for no decoding + */ + private static NodeRef resolveWebDAVPath(final WebApplicationContext wc, final String[] args, final boolean decode) + { + return AuthenticationUtil.runAs(new RunAsWork() + { + public NodeRef doWork() throws Exception + { + NodeRef nodeRef = null; + + List paths = new ArrayList(args.length - 1); + + FileInfo file = null; + try + { + // create a list of path elements (decode the URL as we go) + for (int x = 1; x < args.length; x++) + { + paths.add(decode ? URLDecoder.decode(args[x]) : args[x]); + } + + if (logger.isDebugEnabled()) + logger.debug("Attempting to resolve webdav path: " + paths); + + // get the company home node to start the search from + nodeRef = new NodeRef(Repository.getStoreRef(), Application.getCompanyRootId()); + + TenantService tenantService = (TenantService)wc.getBean("tenantService"); + if (tenantService != null && tenantService.isEnabled()) + { + if (logger.isDebugEnabled()) + logger.debug("MT is enabled."); + + NodeService nodeService = (NodeService) wc.getBean("NodeService"); + SearchService searchService = (SearchService) wc.getBean("SearchService"); + NamespaceService namespaceService = (NamespaceService) wc.getBean("NamespaceService"); + + // TODO: since these constants are used more widely than just the WebDAVServlet, + // they should be defined somewhere other than in that servlet + String rootPath = wc.getServletContext().getInitParameter(BaseServlet.KEY_ROOT_PATH); + + // note: rootNodeRef is required (for storeRef part) + nodeRef = tenantService.getRootNode(nodeService, searchService, namespaceService, rootPath, nodeRef); + } + + if (paths.size() != 0) + { + FileFolderService ffs = (FileFolderService)wc.getBean("FileFolderService"); + file = ffs.resolveNamePath(nodeRef, paths); + nodeRef = file.getNodeRef(); + } + + if (logger.isDebugEnabled()) + logger.debug("Resolved webdav path to NodeRef: " + nodeRef); + } + catch (FileNotFoundException fne) + { + if (logger.isWarnEnabled()) + logger.warn("Failed to resolve webdav path", fne); + + nodeRef = null; + } + return nodeRef; + } + }, AuthenticationUtil.getSystemUserName()); + } + + /** + * Resolve a name based into a NodeRef and Filename string + * + * @param sc ServletContext + * @param path 'cm:name' based path using the '/' character as a separator + * + * @return PathRefInfo structure containing the resolved NodeRef and filename + * + * @throws IllegalArgumentException + */ + public final static PathRefInfo resolveNamePath(ServletContext sc, String path) + { + StringTokenizer t = new StringTokenizer(path, "/"); + int tokenCount = t.countTokens(); + String[] elements = new String[tokenCount]; + for (int i=0; i - * This will show all debug entries from this class as though they - * came from the subclass. - * - * @return The logger - */ - protected abstract Log getLogger(); - - /** - * Builds the FreeMarker model - * - * @param services Service Registry instance - * @param req Http request - * @param templateRef The node ref of the template to process - * @return The FreeMarker model - */ - protected abstract Map buildModel(ServiceRegistry services, - HttpServletRequest req, NodeRef templateRef); - - /** - * Processes the template request using the current context i.e. no - * authentication checks are made, it is presumed they have already - * been done. - * - * @param req The HTTP request - * @param res The HTTP response - * @param redirectToLogin Flag to determine whether to redirect to the login - * page if the user does not have the correct permissions - */ - protected void processTemplateRequest(HttpServletRequest req, HttpServletResponse res, - boolean redirectToLogin) throws ServletException, IOException - { - Log logger = getLogger(); - String uri = req.getRequestURI(); - - if (logger.isDebugEnabled()) - { - String queryString = req.getQueryString(); - logger.debug("Processing URL: " + uri + - ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); - } - - uri = uri.substring(req.getContextPath().length()); - StringTokenizer t = new StringTokenizer(uri, "/"); - int tokenCount = t.countTokens(); - - t.nextToken(); // skip servlet name - - NodeRef nodeRef = null; - NodeRef templateRef = null; - - try - { - String contentPath = req.getParameter(ARG_CONTEXT_PATH); - if (contentPath != null && contentPath.length() != 0) - { - // process the name based path to resolve the NodeRef - PathRefInfo pathInfo = resolveNamePath(getServletContext(), contentPath); - - nodeRef = pathInfo.NodeRef; - } - else if (tokenCount > 3) - { - // get NodeRef to the content from the URL elements - StoreRef storeRef = new StoreRef(t.nextToken(), t.nextToken()); - nodeRef = new NodeRef(storeRef, t.nextToken()); - } - - // get NodeRef to the template if supplied - String templatePath = req.getParameter(ARG_TEMPLATE_PATH); - if (templatePath != null && templatePath.length() != 0) - { - // process the name based path to resolve the NodeRef - PathRefInfo pathInfo = resolveNamePath(getServletContext(), templatePath); - - templateRef = pathInfo.NodeRef; - } - else if (tokenCount >= 7) - { - StoreRef storeRef = new StoreRef(t.nextToken(), t.nextToken()); - templateRef = new NodeRef(storeRef, t.nextToken()); - } - } - catch (AccessDeniedException err) - { - if (redirectToLogin) - { - if (logger.isDebugEnabled()) - logger.debug("Redirecting to login page..."); - - redirectToLoginPage(req, res, getServletContext()); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("Returning 403 Forbidden error..."); - - res.sendError(HttpServletResponse.SC_FORBIDDEN); - } - - return; - } - - // if no context is specified, use the template itself - // TODO: should this default to something else? - if (nodeRef == null && templateRef != null) - { - nodeRef = templateRef; - } - - if (nodeRef == null) - { - throw new TemplateException("Not enough elements supplied in URL or no 'path' argument specified."); - } - - // get the services we need to retrieve the content - ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); - NodeService nodeService = serviceRegistry.getNodeService(); - TemplateService templateService = serviceRegistry.getTemplateService(); - PermissionService permissionService = serviceRegistry.getPermissionService(); - - // check that the user has at least READ access on any nodes - else redirect to the login page - if (permissionService.hasPermission(nodeRef, PermissionService.READ) == AccessStatus.DENIED || - (templateRef != null && permissionService.hasPermission(templateRef, PermissionService.READ) == AccessStatus.DENIED)) - { - if (redirectToLogin) - { - if (logger.isDebugEnabled()) - logger.debug("Redirecting to login page..."); - - redirectToLoginPage(req, res, getServletContext()); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("Returning 403 Forbidden error..."); - - res.sendError(HttpServletResponse.SC_FORBIDDEN); - } - - return; - } - - String mimetype = MIMETYPE_HTML; - if (req.getParameter(ARG_MIMETYPE) != null) - { - mimetype = req.getParameter(ARG_MIMETYPE); - } - res.setContentType(mimetype); - - try - { - UserTransaction txn = null; - try - { - txn = serviceRegistry.getTransactionService().getUserTransaction(true); - txn.begin(); - - // if template not supplied, then use the default against the node - if (templateRef == null) - { - if (nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TEMPLATABLE)) - { - templateRef = (NodeRef)nodeService.getProperty(nodeRef, ContentModel.PROP_TEMPLATE); - } - if (templateRef == null) - { - throw new TemplateException("Template reference not set against node or not supplied in URL."); - } - } - - // create the model - put the supplied noderef in as space/document as appropriate - Map model = getModel(serviceRegistry, req, templateRef, nodeRef); - - // process the template against the node content directly to the response output stream - // assuming the repo is capable of streaming in chunks, this should allow large files - // to be streamed directly to the browser response stream. - try - { - templateService.processTemplate( - templateRef.toString(), - model, - res.getWriter()); - - // commit the transaction - txn.commit(); - } - catch (SocketException e) - { - if (e.getMessage().contains("ClientAbortException")) - { - // the client cut the connection - our mission was accomplished apart from a little error message - logger.error("Client aborted stream read:\n node: " + nodeRef + "\n template: " + templateRef); - try { if (txn != null) {txn.rollback();} } catch (Exception tex) {} - } - else - { - throw e; - } - } - finally - { - res.getWriter().close(); - } - } - catch (Throwable txnErr) - { - try { if (txn != null) {txn.rollback();} } catch (Exception tex) {} - throw txnErr; - } - } - catch (Throwable err) - { - throw new AlfrescoRuntimeException("Error during template servlet processing: " + err.getMessage(), err); - } - } - - /** - * Build the model that to process the template against. - *

- * The model includes the usual template root objects such as 'companyhome', 'userhome', - * 'person' and also includes the node specified on the servlet URL as 'space' and 'document' - * - * @param services ServiceRegistry - * @param req Http request - for accessing Session and url args - * @param templateRef NodeRef of the template itself - * @param nodeRef NodeRef of the space/document to process template against - * - * @return an object model ready for executing template against - */ - @SuppressWarnings("unchecked") - private Map getModel(ServiceRegistry services, HttpServletRequest req, NodeRef templateRef, NodeRef nodeRef) - { - // build FreeMarker default model and merge - Map root = buildModel(services, req, templateRef); - - // put the current NodeRef in as "space" and "document" - root.put("space", nodeRef); - root.put("document", nodeRef); - - // add URL arguments as a map called 'args' to the root of the model - Map args = new HashMap(8, 1.0f); - Enumeration names = req.getParameterNames(); - while (names.hasMoreElements()) - { - String name = (String)names.nextElement(); - try - { - args.put(name, new String(req.getParameter(name).getBytes(), "UTF-8")); - } - catch (UnsupportedEncodingException err) {} - } - root.put("args", args); - - // Add the image resolver - root.put(TemplateService.KEY_IMAGE_RESOLVER, imageResolver); - - // method to allow client urls to be generated - root.put("url", new URLHelper(req)); - - return root; - } - - /** Template Image resolver helper */ - protected TemplateImageResolver imageResolver = new TemplateImageResolver() - { - public String resolveImagePathForName(String filename, FileTypeImageSize size) - { - return FileTypeImageUtils.getFileTypeImage(getServletContext(), filename, size); - } - }; - - /** - * Helper to return context path for generating urls - */ - public static class URLHelper - { - String contextPath; - String serverPath; - - public URLHelper(HttpServletRequest request) - { - this.contextPath = request.getContextPath(); - this.serverPath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort(); - } - - public URLHelper(FacesContext context) - { - this.contextPath = context.getExternalContext().getRequestContextPath(); - final Object request = context.getExternalContext().getRequest(); - if (request instanceof HttpServletRequest) - { - final HttpServletRequest httpServletRequest = (HttpServletRequest) request; - this.serverPath = httpServletRequest.getScheme() + "://" + httpServletRequest.getServerName() + ":" + httpServletRequest.getServerPort(); - } - } - - public String getContext() - { - return this.contextPath; - } - - public String getServerPath() - { - return this.serverPath; - } - } -} +package org.alfresco.web.app.servlet; + +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.net.SocketException; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; +import java.util.StringTokenizer; + +import javax.faces.context.FacesContext; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.transaction.UserTransaction; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.security.permissions.AccessDeniedException; +import org.alfresco.repo.web.scripts.FileTypeImageUtils; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.FileTypeImageSize; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.repository.StoreRef; +import org.alfresco.service.cmr.repository.TemplateException; +import org.alfresco.service.cmr.repository.TemplateImageResolver; +import org.alfresco.service.cmr.repository.TemplateService; +import org.alfresco.service.cmr.security.AccessStatus; +import org.alfresco.service.cmr.security.PermissionService; +import org.apache.commons.logging.Log; + +/** + * Base class for the template content servlets. Provides common + * processing for the request. + * + * @see org.alfresco.web.app.servlet.TemplateContentServlet + * @see org.alfresco.web.app.servlet.GuestTemplateContentServlet + * + * @author Kevin Roast + * @author gavinc + */ +@SuppressWarnings("serial") +public abstract class BaseTemplateContentServlet extends BaseServlet +{ + private static final String MIMETYPE_HTML = "text/html;charset=utf-8"; + + private static final long serialVersionUID = -4123407921997235977L; + + private static final String ARG_MIMETYPE = "mimetype"; + private static final String ARG_TEMPLATE_PATH = "templatePath"; + private static final String ARG_CONTEXT_PATH = "contextPath"; + + /** + * Gets the logger to use for this request. + *

+ * This will show all debug entries from this class as though they + * came from the subclass. + * + * @return The logger + */ + protected abstract Log getLogger(); + + /** + * Builds the FreeMarker model + * + * @param services Service Registry instance + * @param req Http request + * @param templateRef The node ref of the template to process + * @return The FreeMarker model + */ + protected abstract Map buildModel(ServiceRegistry services, + HttpServletRequest req, NodeRef templateRef); + + /** + * Processes the template request using the current context i.e. no + * authentication checks are made, it is presumed they have already + * been done. + * + * @param req The HTTP request + * @param res The HTTP response + * @param redirectToLogin Flag to determine whether to redirect to the login + * page if the user does not have the correct permissions + */ + protected void processTemplateRequest(HttpServletRequest req, HttpServletResponse res, + boolean redirectToLogin) throws ServletException, IOException + { + Log logger = getLogger(); + String uri = req.getRequestURI(); + + if (logger.isDebugEnabled()) + { + String queryString = req.getQueryString(); + logger.debug("Processing URL: " + uri + + ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); + } + + uri = uri.substring(req.getContextPath().length()); + StringTokenizer t = new StringTokenizer(uri, "/"); + int tokenCount = t.countTokens(); + + t.nextToken(); // skip servlet name + + NodeRef nodeRef = null; + NodeRef templateRef = null; + + try + { + String contentPath = req.getParameter(ARG_CONTEXT_PATH); + if (contentPath != null && contentPath.length() != 0) + { + // process the name based path to resolve the NodeRef + PathRefInfo pathInfo = resolveNamePath(getServletContext(), contentPath); + + nodeRef = pathInfo.NodeRef; + } + else if (tokenCount > 3) + { + // get NodeRef to the content from the URL elements + StoreRef storeRef = new StoreRef(t.nextToken(), t.nextToken()); + nodeRef = new NodeRef(storeRef, t.nextToken()); + } + + // get NodeRef to the template if supplied + String templatePath = req.getParameter(ARG_TEMPLATE_PATH); + if (templatePath != null && templatePath.length() != 0) + { + // process the name based path to resolve the NodeRef + PathRefInfo pathInfo = resolveNamePath(getServletContext(), templatePath); + + templateRef = pathInfo.NodeRef; + } + else if (tokenCount >= 7) + { + StoreRef storeRef = new StoreRef(t.nextToken(), t.nextToken()); + templateRef = new NodeRef(storeRef, t.nextToken()); + } + } + catch (AccessDeniedException err) + { + if (redirectToLogin) + { + if (logger.isDebugEnabled()) + logger.debug("Redirecting to login page..."); + + redirectToLoginPage(req, res, getServletContext()); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("Returning 403 Forbidden error..."); + + res.sendError(HttpServletResponse.SC_FORBIDDEN); + } + + return; + } + + // if no context is specified, use the template itself + // TODO: should this default to something else? + if (nodeRef == null && templateRef != null) + { + nodeRef = templateRef; + } + + if (nodeRef == null) + { + throw new TemplateException("Not enough elements supplied in URL or no 'path' argument specified."); + } + + // get the services we need to retrieve the content + ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); + NodeService nodeService = serviceRegistry.getNodeService(); + TemplateService templateService = serviceRegistry.getTemplateService(); + PermissionService permissionService = serviceRegistry.getPermissionService(); + + // check that the user has at least READ access on any nodes - else redirect to the login page + if (permissionService.hasPermission(nodeRef, PermissionService.READ) == AccessStatus.DENIED || + (templateRef != null && permissionService.hasPermission(templateRef, PermissionService.READ) == AccessStatus.DENIED)) + { + if (redirectToLogin) + { + if (logger.isDebugEnabled()) + logger.debug("Redirecting to login page..."); + + redirectToLoginPage(req, res, getServletContext()); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("Returning 403 Forbidden error..."); + + res.sendError(HttpServletResponse.SC_FORBIDDEN); + } + + return; + } + + String mimetype = MIMETYPE_HTML; + if (req.getParameter(ARG_MIMETYPE) != null) + { + mimetype = req.getParameter(ARG_MIMETYPE); + } + res.setContentType(mimetype); + + try + { + UserTransaction txn = null; + try + { + txn = serviceRegistry.getTransactionService().getUserTransaction(true); + txn.begin(); + + // if template not supplied, then use the default against the node + if (templateRef == null) + { + if (nodeService.hasAspect(nodeRef, ContentModel.ASPECT_TEMPLATABLE)) + { + templateRef = (NodeRef)nodeService.getProperty(nodeRef, ContentModel.PROP_TEMPLATE); + } + if (templateRef == null) + { + throw new TemplateException("Template reference not set against node or not supplied in URL."); + } + } + + // create the model - put the supplied noderef in as space/document as appropriate + Map model = getModel(serviceRegistry, req, templateRef, nodeRef); + + // process the template against the node content directly to the response output stream + // assuming the repo is capable of streaming in chunks, this should allow large files + // to be streamed directly to the browser response stream. + try + { + templateService.processTemplate( + templateRef.toString(), + model, + res.getWriter()); + + // commit the transaction + txn.commit(); + } + catch (SocketException e) + { + if (e.getMessage().contains("ClientAbortException")) + { + // the client cut the connection - our mission was accomplished apart from a little error message + logger.error("Client aborted stream read:\n node: " + nodeRef + "\n template: " + templateRef); + try { if (txn != null) {txn.rollback();} } catch (Exception tex) {} + } + else + { + throw e; + } + } + finally + { + res.getWriter().close(); + } + } + catch (Throwable txnErr) + { + try { if (txn != null) {txn.rollback();} } catch (Exception tex) {} + throw txnErr; + } + } + catch (Throwable err) + { + throw new AlfrescoRuntimeException("Error during template servlet processing: " + err.getMessage(), err); + } + } + + /** + * Build the model that to process the template against. + *

+ * The model includes the usual template root objects such as 'companyhome', 'userhome', + * 'person' and also includes the node specified on the servlet URL as 'space' and 'document' + * + * @param services ServiceRegistry + * @param req Http request - for accessing Session and url args + * @param templateRef NodeRef of the template itself + * @param nodeRef NodeRef of the space/document to process template against + * + * @return an object model ready for executing template against + */ + @SuppressWarnings("unchecked") + private Map getModel(ServiceRegistry services, HttpServletRequest req, NodeRef templateRef, NodeRef nodeRef) + { + // build FreeMarker default model and merge + Map root = buildModel(services, req, templateRef); + + // put the current NodeRef in as "space" and "document" + root.put("space", nodeRef); + root.put("document", nodeRef); + + // add URL arguments as a map called 'args' to the root of the model + Map args = new HashMap(8, 1.0f); + Enumeration names = req.getParameterNames(); + while (names.hasMoreElements()) + { + String name = (String)names.nextElement(); + try + { + args.put(name, new String(req.getParameter(name).getBytes(), "UTF-8")); + } + catch (UnsupportedEncodingException err) {} + } + root.put("args", args); + + // Add the image resolver + root.put(TemplateService.KEY_IMAGE_RESOLVER, imageResolver); + + // method to allow client urls to be generated + root.put("url", new URLHelper(req)); + + return root; + } + + /** Template Image resolver helper */ + protected TemplateImageResolver imageResolver = new TemplateImageResolver() + { + public String resolveImagePathForName(String filename, FileTypeImageSize size) + { + return FileTypeImageUtils.getFileTypeImage(getServletContext(), filename, size); + } + }; + + /** + * Helper to return context path for generating urls + */ + public static class URLHelper + { + String contextPath; + String serverPath; + + public URLHelper(HttpServletRequest request) + { + this.contextPath = request.getContextPath(); + this.serverPath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort(); + } + + public URLHelper(FacesContext context) + { + this.contextPath = context.getExternalContext().getRequestContextPath(); + final Object request = context.getExternalContext().getRequest(); + if (request instanceof HttpServletRequest) + { + final HttpServletRequest httpServletRequest = (HttpServletRequest) request; + this.serverPath = httpServletRequest.getScheme() + "://" + httpServletRequest.getServerName() + ":" + httpServletRequest.getServerPort(); + } + } + + public String getContext() + { + return this.contextPath; + } + + public String getServerPath() + { + return this.serverPath; + } + } +} diff --git a/source/java/org/alfresco/web/app/servlet/CommandServlet.java b/source/java/org/alfresco/web/app/servlet/CommandServlet.java index 41bc23ea2c..8c2fe89201 100644 --- a/source/java/org/alfresco/web/app/servlet/CommandServlet.java +++ b/source/java/org/alfresco/web/app/servlet/CommandServlet.java @@ -1,248 +1,248 @@ -package org.alfresco.web.app.servlet; - -import java.io.IOException; -import java.io.PrintWriter; -import java.net.MalformedURLException; -import java.net.URL; -import java.util.Enumeration; -import java.util.HashMap; -import java.util.Map; -import java.util.StringTokenizer; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import javax.transaction.UserTransaction; - -import org.springframework.extensions.config.Config; -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.command.CommandFactory; -import org.alfresco.web.app.servlet.command.CommandProcessor; -import org.alfresco.web.app.servlet.command.ExtCommandProcessor; -import org.alfresco.web.config.CommandServletConfigElement; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Servlet responsible for executing commands upon node(s). - *

- * The URL to the servlet should be generated thus: - * 

/alfresco/command/processor-name/command-name/args/...
- *

- * The 'processor-name' identifies the command processor to execute the command. For example the - * 'workflow' processor will execute workflow commands upon a node (e.g. "approve" or "reject"). - * For example: - * 

/alfresco/command/workflow/approve/workspace/SpacesStore/0000-0000-0000-0000
- * The store protocol, followed by the store ID, followed by the content Node Id used to - * identify the node to execute the workflow action upon. - *

- * A 'return-page' URL argument can be specified as the redirect page to navigate too after processing. - *

- * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: - * ?ticket=1234567890 - *

- * And/or also followed by the "?guest=true" argument to force guest access login for the URL. - * - * @author Kevin Roast - * @deprecated 5.0 not exposed in web-client web.xml - */ -public class CommandServlet extends BaseServlet -{ - private static final long serialVersionUID = -5432407921038376133L; - - private static Log logger = LogFactory.getLog(CommandServlet.class); - - private static CommandFactory commandfactory = CommandFactory.getInstance(); - - public static final String ARG_RETURNPAGE = "return-page"; - - /** - * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) - */ - protected void service(HttpServletRequest req, HttpServletResponse res) - throws ServletException, IOException - { - String uri = req.getRequestURI(); - - if (logger.isDebugEnabled()) - logger.debug("Processing URL: " + uri + (req.getQueryString() != null ? ("?" + req.getQueryString()) : "")); - - AuthenticationStatus status = servletAuthenticate(req, res); - if (status == AuthenticationStatus.Failure) - { - return; - } - - setNoCacheHeaders(res); - - uri = uri.substring(req.getContextPath().length()); - StringTokenizer t = new StringTokenizer(uri, "/"); - int tokenCount = t.countTokens(); - if (tokenCount < 3) - { - throw new IllegalArgumentException("Command Servlet URL did not contain all required args: " + uri); - } - - t.nextToken(); // skip servlet name - - // get the command processor to execute the command e.g. "workflow" - String procName = t.nextToken(); - - // get the command to perform - String command = t.nextToken(); - - // get any remaining uri elements to pass to the processor - String[] urlElements = new String[tokenCount - 3]; - for (int i=0; i args = new HashMap(8, 1.0f); - Enumeration names = req.getParameterNames(); - while (names.hasMoreElements()) - { - String name = (String)names.nextElement(); - args.put(name, req.getParameter(name)); - } - - try - { - // get configured command processor by name from Config Service - CommandProcessor processor = createCommandProcessor(procName); - - // validate that the processor has everything it needs to run the command - if (processor.validateArguments(getServletContext(), command, args, urlElements) == false) - { - redirectToLoginPage(req, res, getServletContext()); - return; - } - - ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); - UserTransaction txn = null; - try - { - txn = serviceRegistry.getTransactionService().getUserTransaction(); - txn.begin(); - - // inform the processor to execute the specified command - if (processor instanceof ExtCommandProcessor) - { - ((ExtCommandProcessor)processor).process(serviceRegistry, req, res, command); - } - else - { - processor.process(serviceRegistry, req, command); - } - - // commit the transaction - txn.commit(); - } - catch (Throwable txnErr) - { - try { if (txn != null) {txn.rollback();} } catch (Exception tex) {} - throw txnErr; - } - - String returnPage = req.getParameter(ARG_RETURNPAGE); - if (returnPage != null && returnPage.length() != 0) - { - validateReturnPage(returnPage, req); - if (logger.isDebugEnabled()) - logger.debug("Redirecting to specified return page: " + returnPage); - - res.sendRedirect(returnPage); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("No return page specified, displaying status output."); - - if (res.getContentType() == null && !res.isCommitted()) - { - res.setContentType("text/html"); - - // request that the processor output a useful status message - PrintWriter out = res.getWriter(); - processor.outputStatus(out); - out.close(); - } - } - } - catch (Throwable err) - { - throw new AlfrescoRuntimeException("Error during command servlet processing: " + err.getMessage(), err); - } - } - - /** - * ALF-9113 CommandServlet.java, line 179 (Header Manipulation) - * - * Validates that the redirect page is within the current context. - * - * Examples of valid redirect pages: - *

    - *
  • /alfresco/faces/jsp/browse/browse.jsp
    • - *
  • ../../browse/browse.jsp
    • - *
- * - * @param pageUrl - * @param req - * @throws MalformedURLException - * @throws IllegalArgumentException - */ - private void validateReturnPage(String pageUrl, HttpServletRequest req) throws MalformedURLException - { - if (pageUrl.indexOf(':') != -1) - { - // ':' only allowed in a URL as part of a scheme prefix - throw new IllegalArgumentException("The redirect URL doesn't support absolute URls"); - } - // Evaluate it relative to the request URL and strip out .. and . - pageUrl = new URL(new URL(req.getRequestURL().toString()), pageUrl).getPath(); - if (!pageUrl.startsWith(req.getContextPath())) - { - throw new IllegalArgumentException("The redirect URL must be in the same context."); - } - } - - /** - * Created the specified CommandProcessor instance. The name of the processor is looked up - * in the client config, it should find a valid class impl and then create it. - * - * @param procName Name of the CommandProcessor to lookup in the client config. - * - * @return CommandProcessor - * - * @throws InstantiationException - * @throws IllegalAccessException - */ - private CommandProcessor createCommandProcessor(String procName) - throws InstantiationException, IllegalAccessException - { - Config config = Application.getConfigService(getServletContext()).getConfig("Command Servlet"); - if (config == null) - { - throw new AlfrescoRuntimeException("No command processors configured - unable to process any commands."); - } - - CommandServletConfigElement configElement = (CommandServletConfigElement) - config.getConfigElement(CommandServletConfigElement.CONFIG_ELEMENT_ID); - if (configElement == null) - { - throw new AlfrescoRuntimeException("No command processors configured - unable to process any commands."); - } - - Class clazz = configElement.getCommandProcessor(procName); - Object obj = clazz.newInstance(); - if (obj instanceof CommandProcessor == false) - { - throw new AlfrescoRuntimeException("Configured command processor '" + procName + "' is does not implement interface CommandProcessor!"); - } - - return (CommandProcessor)obj; - } -} +package org.alfresco.web.app.servlet; + +import java.io.IOException; +import java.io.PrintWriter; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; +import java.util.StringTokenizer; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.transaction.UserTransaction; + +import org.springframework.extensions.config.Config; +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.command.CommandFactory; +import org.alfresco.web.app.servlet.command.CommandProcessor; +import org.alfresco.web.app.servlet.command.ExtCommandProcessor; +import org.alfresco.web.config.CommandServletConfigElement; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Servlet responsible for executing commands upon node(s). + *

+ * The URL to the servlet should be generated thus: + * 

/alfresco/command/processor-name/command-name/args/...
+ *

+ * The 'processor-name' identifies the command processor to execute the command. For example the + * 'workflow' processor will execute workflow commands upon a node (e.g. "approve" or "reject"). + * For example: + * 

/alfresco/command/workflow/approve/workspace/SpacesStore/0000-0000-0000-0000
+ * The store protocol, followed by the store ID, followed by the content Node Id used to + * identify the node to execute the workflow action upon. + *

+ * A 'return-page' URL argument can be specified as the redirect page to navigate too after processing. + *

+ * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: + * ?ticket=1234567890 + *

+ * And/or also followed by the "?guest=true" argument to force guest access login for the URL. + * + * @author Kevin Roast + * @deprecated 5.0 not exposed in web-client web.xml + */ +public class CommandServlet extends BaseServlet +{ + private static final long serialVersionUID = -5432407921038376133L; + + private static Log logger = LogFactory.getLog(CommandServlet.class); + + private static CommandFactory commandfactory = CommandFactory.getInstance(); + + public static final String ARG_RETURNPAGE = "return-page"; + + /** + * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) + */ + protected void service(HttpServletRequest req, HttpServletResponse res) + throws ServletException, IOException + { + String uri = req.getRequestURI(); + + if (logger.isDebugEnabled()) + logger.debug("Processing URL: " + uri + (req.getQueryString() != null ? ("?" + req.getQueryString()) : "")); + + AuthenticationStatus status = servletAuthenticate(req, res); + if (status == AuthenticationStatus.Failure) + { + return; + } + + setNoCacheHeaders(res); + + uri = uri.substring(req.getContextPath().length()); + StringTokenizer t = new StringTokenizer(uri, "/"); + int tokenCount = t.countTokens(); + if (tokenCount < 3) + { + throw new IllegalArgumentException("Command Servlet URL did not contain all required args: " + uri); + } + + t.nextToken(); // skip servlet name + + // get the command processor to execute the command e.g. "workflow" + String procName = t.nextToken(); + + // get the command to perform + String command = t.nextToken(); + + // get any remaining uri elements to pass to the processor + String[] urlElements = new String[tokenCount - 3]; + for (int i=0; i args = new HashMap(8, 1.0f); + Enumeration names = req.getParameterNames(); + while (names.hasMoreElements()) + { + String name = (String)names.nextElement(); + args.put(name, req.getParameter(name)); + } + + try + { + // get configured command processor by name from Config Service + CommandProcessor processor = createCommandProcessor(procName); + + // validate that the processor has everything it needs to run the command + if (processor.validateArguments(getServletContext(), command, args, urlElements) == false) + { + redirectToLoginPage(req, res, getServletContext()); + return; + } + + ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); + UserTransaction txn = null; + try + { + txn = serviceRegistry.getTransactionService().getUserTransaction(); + txn.begin(); + + // inform the processor to execute the specified command + if (processor instanceof ExtCommandProcessor) + { + ((ExtCommandProcessor)processor).process(serviceRegistry, req, res, command); + } + else + { + processor.process(serviceRegistry, req, command); + } + + // commit the transaction + txn.commit(); + } + catch (Throwable txnErr) + { + try { if (txn != null) {txn.rollback();} } catch (Exception tex) {} + throw txnErr; + } + + String returnPage = req.getParameter(ARG_RETURNPAGE); + if (returnPage != null && returnPage.length() != 0) + { + validateReturnPage(returnPage, req); + if (logger.isDebugEnabled()) + logger.debug("Redirecting to specified return page: " + returnPage); + + res.sendRedirect(returnPage); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("No return page specified, displaying status output."); + + if (res.getContentType() == null && !res.isCommitted()) + { + res.setContentType("text/html"); + + // request that the processor output a useful status message + PrintWriter out = res.getWriter(); + processor.outputStatus(out); + out.close(); + } + } + } + catch (Throwable err) + { + throw new AlfrescoRuntimeException("Error during command servlet processing: " + err.getMessage(), err); + } + } + + /** + * ALF-9113 CommandServlet.java, line 179 (Header Manipulation) + * + * Validates that the redirect page is within the current context. + * + * Examples of valid redirect pages: + *

    + *
  • /alfresco/faces/jsp/browse/browse.jsp
    • + *
  • ../../browse/browse.jsp
    • + *
+ * + * @param pageUrl + * @param req + * @throws MalformedURLException + * @throws IllegalArgumentException + */ + private void validateReturnPage(String pageUrl, HttpServletRequest req) throws MalformedURLException + { + if (pageUrl.indexOf(':') != -1) + { + // ':' only allowed in a URL as part of a scheme prefix + throw new IllegalArgumentException("The redirect URL doesn't support absolute URls"); + } + // Evaluate it relative to the request URL and strip out .. and . + pageUrl = new URL(new URL(req.getRequestURL().toString()), pageUrl).getPath(); + if (!pageUrl.startsWith(req.getContextPath())) + { + throw new IllegalArgumentException("The redirect URL must be in the same context."); + } + } + + /** + * Created the specified CommandProcessor instance. The name of the processor is looked up + * in the client config, it should find a valid class impl and then create it. + * + * @param procName Name of the CommandProcessor to lookup in the client config. + * + * @return CommandProcessor + * + * @throws InstantiationException + * @throws IllegalAccessException + */ + private CommandProcessor createCommandProcessor(String procName) + throws InstantiationException, IllegalAccessException + { + Config config = Application.getConfigService(getServletContext()).getConfig("Command Servlet"); + if (config == null) + { + throw new AlfrescoRuntimeException("No command processors configured - unable to process any commands."); + } + + CommandServletConfigElement configElement = (CommandServletConfigElement) + config.getConfigElement(CommandServletConfigElement.CONFIG_ELEMENT_ID); + if (configElement == null) + { + throw new AlfrescoRuntimeException("No command processors configured - unable to process any commands."); + } + + Class clazz = configElement.getCommandProcessor(procName); + Object obj = clazz.newInstance(); + if (obj instanceof CommandProcessor == false) + { + throw new AlfrescoRuntimeException("Configured command processor '" + procName + "' is does not implement interface CommandProcessor!"); + } + + return (CommandProcessor)obj; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/FacesHelper.java b/source/java/org/alfresco/web/app/servlet/FacesHelper.java index e09ecf526e..c58e116773 100644 --- a/source/java/org/alfresco/web/app/servlet/FacesHelper.java +++ b/source/java/org/alfresco/web/app/servlet/FacesHelper.java @@ -1,320 +1,320 @@ -package org.alfresco.web.app.servlet; - -import javax.faces.FactoryFinder; -import javax.faces.component.UIComponent; -import javax.faces.component.UIViewRoot; -import javax.faces.context.FacesContext; -import javax.faces.context.FacesContextFactory; -import javax.faces.el.EvaluationException; -import javax.faces.el.ValueBinding; -import javax.faces.lifecycle.Lifecycle; -import javax.faces.lifecycle.LifecycleFactory; -import javax.servlet.ServletContext; -import javax.servlet.ServletRequest; -import javax.servlet.ServletResponse; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.web.bean.generator.IComponentGenerator; -import org.alfresco.web.ui.repo.RepoConstants; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * @author Kevin Roast - */ -public final class FacesHelper -{ - /** Root browse screen JSF view ID */ - public static final String BROWSE_VIEW_ID = "/jsp/browse/browse.jsp"; - - private static Log logger = LogFactory.getLog(FacesHelper.class); - - /** - * Mask for hex encoding - */ - private static final int MASK = (1 << 4) - 1; - - /** - * Digits used for hex string encoding - */ - private static final char[] DIGITS = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'}; - - - /** - * Private constructor - */ - private FacesHelper() - { - } - - /** - * Return a valid FacesContext for the specific context, request and response. - * The FacesContext can be constructor for Servlet use. - * - * @param context ServletContext - * @param request ServletRequest - * @param response ServletReponse - * - * @return FacesContext - */ - public static FacesContext getFacesContext(ServletRequest request, ServletResponse response, ServletContext context) - { - return getFacesContextImpl(request, response, context, null); - } - - /** - * Return a valid FacesContext for the specific context, request and response. - * The FacesContext can be constructor for Servlet use. - * - * @param context ServletContext - * @param request ServletRequest - * @param response ServletReponse - * - * @return FacesContext - */ - public static FacesContext getFacesContext(ServletRequest request, ServletResponse response, ServletContext context, String viewRoot) - { - return getFacesContextImpl(request, response, context, viewRoot); - } - - /** - * Return a valid FacesContext for the specific context, request and response. - * The FacesContext can be constructor for Servlet use. - * - * @param context PortletContext - * @param request PortletRequest - * @param response PortletResponse - * - * @return FacesContext - */ - public static FacesContext getFacesContext(Object request, Object response, Object context) - { - return getFacesContextImpl(request, response, context, null); - } - - /** - * Return a valid FacesContext for the specific context, request and response. - * The FacesContext can be constructor for Servlet and Portlet use. - * - * @param context ServletContext or PortletContext - * @param request ServletRequest or PortletRequest - * @param response ServletReponse or PortletResponse - * - * @return FacesContext - */ - private static FacesContext getFacesContextImpl(Object request, Object response, Object context, String viewRoot) - { - FacesContextFactory contextFactory = (FacesContextFactory)FactoryFinder.getFactory(FactoryFinder.FACES_CONTEXT_FACTORY); - LifecycleFactory lifecycleFactory = (LifecycleFactory)FactoryFinder.getFactory(FactoryFinder.LIFECYCLE_FACTORY); - Lifecycle lifecycle = lifecycleFactory.getLifecycle(LifecycleFactory.DEFAULT_LIFECYCLE); - - // Doesn't set this instance as the current instance of FacesContext.getCurrentInstance - FacesContext facesContext = contextFactory.getFacesContext(context, request, response, lifecycle); - - // Set using our inner class - InnerFacesContext.setFacesContextAsCurrent(facesContext); - - // set a new viewRoot, otherwise context.getViewRoot returns null - if (viewRoot == null) - { - viewRoot = FacesHelper.BROWSE_VIEW_ID; - } - - UIViewRoot view = facesContext.getApplication().getViewHandler().createView(facesContext, viewRoot); - facesContext.setViewRoot(view); - - return facesContext; - } - - /** - * Return a JSF managed bean reference. - * - * @param fc FacesContext - * @param name Name of the managed bean to return - * - * @return the managed bean or null if not found - */ - public static Object getManagedBean(FacesContext fc, String name) - { - Object obj = null; - - try - { - ValueBinding vb = fc.getApplication().createValueBinding("#{" + name + "}"); - obj = vb.getValue(fc); - } - catch (EvaluationException ee) - { - // catch exception to resolve ADB-158/ACT-7343 - // not much we can do here, just make sure return is null - if (logger.isDebugEnabled()) - logger.debug("Failed to resolve managed bean: " + name, ee); - obj = null; - } - - return obj; - } - - /** - * Sets up the id for the given component, if the id is null a unique one - * is generated using the standard Faces algorithm. If an id is present it - * is checked for illegal characters. - * - * @param context FacesContext - * @param component The component to set the id for - * @param id The id to set - */ - public static void setupComponentId(FacesContext context, UIComponent component, String id) - { - if (id == null) - { - id = context.getViewRoot().createUniqueId(); - } - else - { - // make sure we do not have illegal characters in the id - id = makeLegalId(id); - } - - component.setId(id); - } - - /** - * Makes the given id a legal JSF component id by replacing illegal characters - * with ISO9075 encoding - which itself a subset of valid HTML ID characters. - * - * @param id The id to make legal - * - * @return the legalised id - */ - public static String makeLegalId(String id) - { - return (id != null ? validFacesId(id) : null); - } - - /** - * Retrieves the named component generator implementation. - * If the named generator is not found the TextFieldGenerator is looked up - * as a default, if this is also not found an AlfrescoRuntimeException is thrown. - * - * @param context FacesContext - * @param generatorName The name of the component generator to retrieve - * @return The component generator instance - */ - public static IComponentGenerator getComponentGenerator(FacesContext context, String generatorName) - { - IComponentGenerator generator = lookupComponentGenerator(context, generatorName); - - if (generator == null) - { - // create a text field if we can't find a component generator (a warning should have already been - // displayed on the appserver console) - - logger.warn("Attempting to find default component generator '" + RepoConstants.GENERATOR_TEXT_FIELD + "'"); - generator = lookupComponentGenerator(context, RepoConstants.GENERATOR_TEXT_FIELD); - } - - // if we still don't have a component generator we should abort as vital configuration is missing - if (generator == null) - { - throw new AlfrescoRuntimeException("Failed to find a component generator, please ensure the '" + - RepoConstants.GENERATOR_TEXT_FIELD + "' bean is present in your configuration"); - } - - return generator; - } - - private static IComponentGenerator lookupComponentGenerator(FacesContext context, String generatorName) - { - IComponentGenerator generator = null; - - Object obj = FacesHelper.getManagedBean(context, generatorName); - if (obj != null) - { - if (obj instanceof IComponentGenerator) - { - generator = (IComponentGenerator)obj; - - if (logger.isDebugEnabled()) - logger.debug("Found component generator for '" + generatorName + "': " + generator); - } - else - { - logger.warn("Bean '" + generatorName + "' does not implement IComponentGenerator"); - } - } - else - { - logger.warn("Failed to find component generator with name of '" + generatorName + "'"); - } - - return generator; - } - - /** - * We need an inner class to be able to call FacesContext.setCurrentInstance - * since it's a protected method - */ - private abstract static class InnerFacesContext extends FacesContext - { - protected static void setFacesContextAsCurrent(FacesContext facesContext) - { - FacesContext.setCurrentInstance(facesContext); - } - } - - /** - * Helper to ensure only valid and acceptable characters are output as Faces component IDs. - * Based on ISO9075 encoding - which itself a subset of valid HTML ID characters. - */ - private static String validFacesId(String id) - { - int len = id.length(); - StringBuilder buf = new StringBuilder(len + (len>>1)); - for (int i = 0; i= 65 && ci <= 90) || // A-Z - (ci >= 97 && ci <= 122)) // a-z - { - buf.append(c); - } - else - { - encode(c, buf); - } - } - else - { - if ((ci >= 65 && ci <= 90) || // A-Z - (ci >= 97 && ci <= 122) || // a-z - (ci >= 48 && ci <= 57) || // 0-9 - ci == 45 || ci == 95) // - and _ - { - buf.append(c); - } - else - { - encode(c, buf); - } - } - } - return buf.toString(); - } - - private static void encode(char c, StringBuilder builder) - { - char[] buf = new char[] { 'x', '0', '0', '0', '0', '_' }; - int charPos = 5; - do - { - buf[--charPos] = DIGITS[c & MASK]; - c >>>= 4; - } - while (c != 0); - builder.append(buf); - } -} +package org.alfresco.web.app.servlet; + +import javax.faces.FactoryFinder; +import javax.faces.component.UIComponent; +import javax.faces.component.UIViewRoot; +import javax.faces.context.FacesContext; +import javax.faces.context.FacesContextFactory; +import javax.faces.el.EvaluationException; +import javax.faces.el.ValueBinding; +import javax.faces.lifecycle.Lifecycle; +import javax.faces.lifecycle.LifecycleFactory; +import javax.servlet.ServletContext; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.bean.generator.IComponentGenerator; +import org.alfresco.web.ui.repo.RepoConstants; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * @author Kevin Roast + */ +public final class FacesHelper +{ + /** Root browse screen JSF view ID */ + public static final String BROWSE_VIEW_ID = "/jsp/browse/browse.jsp"; + + private static Log logger = LogFactory.getLog(FacesHelper.class); + + /** + * Mask for hex encoding + */ + private static final int MASK = (1 << 4) - 1; + + /** + * Digits used for hex string encoding + */ + private static final char[] DIGITS = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'}; + + + /** + * Private constructor + */ + private FacesHelper() + { + } + + /** + * Return a valid FacesContext for the specific context, request and response. + * The FacesContext can be constructor for Servlet use. + * + * @param context ServletContext + * @param request ServletRequest + * @param response ServletReponse + * + * @return FacesContext + */ + public static FacesContext getFacesContext(ServletRequest request, ServletResponse response, ServletContext context) + { + return getFacesContextImpl(request, response, context, null); + } + + /** + * Return a valid FacesContext for the specific context, request and response. + * The FacesContext can be constructor for Servlet use. + * + * @param context ServletContext + * @param request ServletRequest + * @param response ServletReponse + * + * @return FacesContext + */ + public static FacesContext getFacesContext(ServletRequest request, ServletResponse response, ServletContext context, String viewRoot) + { + return getFacesContextImpl(request, response, context, viewRoot); + } + + /** + * Return a valid FacesContext for the specific context, request and response. + * The FacesContext can be constructor for Servlet use. + * + * @param context PortletContext + * @param request PortletRequest + * @param response PortletResponse + * + * @return FacesContext + */ + public static FacesContext getFacesContext(Object request, Object response, Object context) + { + return getFacesContextImpl(request, response, context, null); + } + + /** + * Return a valid FacesContext for the specific context, request and response. + * The FacesContext can be constructor for Servlet and Portlet use. + * + * @param context ServletContext or PortletContext + * @param request ServletRequest or PortletRequest + * @param response ServletReponse or PortletResponse + * + * @return FacesContext + */ + private static FacesContext getFacesContextImpl(Object request, Object response, Object context, String viewRoot) + { + FacesContextFactory contextFactory = (FacesContextFactory)FactoryFinder.getFactory(FactoryFinder.FACES_CONTEXT_FACTORY); + LifecycleFactory lifecycleFactory = (LifecycleFactory)FactoryFinder.getFactory(FactoryFinder.LIFECYCLE_FACTORY); + Lifecycle lifecycle = lifecycleFactory.getLifecycle(LifecycleFactory.DEFAULT_LIFECYCLE); + + // Doesn't set this instance as the current instance of FacesContext.getCurrentInstance + FacesContext facesContext = contextFactory.getFacesContext(context, request, response, lifecycle); + + // Set using our inner class + InnerFacesContext.setFacesContextAsCurrent(facesContext); + + // set a new viewRoot, otherwise context.getViewRoot returns null + if (viewRoot == null) + { + viewRoot = FacesHelper.BROWSE_VIEW_ID; + } + + UIViewRoot view = facesContext.getApplication().getViewHandler().createView(facesContext, viewRoot); + facesContext.setViewRoot(view); + + return facesContext; + } + + /** + * Return a JSF managed bean reference. + * + * @param fc FacesContext + * @param name Name of the managed bean to return + * + * @return the managed bean or null if not found + */ + public static Object getManagedBean(FacesContext fc, String name) + { + Object obj = null; + + try + { + ValueBinding vb = fc.getApplication().createValueBinding("#{" + name + "}"); + obj = vb.getValue(fc); + } + catch (EvaluationException ee) + { + // catch exception to resolve ADB-158/ACT-7343 + // not much we can do here, just make sure return is null + if (logger.isDebugEnabled()) + logger.debug("Failed to resolve managed bean: " + name, ee); + obj = null; + } + + return obj; + } + + /** + * Sets up the id for the given component, if the id is null a unique one + * is generated using the standard Faces algorithm. If an id is present it + * is checked for illegal characters. + * + * @param context FacesContext + * @param component The component to set the id for + * @param id The id to set + */ + public static void setupComponentId(FacesContext context, UIComponent component, String id) + { + if (id == null) + { + id = context.getViewRoot().createUniqueId(); + } + else + { + // make sure we do not have illegal characters in the id + id = makeLegalId(id); + } + + component.setId(id); + } + + /** + * Makes the given id a legal JSF component id by replacing illegal characters + * with ISO9075 encoding - which itself a subset of valid HTML ID characters. + * + * @param id The id to make legal + * + * @return the legalised id + */ + public static String makeLegalId(String id) + { + return (id != null ? validFacesId(id) : null); + } + + /** + * Retrieves the named component generator implementation. + * If the named generator is not found the TextFieldGenerator is looked up + * as a default, if this is also not found an AlfrescoRuntimeException is thrown. + * + * @param context FacesContext + * @param generatorName The name of the component generator to retrieve + * @return The component generator instance + */ + public static IComponentGenerator getComponentGenerator(FacesContext context, String generatorName) + { + IComponentGenerator generator = lookupComponentGenerator(context, generatorName); + + if (generator == null) + { + // create a text field if we can't find a component generator (a warning should have already been + // displayed on the appserver console) + + logger.warn("Attempting to find default component generator '" + RepoConstants.GENERATOR_TEXT_FIELD + "'"); + generator = lookupComponentGenerator(context, RepoConstants.GENERATOR_TEXT_FIELD); + } + + // if we still don't have a component generator we should abort as vital configuration is missing + if (generator == null) + { + throw new AlfrescoRuntimeException("Failed to find a component generator, please ensure the '" + + RepoConstants.GENERATOR_TEXT_FIELD + "' bean is present in your configuration"); + } + + return generator; + } + + private static IComponentGenerator lookupComponentGenerator(FacesContext context, String generatorName) + { + IComponentGenerator generator = null; + + Object obj = FacesHelper.getManagedBean(context, generatorName); + if (obj != null) + { + if (obj instanceof IComponentGenerator) + { + generator = (IComponentGenerator)obj; + + if (logger.isDebugEnabled()) + logger.debug("Found component generator for '" + generatorName + "': " + generator); + } + else + { + logger.warn("Bean '" + generatorName + "' does not implement IComponentGenerator"); + } + } + else + { + logger.warn("Failed to find component generator with name of '" + generatorName + "'"); + } + + return generator; + } + + /** + * We need an inner class to be able to call FacesContext.setCurrentInstance + * since it's a protected method + */ + private abstract static class InnerFacesContext extends FacesContext + { + protected static void setFacesContextAsCurrent(FacesContext facesContext) + { + FacesContext.setCurrentInstance(facesContext); + } + } + + /** + * Helper to ensure only valid and acceptable characters are output as Faces component IDs. + * Based on ISO9075 encoding - which itself a subset of valid HTML ID characters. + */ + private static String validFacesId(String id) + { + int len = id.length(); + StringBuilder buf = new StringBuilder(len + (len>>1)); + for (int i = 0; i= 65 && ci <= 90) || // A-Z + (ci >= 97 && ci <= 122)) // a-z + { + buf.append(c); + } + else + { + encode(c, buf); + } + } + else + { + if ((ci >= 65 && ci <= 90) || // A-Z + (ci >= 97 && ci <= 122) || // a-z + (ci >= 48 && ci <= 57) || // 0-9 + ci == 45 || ci == 95) // - and _ + { + buf.append(c); + } + else + { + encode(c, buf); + } + } + } + return buf.toString(); + } + + private static void encode(char c, StringBuilder builder) + { + char[] buf = new char[] { 'x', '0', '0', '0', '0', '_' }; + int charPos = 5; + do + { + buf[--charPos] = DIGITS[c & MASK]; + c >>>= 4; + } + while (c != 0); + builder.append(buf); + } +} diff --git a/source/java/org/alfresco/web/app/servlet/GuestDownloadContentServlet.java b/source/java/org/alfresco/web/app/servlet/GuestDownloadContentServlet.java index 77efb3c717..858b0b97b1 100644 --- a/source/java/org/alfresco/web/app/servlet/GuestDownloadContentServlet.java +++ b/source/java/org/alfresco/web/app/servlet/GuestDownloadContentServlet.java @@ -1,130 +1,130 @@ -package org.alfresco.web.app.servlet; - -import java.io.IOException; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.repo.security.authentication.AuthenticationUtil; -import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; -import org.alfresco.service.cmr.repository.NodeRef; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Servlet responsible for streaming node content from the repo directly to the response stream. - * The appropriate mimetype is calculated based on filename extension. - *

- * The URL to the servlet should be generated thus: - * 

/alfresco/guestDownload/attach/workspace/SpacesStore/0000-0000-0000-0000/myfile.pdf
- * or - * 
/alfresco/guestDownload/direct/workspace/SpacesStore/0000-0000-0000-0000/myfile.pdf
- * or - * 
/alfresco/guestDownload/[direct|attach]?path=/Company%20Home/MyFolder/myfile.pdf
- * The protocol, followed by either the store and Id (NodeRef) or instead specify a name based - * encoded Path to the content, note that the filename element is used for mimetype lookup and - * as the returning filename for the response stream. - *

- * The 'attach' or 'direct' element is used to indicate whether to display the stream directly - * in the browser or download it as a file attachment. - *

- * By default, the download assumes that the content is on the - * {@link org.alfresco.model.ContentModel#PROP_CONTENT content property}.
- * To retrieve the content of a specific model property, use a 'property' arg, providing the workspace, - * node ID AND the qualified name of the property. - *

- * This servlet only accesses content available to the guest user. If the guest user does not - * have access to the requested a 403 Forbidden response is returned to the caller. - *

- * This servlet does not effect the current session, therefore if guest access is required to a - * resource this servlet can be used without logging out the current user. - * - * @author gavinc - */ -public class GuestDownloadContentServlet extends BaseDownloadContentServlet -{ - private static final long serialVersionUID = -5258137503339817457L; - - private static Log logger = LogFactory.getLog(GuestDownloadContentServlet.class); - - private static final String DOWNLOAD_URL = "/gd/" + URL_ATTACH + "/{0}/{1}/{2}/{3}"; - private static final String BROWSER_URL = "/gd/" + URL_DIRECT + "/{0}/{1}/{2}/{3}"; - - @Override - protected Log getLogger() - { - return logger; - } - - /** - * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) - */ - protected void doGet(HttpServletRequest req, HttpServletResponse res) - throws ServletException, IOException - { - if (logger.isDebugEnabled()) - { - String queryString = req.getQueryString(); - logger.debug("Setting up guest access to URL: " + req.getRequestURI() + - ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); - } - - DownloadContentWork dcw = new DownloadContentWork(req, res); - AuthenticationUtil.runAs(dcw, AuthenticationUtil.getGuestUserName()); - } - - /** - * Helper to generate a URL to a content node for downloading content from the server. - * The content is supplied as an HTTP1.1 attachment to the response. This generally means - * a browser should prompt the user to save the content to specified location. - * - * @param ref NodeRef of the content node to generate URL for (cannot be null) - * @param name File name to return in the URL (cannot be null) - * - * @return URL to download the content from the specified node - */ - public final static String generateDownloadURL(NodeRef ref, String name) - { - return generateUrl(DOWNLOAD_URL, ref, name); - } - - /** - * Helper to generate a URL to a content node for downloading content from the server. - * The content is supplied directly in the reponse. This generally means a browser will - * attempt to open the content directly if possible, else it will prompt to save the file. - * - * @param ref NodeRef of the content node to generate URL for (cannot be null) - * @param name File name to return in the URL (cannot be null) - * - * @return URL to download the content from the specified node - */ - public final static String generateBrowserURL(NodeRef ref, String name) - { - return generateUrl(BROWSER_URL, ref, name); - } - - /** - * Class to wrap the call to processDownloadRequest. - * - * @author gavinc - */ - public class DownloadContentWork implements RunAsWork - { - private HttpServletRequest req = null; - private HttpServletResponse res = null; - - public DownloadContentWork(HttpServletRequest req, HttpServletResponse res) - { - this.req = req; - this.res = res; - } - - public Object doWork() throws Exception - { - processDownloadRequest(this.req, this.res, false, true); - - return null; - } - } -} +package org.alfresco.web.app.servlet; + +import java.io.IOException; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.repo.security.authentication.AuthenticationUtil; +import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; +import org.alfresco.service.cmr.repository.NodeRef; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Servlet responsible for streaming node content from the repo directly to the response stream. + * The appropriate mimetype is calculated based on filename extension. + *

+ * The URL to the servlet should be generated thus: + * 

/alfresco/guestDownload/attach/workspace/SpacesStore/0000-0000-0000-0000/myfile.pdf
+ * or + * 
/alfresco/guestDownload/direct/workspace/SpacesStore/0000-0000-0000-0000/myfile.pdf
+ * or + * 
/alfresco/guestDownload/[direct|attach]?path=/Company%20Home/MyFolder/myfile.pdf
+ * The protocol, followed by either the store and Id (NodeRef) or instead specify a name based + * encoded Path to the content, note that the filename element is used for mimetype lookup and + * as the returning filename for the response stream. + *

+ * The 'attach' or 'direct' element is used to indicate whether to display the stream directly + * in the browser or download it as a file attachment. + *

+ * By default, the download assumes that the content is on the + * {@link org.alfresco.model.ContentModel#PROP_CONTENT content property}.
+ * To retrieve the content of a specific model property, use a 'property' arg, providing the workspace, + * node ID AND the qualified name of the property. + *

+ * This servlet only accesses content available to the guest user. If the guest user does not + * have access to the requested a 403 Forbidden response is returned to the caller. + *

+ * This servlet does not effect the current session, therefore if guest access is required to a + * resource this servlet can be used without logging out the current user. + * + * @author gavinc + */ +public class GuestDownloadContentServlet extends BaseDownloadContentServlet +{ + private static final long serialVersionUID = -5258137503339817457L; + + private static Log logger = LogFactory.getLog(GuestDownloadContentServlet.class); + + private static final String DOWNLOAD_URL = "/gd/" + URL_ATTACH + "/{0}/{1}/{2}/{3}"; + private static final String BROWSER_URL = "/gd/" + URL_DIRECT + "/{0}/{1}/{2}/{3}"; + + @Override + protected Log getLogger() + { + return logger; + } + + /** + * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) + */ + protected void doGet(HttpServletRequest req, HttpServletResponse res) + throws ServletException, IOException + { + if (logger.isDebugEnabled()) + { + String queryString = req.getQueryString(); + logger.debug("Setting up guest access to URL: " + req.getRequestURI() + + ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); + } + + DownloadContentWork dcw = new DownloadContentWork(req, res); + AuthenticationUtil.runAs(dcw, AuthenticationUtil.getGuestUserName()); + } + + /** + * Helper to generate a URL to a content node for downloading content from the server. + * The content is supplied as an HTTP1.1 attachment to the response. This generally means + * a browser should prompt the user to save the content to specified location. + * + * @param ref NodeRef of the content node to generate URL for (cannot be null) + * @param name File name to return in the URL (cannot be null) + * + * @return URL to download the content from the specified node + */ + public final static String generateDownloadURL(NodeRef ref, String name) + { + return generateUrl(DOWNLOAD_URL, ref, name); + } + + /** + * Helper to generate a URL to a content node for downloading content from the server. + * The content is supplied directly in the reponse. This generally means a browser will + * attempt to open the content directly if possible, else it will prompt to save the file. + * + * @param ref NodeRef of the content node to generate URL for (cannot be null) + * @param name File name to return in the URL (cannot be null) + * + * @return URL to download the content from the specified node + */ + public final static String generateBrowserURL(NodeRef ref, String name) + { + return generateUrl(BROWSER_URL, ref, name); + } + + /** + * Class to wrap the call to processDownloadRequest. + * + * @author gavinc + */ + public class DownloadContentWork implements RunAsWork + { + private HttpServletRequest req = null; + private HttpServletResponse res = null; + + public DownloadContentWork(HttpServletRequest req, HttpServletResponse res) + { + this.req = req; + this.res = res; + } + + public Object doWork() throws Exception + { + processDownloadRequest(this.req, this.res, false, true); + + return null; + } + } +} diff --git a/source/java/org/alfresco/web/app/servlet/GuestTemplateContentServlet.java b/source/java/org/alfresco/web/app/servlet/GuestTemplateContentServlet.java index 9c45ff3dbe..5056bc0ae8 100644 --- a/source/java/org/alfresco/web/app/servlet/GuestTemplateContentServlet.java +++ b/source/java/org/alfresco/web/app/servlet/GuestTemplateContentServlet.java @@ -1,171 +1,171 @@ -package org.alfresco.web.app.servlet; - -import java.io.IOException; -import java.text.MessageFormat; -import java.util.Map; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.security.authentication.AuthenticationUtil; -import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.security.AuthenticationService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.cmr.security.PersonService; -import org.alfresco.web.bean.repository.User; -import org.alfresco.web.ui.repo.component.template.DefaultModelHelper; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Servlet responsible for streaming content from a template processed against a node directly - * to the response stream. - *

- * The URL to the servlet should be generated thus: - * 

/alfresco/template/workspace/SpacesStore/0000-0000-0000-0000
- * or - * 
/alfresco/template/workspace/SpacesStore/0000-0000-0000-0000/workspace/SpacesStore/0000-0000-0000-0000
- * or - * 
/alfresco/template?templatePath=/Company%20Home/Data%20Dictionary/Presentation%20Templates/doc_info.ftl&contextPath=/Company%20Home/mydoc.txt
- *

- * The store protocol, followed by the store ID, followed by the content Node Id used to - * identify the node to execute the default template for. The second set of elements encode - * the store and node Id of the template to used if a default is not set or not requested. Instead - * of using NodeRef references to the template and context, path arguments can be used. The URL args - * of 'templatePath' and 'contextPath' can be used instead to specify name based encoded Paths to the - * template and its context. - *

- * The URL may be followed by a 'mimetype' argument specifying the mimetype to return the result as - * on the stream. Otherwise it is assumed that HTML is the default response mimetype. - *

- * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: - * ?ticket=1234567890 - *

- * And/or also followed by the "?guest=true" argument to force guest access login for the URL. If the - * guest=true parameter is used the current session will be logged out and the guest user logged in. - * Therefore upon completion of this request the current user will be "guest". - *

- * This servlet only accesses content available to the guest user. If the guest user does not - * have access to the requested a 401 Forbidden response is returned to the caller. - *

- * This servlet does not effect the current session, therefore if guest access is required to a - * resource this servlet can be used without logging out the current user. - * - * @author gavinc - * @deprecated 5.0 not exposed in web-client web.xml - */ -public class GuestTemplateContentServlet extends BaseTemplateContentServlet -{ - private static final long serialVersionUID = -2510767849932627519L; - - private static final Log logger = LogFactory.getLog(GuestTemplateContentServlet.class); - - private static final String DEFAULT_URL = "/guestTemplate/{0}/{1}/{2}"; - private static final String TEMPLATE_URL = "/guestTemplate/{0}/{1}/{2}/{3}/{4}/{5}"; - - @Override - protected Log getLogger() - { - return logger; - } - - @Override - protected Map buildModel(ServiceRegistry services, HttpServletRequest req, - NodeRef templateRef) - { - // setup the guest user to pass to the build model helper method - AuthenticationService auth = (AuthenticationService)services.getAuthenticationService(); - PersonService personService = (PersonService)services.getPersonService(); - NodeService nodeService = (NodeService)services.getNodeService(); - - NodeRef guestRef = personService.getPerson(AuthenticationUtil.getGuestUserName()); - User guestUser = new User(AuthenticationUtil.getGuestUserName(), auth.getCurrentTicket(), guestRef); - NodeRef guestHomeRef = (NodeRef)nodeService.getProperty(guestRef, ContentModel.PROP_HOMEFOLDER); - if (nodeService.exists(guestHomeRef) == false) - { - throw new InvalidNodeRefException(guestHomeRef); - } - guestUser.setHomeSpaceId(guestHomeRef.getId()); - - // build the default model - return DefaultModelHelper.buildDefaultModel(services, guestUser, templateRef, this.imageResolver); - } - - /** - * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) - */ - protected void service(HttpServletRequest req, HttpServletResponse res) - throws ServletException, IOException - { - if (logger.isDebugEnabled()) - { - String queryString = req.getQueryString(); - logger.debug("Setting up guest access to URL: " + req.getRequestURI() + - ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); - } - - TemplateContentWork tcw = new TemplateContentWork(req, res); - AuthenticationUtil.runAs(tcw, AuthenticationUtil.getGuestUserName()); - } - - /** - * Helper to generate a URL to process a template against a node. - *

- * The result of the template is supplied returned as the response. - * - * @param nodeRef NodeRef of the content node to generate URL for (cannot be null) - * @param templateRef NodeRef of the template to process against, or null to use default - * - * @return URL to process the template - */ - public final static String generateURL(NodeRef nodeRef, NodeRef templateRef) - { - if (templateRef == null) - { - return MessageFormat.format(DEFAULT_URL, new Object[] { - nodeRef.getStoreRef().getProtocol(), - nodeRef.getStoreRef().getIdentifier(), - nodeRef.getId() } ); - } - else - { - return MessageFormat.format(TEMPLATE_URL, new Object[] { - nodeRef.getStoreRef().getProtocol(), - nodeRef.getStoreRef().getIdentifier(), - nodeRef.getId(), - templateRef.getStoreRef().getProtocol(), - templateRef.getStoreRef().getIdentifier(), - templateRef.getId()} ); - } - } - - /** - * Class to wrap the call to processTemplateRequest. - * - * @author gavinc - */ - public class TemplateContentWork implements RunAsWork - { - private HttpServletRequest req = null; - private HttpServletResponse res = null; - - public TemplateContentWork(HttpServletRequest req, HttpServletResponse res) - { - this.req = req; - this.res = res; - } - - public Object doWork() throws Exception - { - processTemplateRequest(this.req, this.res, false); - - return null; - } - } -} +package org.alfresco.web.app.servlet; + +import java.io.IOException; +import java.text.MessageFormat; +import java.util.Map; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.security.authentication.AuthenticationUtil; +import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.security.AuthenticationService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.cmr.security.PersonService; +import org.alfresco.web.bean.repository.User; +import org.alfresco.web.ui.repo.component.template.DefaultModelHelper; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Servlet responsible for streaming content from a template processed against a node directly + * to the response stream. + *

+ * The URL to the servlet should be generated thus: + * 

/alfresco/template/workspace/SpacesStore/0000-0000-0000-0000
+ * or + * 
/alfresco/template/workspace/SpacesStore/0000-0000-0000-0000/workspace/SpacesStore/0000-0000-0000-0000
+ * or + * 
/alfresco/template?templatePath=/Company%20Home/Data%20Dictionary/Presentation%20Templates/doc_info.ftl&contextPath=/Company%20Home/mydoc.txt
+ *

+ * The store protocol, followed by the store ID, followed by the content Node Id used to + * identify the node to execute the default template for. The second set of elements encode + * the store and node Id of the template to used if a default is not set or not requested. Instead + * of using NodeRef references to the template and context, path arguments can be used. The URL args + * of 'templatePath' and 'contextPath' can be used instead to specify name based encoded Paths to the + * template and its context. + *

+ * The URL may be followed by a 'mimetype' argument specifying the mimetype to return the result as + * on the stream. Otherwise it is assumed that HTML is the default response mimetype. + *

+ * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: + * ?ticket=1234567890 + *

+ * And/or also followed by the "?guest=true" argument to force guest access login for the URL. If the + * guest=true parameter is used the current session will be logged out and the guest user logged in. + * Therefore upon completion of this request the current user will be "guest". + *

+ * This servlet only accesses content available to the guest user. If the guest user does not + * have access to the requested a 401 Forbidden response is returned to the caller. + *

+ * This servlet does not effect the current session, therefore if guest access is required to a + * resource this servlet can be used without logging out the current user. + * + * @author gavinc + * @deprecated 5.0 not exposed in web-client web.xml + */ +public class GuestTemplateContentServlet extends BaseTemplateContentServlet +{ + private static final long serialVersionUID = -2510767849932627519L; + + private static final Log logger = LogFactory.getLog(GuestTemplateContentServlet.class); + + private static final String DEFAULT_URL = "/guestTemplate/{0}/{1}/{2}"; + private static final String TEMPLATE_URL = "/guestTemplate/{0}/{1}/{2}/{3}/{4}/{5}"; + + @Override + protected Log getLogger() + { + return logger; + } + + @Override + protected Map buildModel(ServiceRegistry services, HttpServletRequest req, + NodeRef templateRef) + { + // setup the guest user to pass to the build model helper method + AuthenticationService auth = (AuthenticationService)services.getAuthenticationService(); + PersonService personService = (PersonService)services.getPersonService(); + NodeService nodeService = (NodeService)services.getNodeService(); + + NodeRef guestRef = personService.getPerson(AuthenticationUtil.getGuestUserName()); + User guestUser = new User(AuthenticationUtil.getGuestUserName(), auth.getCurrentTicket(), guestRef); + NodeRef guestHomeRef = (NodeRef)nodeService.getProperty(guestRef, ContentModel.PROP_HOMEFOLDER); + if (nodeService.exists(guestHomeRef) == false) + { + throw new InvalidNodeRefException(guestHomeRef); + } + guestUser.setHomeSpaceId(guestHomeRef.getId()); + + // build the default model + return DefaultModelHelper.buildDefaultModel(services, guestUser, templateRef, this.imageResolver); + } + + /** + * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) + */ + protected void service(HttpServletRequest req, HttpServletResponse res) + throws ServletException, IOException + { + if (logger.isDebugEnabled()) + { + String queryString = req.getQueryString(); + logger.debug("Setting up guest access to URL: " + req.getRequestURI() + + ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); + } + + TemplateContentWork tcw = new TemplateContentWork(req, res); + AuthenticationUtil.runAs(tcw, AuthenticationUtil.getGuestUserName()); + } + + /** + * Helper to generate a URL to process a template against a node. + *

+ * The result of the template is supplied returned as the response. + * + * @param nodeRef NodeRef of the content node to generate URL for (cannot be null) + * @param templateRef NodeRef of the template to process against, or null to use default + * + * @return URL to process the template + */ + public final static String generateURL(NodeRef nodeRef, NodeRef templateRef) + { + if (templateRef == null) + { + return MessageFormat.format(DEFAULT_URL, new Object[] { + nodeRef.getStoreRef().getProtocol(), + nodeRef.getStoreRef().getIdentifier(), + nodeRef.getId() } ); + } + else + { + return MessageFormat.format(TEMPLATE_URL, new Object[] { + nodeRef.getStoreRef().getProtocol(), + nodeRef.getStoreRef().getIdentifier(), + nodeRef.getId(), + templateRef.getStoreRef().getProtocol(), + templateRef.getStoreRef().getIdentifier(), + templateRef.getId()} ); + } + } + + /** + * Class to wrap the call to processTemplateRequest. + * + * @author gavinc + */ + public class TemplateContentWork implements RunAsWork + { + private HttpServletRequest req = null; + private HttpServletResponse res = null; + + public TemplateContentWork(HttpServletRequest req, HttpServletResponse res) + { + this.req = req; + this.res = res; + } + + public Object doWork() throws Exception + { + processTemplateRequest(this.req, this.res, false); + + return null; + } + } +} diff --git a/source/java/org/alfresco/web/app/servlet/JBPMDeployProcessServlet.java b/source/java/org/alfresco/web/app/servlet/JBPMDeployProcessServlet.java index 641849d3d8..2930f8249c 100644 --- a/source/java/org/alfresco/web/app/servlet/JBPMDeployProcessServlet.java +++ b/source/java/org/alfresco/web/app/servlet/JBPMDeployProcessServlet.java @@ -1,146 +1,146 @@ -package org.alfresco.web.app.servlet; - -import java.io.IOException; -import java.io.InputStream; -import java.util.Iterator; -import java.util.List; -import java.util.Properties; - -import javax.servlet.ServletException; -import javax.servlet.UnavailableException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.workflow.jbpm.JBPMEngine; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.workflow.WorkflowDefinition; -import org.alfresco.service.cmr.workflow.WorkflowDeployment; -import org.alfresco.service.cmr.workflow.WorkflowException; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.util.PropertyCheck; -import org.apache.commons.fileupload.DiskFileUpload; -import org.apache.commons.fileupload.FileItem; -import org.apache.commons.fileupload.FileUpload; -import org.apache.commons.fileupload.FileUploadException; -import org.springframework.web.context.WebApplicationContext; -import org.springframework.web.context.support.WebApplicationContextUtils; - - -/** - * Servlet for handling process deployments from jBPM process designer. - * - * @author davidc - * @deprecated 5.0 not exposed in web-client web.xml - */ -public class JBPMDeployProcessServlet extends HttpServlet -{ - private static final long serialVersionUID = 8002539291245090187L; - private static final String BEAN_GLOBAL_PROPERTIES = "global-properties"; - private static final String PROP_ENABLED = "system.workflow.deployservlet.enabled"; - - @Override - public void init() throws ServletException - { - // Render this servlet permanently unavailable if its enablement property is not set - WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext()); - Properties globalProperties = (Properties) wc.getBean(BEAN_GLOBAL_PROPERTIES); - String enabled = globalProperties.getProperty(PROP_ENABLED); - if (!PropertyCheck.isValidPropertyString(enabled) || !Boolean.parseBoolean(enabled)) - { - throw new UnavailableException("system.workflow.deployservlet.enabled=false"); - } - } - - @Override - public void service(HttpServletRequest request, HttpServletResponse response) throws IOException - { - try - { - response.setContentType("text/html"); - InputStream deploymentArchive = getDeploymentArchive(request); - WorkflowDefinition workflowDef = deployArchive(deploymentArchive); - response.getWriter().println("Deployed archive " + workflowDef.title + " successfully"); - } - catch(IOException e) - { - // NOTE: according to original jBPM deployment servlet - response.getWriter().println("IOException"); - } - catch(FileUploadException e) - { - // NOTE: according to original jBPM deployment servlet - response.getWriter().println("FileUploadException"); - } - } - - /** - * Retrieve the JBPM Process Designer deployment archive from the request - * - * @param request the request - * @return the input stream onto the deployment archive - * @throws WorkflowException - * @throws FileUploadException - * @throws IOException - */ - private InputStream getDeploymentArchive(HttpServletRequest request) - throws FileUploadException, IOException - { - if (!FileUpload.isMultipartContent(request)) - { - throw new FileUploadException("Not a multipart request"); - } - - GPDUpload fileUpload = new GPDUpload(); - List list = fileUpload.parseRequest(request); - Iterator iterator = list.iterator(); - if (!iterator.hasNext()) - { - throw new FileUploadException("No process file in the request"); - } - - FileItem fileItem = (FileItem) iterator.next(); - if (fileItem.getContentType().indexOf("application/x-zip-compressed") == -1) - { - throw new FileUploadException("Not a process archive"); - } - - return fileItem.getInputStream(); - } - - - /** - * Deploy the jBPM process archive to the Alfresco Repository - * - * @param deploymentArchive the archive to deploy - * @return the deployed workflow definition - */ - private WorkflowDefinition deployArchive(InputStream deploymentArchive) - { - WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext()); - WorkflowService workflowService = (WorkflowService)wc.getBean(ServiceRegistry.WORKFLOW_SERVICE.getLocalName()); - WorkflowDeployment deployment = workflowService.deployDefinition(JBPMEngine.ENGINE_ID, deploymentArchive, MimetypeMap.MIMETYPE_ZIP); - return deployment.definition; - } - - - /** - * NOTE: Workaround... - * - * The JBPM process designer (as of 3.1.2) issues a request with a multi-part line - * delimited by ",". It should be ":" according to the HTTP specification which - * the commons file-upload is adhering to. - * - * @author davidc - */ - @SuppressWarnings("deprecation") - private class GPDUpload extends DiskFileUpload - { - @Override - protected byte[] getBoundary(String contentType) - { - return super.getBoundary(contentType.replace(",", ";")); - } - } +package org.alfresco.web.app.servlet; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Iterator; +import java.util.List; +import java.util.Properties; + +import javax.servlet.ServletException; +import javax.servlet.UnavailableException; +import javax.servlet.http.HttpServlet; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.workflow.jbpm.JBPMEngine; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.workflow.WorkflowDefinition; +import org.alfresco.service.cmr.workflow.WorkflowDeployment; +import org.alfresco.service.cmr.workflow.WorkflowException; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.util.PropertyCheck; +import org.apache.commons.fileupload.DiskFileUpload; +import org.apache.commons.fileupload.FileItem; +import org.apache.commons.fileupload.FileUpload; +import org.apache.commons.fileupload.FileUploadException; +import org.springframework.web.context.WebApplicationContext; +import org.springframework.web.context.support.WebApplicationContextUtils; + + +/** + * Servlet for handling process deployments from jBPM process designer. + * + * @author davidc + * @deprecated 5.0 not exposed in web-client web.xml + */ +public class JBPMDeployProcessServlet extends HttpServlet +{ + private static final long serialVersionUID = 8002539291245090187L; + private static final String BEAN_GLOBAL_PROPERTIES = "global-properties"; + private static final String PROP_ENABLED = "system.workflow.deployservlet.enabled"; + + @Override + public void init() throws ServletException + { + // Render this servlet permanently unavailable if its enablement property is not set + WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext()); + Properties globalProperties = (Properties) wc.getBean(BEAN_GLOBAL_PROPERTIES); + String enabled = globalProperties.getProperty(PROP_ENABLED); + if (!PropertyCheck.isValidPropertyString(enabled) || !Boolean.parseBoolean(enabled)) + { + throw new UnavailableException("system.workflow.deployservlet.enabled=false"); + } + } + + @Override + public void service(HttpServletRequest request, HttpServletResponse response) throws IOException + { + try + { + response.setContentType("text/html"); + InputStream deploymentArchive = getDeploymentArchive(request); + WorkflowDefinition workflowDef = deployArchive(deploymentArchive); + response.getWriter().println("Deployed archive " + workflowDef.title + " successfully"); + } + catch(IOException e) + { + // NOTE: according to original jBPM deployment servlet + response.getWriter().println("IOException"); + } + catch(FileUploadException e) + { + // NOTE: according to original jBPM deployment servlet + response.getWriter().println("FileUploadException"); + } + } + + /** + * Retrieve the JBPM Process Designer deployment archive from the request + * + * @param request the request + * @return the input stream onto the deployment archive + * @throws WorkflowException + * @throws FileUploadException + * @throws IOException + */ + private InputStream getDeploymentArchive(HttpServletRequest request) + throws FileUploadException, IOException + { + if (!FileUpload.isMultipartContent(request)) + { + throw new FileUploadException("Not a multipart request"); + } + + GPDUpload fileUpload = new GPDUpload(); + List list = fileUpload.parseRequest(request); + Iterator iterator = list.iterator(); + if (!iterator.hasNext()) + { + throw new FileUploadException("No process file in the request"); + } + + FileItem fileItem = (FileItem) iterator.next(); + if (fileItem.getContentType().indexOf("application/x-zip-compressed") == -1) + { + throw new FileUploadException("Not a process archive"); + } + + return fileItem.getInputStream(); + } + + + /** + * Deploy the jBPM process archive to the Alfresco Repository + * + * @param deploymentArchive the archive to deploy + * @return the deployed workflow definition + */ + private WorkflowDefinition deployArchive(InputStream deploymentArchive) + { + WebApplicationContext wc = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext()); + WorkflowService workflowService = (WorkflowService)wc.getBean(ServiceRegistry.WORKFLOW_SERVICE.getLocalName()); + WorkflowDeployment deployment = workflowService.deployDefinition(JBPMEngine.ENGINE_ID, deploymentArchive, MimetypeMap.MIMETYPE_ZIP); + return deployment.definition; + } + + + /** + * NOTE: Workaround... + * + * The JBPM process designer (as of 3.1.2) issues a request with a multi-part line + * delimited by ",". It should be ":" according to the HTTP specification which + * the commons file-upload is adhering to. + * + * @author davidc + */ + @SuppressWarnings("deprecation") + private class GPDUpload extends DiskFileUpload + { + @Override + protected byte[] getBoundary(String contentType) + { + return super.getBoundary(contentType.replace(",", ";")); + } + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/app/servlet/UploadContentServlet.java b/source/java/org/alfresco/web/app/servlet/UploadContentServlet.java index a911193efa..18e8c6b531 100644 --- a/source/java/org/alfresco/web/app/servlet/UploadContentServlet.java +++ b/source/java/org/alfresco/web/app/servlet/UploadContentServlet.java @@ -1,259 +1,259 @@ -package org.alfresco.web.app.servlet; - -import java.io.BufferedInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.nio.charset.Charset; -import java.util.Locale; -import java.util.StringTokenizer; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.encoding.ContentCharsetFinder; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.ContentData; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.MimetypeService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.repository.StoreRef; -import org.alfresco.service.cmr.security.AccessStatus; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.namespace.QName; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.extensions.surf.util.I18NUtil; - -/** - * Servlet responsible for streaming content directly into the repository from the PUT request. - * The appropriate mimetype is calculated based on filename extension. - *

- * The URL to the servlet should be generated thus: - * 

/alfresco/upload/workspace/SpacesStore/0000-0000-0000-0000/myfile.pdf
- * or - * 
/alfresco/upload/myfile.pdf
- *

- * If the store and node id are specified in the URL then the content provided will be streamed onto the node - * using an updating writer, updating the content property value accordingly. - *

- * If only the file name is specified the content will be streamed into the content store and the content data - * will be returned in the reposonse. This can then be used to update the value of a content property manually. - * Any used content will be cleared up in the usual manner. - *

- * By default, the download assumes that the content is on the - * {@link org.alfresco.model.ContentModel#PROP_CONTENT content property}.
- * To set the content of a specific model property, use a 'property' arg, providing the qualified name of the property. - *

- * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: - * ?ticket=1234567890 - *

- * Guest access is currently disabled for this servlet. - * - * @author Roy Wetherall - */ -public class UploadContentServlet extends BaseServlet -{ - /** Serial version UID */ - private static final long serialVersionUID = 1055960980867420355L; - - /** Logger */ - private static Log logger = LogFactory.getLog(UploadContentServlet.class); - - /** Default mime type */ - protected static final String MIMETYPE_OCTET_STREAM = "application/octet-stream"; - - /** Argument properties */ - protected static final String ARG_PROPERTY = "property"; - protected static final String ARG_MIMETYPE = "mimetype"; - protected static final String ARG_ENCODING = "encoding"; - protected static final String ARG_LOCALE = "locale"; - - /** - * @see javax.servlet.http.HttpServlet#doPut(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) - */ - protected void doPut(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException - { - if (logger.isDebugEnabled() == true) - { - String queryString = req.getQueryString(); - logger.debug("Authenticating request to URL: " + req.getRequestURI() - + ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); - } - - AuthenticationStatus status = servletAuthenticate(req, res, false); - if (status == AuthenticationStatus.Failure || status == AuthenticationStatus.Guest) - { - res.sendError(HttpServletResponse.SC_UNAUTHORIZED); - return; - } - - // Tokenise the URI - String uri = req.getRequestURI(); - uri = uri.substring(req.getContextPath().length()); - StringTokenizer t = new StringTokenizer(uri, "/"); - int tokenCount = t.countTokens(); - - t.nextToken(); // skip servlet name - - // get or calculate the noderef and filename to download as - NodeRef nodeRef = null; - String filename = null; - QName propertyQName = null; - - if (tokenCount == 2) - { - // filename is the only token - filename = t.nextToken(); - } - else if (tokenCount == 4 || tokenCount == 5) - { - // assume 'workspace' or other NodeRef based protocol for remaining URL - // elements - StoreRef storeRef = new StoreRef(t.nextToken(), t.nextToken()); - String id = t.nextToken(); - // build noderef from the appropriate URL elements - nodeRef = new NodeRef(storeRef, id); - - if (tokenCount == 5) - { - // filename is last remaining token - filename = t.nextToken(); - } - - // get qualified of the property to get content from - default to - // ContentModel.PROP_CONTENT - propertyQName = ContentModel.PROP_CONTENT; - String property = req.getParameter(ARG_PROPERTY); - if (property != null && property.length() != 0) - { - propertyQName = QName.createQName(property); - } - } - else - { - logger.debug("Upload URL did not contain all required args: " + uri); - res.sendError(HttpServletResponse.SC_EXPECTATION_FAILED); - return; - } - - // get the services we need to retrieve the content - ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); - ContentService contentService = serviceRegistry.getContentService(); - PermissionService permissionService = serviceRegistry.getPermissionService(); - MimetypeService mimetypeService = serviceRegistry.getMimetypeService(); - NodeService nodeService = serviceRegistry.getNodeService(); - - InputStream is = req.getInputStream(); - BufferedInputStream inputStream = new BufferedInputStream(is); - - // Sort out the mimetype - String mimetype = req.getParameter(ARG_MIMETYPE); - if (mimetype == null || mimetype.length() == 0) - { - mimetype = MIMETYPE_OCTET_STREAM; - if (filename != null) - { - MimetypeService mimetypeMap = serviceRegistry.getMimetypeService(); - int extIndex = filename.lastIndexOf('.'); - if (extIndex != -1) - { - String ext = filename.substring(extIndex + 1); - mimetype = mimetypeService.getMimetype(ext); - } - } - } - - // Get the encoding - String encoding = req.getParameter(ARG_ENCODING); - if (encoding == null || encoding.length() == 0) - { - // Get the encoding - ContentCharsetFinder charsetFinder = mimetypeService.getContentCharsetFinder(); - Charset charset = charsetFinder.getCharset(inputStream, mimetype); - encoding = charset.name(); - } - - // Get the locale - Locale locale = I18NUtil.parseLocale(req.getParameter(ARG_LOCALE)); - if (locale == null) - { - locale = I18NUtil.getContentLocale(); - if (nodeRef != null) - { - ContentData contentData = (ContentData) nodeService.getProperty(nodeRef, propertyQName); - if (contentData != null) - { - locale = contentData.getLocale(); - } - } - } - - if (logger.isDebugEnabled()) - { - if (nodeRef != null) {logger.debug("Found NodeRef: " + nodeRef.toString());} - logger.debug("For property: " + propertyQName); - logger.debug("File name: " + filename); - logger.debug("Mimetype: " + mimetype); - logger.debug("Encoding: " + encoding); - logger.debug("Locale: " + locale); - } - - // Check that the user has the permissions to write the content - if (permissionService.hasPermission(nodeRef, PermissionService.WRITE_CONTENT) == AccessStatus.DENIED) - { - if (logger.isDebugEnabled() == true) - { - logger.debug("User does not have permissions to wrtie content for NodeRef: " + nodeRef.toString()); - } - - if (logger.isDebugEnabled()) - { - logger.debug("Returning 403 Forbidden error..."); - } - - res.sendError(HttpServletResponse.SC_FORBIDDEN); - return; - } - - // Try and get the content writer - ContentWriter writer = contentService.getWriter(nodeRef, propertyQName, true); - if (writer == null) - { - if (logger.isDebugEnabled() == true) - { - logger.debug("Content writer cannot be obtained for NodeRef: " + nodeRef.toString()); - } - res.sendError(HttpServletResponse.SC_EXPECTATION_FAILED); - return; - } - - // Set the mimetype, encoding and locale - writer.setMimetype(mimetype); - writer.setEncoding(encoding); - if (locale != null) - { - writer.setLocale(locale); - } - - // Stream the content into the repository - writer.putContent(inputStream); - - if (logger.isDebugEnabled() == true) - { - logger.debug("Content details: " + writer.getContentData().toString()); - } - - // Set return status - res.getWriter().write(writer.getContentData().toString()); - res.flushBuffer(); - - if (logger.isDebugEnabled() == true) - { - logger.debug("UploadContentServlet done"); - } - } -} +package org.alfresco.web.app.servlet; + +import java.io.BufferedInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.Charset; +import java.util.Locale; +import java.util.StringTokenizer; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.encoding.ContentCharsetFinder; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.ContentData; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.MimetypeService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.repository.StoreRef; +import org.alfresco.service.cmr.security.AccessStatus; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.namespace.QName; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.extensions.surf.util.I18NUtil; + +/** + * Servlet responsible for streaming content directly into the repository from the PUT request. + * The appropriate mimetype is calculated based on filename extension. + *

+ * The URL to the servlet should be generated thus: + * 

/alfresco/upload/workspace/SpacesStore/0000-0000-0000-0000/myfile.pdf
+ * or + * 
/alfresco/upload/myfile.pdf
+ *

+ * If the store and node id are specified in the URL then the content provided will be streamed onto the node + * using an updating writer, updating the content property value accordingly. + *

+ * If only the file name is specified the content will be streamed into the content store and the content data + * will be returned in the reposonse. This can then be used to update the value of a content property manually. + * Any used content will be cleared up in the usual manner. + *

+ * By default, the download assumes that the content is on the + * {@link org.alfresco.model.ContentModel#PROP_CONTENT content property}.
+ * To set the content of a specific model property, use a 'property' arg, providing the qualified name of the property. + *

+ * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: + * ?ticket=1234567890 + *

+ * Guest access is currently disabled for this servlet. + * + * @author Roy Wetherall + */ +public class UploadContentServlet extends BaseServlet +{ + /** Serial version UID */ + private static final long serialVersionUID = 1055960980867420355L; + + /** Logger */ + private static Log logger = LogFactory.getLog(UploadContentServlet.class); + + /** Default mime type */ + protected static final String MIMETYPE_OCTET_STREAM = "application/octet-stream"; + + /** Argument properties */ + protected static final String ARG_PROPERTY = "property"; + protected static final String ARG_MIMETYPE = "mimetype"; + protected static final String ARG_ENCODING = "encoding"; + protected static final String ARG_LOCALE = "locale"; + + /** + * @see javax.servlet.http.HttpServlet#doPut(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) + */ + protected void doPut(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException + { + if (logger.isDebugEnabled() == true) + { + String queryString = req.getQueryString(); + logger.debug("Authenticating request to URL: " + req.getRequestURI() + + ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); + } + + AuthenticationStatus status = servletAuthenticate(req, res, false); + if (status == AuthenticationStatus.Failure || status == AuthenticationStatus.Guest) + { + res.sendError(HttpServletResponse.SC_UNAUTHORIZED); + return; + } + + // Tokenise the URI + String uri = req.getRequestURI(); + uri = uri.substring(req.getContextPath().length()); + StringTokenizer t = new StringTokenizer(uri, "/"); + int tokenCount = t.countTokens(); + + t.nextToken(); // skip servlet name + + // get or calculate the noderef and filename to download as + NodeRef nodeRef = null; + String filename = null; + QName propertyQName = null; + + if (tokenCount == 2) + { + // filename is the only token + filename = t.nextToken(); + } + else if (tokenCount == 4 || tokenCount == 5) + { + // assume 'workspace' or other NodeRef based protocol for remaining URL + // elements + StoreRef storeRef = new StoreRef(t.nextToken(), t.nextToken()); + String id = t.nextToken(); + // build noderef from the appropriate URL elements + nodeRef = new NodeRef(storeRef, id); + + if (tokenCount == 5) + { + // filename is last remaining token + filename = t.nextToken(); + } + + // get qualified of the property to get content from - default to + // ContentModel.PROP_CONTENT + propertyQName = ContentModel.PROP_CONTENT; + String property = req.getParameter(ARG_PROPERTY); + if (property != null && property.length() != 0) + { + propertyQName = QName.createQName(property); + } + } + else + { + logger.debug("Upload URL did not contain all required args: " + uri); + res.sendError(HttpServletResponse.SC_EXPECTATION_FAILED); + return; + } + + // get the services we need to retrieve the content + ServiceRegistry serviceRegistry = getServiceRegistry(getServletContext()); + ContentService contentService = serviceRegistry.getContentService(); + PermissionService permissionService = serviceRegistry.getPermissionService(); + MimetypeService mimetypeService = serviceRegistry.getMimetypeService(); + NodeService nodeService = serviceRegistry.getNodeService(); + + InputStream is = req.getInputStream(); + BufferedInputStream inputStream = new BufferedInputStream(is); + + // Sort out the mimetype + String mimetype = req.getParameter(ARG_MIMETYPE); + if (mimetype == null || mimetype.length() == 0) + { + mimetype = MIMETYPE_OCTET_STREAM; + if (filename != null) + { + MimetypeService mimetypeMap = serviceRegistry.getMimetypeService(); + int extIndex = filename.lastIndexOf('.'); + if (extIndex != -1) + { + String ext = filename.substring(extIndex + 1); + mimetype = mimetypeService.getMimetype(ext); + } + } + } + + // Get the encoding + String encoding = req.getParameter(ARG_ENCODING); + if (encoding == null || encoding.length() == 0) + { + // Get the encoding + ContentCharsetFinder charsetFinder = mimetypeService.getContentCharsetFinder(); + Charset charset = charsetFinder.getCharset(inputStream, mimetype); + encoding = charset.name(); + } + + // Get the locale + Locale locale = I18NUtil.parseLocale(req.getParameter(ARG_LOCALE)); + if (locale == null) + { + locale = I18NUtil.getContentLocale(); + if (nodeRef != null) + { + ContentData contentData = (ContentData) nodeService.getProperty(nodeRef, propertyQName); + if (contentData != null) + { + locale = contentData.getLocale(); + } + } + } + + if (logger.isDebugEnabled()) + { + if (nodeRef != null) {logger.debug("Found NodeRef: " + nodeRef.toString());} + logger.debug("For property: " + propertyQName); + logger.debug("File name: " + filename); + logger.debug("Mimetype: " + mimetype); + logger.debug("Encoding: " + encoding); + logger.debug("Locale: " + locale); + } + + // Check that the user has the permissions to write the content + if (permissionService.hasPermission(nodeRef, PermissionService.WRITE_CONTENT) == AccessStatus.DENIED) + { + if (logger.isDebugEnabled() == true) + { + logger.debug("User does not have permissions to wrtie content for NodeRef: " + nodeRef.toString()); + } + + if (logger.isDebugEnabled()) + { + logger.debug("Returning 403 Forbidden error..."); + } + + res.sendError(HttpServletResponse.SC_FORBIDDEN); + return; + } + + // Try and get the content writer + ContentWriter writer = contentService.getWriter(nodeRef, propertyQName, true); + if (writer == null) + { + if (logger.isDebugEnabled() == true) + { + logger.debug("Content writer cannot be obtained for NodeRef: " + nodeRef.toString()); + } + res.sendError(HttpServletResponse.SC_EXPECTATION_FAILED); + return; + } + + // Set the mimetype, encoding and locale + writer.setMimetype(mimetype); + writer.setEncoding(encoding); + if (locale != null) + { + writer.setLocale(locale); + } + + // Stream the content into the repository + writer.putContent(inputStream); + + if (logger.isDebugEnabled() == true) + { + logger.debug("Content details: " + writer.getContentData().toString()); + } + + // Set return status + res.getWriter().write(writer.getContentData().toString()); + res.flushBuffer(); + + if (logger.isDebugEnabled() == true) + { + logger.debug("UploadContentServlet done"); + } + } +} diff --git a/source/java/org/alfresco/web/app/servlet/WebScriptSSOAuthenticationFilter.java b/source/java/org/alfresco/web/app/servlet/WebScriptSSOAuthenticationFilter.java index 5361f88d81..07828db9d6 100644 --- a/source/java/org/alfresco/web/app/servlet/WebScriptSSOAuthenticationFilter.java +++ b/source/java/org/alfresco/web/app/servlet/WebScriptSSOAuthenticationFilter.java @@ -1,107 +1,107 @@ -package org.alfresco.web.app.servlet; - -import java.io.IOException; - -import javax.servlet.FilterChain; -import javax.servlet.ServletContext; -import javax.servlet.ServletException; -import javax.servlet.ServletRequest; -import javax.servlet.ServletResponse; -import javax.servlet.http.HttpServletRequest; - -import org.alfresco.repo.management.subsystems.ActivateableBean; -import org.alfresco.repo.web.filter.beans.DependencyInjectedFilter; -import org.alfresco.repo.webdav.auth.BaseAuthenticationFilter; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.extensions.surf.util.URLDecoder; -import org.springframework.extensions.webscripts.Description.RequiredAuthentication; -import org.springframework.extensions.webscripts.Match; -import org.springframework.extensions.webscripts.RuntimeContainer; - -/** - * WebScript aware Authentication Filter Class. Takes into account the authentication setting in the descriptor for the - * webscript before chaining to the downstream authentication filters. If authentication is not required then chains - * with the NO_AUTH_REQUIRED request attribute set, which should cause any downstream authentication filter to bypass - * authentication checks. - * - * @author Kevin Roast - * @author dward - */ -public class WebScriptSSOAuthenticationFilter extends BaseAuthenticationFilter implements DependencyInjectedFilter, - ActivateableBean -{ - private static final Log logger = LogFactory.getLog(WebScriptSSOAuthenticationFilter.class); - private RuntimeContainer container; - private boolean isActive = true; - - /** - * @param container the container to set - */ - public void setContainer(RuntimeContainer container) - { - this.container = container; - } - - /** - * Activates or deactivates the bean - * - * @param active - * true if the bean is active and initialization should complete - */ - public final void setActive(boolean active) - { - this.isActive = active; - } - - /* - * (non-Javadoc) - * @see org.alfresco.repo.management.subsystems.ActivateableBean#isActive() - */ - public final boolean isActive() - { - return isActive; - } - - /* (non-Javadoc) - * @see org.alfresco.repo.webdav.auth.BaseNTLMAuthenticationFilter#doFilter(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) - */ - public void doFilter(ServletContext context, ServletRequest sreq, ServletResponse sresp, FilterChain chain) - throws IOException, ServletException - { - // Get the HTTP request/response - HttpServletRequest req = (HttpServletRequest)sreq; - - // find a webscript match for the requested URI - String requestURI = req.getRequestURI(); - String pathInfo = requestURI.substring((req.getContextPath() + req.getServletPath()).length()); - - if (getLogger().isDebugEnabled()) - getLogger().debug("Processing request: " + requestURI + " SID:" + - (req.getSession(false) != null ? req.getSession().getId() : null)); - - Match match = container.getRegistry().findWebScript(req.getMethod(), URLDecoder.decode(pathInfo)); - if (match != null && match.getWebScript() != null) - { - // check the authentication required - if none then we don't want any of - // the filters down the chain to require any authentication checks - if (RequiredAuthentication.none == match.getWebScript().getDescription().getRequiredAuthentication()) - { - if (getLogger().isDebugEnabled()) - getLogger().debug("Found webscript with no authentication - set NO_AUTH_REQUIRED flag."); - req.setAttribute(NO_AUTH_REQUIRED, Boolean.TRUE); - } - } - - chain.doFilter(sreq, sresp); - } - - /* (non-Javadoc) - * @see org.alfresco.repo.webdav.auth.BaseAuthenticationFilter#getLogger() - */ - @Override - protected Log getLogger() - { - return logger; - } -} +package org.alfresco.web.app.servlet; + +import java.io.IOException; + +import javax.servlet.FilterChain; +import javax.servlet.ServletContext; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletRequest; + +import org.alfresco.repo.management.subsystems.ActivateableBean; +import org.alfresco.repo.web.filter.beans.DependencyInjectedFilter; +import org.alfresco.repo.webdav.auth.BaseAuthenticationFilter; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.extensions.surf.util.URLDecoder; +import org.springframework.extensions.webscripts.Description.RequiredAuthentication; +import org.springframework.extensions.webscripts.Match; +import org.springframework.extensions.webscripts.RuntimeContainer; + +/** + * WebScript aware Authentication Filter Class. Takes into account the authentication setting in the descriptor for the + * webscript before chaining to the downstream authentication filters. If authentication is not required then chains + * with the NO_AUTH_REQUIRED request attribute set, which should cause any downstream authentication filter to bypass + * authentication checks. + * + * @author Kevin Roast + * @author dward + */ +public class WebScriptSSOAuthenticationFilter extends BaseAuthenticationFilter implements DependencyInjectedFilter, + ActivateableBean +{ + private static final Log logger = LogFactory.getLog(WebScriptSSOAuthenticationFilter.class); + private RuntimeContainer container; + private boolean isActive = true; + + /** + * @param container the container to set + */ + public void setContainer(RuntimeContainer container) + { + this.container = container; + } + + /** + * Activates or deactivates the bean + * + * @param active + * true if the bean is active and initialization should complete + */ + public final void setActive(boolean active) + { + this.isActive = active; + } + + /* + * (non-Javadoc) + * @see org.alfresco.repo.management.subsystems.ActivateableBean#isActive() + */ + public final boolean isActive() + { + return isActive; + } + + /* (non-Javadoc) + * @see org.alfresco.repo.webdav.auth.BaseNTLMAuthenticationFilter#doFilter(javax.servlet.ServletContext, javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) + */ + public void doFilter(ServletContext context, ServletRequest sreq, ServletResponse sresp, FilterChain chain) + throws IOException, ServletException + { + // Get the HTTP request/response + HttpServletRequest req = (HttpServletRequest)sreq; + + // find a webscript match for the requested URI + String requestURI = req.getRequestURI(); + String pathInfo = requestURI.substring((req.getContextPath() + req.getServletPath()).length()); + + if (getLogger().isDebugEnabled()) + getLogger().debug("Processing request: " + requestURI + " SID:" + + (req.getSession(false) != null ? req.getSession().getId() : null)); + + Match match = container.getRegistry().findWebScript(req.getMethod(), URLDecoder.decode(pathInfo)); + if (match != null && match.getWebScript() != null) + { + // check the authentication required - if none then we don't want any of + // the filters down the chain to require any authentication checks + if (RequiredAuthentication.none == match.getWebScript().getDescription().getRequiredAuthentication()) + { + if (getLogger().isDebugEnabled()) + getLogger().debug("Found webscript with no authentication - set NO_AUTH_REQUIRED flag."); + req.setAttribute(NO_AUTH_REQUIRED, Boolean.TRUE); + } + } + + chain.doFilter(sreq, sresp); + } + + /* (non-Javadoc) + * @see org.alfresco.repo.webdav.auth.BaseAuthenticationFilter#getLogger() + */ + @Override + protected Log getLogger() + { + return logger; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/ajax/AjaxCommand.java b/source/java/org/alfresco/web/app/servlet/ajax/AjaxCommand.java index c61a623e8c..23202b756c 100644 --- a/source/java/org/alfresco/web/app/servlet/ajax/AjaxCommand.java +++ b/source/java/org/alfresco/web/app/servlet/ajax/AjaxCommand.java @@ -1,37 +1,37 @@ -package org.alfresco.web.app.servlet.ajax; - -import java.io.IOException; - -import javax.faces.context.FacesContext; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -/** - * Interface for all Ajax commands executed by this servlet. - * - * The method is responsible for invoking the underlying managed bean - * and dealing with the response. - * - * @author gavinc - */ -public interface AjaxCommand -{ - /** - * Invokes the relevant method on the bean represented by the given - * expression. Parameters required to call the method can be retrieved - * from the request. - * - * Currently the content type of the response will always be text/xml, in the - * future sublcasses may provide a mechanism to allow the content type to be set - * dynamically. - * - * @param facesContext FacesContext - * @param expression The binding expression - * @param request The request - * @param response The response - */ - public abstract void execute(FacesContext facesContext, String expression, - HttpServletRequest request, HttpServletResponse response) - throws ServletException, IOException; -} +package org.alfresco.web.app.servlet.ajax; + +import java.io.IOException; + +import javax.faces.context.FacesContext; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +/** + * Interface for all Ajax commands executed by this servlet. + * + * The method is responsible for invoking the underlying managed bean + * and dealing with the response. + * + * @author gavinc + */ +public interface AjaxCommand +{ + /** + * Invokes the relevant method on the bean represented by the given + * expression. Parameters required to call the method can be retrieved + * from the request. + * + * Currently the content type of the response will always be text/xml, in the + * future sublcasses may provide a mechanism to allow the content type to be set + * dynamically. + * + * @param facesContext FacesContext + * @param expression The binding expression + * @param request The request + * @param response The response + */ + public abstract void execute(FacesContext facesContext, String expression, + HttpServletRequest request, HttpServletResponse response) + throws ServletException, IOException; +} diff --git a/source/java/org/alfresco/web/app/servlet/ajax/AjaxServlet.java b/source/java/org/alfresco/web/app/servlet/ajax/AjaxServlet.java index 81764ae11a..e553383eb8 100644 --- a/source/java/org/alfresco/web/app/servlet/ajax/AjaxServlet.java +++ b/source/java/org/alfresco/web/app/servlet/ajax/AjaxServlet.java @@ -1,197 +1,197 @@ -package org.alfresco.web.app.servlet.ajax; - -import java.io.IOException; -import java.util.Enumeration; - -import javax.faces.context.FacesContext; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import net.sf.acegisecurity.context.ContextHolder; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.web.app.servlet.AuthenticationStatus; -import org.alfresco.web.app.servlet.BaseServlet; -import org.alfresco.web.app.servlet.FacesHelper; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Servlet responsible for processing AJAX requests. - * - * The URL to the servlet should be in the form: - * 

/alfresco/ajax/command/Bean.binding.expression
- *

- * See http://wiki.alfresco.com/wiki/AJAX_Support for details. - *

- * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: - * ?ticket=1234567890 - * - * @author gavinc - * @deprecated 5.0 not exposed in web-client web.xml - */ -public class AjaxServlet extends BaseServlet -{ - public static final String AJAX_LOG_KEY = "alfresco.ajax"; - - protected enum Command { invoke, get, set}; - - private static final long serialVersionUID = -7654769105419391840L; - private static Log logger = LogFactory.getLog(AJAX_LOG_KEY); - private static Log headersLogger = LogFactory.getLog(AJAX_LOG_KEY + ".headers"); - private static Log perfLogger = LogFactory.getLog(AJAX_LOG_KEY + ".performance"); - - /** - * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) - */ - protected void service(final HttpServletRequest request, - final HttpServletResponse response) - throws ServletException, IOException - { - request.setCharacterEncoding("utf-8"); - // set default character encoding for the response - response.setCharacterEncoding("utf-8"); - response.setContentType("text/xml;charset=UTF-8"); - - long startTime = 0; - String uri = request.getRequestURI(); - if (logger.isDebugEnabled()) - { - final String queryString = request.getQueryString(); - logger.debug("Processing URL: " + uri + - ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); - } - - // dump the request headers - if (headersLogger.isDebugEnabled()) - { - final Enumeration headers = request.getHeaderNames(); - while (headers.hasMoreElements()) - { - final String name = (String)headers.nextElement(); - headersLogger.debug(name + ": " + request.getHeader(name)); - } - } - - try - { - - // Make sure the user is authenticated, if not throw an error to return the - // 500 Internal Server Error code back to the client - AuthenticationStatus status = servletAuthenticate(request, response, false); - if (status == AuthenticationStatus.Failure) - { - response.sendError(HttpServletResponse.SC_UNAUTHORIZED, - "Access Denied: User not authenticated"); - return; - } - - setNoCacheHeaders(response); - - uri = uri.substring(request.getContextPath().length() + "/".length()); - final String[] tokens = uri.split("/"); - if (tokens.length < 3) - { - throw new AlfrescoRuntimeException("Servlet URL did not contain all required args: " + uri); - } - - // retrieve the command from the URL - final String commandName = tokens[1]; - // retrieve the binding expression from the URL - final String expression = tokens[2]; - - // setup the faces context - final FacesContext facesContext = FacesHelper.getFacesContext(request, response, getServletContext()); - - // start a timer - if (perfLogger.isDebugEnabled()) - startTime = System.currentTimeMillis(); - - // instantiate the relevant command - AjaxCommand command = null; - if (Command.invoke.toString().equals(commandName)) - { - command = new InvokeCommand(); - } - else if (Command.get.toString().equals(commandName)) - { - command = new GetCommand(); - } - else - { - throw new AlfrescoRuntimeException("Unrecognised command received: " + commandName); - } - - // execute the command - command.execute(facesContext, expression, request, response); - } - catch (RuntimeException error) - { - handleError(response, error); - } - finally - { - // measure the time taken - if (perfLogger.isDebugEnabled()) - { - perfLogger.debug("Time to execute command: " + (System.currentTimeMillis() - startTime) + "ms"); - } - - ContextHolder.setContext(null); - } - } - - /** - * Handles any error that occurs during the execution of the servlet - * - * @param response The response - * @param cause The cause of the error - */ - protected void handleError(HttpServletResponse response, RuntimeException cause) - throws ServletException, IOException - { - // if we can send back the 500 error with the error from the top of the - // stack as the error status message. - - // NOTE: if we use the built in support for generating error pages for - // 500 errors we can tailor the output for AJAX calls so that the - // body of the response can be used to show the error details. - - if (!response.isCommitted()) - { - // dump the error if debugging is enabled - if (logger.isDebugEnabled()) - { - logger.error(cause); - Throwable theCause = cause.getCause(); - if (theCause != null) - { - logger.error("caused by: ", theCause); - } - } - - // extract a message from the exception - String msg = cause.getMessage(); - if (msg == null) - { - msg = cause.toString(); - } - // ALF-9036. We need to trap incomplete sessions - if (cause instanceof IllegalStateException) - { - response.sendError(HttpServletResponse.SC_UNAUTHORIZED, cause.getMessage()); - } - else - { - response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, msg); - } - } - else - { - // the response has already been comitted, not much we can do but - // let the error through and let the container deal with it - throw cause; - } - } -} +package org.alfresco.web.app.servlet.ajax; + +import java.io.IOException; +import java.util.Enumeration; + +import javax.faces.context.FacesContext; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import net.sf.acegisecurity.context.ContextHolder; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.app.servlet.AuthenticationStatus; +import org.alfresco.web.app.servlet.BaseServlet; +import org.alfresco.web.app.servlet.FacesHelper; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Servlet responsible for processing AJAX requests. + * + * The URL to the servlet should be in the form: + * 

/alfresco/ajax/command/Bean.binding.expression
+ *

+ * See http://wiki.alfresco.com/wiki/AJAX_Support for details. + *

+ * Like most Alfresco servlets, the URL may be followed by a valid 'ticket' argument for authentication: + * ?ticket=1234567890 + * + * @author gavinc + * @deprecated 5.0 not exposed in web-client web.xml + */ +public class AjaxServlet extends BaseServlet +{ + public static final String AJAX_LOG_KEY = "alfresco.ajax"; + + protected enum Command { invoke, get, set}; + + private static final long serialVersionUID = -7654769105419391840L; + private static Log logger = LogFactory.getLog(AJAX_LOG_KEY); + private static Log headersLogger = LogFactory.getLog(AJAX_LOG_KEY + ".headers"); + private static Log perfLogger = LogFactory.getLog(AJAX_LOG_KEY + ".performance"); + + /** + * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) + */ + protected void service(final HttpServletRequest request, + final HttpServletResponse response) + throws ServletException, IOException + { + request.setCharacterEncoding("utf-8"); + // set default character encoding for the response + response.setCharacterEncoding("utf-8"); + response.setContentType("text/xml;charset=UTF-8"); + + long startTime = 0; + String uri = request.getRequestURI(); + if (logger.isDebugEnabled()) + { + final String queryString = request.getQueryString(); + logger.debug("Processing URL: " + uri + + ((queryString != null && queryString.length() > 0) ? ("?" + queryString) : "")); + } + + // dump the request headers + if (headersLogger.isDebugEnabled()) + { + final Enumeration headers = request.getHeaderNames(); + while (headers.hasMoreElements()) + { + final String name = (String)headers.nextElement(); + headersLogger.debug(name + ": " + request.getHeader(name)); + } + } + + try + { + + // Make sure the user is authenticated, if not throw an error to return the + // 500 Internal Server Error code back to the client + AuthenticationStatus status = servletAuthenticate(request, response, false); + if (status == AuthenticationStatus.Failure) + { + response.sendError(HttpServletResponse.SC_UNAUTHORIZED, + "Access Denied: User not authenticated"); + return; + } + + setNoCacheHeaders(response); + + uri = uri.substring(request.getContextPath().length() + "/".length()); + final String[] tokens = uri.split("/"); + if (tokens.length < 3) + { + throw new AlfrescoRuntimeException("Servlet URL did not contain all required args: " + uri); + } + + // retrieve the command from the URL + final String commandName = tokens[1]; + // retrieve the binding expression from the URL + final String expression = tokens[2]; + + // setup the faces context + final FacesContext facesContext = FacesHelper.getFacesContext(request, response, getServletContext()); + + // start a timer + if (perfLogger.isDebugEnabled()) + startTime = System.currentTimeMillis(); + + // instantiate the relevant command + AjaxCommand command = null; + if (Command.invoke.toString().equals(commandName)) + { + command = new InvokeCommand(); + } + else if (Command.get.toString().equals(commandName)) + { + command = new GetCommand(); + } + else + { + throw new AlfrescoRuntimeException("Unrecognised command received: " + commandName); + } + + // execute the command + command.execute(facesContext, expression, request, response); + } + catch (RuntimeException error) + { + handleError(response, error); + } + finally + { + // measure the time taken + if (perfLogger.isDebugEnabled()) + { + perfLogger.debug("Time to execute command: " + (System.currentTimeMillis() - startTime) + "ms"); + } + + ContextHolder.setContext(null); + } + } + + /** + * Handles any error that occurs during the execution of the servlet + * + * @param response The response + * @param cause The cause of the error + */ + protected void handleError(HttpServletResponse response, RuntimeException cause) + throws ServletException, IOException + { + // if we can send back the 500 error with the error from the top of the + // stack as the error status message. + + // NOTE: if we use the built in support for generating error pages for + // 500 errors we can tailor the output for AJAX calls so that the + // body of the response can be used to show the error details. + + if (!response.isCommitted()) + { + // dump the error if debugging is enabled + if (logger.isDebugEnabled()) + { + logger.error(cause); + Throwable theCause = cause.getCause(); + if (theCause != null) + { + logger.error("caused by: ", theCause); + } + } + + // extract a message from the exception + String msg = cause.getMessage(); + if (msg == null) + { + msg = cause.toString(); + } + // ALF-9036. We need to trap incomplete sessions + if (cause instanceof IllegalStateException) + { + response.sendError(HttpServletResponse.SC_UNAUTHORIZED, cause.getMessage()); + } + else + { + response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, msg); + } + } + else + { + // the response has already been comitted, not much we can do but + // let the error through and let the container deal with it + throw cause; + } + } +} diff --git a/source/java/org/alfresco/web/app/servlet/ajax/BaseAjaxCommand.java b/source/java/org/alfresco/web/app/servlet/ajax/BaseAjaxCommand.java index 0ed97ccbc4..7806c9c8d5 100644 --- a/source/java/org/alfresco/web/app/servlet/ajax/BaseAjaxCommand.java +++ b/source/java/org/alfresco/web/app/servlet/ajax/BaseAjaxCommand.java @@ -1,19 +1,19 @@ -package org.alfresco.web.app.servlet.ajax; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Base class for all Ajax based commands - * - * @author gavinc - */ -public abstract class BaseAjaxCommand implements AjaxCommand -{ - protected static Log logger = LogFactory.getLog(AjaxServlet.AJAX_LOG_KEY); - - public String makeBindingExpression(String expression) - { - return "#{" + expression + "}"; - } -} +package org.alfresco.web.app.servlet.ajax; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Base class for all Ajax based commands + * + * @author gavinc + */ +public abstract class BaseAjaxCommand implements AjaxCommand +{ + protected static Log logger = LogFactory.getLog(AjaxServlet.AJAX_LOG_KEY); + + public String makeBindingExpression(String expression) + { + return "#{" + expression + "}"; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/ajax/GetCommand.java b/source/java/org/alfresco/web/app/servlet/ajax/GetCommand.java index b513e27154..3e1b10b6b2 100644 --- a/source/java/org/alfresco/web/app/servlet/ajax/GetCommand.java +++ b/source/java/org/alfresco/web/app/servlet/ajax/GetCommand.java @@ -1,69 +1,69 @@ -package org.alfresco.web.app.servlet.ajax; - -import java.io.IOException; - -import javax.faces.context.FacesContext; -import javax.faces.el.ValueBinding; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import javax.transaction.UserTransaction; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.web.bean.repository.Repository; - -/** - * Command that executes the given value binding expression. - *

- * This command is intended to be used for calling existing managed - * bean methods. The result of the value binding is added to - * the response as is i.e. by calling toString(). - * The content type of the response is always text/html. - * - * @author gavinc - */ -public class GetCommand extends BaseAjaxCommand -{ - public void execute(FacesContext facesContext, String expression, - HttpServletRequest request, HttpServletResponse response) - throws ServletException, IOException - { - // create the JSF binding expression - String bindingExpr = makeBindingExpression(expression); - - if (logger.isDebugEnabled()) - logger.debug("Retrieving value from value binding: " + bindingExpr); - - UserTransaction tx = null; - try - { - // create the value binding - ValueBinding binding = facesContext.getApplication(). - createValueBinding(bindingExpr); - - if (binding != null) - { - // setup the transaction - tx = Repository.getUserTransaction(facesContext, true); - tx.begin(); - - // get the value from the value binding - Object value = binding.getValue(facesContext); - if (value != null) - { - response.getWriter().write(value.toString()); - } - - // commit - tx.commit(); - } - } - catch (Throwable err) - { - // rollback the transaction - try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} - - throw new AlfrescoRuntimeException("Failed to retrieve value: " + err.getMessage(), err); - } - } -} +package org.alfresco.web.app.servlet.ajax; + +import java.io.IOException; + +import javax.faces.context.FacesContext; +import javax.faces.el.ValueBinding; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.transaction.UserTransaction; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.bean.repository.Repository; + +/** + * Command that executes the given value binding expression. + *

+ * This command is intended to be used for calling existing managed + * bean methods. The result of the value binding is added to + * the response as is i.e. by calling toString(). + * The content type of the response is always text/html. + * + * @author gavinc + */ +public class GetCommand extends BaseAjaxCommand +{ + public void execute(FacesContext facesContext, String expression, + HttpServletRequest request, HttpServletResponse response) + throws ServletException, IOException + { + // create the JSF binding expression + String bindingExpr = makeBindingExpression(expression); + + if (logger.isDebugEnabled()) + logger.debug("Retrieving value from value binding: " + bindingExpr); + + UserTransaction tx = null; + try + { + // create the value binding + ValueBinding binding = facesContext.getApplication(). + createValueBinding(bindingExpr); + + if (binding != null) + { + // setup the transaction + tx = Repository.getUserTransaction(facesContext, true); + tx.begin(); + + // get the value from the value binding + Object value = binding.getValue(facesContext); + if (value != null) + { + response.getWriter().write(value.toString()); + } + + // commit + tx.commit(); + } + } + catch (Throwable err) + { + // rollback the transaction + try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} + + throw new AlfrescoRuntimeException("Failed to retrieve value: " + err.getMessage(), err); + } + } +} diff --git a/source/java/org/alfresco/web/app/servlet/ajax/InvokeCommand.java b/source/java/org/alfresco/web/app/servlet/ajax/InvokeCommand.java index ad2b057ad1..2ba235946b 100644 --- a/source/java/org/alfresco/web/app/servlet/ajax/InvokeCommand.java +++ b/source/java/org/alfresco/web/app/servlet/ajax/InvokeCommand.java @@ -1,218 +1,218 @@ -package org.alfresco.web.app.servlet.ajax; - -import java.io.IOException; -import java.io.OutputStream; -import java.io.OutputStreamWriter; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; -import java.lang.reflect.InvocationTargetException; -import java.lang.reflect.Method; -import java.util.Enumeration; - -import javax.faces.FactoryFinder; -import javax.faces.component.UIViewRoot; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.EvaluationException; -import javax.faces.el.VariableResolver; -import javax.faces.render.RenderKit; -import javax.faces.render.RenderKitFactory; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; - -/** - * Command that invokes the method represented by the expression. - *

- * The managed bean method called is responsible for writing the response - * by getting hold of the JSF ResponseWriter. Parameters can also be - * retrieved via the JSF ExternalContext object. - *

- * In a future release (if required) annotations may be used to state - * what content type to use for the response. - * - * @author gavinc - */ -public class InvokeCommand extends BaseAjaxCommand -{ - - ///////////////////////////////////////////////////////////////////////////// - - /** - * Annotation for a bean method that handles an ajax request. - */ - @Retention(RetentionPolicy.RUNTIME) - @Target(ElementType.METHOD) - public @interface ResponseMimetype - { - // NOTE: replaced Mimetype.MIMETYPE_XML with string literal due to bug - // http://bugs.sun.com/view_bug.do?bug_id=6512707 - causing build to fail - public String value() default "text/xml"; - } - - ///////////////////////////////////////////////////////////////////////////// - - public void execute(final FacesContext facesContext, - final String expression, - final HttpServletRequest request, - final HttpServletResponse response) - throws ServletException, IOException - { - ResponseWriter writer = null; - try - { - final int indexOfDot = expression.indexOf('.'); - final String variableName = expression.substring(0, indexOfDot); - final String methodName = expression.substring(indexOfDot + 1); - - if (logger.isDebugEnabled()) - logger.debug("Invoking method represented by " + expression + - " on variable " + variableName + - " with method " + methodName); - - Object bean = null; - if (Application.inPortalServer()) - { - // retrieve the managed bean, this is really weak but if the - // request comes from a portal server the bean we need to get - // is in the session with a prefix chosen by the portal vendor, - // to cover this scenario we have to go through the names of - // all the objects in the session to find the bean we want. - - String beanNameSuffix = "?" + variableName; - Enumeration enumNames = request.getSession().getAttributeNames(); - while (enumNames.hasMoreElements()) - { - String name = (String)enumNames.nextElement(); - if (name.endsWith(beanNameSuffix)) - { - bean = request.getSession().getAttribute(name); - - if (logger.isDebugEnabled()) - logger.debug("Found bean " + bean + " in the session"); - - break; - } - } - } - - // if we don't have the bean yet try and get it via the variable resolver - if (bean == null) - { - VariableResolver vr = facesContext.getApplication().getVariableResolver(); - bean = vr.resolveVariable(facesContext, variableName); - - if (logger.isDebugEnabled()) - logger.debug("Created bean " + bean + " via the variable resolver"); - } - - final Method method = bean.getClass().getMethod(methodName); - - final String responseMimetype = - (method.isAnnotationPresent(ResponseMimetype.class) - ? method.getAnnotation(ResponseMimetype.class).value() - : MimetypeMap.MIMETYPE_XML); - - if (logger.isDebugEnabled()) - logger.debug("invoking method " + method + - " with repsonse mimetype " + responseMimetype); - - writer = this.setupResponseWriter(responseMimetype, - response, - facesContext); - - // setup the transaction - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); - final Object beanFinal = bean; - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // invoke the method - try - { - method.invoke(beanFinal); - return null; - } - // Let's prevent RuntimeExceptions being wrapped twice by unwrapping InvocationTargetExceptions - catch (InvocationTargetException e) - { - if (e.getCause() != null) - { - throw e.getCause(); - } - throw e; - } - } - }; - txnHelper.doInTransaction(callback); - } - catch (EvaluationException e) - { - Throwable err = e.getCause(); - if (err == null) - { - logger.error("Failed to execute method " + expression + ": " + e.getMessage(), e); - throw e; - } - else - { - logger.error("Failed to execute method " + expression + ": " + err.getMessage(), err); - if (err instanceof RuntimeException) - { - throw (RuntimeException)err; - } - else - { - throw new AlfrescoRuntimeException("Failed to execute method " + expression + ": " + err.getMessage(), err); - } - } - } - catch (RuntimeException err) - { - - logger.error("Failed to execute method " + expression + ": " + err.getMessage(), err); - throw err; - } - catch (Exception err) - { - - logger.error("Failed to execute method " + expression + ": " + err.getMessage(), err); - throw new AlfrescoRuntimeException("Failed to execute method " + expression + ": " + err.getMessage(), err); - } - - // force the output back to the client - writer.close(); - } - - /** setup the JSF response writer. */ - private ResponseWriter setupResponseWriter(final String mimetype, - final HttpServletResponse response, - final FacesContext facesContext) - throws IOException - { - final OutputStream os = response.getOutputStream(); - final UIViewRoot viewRoot = facesContext.getViewRoot(); - final RenderKitFactory renderFactory = (RenderKitFactory) - FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY); - final RenderKit renderKit = - renderFactory.getRenderKit(facesContext, viewRoot.getRenderKitId()); - final ResponseWriter writer = - renderKit.createResponseWriter(new OutputStreamWriter(os, "UTF-8"), - mimetype, - "UTF-8"); - facesContext.setResponseWriter(writer); - // must be text/xml otherwise IE doesn't parse the response properly into responseXML - response.setContentType(mimetype); - return writer; - } -} +package org.alfresco.web.app.servlet.ajax; + +import java.io.IOException; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.util.Enumeration; + +import javax.faces.FactoryFinder; +import javax.faces.component.UIViewRoot; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.EvaluationException; +import javax.faces.el.VariableResolver; +import javax.faces.render.RenderKit; +import javax.faces.render.RenderKitFactory; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; + +/** + * Command that invokes the method represented by the expression. + *

+ * The managed bean method called is responsible for writing the response + * by getting hold of the JSF ResponseWriter. Parameters can also be + * retrieved via the JSF ExternalContext object. + *

+ * In a future release (if required) annotations may be used to state + * what content type to use for the response. + * + * @author gavinc + */ +public class InvokeCommand extends BaseAjaxCommand +{ + + ///////////////////////////////////////////////////////////////////////////// + + /** + * Annotation for a bean method that handles an ajax request. + */ + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.METHOD) + public @interface ResponseMimetype + { + // NOTE: replaced Mimetype.MIMETYPE_XML with string literal due to bug + // http://bugs.sun.com/view_bug.do?bug_id=6512707 - causing build to fail + public String value() default "text/xml"; + } + + ///////////////////////////////////////////////////////////////////////////// + + public void execute(final FacesContext facesContext, + final String expression, + final HttpServletRequest request, + final HttpServletResponse response) + throws ServletException, IOException + { + ResponseWriter writer = null; + try + { + final int indexOfDot = expression.indexOf('.'); + final String variableName = expression.substring(0, indexOfDot); + final String methodName = expression.substring(indexOfDot + 1); + + if (logger.isDebugEnabled()) + logger.debug("Invoking method represented by " + expression + + " on variable " + variableName + + " with method " + methodName); + + Object bean = null; + if (Application.inPortalServer()) + { + // retrieve the managed bean, this is really weak but if the + // request comes from a portal server the bean we need to get + // is in the session with a prefix chosen by the portal vendor, + // to cover this scenario we have to go through the names of + // all the objects in the session to find the bean we want. + + String beanNameSuffix = "?" + variableName; + Enumeration enumNames = request.getSession().getAttributeNames(); + while (enumNames.hasMoreElements()) + { + String name = (String)enumNames.nextElement(); + if (name.endsWith(beanNameSuffix)) + { + bean = request.getSession().getAttribute(name); + + if (logger.isDebugEnabled()) + logger.debug("Found bean " + bean + " in the session"); + + break; + } + } + } + + // if we don't have the bean yet try and get it via the variable resolver + if (bean == null) + { + VariableResolver vr = facesContext.getApplication().getVariableResolver(); + bean = vr.resolveVariable(facesContext, variableName); + + if (logger.isDebugEnabled()) + logger.debug("Created bean " + bean + " via the variable resolver"); + } + + final Method method = bean.getClass().getMethod(methodName); + + final String responseMimetype = + (method.isAnnotationPresent(ResponseMimetype.class) + ? method.getAnnotation(ResponseMimetype.class).value() + : MimetypeMap.MIMETYPE_XML); + + if (logger.isDebugEnabled()) + logger.debug("invoking method " + method + + " with repsonse mimetype " + responseMimetype); + + writer = this.setupResponseWriter(responseMimetype, + response, + facesContext); + + // setup the transaction + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); + final Object beanFinal = bean; + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // invoke the method + try + { + method.invoke(beanFinal); + return null; + } + // Let's prevent RuntimeExceptions being wrapped twice by unwrapping InvocationTargetExceptions + catch (InvocationTargetException e) + { + if (e.getCause() != null) + { + throw e.getCause(); + } + throw e; + } + } + }; + txnHelper.doInTransaction(callback); + } + catch (EvaluationException e) + { + Throwable err = e.getCause(); + if (err == null) + { + logger.error("Failed to execute method " + expression + ": " + e.getMessage(), e); + throw e; + } + else + { + logger.error("Failed to execute method " + expression + ": " + err.getMessage(), err); + if (err instanceof RuntimeException) + { + throw (RuntimeException)err; + } + else + { + throw new AlfrescoRuntimeException("Failed to execute method " + expression + ": " + err.getMessage(), err); + } + } + } + catch (RuntimeException err) + { + + logger.error("Failed to execute method " + expression + ": " + err.getMessage(), err); + throw err; + } + catch (Exception err) + { + + logger.error("Failed to execute method " + expression + ": " + err.getMessage(), err); + throw new AlfrescoRuntimeException("Failed to execute method " + expression + ": " + err.getMessage(), err); + } + + // force the output back to the client + writer.close(); + } + + /** setup the JSF response writer. */ + private ResponseWriter setupResponseWriter(final String mimetype, + final HttpServletResponse response, + final FacesContext facesContext) + throws IOException + { + final OutputStream os = response.getOutputStream(); + final UIViewRoot viewRoot = facesContext.getViewRoot(); + final RenderKitFactory renderFactory = (RenderKitFactory) + FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY); + final RenderKit renderKit = + renderFactory.getRenderKit(facesContext, viewRoot.getRenderKitId()); + final ResponseWriter writer = + renderKit.createResponseWriter(new OutputStreamWriter(os, "UTF-8"), + mimetype, + "UTF-8"); + facesContext.setResponseWriter(writer); + // must be text/xml otherwise IE doesn't parse the response properly into responseXML + response.setContentType(mimetype); + return writer; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/ApproveWorkflowCommand.java b/source/java/org/alfresco/web/app/servlet/command/ApproveWorkflowCommand.java index fe57aaf7a0..81b5be112f 100644 --- a/source/java/org/alfresco/web/app/servlet/command/ApproveWorkflowCommand.java +++ b/source/java/org/alfresco/web/app/servlet/command/ApproveWorkflowCommand.java @@ -1,45 +1,45 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.bean.workflow.WorkflowUtil; - -/** - * Approve Workflow command implementation - * - * @author Kevin Roast - */ -public final class ApproveWorkflowCommand implements Command -{ - public static final String PROP_TARGET = "target"; - - private static final String[] PROPERTIES = new String[] {PROP_TARGET}; - - /** - * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() - */ - public String[] getPropertyNames() - { - return PROPERTIES; - } - - /** - * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) - */ - public Object execute(ServiceRegistry serviceRegistry, Map properties) - { - // get the target Node for the command - NodeRef nodeRef = (NodeRef)properties.get(PROP_TARGET); - if (nodeRef == null) - { - throw new IllegalArgumentException( - "Unable to execute ApproveCommand - mandatory parameter not supplied: " + PROP_TARGET); - } - - WorkflowUtil.approve(nodeRef, serviceRegistry.getNodeService(), serviceRegistry.getCopyService()); - - return true; - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.bean.workflow.WorkflowUtil; + +/** + * Approve Workflow command implementation + * + * @author Kevin Roast + */ +public final class ApproveWorkflowCommand implements Command +{ + public static final String PROP_TARGET = "target"; + + private static final String[] PROPERTIES = new String[] {PROP_TARGET}; + + /** + * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() + */ + public String[] getPropertyNames() + { + return PROPERTIES; + } + + /** + * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) + */ + public Object execute(ServiceRegistry serviceRegistry, Map properties) + { + // get the target Node for the command + NodeRef nodeRef = (NodeRef)properties.get(PROP_TARGET); + if (nodeRef == null) + { + throw new IllegalArgumentException( + "Unable to execute ApproveCommand - mandatory parameter not supplied: " + PROP_TARGET); + } + + WorkflowUtil.approve(nodeRef, serviceRegistry.getNodeService(), serviceRegistry.getCopyService()); + + return true; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/BaseNodeCommandProcessor.java b/source/java/org/alfresco/web/app/servlet/command/BaseNodeCommandProcessor.java index 184e009076..4faf2bfa3e 100644 --- a/source/java/org/alfresco/web/app/servlet/command/BaseNodeCommandProcessor.java +++ b/source/java/org/alfresco/web/app/servlet/command/BaseNodeCommandProcessor.java @@ -1,47 +1,47 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import javax.servlet.ServletContext; - -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.StoreRef; -import org.alfresco.service.cmr.security.AccessStatus; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.bean.repository.Repository; - -/** - * Initial implementation of a Command Processor that is always passed enough URL elements - * to construct a single NodeRef argument. The NodeRef is checked against READ permissions - * for the current user during the validateArguments() call. - *

- * This class should be enough to form the base of Command Processor objects that only require - * a single NodeRef passed on the URL. - * - * @author Kevin Roast - */ -public abstract class BaseNodeCommandProcessor implements CommandProcessor -{ - protected NodeRef targetRef; - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) - */ - public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements) - { - if (urlElements.length < 3) - { - throw new IllegalArgumentException("Not enough URL arguments passed to command servlet."); - } - - // get NodeRef to the node with the workflow attached to it - StoreRef storeRef = new StoreRef(urlElements[0], urlElements[1]); - this.targetRef = new NodeRef(storeRef, urlElements[2]); - - // get the services we need to execute the workflow command - PermissionService permissionService = Repository.getServiceRegistry(sc).getPermissionService(); - - // check that the user has at least READ access on the node - else redirect to the login page - return (permissionService.hasPermission(this.targetRef, PermissionService.READ) == AccessStatus.ALLOWED); - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import javax.servlet.ServletContext; + +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.StoreRef; +import org.alfresco.service.cmr.security.AccessStatus; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.bean.repository.Repository; + +/** + * Initial implementation of a Command Processor that is always passed enough URL elements + * to construct a single NodeRef argument. The NodeRef is checked against READ permissions + * for the current user during the validateArguments() call. + *

+ * This class should be enough to form the base of Command Processor objects that only require + * a single NodeRef passed on the URL. + * + * @author Kevin Roast + */ +public abstract class BaseNodeCommandProcessor implements CommandProcessor +{ + protected NodeRef targetRef; + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) + */ + public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements) + { + if (urlElements.length < 3) + { + throw new IllegalArgumentException("Not enough URL arguments passed to command servlet."); + } + + // get NodeRef to the node with the workflow attached to it + StoreRef storeRef = new StoreRef(urlElements[0], urlElements[1]); + this.targetRef = new NodeRef(storeRef, urlElements[2]); + + // get the services we need to execute the workflow command + PermissionService permissionService = Repository.getServiceRegistry(sc).getPermissionService(); + + // check that the user has at least READ access on the node - else redirect to the login page + return (permissionService.hasPermission(this.targetRef, PermissionService.READ) == AccessStatus.ALLOWED); + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/BaseUIActionCommand.java b/source/java/org/alfresco/web/app/servlet/command/BaseUIActionCommand.java index 366778058a..30037fc15d 100644 --- a/source/java/org/alfresco/web/app/servlet/command/BaseUIActionCommand.java +++ b/source/java/org/alfresco/web/app/servlet/command/BaseUIActionCommand.java @@ -1,15 +1,15 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import org.alfresco.service.ServiceRegistry; - -/** - * @author Kevin Roast - */ -public abstract class BaseUIActionCommand implements Command -{ - public static final String PROP_SERVLETCONTEXT = "ServletContext"; - public static final String PROP_REQUEST = "Request"; - public static final String PROP_RESPONSE = "Response"; -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import org.alfresco.service.ServiceRegistry; + +/** + * @author Kevin Roast + */ +public abstract class BaseUIActionCommand implements Command +{ + public static final String PROP_SERVLETCONTEXT = "ServletContext"; + public static final String PROP_REQUEST = "Request"; + public static final String PROP_RESPONSE = "Response"; +} diff --git a/source/java/org/alfresco/web/app/servlet/command/Command.java b/source/java/org/alfresco/web/app/servlet/command/Command.java index f97298aef7..c9f648a908 100644 --- a/source/java/org/alfresco/web/app/servlet/command/Command.java +++ b/source/java/org/alfresco/web/app/servlet/command/Command.java @@ -1,28 +1,28 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import org.alfresco.service.ServiceRegistry; - -/** - * Simple servlet command pattern interface. - * - * @author Kevin Roast - */ -public interface Command -{ - /** - * Execute the command - * - * @param serviceRegistry The ServiceRegistry instance - * @param properties Bag of named properties for the command - * - * @return return value from the command if any - */ - public Object execute(ServiceRegistry serviceRegistry, Map properties); - - /** - * @return the names of the properties required for this command - */ - public String[] getPropertyNames(); -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import org.alfresco.service.ServiceRegistry; + +/** + * Simple servlet command pattern interface. + * + * @author Kevin Roast + */ +public interface Command +{ + /** + * Execute the command + * + * @param serviceRegistry The ServiceRegistry instance + * @param properties Bag of named properties for the command + * + * @return return value from the command if any + */ + public Object execute(ServiceRegistry serviceRegistry, Map properties); + + /** + * @return the names of the properties required for this command + */ + public String[] getPropertyNames(); +} diff --git a/source/java/org/alfresco/web/app/servlet/command/CommandFactory.java b/source/java/org/alfresco/web/app/servlet/command/CommandFactory.java index 0db58b8dce..a44d774311 100644 --- a/source/java/org/alfresco/web/app/servlet/command/CommandFactory.java +++ b/source/java/org/alfresco/web/app/servlet/command/CommandFactory.java @@ -1,81 +1,81 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.HashMap; -import java.util.Map; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Command Factory helper - * - * @author Kevin Roast - */ -public final class CommandFactory -{ - private static Log logger = LogFactory.getLog(CommandFactory.class); - - private static CommandFactory instance = new CommandFactory(); - - private static Map registry = new HashMap(16, 1.0f); - - /** - * Private constructor - protect the singleton instance - */ - private CommandFactory() - { - } - - /** - * @return the singleton CommandFactory instance - */ - public static CommandFactory getInstance() - { - return instance; - } - - /** - * Register a command name against an implementation - * - * @param name Unique name of the command - * @param clazz Class implementation of the command - */ - public void registerCommand(String name, Class clazz) - { - registry.put(name, clazz); - } - - /** - * Create a command instance of the specified command name - * - * @param name Name of the command to create (must be registered) - * - * @return the Command instance or null if not found - */ - public Command createCommand(String name) - { - Command result = null; - - // lookup command by name in the registry - Class clazz = registry.get(name); - if (clazz != null) - { - try - { - Object obj = clazz.newInstance(); - if (obj instanceof Command) - { - result = (Command)obj; - } - } - catch (Throwable err) - { - // return default if this occurs - logger.warn("Unable to create workflow command instance '" + name + - "' with classname '" + clazz.getName() + "' due to error: " + err.getMessage()); - } - } - - return result; - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.HashMap; +import java.util.Map; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Command Factory helper + * + * @author Kevin Roast + */ +public final class CommandFactory +{ + private static Log logger = LogFactory.getLog(CommandFactory.class); + + private static CommandFactory instance = new CommandFactory(); + + private static Map registry = new HashMap(16, 1.0f); + + /** + * Private constructor - protect the singleton instance + */ + private CommandFactory() + { + } + + /** + * @return the singleton CommandFactory instance + */ + public static CommandFactory getInstance() + { + return instance; + } + + /** + * Register a command name against an implementation + * + * @param name Unique name of the command + * @param clazz Class implementation of the command + */ + public void registerCommand(String name, Class clazz) + { + registry.put(name, clazz); + } + + /** + * Create a command instance of the specified command name + * + * @param name Name of the command to create (must be registered) + * + * @return the Command instance or null if not found + */ + public Command createCommand(String name) + { + Command result = null; + + // lookup command by name in the registry + Class clazz = registry.get(name); + if (clazz != null) + { + try + { + Object obj = clazz.newInstance(); + if (obj instanceof Command) + { + result = (Command)obj; + } + } + catch (Throwable err) + { + // return default if this occurs + logger.warn("Unable to create workflow command instance '" + name + + "' with classname '" + clazz.getName() + "' due to error: " + err.getMessage()); + } + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/CommandProcessor.java b/source/java/org/alfresco/web/app/servlet/command/CommandProcessor.java index 780ba403d1..79a9cf8473 100644 --- a/source/java/org/alfresco/web/app/servlet/command/CommandProcessor.java +++ b/source/java/org/alfresco/web/app/servlet/command/CommandProcessor.java @@ -1,63 +1,63 @@ -package org.alfresco.web.app.servlet.command; - -import java.io.PrintWriter; -import java.util.Map; - -import javax.servlet.ServletContext; -import javax.servlet.http.HttpServletRequest; - -import org.alfresco.service.ServiceRegistry; - -/** - * This interfaces defines the contract and lifecycle of a Servlet Command Processor. - *

- * A command processor is defined as a class capable of executing a set of related Command - * objects. It performs the bulk of the work for the command servlet. The processor impl - * is responsible for validating that the command can be processed (given the supplied remaining - * URL arguments from the servlet) and processing the command. It is also responsible for - * supply an output status page on successfuly execution of the command. - *

- * The arguments passed to a Command Processor are the remaining URL elements from the command - * servlet URL after removing the web-app name, servlet name and command processor name. - * - * @author Kevin Roast - */ -public interface CommandProcessor -{ - /** - * Pass and validate URL arguments for the command processor. Validate if the command can be - * executed given the arguments supplied. Generally at this post a Command Processor will - * convert the supplied arguments to the objects it expects, and also check any permissions - * that are required by the current user to execute the command. - * - * @param sc ServletContext, can be used to retrieve ServiceRegistry instance - * from the Repository bean. - * @param command Name of the command the arguments are for - * @param args Map of URL args passed to the command servlet - * @param urlElements String[] of the remaining URL arguments to the command servlet - * - * @return true if the command can be executed by the current user given the supplied args. - */ - public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements); - - /** - * Process the supplied command name. It is the responsibility of the Command Processor - * to lookup the specified command name using the CommandFactory registry. For that reason - * it also has the responsiblity to initially register commands it is responsible for so - * they can be constructed later. If the supplied command is unknown to it then an - * exception should be thrown to indicate this. - * - * @param serviceRegistry ServiceRegistry - * @param request HttpServletRequest - * @param command Name of the command to construct and execute - */ - public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command); - - /** - * Output a simple status message to the supplied PrintWriter. - * It can be assumed that the process() method was successful if this method is called. - * - * @param out PrintWriter - */ - public void outputStatus(PrintWriter out); -} +package org.alfresco.web.app.servlet.command; + +import java.io.PrintWriter; +import java.util.Map; + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; + +import org.alfresco.service.ServiceRegistry; + +/** + * This interfaces defines the contract and lifecycle of a Servlet Command Processor. + *

+ * A command processor is defined as a class capable of executing a set of related Command + * objects. It performs the bulk of the work for the command servlet. The processor impl + * is responsible for validating that the command can be processed (given the supplied remaining + * URL arguments from the servlet) and processing the command. It is also responsible for + * supply an output status page on successfuly execution of the command. + *

+ * The arguments passed to a Command Processor are the remaining URL elements from the command + * servlet URL after removing the web-app name, servlet name and command processor name. + * + * @author Kevin Roast + */ +public interface CommandProcessor +{ + /** + * Pass and validate URL arguments for the command processor. Validate if the command can be + * executed given the arguments supplied. Generally at this post a Command Processor will + * convert the supplied arguments to the objects it expects, and also check any permissions + * that are required by the current user to execute the command. + * + * @param sc ServletContext, can be used to retrieve ServiceRegistry instance + * from the Repository bean. + * @param command Name of the command the arguments are for + * @param args Map of URL args passed to the command servlet + * @param urlElements String[] of the remaining URL arguments to the command servlet + * + * @return true if the command can be executed by the current user given the supplied args. + */ + public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements); + + /** + * Process the supplied command name. It is the responsibility of the Command Processor + * to lookup the specified command name using the CommandFactory registry. For that reason + * it also has the responsiblity to initially register commands it is responsible for so + * they can be constructed later. If the supplied command is unknown to it then an + * exception should be thrown to indicate this. + * + * @param serviceRegistry ServiceRegistry + * @param request HttpServletRequest + * @param command Name of the command to construct and execute + */ + public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command); + + /** + * Output a simple status message to the supplied PrintWriter. + * It can be assumed that the process() method was successful if this method is called. + * + * @param out PrintWriter + */ + public void outputStatus(PrintWriter out); +} diff --git a/source/java/org/alfresco/web/app/servlet/command/EditContentPropertiesCommand.java b/source/java/org/alfresco/web/app/servlet/command/EditContentPropertiesCommand.java index 9f6e2e2853..5bbc270756 100644 --- a/source/java/org/alfresco/web/app/servlet/command/EditContentPropertiesCommand.java +++ b/source/java/org/alfresco/web/app/servlet/command/EditContentPropertiesCommand.java @@ -1,72 +1,72 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import javax.faces.application.NavigationHandler; -import javax.faces.context.FacesContext; -import javax.servlet.ServletContext; -import javax.servlet.ServletRequest; -import javax.servlet.ServletResponse; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.NodeRef; -import org.springframework.extensions.surf.util.ParameterCheck; -import org.alfresco.web.app.servlet.BaseServlet; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.BrowseBean; -import org.alfresco.web.bean.repository.Node; - -/** - * Command to execute the Edit Content Properties dialog via url. - *

- * Arguments: noderef - of the document to show the edit props dialog for - * - * @author Kevin Roast - */ -public class EditContentPropertiesCommand extends BaseUIActionCommand -{ - public static final String PROP_NODEREF = "noderef"; - - private static final String[] PROPERTIES = new String[] { - PROP_SERVLETCONTEXT, PROP_REQUEST, PROP_RESPONSE, PROP_NODEREF}; - - /** - * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) - */ - public Object execute(ServiceRegistry serviceRegistry, Map properties) - { - ServletContext sc = (ServletContext)properties.get(PROP_SERVLETCONTEXT); - ServletRequest req = (ServletRequest)properties.get(PROP_REQUEST); - ServletResponse res = (ServletResponse)properties.get(PROP_RESPONSE); - FacesContext fc = FacesHelper.getFacesContext(req, res, sc, "/jsp/close.jsp"); - BrowseBean browseBean = (BrowseBean)FacesHelper.getManagedBean(fc, BrowseBean.BEAN_NAME); - - // setup context from url args in properties map - String strNodeRef = (String)properties.get(PROP_NODEREF); - ParameterCheck.mandatoryString(PROP_NODEREF, strNodeRef); - browseBean.setDocument(new Node(new NodeRef(strNodeRef))); - - NavigationHandler navigationHandler = fc.getApplication().getNavigationHandler(); - navigationHandler.handleNavigation(fc, null, "dialog:editContentProperties"); - String viewId = fc.getViewRoot().getViewId(); - try - { - sc.getRequestDispatcher(BaseServlet.FACES_SERVLET + viewId).forward(req, res); - } - catch (Exception e) - { - throw new AlfrescoRuntimeException("Unable to forward to viewId: " + viewId, e); - } - - return null; - } - - /** - * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() - */ - public String[] getPropertyNames() - { - return PROPERTIES; - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import javax.faces.application.NavigationHandler; +import javax.faces.context.FacesContext; +import javax.servlet.ServletContext; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.NodeRef; +import org.springframework.extensions.surf.util.ParameterCheck; +import org.alfresco.web.app.servlet.BaseServlet; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.BrowseBean; +import org.alfresco.web.bean.repository.Node; + +/** + * Command to execute the Edit Content Properties dialog via url. + *

+ * Arguments: noderef - of the document to show the edit props dialog for + * + * @author Kevin Roast + */ +public class EditContentPropertiesCommand extends BaseUIActionCommand +{ + public static final String PROP_NODEREF = "noderef"; + + private static final String[] PROPERTIES = new String[] { + PROP_SERVLETCONTEXT, PROP_REQUEST, PROP_RESPONSE, PROP_NODEREF}; + + /** + * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) + */ + public Object execute(ServiceRegistry serviceRegistry, Map properties) + { + ServletContext sc = (ServletContext)properties.get(PROP_SERVLETCONTEXT); + ServletRequest req = (ServletRequest)properties.get(PROP_REQUEST); + ServletResponse res = (ServletResponse)properties.get(PROP_RESPONSE); + FacesContext fc = FacesHelper.getFacesContext(req, res, sc, "/jsp/close.jsp"); + BrowseBean browseBean = (BrowseBean)FacesHelper.getManagedBean(fc, BrowseBean.BEAN_NAME); + + // setup context from url args in properties map + String strNodeRef = (String)properties.get(PROP_NODEREF); + ParameterCheck.mandatoryString(PROP_NODEREF, strNodeRef); + browseBean.setDocument(new Node(new NodeRef(strNodeRef))); + + NavigationHandler navigationHandler = fc.getApplication().getNavigationHandler(); + navigationHandler.handleNavigation(fc, null, "dialog:editContentProperties"); + String viewId = fc.getViewRoot().getViewId(); + try + { + sc.getRequestDispatcher(BaseServlet.FACES_SERVLET + viewId).forward(req, res); + } + catch (Exception e) + { + throw new AlfrescoRuntimeException("Unable to forward to viewId: " + viewId, e); + } + + return null; + } + + /** + * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() + */ + public String[] getPropertyNames() + { + return PROPERTIES; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/EndTaskCommand.java b/source/java/org/alfresco/web/app/servlet/command/EndTaskCommand.java index 8931a08d9d..06349ccf04 100644 --- a/source/java/org/alfresco/web/app/servlet/command/EndTaskCommand.java +++ b/source/java/org/alfresco/web/app/servlet/command/EndTaskCommand.java @@ -1,44 +1,44 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.workflow.WorkflowService; - -/** - * End Task command implementation - * - * @author David Caruana - */ -public final class EndTaskCommand implements Command -{ - public static final String PROP_TASK_ID = "taskId"; - public static final String PROP_TRANSITION = "transition"; - - private static final String[] PROPERTIES = new String[] {PROP_TASK_ID, PROP_TRANSITION}; - - /** - * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() - */ - public String[] getPropertyNames() - { - return PROPERTIES; - } - - /** - * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) - */ - public Object execute(ServiceRegistry serviceRegistry, Map properties) - { - String taskId = (String)properties.get(PROP_TASK_ID); - if (taskId == null) - { - throw new IllegalArgumentException("Unable to execute EndTaskCommand - mandatory parameter not supplied: " + PROP_TASK_ID); - } - String transition = (String)properties.get(PROP_TRANSITION); - - // end task - WorkflowService workflowService = serviceRegistry.getWorkflowService(); - return workflowService.endTask(taskId, transition); - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.workflow.WorkflowService; + +/** + * End Task command implementation + * + * @author David Caruana + */ +public final class EndTaskCommand implements Command +{ + public static final String PROP_TASK_ID = "taskId"; + public static final String PROP_TRANSITION = "transition"; + + private static final String[] PROPERTIES = new String[] {PROP_TASK_ID, PROP_TRANSITION}; + + /** + * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() + */ + public String[] getPropertyNames() + { + return PROPERTIES; + } + + /** + * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) + */ + public Object execute(ServiceRegistry serviceRegistry, Map properties) + { + String taskId = (String)properties.get(PROP_TASK_ID); + if (taskId == null) + { + throw new IllegalArgumentException("Unable to execute EndTaskCommand - mandatory parameter not supplied: " + PROP_TASK_ID); + } + String transition = (String)properties.get(PROP_TRANSITION); + + // end task + WorkflowService workflowService = serviceRegistry.getWorkflowService(); + return workflowService.endTask(taskId, transition); + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/ExecuteScriptCommand.java b/source/java/org/alfresco/web/app/servlet/command/ExecuteScriptCommand.java index fb0fd5d2c9..bf181ea9fb 100644 --- a/source/java/org/alfresco/web/app/servlet/command/ExecuteScriptCommand.java +++ b/source/java/org/alfresco/web/app/servlet/command/ExecuteScriptCommand.java @@ -1,81 +1,81 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; - -/** - * Execute Script command implementation. - *

- * Executes the supplied script against the default data-model. - * - * @author Kevin Roast - */ -public final class ExecuteScriptCommand implements Command -{ - public static final String PROP_SCRIPT = "script"; - public static final String PROP_DOCUMENT = "document"; - public static final String PROP_USERPERSON = "person"; - public static final String PROP_ARGS = "args"; - - private static final String[] PROPERTIES = new String[] {PROP_SCRIPT, PROP_DOCUMENT, PROP_USERPERSON, PROP_ARGS}; - - - /** - * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() - */ - public String[] getPropertyNames() - { - return PROPERTIES; - } - - /** - * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) - */ - public Object execute(ServiceRegistry serviceRegistry, Map properties) - { - // get the target Script node for the command - NodeRef scriptRef = (NodeRef)properties.get(PROP_SCRIPT); - if (scriptRef == null) - { - throw new IllegalArgumentException( - "Unable to execute ExecuteScriptCommand - mandatory parameter not supplied: " + PROP_SCRIPT); - } - - NodeRef personRef = (NodeRef)properties.get(PROP_USERPERSON); - if (personRef == null) - { - throw new IllegalArgumentException( - "Unable to execute ExecuteScriptCommand - mandatory parameter not supplied: " + PROP_USERPERSON); - } - - // get the optional document and space context ref - NodeService nodeService = serviceRegistry.getNodeService(); - NodeRef docRef = (NodeRef)properties.get(PROP_DOCUMENT); - NodeRef spaceRef = null; - if (docRef != null) - { - spaceRef = nodeService.getPrimaryParent(docRef).getParentRef(); - } - - // build the model needed to execute the script - Map model = serviceRegistry.getScriptService().buildDefaultModel( - personRef, - new NodeRef(Repository.getStoreRef(), Application.getCompanyRootId()), - (NodeRef)nodeService.getProperty(personRef, ContentModel.PROP_HOMEFOLDER), - scriptRef, - docRef, - spaceRef); - - // add the url arguments map - model.put("args", properties.get(PROP_ARGS)); - - // execute the script and return the result - return serviceRegistry.getScriptService().executeScript(scriptRef, null, model); - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; + +/** + * Execute Script command implementation. + *

+ * Executes the supplied script against the default data-model. + * + * @author Kevin Roast + */ +public final class ExecuteScriptCommand implements Command +{ + public static final String PROP_SCRIPT = "script"; + public static final String PROP_DOCUMENT = "document"; + public static final String PROP_USERPERSON = "person"; + public static final String PROP_ARGS = "args"; + + private static final String[] PROPERTIES = new String[] {PROP_SCRIPT, PROP_DOCUMENT, PROP_USERPERSON, PROP_ARGS}; + + + /** + * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() + */ + public String[] getPropertyNames() + { + return PROPERTIES; + } + + /** + * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) + */ + public Object execute(ServiceRegistry serviceRegistry, Map properties) + { + // get the target Script node for the command + NodeRef scriptRef = (NodeRef)properties.get(PROP_SCRIPT); + if (scriptRef == null) + { + throw new IllegalArgumentException( + "Unable to execute ExecuteScriptCommand - mandatory parameter not supplied: " + PROP_SCRIPT); + } + + NodeRef personRef = (NodeRef)properties.get(PROP_USERPERSON); + if (personRef == null) + { + throw new IllegalArgumentException( + "Unable to execute ExecuteScriptCommand - mandatory parameter not supplied: " + PROP_USERPERSON); + } + + // get the optional document and space context ref + NodeService nodeService = serviceRegistry.getNodeService(); + NodeRef docRef = (NodeRef)properties.get(PROP_DOCUMENT); + NodeRef spaceRef = null; + if (docRef != null) + { + spaceRef = nodeService.getPrimaryParent(docRef).getParentRef(); + } + + // build the model needed to execute the script + Map model = serviceRegistry.getScriptService().buildDefaultModel( + personRef, + new NodeRef(Repository.getStoreRef(), Application.getCompanyRootId()), + (NodeRef)nodeService.getProperty(personRef, ContentModel.PROP_HOMEFOLDER), + scriptRef, + docRef, + spaceRef); + + // add the url arguments map + model.put("args", properties.get(PROP_ARGS)); + + // execute the script and return the result + return serviceRegistry.getScriptService().executeScript(scriptRef, null, model); + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/ExtCommandProcessor.java b/source/java/org/alfresco/web/app/servlet/command/ExtCommandProcessor.java index 843623092d..5daff31bc4 100644 --- a/source/java/org/alfresco/web/app/servlet/command/ExtCommandProcessor.java +++ b/source/java/org/alfresco/web/app/servlet/command/ExtCommandProcessor.java @@ -1,35 +1,35 @@ -package org.alfresco.web.app.servlet.command; - -import java.io.PrintWriter; -import java.util.Map; - -import javax.servlet.ServletContext; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.service.ServiceRegistry; - -/** - * This interfaces defines the contract and lifecycle of a Servlet Command Processor. - *

- * The ExtCommandProcessor adds an overloaded process() method to allow the - * HttpServletResponse to be passed. - * - * @author Kevin Roast - */ -public interface ExtCommandProcessor extends CommandProcessor -{ - /** - * Process the supplied command name. It is the responsibility of the Command Processor - * to lookup the specified command name using the CommandFactory registry. For that reason - * it also has the responsiblity to initially register commands it is responsible for so - * they can be constructed later. If the supplied command is unknown to it then an - * exception should be thrown to indicate this. - * - * @param serviceRegistry ServiceRegistry - * @param request HttpServletRequest - * @param response HttpServletResponse - * @param command Name of the command to construct and execute - */ - public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, HttpServletResponse response, String command); -} +package org.alfresco.web.app.servlet.command; + +import java.io.PrintWriter; +import java.util.Map; + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.service.ServiceRegistry; + +/** + * This interfaces defines the contract and lifecycle of a Servlet Command Processor. + *

+ * The ExtCommandProcessor adds an overloaded process() method to allow the + * HttpServletResponse to be passed. + * + * @author Kevin Roast + */ +public interface ExtCommandProcessor extends CommandProcessor +{ + /** + * Process the supplied command name. It is the responsibility of the Command Processor + * to lookup the specified command name using the CommandFactory registry. For that reason + * it also has the responsiblity to initially register commands it is responsible for so + * they can be constructed later. If the supplied command is unknown to it then an + * exception should be thrown to indicate this. + * + * @param serviceRegistry ServiceRegistry + * @param request HttpServletRequest + * @param response HttpServletResponse + * @param command Name of the command to construct and execute + */ + public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, HttpServletResponse response, String command); +} diff --git a/source/java/org/alfresco/web/app/servlet/command/ManageTaskDialogCommand.java b/source/java/org/alfresco/web/app/servlet/command/ManageTaskDialogCommand.java index 6d66e652a6..e01eeac764 100644 --- a/source/java/org/alfresco/web/app/servlet/command/ManageTaskDialogCommand.java +++ b/source/java/org/alfresco/web/app/servlet/command/ManageTaskDialogCommand.java @@ -1,75 +1,75 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import javax.faces.application.NavigationHandler; -import javax.faces.context.FacesContext; -import javax.servlet.ServletContext; -import javax.servlet.ServletRequest; -import javax.servlet.ServletResponse; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.web.app.servlet.BaseServlet; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.workflow.WorkflowBean; -import org.springframework.extensions.surf.util.ParameterCheck; - -/** - * Command to execute the Manage Task dialog via url. - *

- * Arguments: id = the id of the task - * type = the qname type of the task - * - * @author Kevin Roast - */ -public class ManageTaskDialogCommand extends BaseUIActionCommand -{ - public static final String PROP_TASKID = "id"; - public static final String PROP_TASKTYPE = "type"; - - private static final String[] PROPERTIES = new String[] { - PROP_SERVLETCONTEXT, PROP_REQUEST, PROP_RESPONSE, PROP_TASKID, PROP_TASKTYPE}; - - /** - * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) - */ - public Object execute(ServiceRegistry serviceRegistry, Map properties) - { - ServletContext sc = (ServletContext)properties.get(PROP_SERVLETCONTEXT); - ServletRequest req = (ServletRequest)properties.get(PROP_REQUEST); - ServletResponse res = (ServletResponse)properties.get(PROP_RESPONSE); - FacesContext fc = FacesHelper.getFacesContext(req, res, sc, "/jsp/close.jsp"); - WorkflowBean wfBean = (WorkflowBean)FacesHelper.getManagedBean(fc, WorkflowBean.BEAN_NAME); - - // setup dialog context from url args in properties map - String taskId = (String)properties.get(PROP_TASKID); - ParameterCheck.mandatoryString(PROP_TASKID, taskId); - String taskType = (String)properties.get(PROP_TASKTYPE); - ParameterCheck.mandatoryString(PROP_TASKTYPE, taskType); - - wfBean.setupTaskDialog(taskId, taskType); - - NavigationHandler navigationHandler = fc.getApplication().getNavigationHandler(); - navigationHandler.handleNavigation(fc, null, "dialog:manageTask"); - String viewId = fc.getViewRoot().getViewId(); - try - { - sc.getRequestDispatcher(BaseServlet.FACES_SERVLET + viewId).forward(req, res); - } - catch (Exception e) - { - throw new AlfrescoRuntimeException("Unable to forward to viewId: " + viewId, e); - } - - return null; - } - - /** - * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() - */ - public String[] getPropertyNames() - { - return PROPERTIES; - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import javax.faces.application.NavigationHandler; +import javax.faces.context.FacesContext; +import javax.servlet.ServletContext; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.web.app.servlet.BaseServlet; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.workflow.WorkflowBean; +import org.springframework.extensions.surf.util.ParameterCheck; + +/** + * Command to execute the Manage Task dialog via url. + *

+ * Arguments: id = the id of the task + * type = the qname type of the task + * + * @author Kevin Roast + */ +public class ManageTaskDialogCommand extends BaseUIActionCommand +{ + public static final String PROP_TASKID = "id"; + public static final String PROP_TASKTYPE = "type"; + + private static final String[] PROPERTIES = new String[] { + PROP_SERVLETCONTEXT, PROP_REQUEST, PROP_RESPONSE, PROP_TASKID, PROP_TASKTYPE}; + + /** + * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) + */ + public Object execute(ServiceRegistry serviceRegistry, Map properties) + { + ServletContext sc = (ServletContext)properties.get(PROP_SERVLETCONTEXT); + ServletRequest req = (ServletRequest)properties.get(PROP_REQUEST); + ServletResponse res = (ServletResponse)properties.get(PROP_RESPONSE); + FacesContext fc = FacesHelper.getFacesContext(req, res, sc, "/jsp/close.jsp"); + WorkflowBean wfBean = (WorkflowBean)FacesHelper.getManagedBean(fc, WorkflowBean.BEAN_NAME); + + // setup dialog context from url args in properties map + String taskId = (String)properties.get(PROP_TASKID); + ParameterCheck.mandatoryString(PROP_TASKID, taskId); + String taskType = (String)properties.get(PROP_TASKTYPE); + ParameterCheck.mandatoryString(PROP_TASKTYPE, taskType); + + wfBean.setupTaskDialog(taskId, taskType); + + NavigationHandler navigationHandler = fc.getApplication().getNavigationHandler(); + navigationHandler.handleNavigation(fc, null, "dialog:manageTask"); + String viewId = fc.getViewRoot().getViewId(); + try + { + sc.getRequestDispatcher(BaseServlet.FACES_SERVLET + viewId).forward(req, res); + } + catch (Exception e) + { + throw new AlfrescoRuntimeException("Unable to forward to viewId: " + viewId, e); + } + + return null; + } + + /** + * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() + */ + public String[] getPropertyNames() + { + return PROPERTIES; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/RejectWorkflowCommand.java b/source/java/org/alfresco/web/app/servlet/command/RejectWorkflowCommand.java index 02b732e49d..e6acbba53f 100644 --- a/source/java/org/alfresco/web/app/servlet/command/RejectWorkflowCommand.java +++ b/source/java/org/alfresco/web/app/servlet/command/RejectWorkflowCommand.java @@ -1,45 +1,45 @@ -package org.alfresco.web.app.servlet.command; - -import java.util.Map; - -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.bean.workflow.WorkflowUtil; - -/** - * Reject Workflow command implementation - * - * @author Kevin Roast - */ -public final class RejectWorkflowCommand implements Command -{ - public static final String PROP_TARGET = "target"; - - private static final String[] PROPERTIES = new String[] {PROP_TARGET}; - - /** - * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() - */ - public String[] getPropertyNames() - { - return PROPERTIES; - } - - /** - * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) - */ - public Object execute(ServiceRegistry serviceRegistry, Map properties) - { - // get the target Node for the command - NodeRef nodeRef = (NodeRef)properties.get(PROP_TARGET); - if (nodeRef == null) - { - throw new IllegalArgumentException( - "Unable to execute RejectCommand - mandatory parameter not supplied: " + PROP_TARGET); - } - - WorkflowUtil.reject(nodeRef, serviceRegistry.getNodeService(), serviceRegistry.getCopyService()); - - return true; - } -} +package org.alfresco.web.app.servlet.command; + +import java.util.Map; + +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.bean.workflow.WorkflowUtil; + +/** + * Reject Workflow command implementation + * + * @author Kevin Roast + */ +public final class RejectWorkflowCommand implements Command +{ + public static final String PROP_TARGET = "target"; + + private static final String[] PROPERTIES = new String[] {PROP_TARGET}; + + /** + * @see org.alfresco.web.app.servlet.command.Command#getPropertyNames() + */ + public String[] getPropertyNames() + { + return PROPERTIES; + } + + /** + * @see org.alfresco.web.app.servlet.command.Command#execute(org.alfresco.service.ServiceRegistry, java.util.Map) + */ + public Object execute(ServiceRegistry serviceRegistry, Map properties) + { + // get the target Node for the command + NodeRef nodeRef = (NodeRef)properties.get(PROP_TARGET); + if (nodeRef == null) + { + throw new IllegalArgumentException( + "Unable to execute RejectCommand - mandatory parameter not supplied: " + PROP_TARGET); + } + + WorkflowUtil.reject(nodeRef, serviceRegistry.getNodeService(), serviceRegistry.getCopyService()); + + return true; + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/ScriptCommandProcessor.java b/source/java/org/alfresco/web/app/servlet/command/ScriptCommandProcessor.java index 321fd91ff2..4ae352fcb1 100644 --- a/source/java/org/alfresco/web/app/servlet/command/ScriptCommandProcessor.java +++ b/source/java/org/alfresco/web/app/servlet/command/ScriptCommandProcessor.java @@ -1,143 +1,143 @@ -package org.alfresco.web.app.servlet.command; - -import java.io.PrintWriter; -import java.util.Enumeration; -import java.util.HashMap; -import java.util.Map; - -import javax.servlet.ServletContext; -import javax.servlet.http.HttpServletRequest; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.repo.jscript.ScriptableHashMap; -import org.alfresco.repo.security.authentication.AuthenticationUtil; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.StoreRef; -import org.alfresco.service.cmr.security.AccessStatus; -import org.alfresco.service.cmr.security.AuthorityService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.BaseServlet; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.User; -import org.alfresco.web.config.ClientConfigElement; -import org.springframework.extensions.config.ConfigService; - -/** - * Script command processor implementation. - *

- * Responsible for executing 'execute' script commands on a Node. - * - * @author Kevin Roast - */ -public final class ScriptCommandProcessor implements CommandProcessor -{ - private static final String ARG_SCRIPT_PATH = "scriptPath"; - private static final String ARG_CONTEXT_PATH = "contextPath"; - - private NodeRef scriptRef; - private NodeRef docRef; - private Object result; - - static - { - // add our commands to the command registry - CommandFactory.getInstance().registerCommand("execute", ExecuteScriptCommand.class); - } - - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) - */ - public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements) - { - boolean allowed = false; - String scriptPath = args.get(ARG_SCRIPT_PATH); - if (scriptPath != null) - { - // resolve path to a node - this.scriptRef = BaseServlet.resolveNamePath(sc, scriptPath).NodeRef; - - // same for the document context path if specified - String docPath = args.get(ARG_CONTEXT_PATH); - if (docPath != null) - { - this.docRef = BaseServlet.resolveNamePath(sc, docPath).NodeRef; - } - } - else - { - if (urlElements.length < 3) - { - throw new IllegalArgumentException("Not enough URL arguments passed to command servlet."); - } - - // get NodeRef to the node script to execute - StoreRef storeRef = new StoreRef(urlElements[0], urlElements[1]); - this.scriptRef = new NodeRef(storeRef, urlElements[2]); - - if (urlElements.length >= 6) - { - storeRef = new StoreRef(urlElements[3], urlElements[4]); - this.docRef = new NodeRef(storeRef, urlElements[5]); - } - } - - // check we can READ access the nodes specified - PermissionService ps = Repository.getServiceRegistry(sc).getPermissionService(); - allowed = (ps.hasPermission(this.scriptRef, PermissionService.READ) == AccessStatus.ALLOWED); - if (this.docRef != null) - { - allowed &= (ps.hasPermission(this.docRef, PermissionService.READ) == AccessStatus.ALLOWED); - } - - // check to see if user is allowed to execute arbituary javascript - // by default only an admin authority can perform this action - ConfigService configService = Application.getConfigService(sc); - ClientConfigElement configElement = (ClientConfigElement)configService.getGlobalConfig().getConfigElement("client"); - boolean allowScriptExecute = configElement.getAllowUserScriptExecute(); - AuthorityService authService = Repository.getServiceRegistry(sc).getAuthorityService(); - allowed &= (allowScriptExecute || authService.isAdminAuthority(AuthenticationUtil.getFullyAuthenticatedUser())); - - return allowed; - } - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, java.lang.String) - */ - public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command) - { - Map properties = new HashMap(4, 1.0f); - - properties.put(ExecuteScriptCommand.PROP_SCRIPT, this.scriptRef); - properties.put(ExecuteScriptCommand.PROP_DOCUMENT, this.docRef); - User user = Application.getCurrentUser(request.getSession()); - properties.put(ExecuteScriptCommand.PROP_USERPERSON, user.getPerson()); - - // add URL arguments as a special Scriptable Map property called 'args' - Map args = new ScriptableHashMap(); - Enumeration names = request.getParameterNames(); - while (names.hasMoreElements()) - { - String name = (String)names.nextElement(); - args.put(name, request.getParameter(name)); - } - properties.put(ExecuteScriptCommand.PROP_ARGS, args); - - Command cmd = CommandFactory.getInstance().createCommand(command); - if (cmd == null) - { - throw new AlfrescoRuntimeException("Unregistered script command specified: " + command); - } - this.result = cmd.execute(serviceRegistry, properties); - } - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) - */ - public void outputStatus(PrintWriter out) - { - out.write(this.result != null ? this.result.toString() : "Successfully executed script."); - } -} +package org.alfresco.web.app.servlet.command; + +import java.io.PrintWriter; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.repo.jscript.ScriptableHashMap; +import org.alfresco.repo.security.authentication.AuthenticationUtil; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.StoreRef; +import org.alfresco.service.cmr.security.AccessStatus; +import org.alfresco.service.cmr.security.AuthorityService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.BaseServlet; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.User; +import org.alfresco.web.config.ClientConfigElement; +import org.springframework.extensions.config.ConfigService; + +/** + * Script command processor implementation. + *

+ * Responsible for executing 'execute' script commands on a Node. + * + * @author Kevin Roast + */ +public final class ScriptCommandProcessor implements CommandProcessor +{ + private static final String ARG_SCRIPT_PATH = "scriptPath"; + private static final String ARG_CONTEXT_PATH = "contextPath"; + + private NodeRef scriptRef; + private NodeRef docRef; + private Object result; + + static + { + // add our commands to the command registry + CommandFactory.getInstance().registerCommand("execute", ExecuteScriptCommand.class); + } + + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) + */ + public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements) + { + boolean allowed = false; + String scriptPath = args.get(ARG_SCRIPT_PATH); + if (scriptPath != null) + { + // resolve path to a node + this.scriptRef = BaseServlet.resolveNamePath(sc, scriptPath).NodeRef; + + // same for the document context path if specified + String docPath = args.get(ARG_CONTEXT_PATH); + if (docPath != null) + { + this.docRef = BaseServlet.resolveNamePath(sc, docPath).NodeRef; + } + } + else + { + if (urlElements.length < 3) + { + throw new IllegalArgumentException("Not enough URL arguments passed to command servlet."); + } + + // get NodeRef to the node script to execute + StoreRef storeRef = new StoreRef(urlElements[0], urlElements[1]); + this.scriptRef = new NodeRef(storeRef, urlElements[2]); + + if (urlElements.length >= 6) + { + storeRef = new StoreRef(urlElements[3], urlElements[4]); + this.docRef = new NodeRef(storeRef, urlElements[5]); + } + } + + // check we can READ access the nodes specified + PermissionService ps = Repository.getServiceRegistry(sc).getPermissionService(); + allowed = (ps.hasPermission(this.scriptRef, PermissionService.READ) == AccessStatus.ALLOWED); + if (this.docRef != null) + { + allowed &= (ps.hasPermission(this.docRef, PermissionService.READ) == AccessStatus.ALLOWED); + } + + // check to see if user is allowed to execute arbituary javascript + // by default only an admin authority can perform this action + ConfigService configService = Application.getConfigService(sc); + ClientConfigElement configElement = (ClientConfigElement)configService.getGlobalConfig().getConfigElement("client"); + boolean allowScriptExecute = configElement.getAllowUserScriptExecute(); + AuthorityService authService = Repository.getServiceRegistry(sc).getAuthorityService(); + allowed &= (allowScriptExecute || authService.isAdminAuthority(AuthenticationUtil.getFullyAuthenticatedUser())); + + return allowed; + } + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, java.lang.String) + */ + public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command) + { + Map properties = new HashMap(4, 1.0f); + + properties.put(ExecuteScriptCommand.PROP_SCRIPT, this.scriptRef); + properties.put(ExecuteScriptCommand.PROP_DOCUMENT, this.docRef); + User user = Application.getCurrentUser(request.getSession()); + properties.put(ExecuteScriptCommand.PROP_USERPERSON, user.getPerson()); + + // add URL arguments as a special Scriptable Map property called 'args' + Map args = new ScriptableHashMap(); + Enumeration names = request.getParameterNames(); + while (names.hasMoreElements()) + { + String name = (String)names.nextElement(); + args.put(name, request.getParameter(name)); + } + properties.put(ExecuteScriptCommand.PROP_ARGS, args); + + Command cmd = CommandFactory.getInstance().createCommand(command); + if (cmd == null) + { + throw new AlfrescoRuntimeException("Unregistered script command specified: " + command); + } + this.result = cmd.execute(serviceRegistry, properties); + } + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) + */ + public void outputStatus(PrintWriter out) + { + out.write(this.result != null ? this.result.toString() : "Successfully executed script."); + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/TaskCommandProcessor.java b/source/java/org/alfresco/web/app/servlet/command/TaskCommandProcessor.java index ddf3744216..73c7356642 100644 --- a/source/java/org/alfresco/web/app/servlet/command/TaskCommandProcessor.java +++ b/source/java/org/alfresco/web/app/servlet/command/TaskCommandProcessor.java @@ -1,84 +1,84 @@ -package org.alfresco.web.app.servlet.command; - -import java.io.PrintWriter; -import java.util.HashMap; -import java.util.Map; - -import javax.servlet.ServletContext; -import javax.servlet.http.HttpServletRequest; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.web.bean.workflow.WorkflowUtil; -import org.alfresco.web.ui.common.Utils; - -/** - * Task specific command processor implementation. - *

- * Responsible for executing workflow task operations. - * - * @author David Caruana - */ -public final class TaskCommandProcessor implements CommandProcessor -{ - private String taskId; - private String transition = null; - private String command; - - static - { - // add our commands to the command registry - CommandFactory.getInstance().registerCommand("end", EndTaskCommand.class); - } - - - /* (non-Javadoc) - * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) - */ - public boolean validateArguments(ServletContext sc, String cmd, Map args, String[] urlElements) - { - if (urlElements.length == 0) - { - throw new IllegalArgumentException("Not enough URL arguments passed to command servlet."); - } - taskId = urlElements[0]; - if (urlElements.length == 2) - { - transition = urlElements[1]; - } - return WorkflowUtil.isTaskEditable(taskId, sc); - } - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, java.lang.String) - */ - public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String commandName) - { - Map properties = new HashMap(1, 1.0f); - // all workflow commands use a "target" Node property as an argument - properties.put(EndTaskCommand.PROP_TASK_ID, taskId); - if (transition != null) - { - properties.put(EndTaskCommand.PROP_TRANSITION, transition); - } - Command cmd = CommandFactory.getInstance().createCommand(commandName); - if (cmd == null) - { - throw new AlfrescoRuntimeException("Unregistered workflow command specified: " + commandName); - } - cmd.execute(serviceRegistry, properties); - this.command = commandName; - } - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) - */ - public void outputStatus(PrintWriter out) - { - out.print("Task command: '"); - out.print(Utils.encode(command)); - out.print("' executed against task: "); - out.println(Utils.encode(taskId)); - } - -} +package org.alfresco.web.app.servlet.command; + +import java.io.PrintWriter; +import java.util.HashMap; +import java.util.Map; + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.web.bean.workflow.WorkflowUtil; +import org.alfresco.web.ui.common.Utils; + +/** + * Task specific command processor implementation. + *

+ * Responsible for executing workflow task operations. + * + * @author David Caruana + */ +public final class TaskCommandProcessor implements CommandProcessor +{ + private String taskId; + private String transition = null; + private String command; + + static + { + // add our commands to the command registry + CommandFactory.getInstance().registerCommand("end", EndTaskCommand.class); + } + + + /* (non-Javadoc) + * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) + */ + public boolean validateArguments(ServletContext sc, String cmd, Map args, String[] urlElements) + { + if (urlElements.length == 0) + { + throw new IllegalArgumentException("Not enough URL arguments passed to command servlet."); + } + taskId = urlElements[0]; + if (urlElements.length == 2) + { + transition = urlElements[1]; + } + return WorkflowUtil.isTaskEditable(taskId, sc); + } + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, java.lang.String) + */ + public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String commandName) + { + Map properties = new HashMap(1, 1.0f); + // all workflow commands use a "target" Node property as an argument + properties.put(EndTaskCommand.PROP_TASK_ID, taskId); + if (transition != null) + { + properties.put(EndTaskCommand.PROP_TRANSITION, transition); + } + Command cmd = CommandFactory.getInstance().createCommand(commandName); + if (cmd == null) + { + throw new AlfrescoRuntimeException("Unregistered workflow command specified: " + commandName); + } + cmd.execute(serviceRegistry, properties); + this.command = commandName; + } + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) + */ + public void outputStatus(PrintWriter out) + { + out.print("Task command: '"); + out.print(Utils.encode(command)); + out.print("' executed against task: "); + out.println(Utils.encode(taskId)); + } + +} diff --git a/source/java/org/alfresco/web/app/servlet/command/UIActionCommandProcessor.java b/source/java/org/alfresco/web/app/servlet/command/UIActionCommandProcessor.java index 836589ac9c..f72aa7b620 100644 --- a/source/java/org/alfresco/web/app/servlet/command/UIActionCommandProcessor.java +++ b/source/java/org/alfresco/web/app/servlet/command/UIActionCommandProcessor.java @@ -1,112 +1,112 @@ -package org.alfresco.web.app.servlet.command; - -import java.io.PrintWriter; -import java.util.HashMap; -import java.util.Map; - -import javax.servlet.ServletContext; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.bean.workflow.WorkflowUtil; -import org.alfresco.web.ui.common.Utils; - -/** - * UI action command processor implementation. - *

- * Responsible for executing specific UI actions via a REST style URL interface. - *

- * The URL postfix for each specific command depends on the context that is required - * for that command. For example, a command to launch the Create Web Content dialog may - * require the current sandbox and the current web project as its context e.g. - *
- * http://server/alfresco/command/ui/createwebcontent?sandbox=website1&webproject=1234567890 - * - * @author Kevin Roast - */ -public class UIActionCommandProcessor implements ExtCommandProcessor -{ - private static final String MANAGE_TASK = "managetask"; - - public static final String PARAM_CONTAINER = "container"; - - private ServletContext sc = null; - private String command = null; - private Map args = null; - - static - { - // add our commands to the command registry - CommandFactory.getInstance().registerCommand(MANAGE_TASK, ManageTaskDialogCommand.class); - CommandFactory.getInstance().registerCommand("editcontentprops", EditContentPropertiesCommand.class); - CommandFactory.getInstance().registerCommand("userprofile", UserProfileDialogCommand.class); - CommandFactory.getInstance().registerCommand("editspace", EditSpaceCommand.class); - } - - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) - */ - public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements) - { - this.sc = sc; - if (args.size() != 0) - { - this.args = new HashMap(args); - } - if (MANAGE_TASK.equals(command)) - { - String taskId = args.get(ManageTaskDialogCommand.PROP_TASKID); - return WorkflowUtil.isTaskEditable(taskId, sc); - } - return true; - } - - public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command) - { - // not implemented in ExtCommandProcessor! - } - - /** - * @see org.alfresco.web.app.servlet.command.ExtCommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String) - */ - public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, HttpServletResponse response, String command) - { - Map properties = new HashMap(this.args); - - properties.put(BaseUIActionCommand.PROP_SERVLETCONTEXT, this.sc); - properties.put(BaseUIActionCommand.PROP_REQUEST, request); - properties.put(BaseUIActionCommand.PROP_RESPONSE, response); - - // if the container parameter is present and equal to "plain" add the - // external container object to the session - String container = request.getParameter(PARAM_CONTAINER); - if (container != null && container.equalsIgnoreCase("plain")) - { - request.getSession().setAttribute( - AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION, Boolean.TRUE); - } - - Command cmd = CommandFactory.getInstance().createCommand(command); - if (cmd == null) - { - throw new AlfrescoRuntimeException("Unregistered UI Action command specified: " + command); - } - cmd.execute(serviceRegistry, properties); - this.command = command; - } - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) - */ - public void outputStatus(PrintWriter out) - { - out.print("UI Action command: '"); - out.print(Utils.encode(this.command)); - out.print("' executed with args: "); - out.println(this.args != null ? (Utils.encode(this.args.toString())) : ""); - } -} +package org.alfresco.web.app.servlet.command; + +import java.io.PrintWriter; +import java.util.HashMap; +import java.util.Map; + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.bean.workflow.WorkflowUtil; +import org.alfresco.web.ui.common.Utils; + +/** + * UI action command processor implementation. + *

+ * Responsible for executing specific UI actions via a REST style URL interface. + *

+ * The URL postfix for each specific command depends on the context that is required + * for that command. For example, a command to launch the Create Web Content dialog may + * require the current sandbox and the current web project as its context e.g. + *
+ * http://server/alfresco/command/ui/createwebcontent?sandbox=website1&webproject=1234567890 + * + * @author Kevin Roast + */ +public class UIActionCommandProcessor implements ExtCommandProcessor +{ + private static final String MANAGE_TASK = "managetask"; + + public static final String PARAM_CONTAINER = "container"; + + private ServletContext sc = null; + private String command = null; + private Map args = null; + + static + { + // add our commands to the command registry + CommandFactory.getInstance().registerCommand(MANAGE_TASK, ManageTaskDialogCommand.class); + CommandFactory.getInstance().registerCommand("editcontentprops", EditContentPropertiesCommand.class); + CommandFactory.getInstance().registerCommand("userprofile", UserProfileDialogCommand.class); + CommandFactory.getInstance().registerCommand("editspace", EditSpaceCommand.class); + } + + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#validateArguments(javax.servlet.ServletContext, java.lang.String, java.util.Map, java.lang.String[]) + */ + public boolean validateArguments(ServletContext sc, String command, Map args, String[] urlElements) + { + this.sc = sc; + if (args.size() != 0) + { + this.args = new HashMap(args); + } + if (MANAGE_TASK.equals(command)) + { + String taskId = args.get(ManageTaskDialogCommand.PROP_TASKID); + return WorkflowUtil.isTaskEditable(taskId, sc); + } + return true; + } + + public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command) + { + // not implemented in ExtCommandProcessor! + } + + /** + * @see org.alfresco.web.app.servlet.command.ExtCommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String) + */ + public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, HttpServletResponse response, String command) + { + Map properties = new HashMap(this.args); + + properties.put(BaseUIActionCommand.PROP_SERVLETCONTEXT, this.sc); + properties.put(BaseUIActionCommand.PROP_REQUEST, request); + properties.put(BaseUIActionCommand.PROP_RESPONSE, response); + + // if the container parameter is present and equal to "plain" add the + // external container object to the session + String container = request.getParameter(PARAM_CONTAINER); + if (container != null && container.equalsIgnoreCase("plain")) + { + request.getSession().setAttribute( + AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION, Boolean.TRUE); + } + + Command cmd = CommandFactory.getInstance().createCommand(command); + if (cmd == null) + { + throw new AlfrescoRuntimeException("Unregistered UI Action command specified: " + command); + } + cmd.execute(serviceRegistry, properties); + this.command = command; + } + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) + */ + public void outputStatus(PrintWriter out) + { + out.print("UI Action command: '"); + out.print(Utils.encode(this.command)); + out.print("' executed with args: "); + out.println(this.args != null ? (Utils.encode(this.args.toString())) : ""); + } +} diff --git a/source/java/org/alfresco/web/app/servlet/command/WorkflowCommandProcessor.java b/source/java/org/alfresco/web/app/servlet/command/WorkflowCommandProcessor.java index 173b6431c9..1eb11749e3 100644 --- a/source/java/org/alfresco/web/app/servlet/command/WorkflowCommandProcessor.java +++ b/source/java/org/alfresco/web/app/servlet/command/WorkflowCommandProcessor.java @@ -1,59 +1,59 @@ -package org.alfresco.web.app.servlet.command; - -import java.io.PrintWriter; -import java.util.HashMap; -import java.util.Map; - -import javax.servlet.http.HttpServletRequest; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.web.ui.common.Utils; - -/** - * Workflow specific command processor implementation. - *

- * Responsible for executing 'approve' and 'reject' workflow commands on a Node. - * - * @author Kevin Roast - */ -public final class WorkflowCommandProcessor extends BaseNodeCommandProcessor -{ - private String command; - - static - { - // add our commands to the command registry - CommandFactory.getInstance().registerCommand("approve", ApproveWorkflowCommand.class); - CommandFactory.getInstance().registerCommand("reject", RejectWorkflowCommand.class); - } - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, java.lang.String) - */ - public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command) - { - Map properties = new HashMap(1, 1.0f); - // all workflow commands use a "target" Node property as an argument - properties.put(ApproveWorkflowCommand.PROP_TARGET, this.targetRef); - Command cmd = CommandFactory.getInstance().createCommand(command); - if (cmd == null) - { - throw new AlfrescoRuntimeException("Unregistered workflow command specified: " + command); - } - cmd.execute(serviceRegistry, properties); - - this.command = command; - } - - /** - * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) - */ - public void outputStatus(PrintWriter out) - { - out.print("Workflow command: '"); - out.print(Utils.encode(this.command)); - out.print("' executed against node: "); - out.println(Utils.encode(this.targetRef.toString())); - } -} +package org.alfresco.web.app.servlet.command; + +import java.io.PrintWriter; +import java.util.HashMap; +import java.util.Map; + +import javax.servlet.http.HttpServletRequest; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.web.ui.common.Utils; + +/** + * Workflow specific command processor implementation. + *

+ * Responsible for executing 'approve' and 'reject' workflow commands on a Node. + * + * @author Kevin Roast + */ +public final class WorkflowCommandProcessor extends BaseNodeCommandProcessor +{ + private String command; + + static + { + // add our commands to the command registry + CommandFactory.getInstance().registerCommand("approve", ApproveWorkflowCommand.class); + CommandFactory.getInstance().registerCommand("reject", RejectWorkflowCommand.class); + } + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#process(org.alfresco.service.ServiceRegistry, javax.servlet.http.HttpServletRequest, java.lang.String) + */ + public void process(ServiceRegistry serviceRegistry, HttpServletRequest request, String command) + { + Map properties = new HashMap(1, 1.0f); + // all workflow commands use a "target" Node property as an argument + properties.put(ApproveWorkflowCommand.PROP_TARGET, this.targetRef); + Command cmd = CommandFactory.getInstance().createCommand(command); + if (cmd == null) + { + throw new AlfrescoRuntimeException("Unregistered workflow command specified: " + command); + } + cmd.execute(serviceRegistry, properties); + + this.command = command; + } + + /** + * @see org.alfresco.web.app.servlet.command.CommandProcessor#outputStatus(java.io.PrintWriter) + */ + public void outputStatus(PrintWriter out) + { + out.print("Workflow command: '"); + out.print(Utils.encode(this.command)); + out.print("' executed against node: "); + out.println(Utils.encode(this.targetRef.toString())); + } +} diff --git a/source/java/org/alfresco/web/bean/AboutBean.java b/source/java/org/alfresco/web/bean/AboutBean.java index 826ae19a04..1bdc399a37 100644 --- a/source/java/org/alfresco/web/bean/AboutBean.java +++ b/source/java/org/alfresco/web/bean/AboutBean.java @@ -1,88 +1,88 @@ -package org.alfresco.web.bean; - -import javax.faces.context.FacesContext; - -import org.alfresco.service.descriptor.DescriptorService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Repository; - -/** - * Simple backing bean used by the about page to display the version. - * - * @author gavinc - */ -public class AboutBean extends BaseDialogBean -{ - private static final long serialVersionUID = -3777479360531145878L; - - private final static String MSG_VERSION = "version"; - private final static String MSG_CLOSE = "close"; - - transient private DescriptorService descriptorService; - - /** - * Retrieves the version of the repository. - * - * @return The version string - */ - public String getVersion() - { - return this.getDescriptorService().getServerDescriptor().getVersion(); - } - - /** - * Retrieves the edition of the repository. - * - * @return The edition - */ - public String getEdition() - { - return this.getDescriptorService().getServerDescriptor().getEdition(); - } - - /** - * Sets the DescriptorService. - * - * @param descriptorService The DescriptorService - */ - public void setDescriptorService(DescriptorService descriptorService) - { - this.descriptorService = descriptorService; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return null; - } - - @Override - public String getContainerDescription() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_VERSION) + " :" + getEdition() + " - v" + getVersion(); - } - - DescriptorService getDescriptorService() - { - //check for null in cluster environment - if (descriptorService == null) - { - descriptorService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getDescriptorService(); - } - return descriptorService; - } - - @Override - public String getCancelButtonLabel() - { - - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } - - @Override - protected String getDefaultCancelOutcome() - { - return "dialog:close:browse"; - } -} +package org.alfresco.web.bean; + +import javax.faces.context.FacesContext; + +import org.alfresco.service.descriptor.DescriptorService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Repository; + +/** + * Simple backing bean used by the about page to display the version. + * + * @author gavinc + */ +public class AboutBean extends BaseDialogBean +{ + private static final long serialVersionUID = -3777479360531145878L; + + private final static String MSG_VERSION = "version"; + private final static String MSG_CLOSE = "close"; + + transient private DescriptorService descriptorService; + + /** + * Retrieves the version of the repository. + * + * @return The version string + */ + public String getVersion() + { + return this.getDescriptorService().getServerDescriptor().getVersion(); + } + + /** + * Retrieves the edition of the repository. + * + * @return The edition + */ + public String getEdition() + { + return this.getDescriptorService().getServerDescriptor().getEdition(); + } + + /** + * Sets the DescriptorService. + * + * @param descriptorService The DescriptorService + */ + public void setDescriptorService(DescriptorService descriptorService) + { + this.descriptorService = descriptorService; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return null; + } + + @Override + public String getContainerDescription() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_VERSION) + " :" + getEdition() + " - v" + getVersion(); + } + + DescriptorService getDescriptorService() + { + //check for null in cluster environment + if (descriptorService == null) + { + descriptorService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getDescriptorService(); + } + return descriptorService; + } + + @Override + public String getCancelButtonLabel() + { + + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } + + @Override + protected String getDefaultCancelOutcome() + { + return "dialog:close:browse"; + } +} diff --git a/source/java/org/alfresco/web/bean/BaseDetailsBean.java b/source/java/org/alfresco/web/bean/BaseDetailsBean.java index daa10727b6..655d8f9fc2 100644 --- a/source/java/org/alfresco/web/bean/BaseDetailsBean.java +++ b/source/java/org/alfresco/web/bean/BaseDetailsBean.java @@ -1,728 +1,728 @@ -package org.alfresco.web.bean; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.application.FacesMessage; -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.repo.web.scripts.FileTypeImageUtils; -import org.alfresco.service.cmr.repository.CopyService; -import org.alfresco.service.cmr.repository.FileTypeImageSize; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.TemplateImageResolver; -import org.alfresco.service.cmr.security.AccessStatus; -import org.alfresco.service.cmr.security.OwnableService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.bean.actions.handlers.SimpleWorkflowHandler; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.workflow.WorkflowUtil; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.Utils.URLMode; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.alfresco.web.ui.common.component.UIPanel.ExpandedEvent; - -/** - * Backing bean provided access to the details of a Node - * - * @author Kevin Roast - */ -public abstract class BaseDetailsBean extends BaseDialogBean -{ - private static final String MSG_SUCCESS_OWNERSHIP = "success_ownership"; - - /** OwnableService bean reference */ - transient private OwnableService ownableService; - - /** CopyService bean reference */ - transient private CopyService copyService; - - /** The PermissionService reference */ - transient private PermissionService permissionService; - - /** Selected template Id */ - protected String template; - - /** The map of workflow properties */ - protected Map workflowProperties; - - protected Map panels = new HashMap(4, 1.0f); - - private static final String MSG_ERROR_WORKFLOW_REJECT = "error_workflow_reject"; - private static final String MSG_ERROR_WORKFLOW_APPROVE = "error_workflow_approve"; - private static final String MSG_ERROR_UPDATE_SIMPLEWORKFLOW = "error_update_simpleworkflow"; - - public BaseDetailsBean() - { - // initial state of some panels that don't use the default - panels.put("workflow-panel", false); - panels.put("category-panel", false); - } - - // ------------------------------------------------------------------------------ - // Bean property getters and setters - - /** - * Sets the ownable service instance the bean should use - * - * @param ownableService The OwnableService - */ - public void setOwnableService(OwnableService ownableService) - { - this.ownableService = ownableService; - } - - protected OwnableService getOwnableService() - { - if (ownableService == null) - { - ownableService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getOwnableService(); - } - return ownableService; - } - - /** - * Sets the copy service instance the bean should use - * - * @param copyService The CopyService - */ - public void setCopyService(CopyService copyService) - { - this.copyService = copyService; - } - - protected CopyService getCopyService() - { - if (copyService == null) - { - copyService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCopyService(); - } - return copyService; - } - - /** - * @param permissionService The PermissionService to set. - */ - public void setPermissionService(PermissionService permissionService) - { - this.permissionService = permissionService; - } - - protected PermissionService getPermissionService() - { - if (permissionService == null) - { - permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); - } - return permissionService; - } - - /** - * @return Returns the panels expanded state map. - */ - public Map getPanels() - { - return this.panels; - } - - /** - * @param panels The panels expanded state map. - */ - public void setPanels(Map panels) - { - this.panels = panels; - } - - /** - * Returns the Node this bean is currently representing - * - * @return The Node - */ - public abstract Node getNode(); - - /** - * Returns the id of the current node - * - * @return The id - */ - public String getId() - { - return getNode().getId(); - } - - /** - * Returns the name of the current node - * - * @return Name of the current - */ - public String getName() - { - return getNode().getName(); - } - - /** - * Return the Alfresco NodeRef URL for the current node - * - * @return the Alfresco NodeRef URL - */ - public String getNodeRefUrl() - { - return getNode().getNodeRef().toString(); - } - - /** - * Returns the WebDAV URL for the current node - * - * @return The WebDAV url - */ - public String getWebdavUrl() - { - Node node = getLinkResolvedNode(); - return Utils.generateURL(FacesContext.getCurrentInstance(), node, URLMode.WEBDAV); - } - - /** - * Returns the CIFS path for the current node - * - * @return The CIFS path - */ - public String getCifsPath() - { - Node node = getLinkResolvedNode(); - return Utils.generateURL(FacesContext.getCurrentInstance(), node, URLMode.CIFS); - } - - /** - * Returns the URL to access the details page for the current node - * - * @return The bookmark URL - */ - public String getBookmarkUrl() - { - return Utils.generateURL(FacesContext.getCurrentInstance(), getNode(), URLMode.SHOW_DETAILS); - } - - /** - * Resolve the actual Node from any Link object that may be proxying it - * - * @return current Node or Node resolved from any Link object - */ - protected abstract Node getLinkResolvedNode(); - - /** - * @return Returns the template Id. - */ - public String getTemplate() - { - // return current template if it exists - NodeRef ref = (NodeRef)getNode().getProperties().get(ContentModel.PROP_TEMPLATE); - return ref != null ? ref.getId() : this.template; - } - - /** - * @param template The template Id to set. - */ - public void setTemplate(String template) - { - this.template = template; - } - - /** - * @return true if the current node has a custom Template or Webscript view applied and - * references a template/webscript that currently exists in the system. - */ - public boolean getHasCustomView() - { - return getHasWebscriptView() || getHasTemplateView(); - } - - /** - * @return true if the current node has a Template based custom view available - */ - public boolean getHasTemplateView() - { - if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE)) - { - NodeRef templateRef = (NodeRef)getNode().getProperties().get(ContentModel.PROP_TEMPLATE); - return (templateRef != null && this.getNodeService().exists(templateRef) && - this.getPermissionService().hasPermission(templateRef, PermissionService.READ) == AccessStatus.ALLOWED); - } - return false; - } - - /** - * @return true if the current node has a Webscript based custom view available - */ - public boolean getHasWebscriptView() - { - if (getNode().hasAspect(ContentModel.ASPECT_WEBSCRIPTABLE)) - { - return (getNode().getProperties().get(ContentModel.PROP_WEBSCRIPT) != null); - } - return false; - } - - /** - * @return String of the NodeRef for the custom view for the node - */ - public String getTemplateRef() - { - NodeRef ref = (NodeRef)getNode().getProperties().get(ContentModel.PROP_TEMPLATE); - return ref != null ? ref.toString() : null; - } - - /** - * @return Webscript URL for the custom view for the node - */ - public String getWebscriptUrl() - { - return (String)getNode().getProperties().get(ContentModel.PROP_WEBSCRIPT); - } - - /** - * Returns a model for use by a template on the Details page. - * - * @return model containing current current node info. - */ - public abstract Map getTemplateModel(); - - /** Template Image resolver helper */ - protected TemplateImageResolver imageResolver = new TemplateImageResolver() - { - private static final long serialVersionUID = 1539708282743314697L; - - public String resolveImagePathForName(String filename, FileTypeImageSize size) - { - return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); - } - }; - - /** - * Returns the properties for the attached workflow as a map - * - * @return Properties of the attached workflow, null if there is no workflow - */ - public Map getWorkflowProperties() - { - if (this.workflowProperties == null && - getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) - { - // get the exisiting properties for the node - Map props = getNode().getProperties(); - - String approveStepName = (String)props.get( - ApplicationModel.PROP_APPROVE_STEP.toString()); - String rejectStepName = (String)props.get( - ApplicationModel.PROP_REJECT_STEP.toString()); - - Boolean approveMove = (Boolean)props.get( - ApplicationModel.PROP_APPROVE_MOVE.toString()); - Boolean rejectMove = (Boolean)props.get( - ApplicationModel.PROP_REJECT_MOVE.toString()); - - NodeRef approveFolder = (NodeRef)props.get( - ApplicationModel.PROP_APPROVE_FOLDER.toString()); - NodeRef rejectFolder = (NodeRef)props.get( - ApplicationModel.PROP_REJECT_FOLDER.toString()); - - // put the workflow properties in a separate map for use by the JSP - this.workflowProperties = new HashMap(7); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME, - approveStepName); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_ACTION, - approveMove ? "move" : "copy"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_FOLDER, approveFolder); - - if (rejectStepName == null || rejectMove == null || rejectFolder == null) - { - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "no"); - } - else - { - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, - "yes"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME, - rejectStepName); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_ACTION, - rejectMove ? "move" : "copy"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_FOLDER, - rejectFolder); - } - } - - return this.workflowProperties; - } - - /** - * Cancel Workflow Edit dialog - */ - public String cancelWorkflowEdit() - { - // resets the workflow properties map so any changes made - // don't appear to be persisted - this.workflowProperties.clear(); - this.workflowProperties = null; - return "cancel"; - } - - /** - * Saves the details of the workflow stored in workflowProperties - * to the current node - * - * @return The outcome string - */ - public String saveWorkflow() - { - String outcome = "cancel"; - - try - { - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // firstly retrieve all the properties for the current node - Map updateProps = getNodeService().getProperties( - getNode().getNodeRef()); - - // update the simple workflow properties - - // set the approve step name - updateProps.put(ApplicationModel.PROP_APPROVE_STEP, - workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME)); - - // specify whether the approve step will copy or move the content - boolean approveMove = true; - String approveAction = (String)workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_ACTION); - if (approveAction != null && approveAction.equals("copy")) - { - approveMove = false; - } - updateProps.put(ApplicationModel.PROP_APPROVE_MOVE, Boolean.valueOf(approveMove)); - - // create node ref representation of the destination folder - updateProps.put(ApplicationModel.PROP_APPROVE_FOLDER, - workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_FOLDER)); - - // determine whether there should be a reject step - boolean requireReject = true; - String rejectStepPresent = (String)workflowProperties.get( - SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT); - if (rejectStepPresent != null && rejectStepPresent.equals("no")) - { - requireReject = false; - } - - if (requireReject) - { - // set the reject step name - updateProps.put(ApplicationModel.PROP_REJECT_STEP, - workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME)); - - // specify whether the reject step will copy or move the content - boolean rejectMove = true; - String rejectAction = (String)workflowProperties.get( - SimpleWorkflowHandler.PROP_REJECT_ACTION); - if (rejectAction != null && rejectAction.equals("copy")) - { - rejectMove = false; - } - updateProps.put(ApplicationModel.PROP_REJECT_MOVE, Boolean.valueOf(rejectMove)); - - // create node ref representation of the destination folder - updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, - workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_FOLDER)); - } - else - { - // set all the reject properties to null to signify there should - // be no reject step - updateProps.put(ApplicationModel.PROP_REJECT_STEP, null); - updateProps.put(ApplicationModel.PROP_REJECT_MOVE, null); - updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, null); - } - - // set the properties on the node - getNodeService().setProperties(getNode().getNodeRef(), updateProps); - return null; - } - }; - txnHelper.doInTransaction(callback); - - // reset the state of the current node so it reflects the changes just made - getNode().reset(); - - outcome = "finish"; - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), MSG_ERROR_UPDATE_SIMPLEWORKFLOW), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - - return outcome; - } - - /** - * Returns the name of the approve step of the attached workflow - * - * @return The name of the approve step or null if there is no workflow - */ - public String getApproveStepName() - { - String approveStepName = null; - - if (getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) - { - approveStepName = (String)getNode().getProperties().get( - ApplicationModel.PROP_APPROVE_STEP.toString()); - } - - return approveStepName; - } - - /** - * Event handler called to handle the approve step of the simple workflow - * - * @param event The event that was triggered - */ - public void approve(ActionEvent event) - { - UIActionLink link = (UIActionLink)event.getComponent(); - Map params = link.getParameterMap(); - String id = params.get("id"); - if (id == null || id.length() == 0) - { - throw new AlfrescoRuntimeException("approve called without an id"); - } - - final NodeRef docNodeRef = new NodeRef(Repository.getStoreRef(), id); - - try - { - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // call the service to perform the approve - WorkflowUtil.approve(docNodeRef, getNodeService(), getCopyService()); - return null; - } - }; - txnHelper.doInTransaction(callback); - - // if this was called via the node details dialog we need to reset the node - if (getNode() != null) - { - getNode().reset(); - } - - // also make sure the UI will get refreshed - UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), MSG_ERROR_WORKFLOW_APPROVE), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } - - /** - * Returns the name of the reject step of the attached workflow - * - * @return The name of the reject step or null if there is no workflow - */ - public String getRejectStepName() - { - String approveStepName = null; - - if (getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) - { - approveStepName = (String)getNode().getProperties().get( - ApplicationModel.PROP_REJECT_STEP.toString()); - } - - return approveStepName; - } - - /** - * Event handler called to handle the approve step of the simple workflow - * - * @param event The event that was triggered - */ - public void reject(ActionEvent event) - { - UIActionLink link = (UIActionLink)event.getComponent(); - Map params = link.getParameterMap(); - String id = params.get("id"); - if (id == null || id.length() == 0) - { - throw new AlfrescoRuntimeException("reject called without an id"); - } - - final NodeRef docNodeRef = new NodeRef(Repository.getStoreRef(), id); - - try - { - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // call the service to perform the reject - WorkflowUtil.reject(docNodeRef, getNodeService(), getCopyService()); - return null; - } - }; - txnHelper.doInTransaction(callback); - - // if this was called via the node details dialog we need to reset the node - if (getNode() != null) - { - getNode().reset(); - } - - // also make sure the UI will get refreshed - UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); - } - catch (Throwable e) - { - // rollback the transaction - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), MSG_ERROR_WORKFLOW_REJECT), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } - - // ------------------------------------------------------------------------------ - // Action event handlers - - /** - * Action handler to apply the selected Template and Templatable aspect to the current node - */ - public void applyTemplate(ActionEvent event) - { - if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) - { - try - { - // apply the templatable aspect if required - if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE) == false) - { - this.getNodeService().addAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE, null); - } - - // get the selected template from the Template Picker - NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); - - // set the template NodeRef into the templatable aspect property - this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, templateRef); - - // reset node details for next refresh of details page - getNode().reset(); - } - catch (Exception e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); - } - } - } - - /** - * Action handler to remove a custom view template from the current node - */ - public void removeTemplate(ActionEvent event) - { - try - { - // clear template property - this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, null); - this.getNodeService().removeAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE); - this.getNodeService().removeAspect(getNode().getNodeRef(), ContentModel.ASPECT_WEBSCRIPTABLE); - - // reset node details for next refresh of details page - getNode().reset(); - } - catch (Exception e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); - } - } - - /** - * Action Handler to take Ownership of the current node - */ - public void takeOwnership(final ActionEvent event) - { - final FacesContext fc = FacesContext.getCurrentInstance(); - - try - { - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - getOwnableService().takeOwnership(getNode().getNodeRef()); - - String msg = Application.getMessage(fc, MSG_SUCCESS_OWNERSHIP); - FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_INFO, msg, msg); - String formId = Utils.getParentForm(fc, event.getComponent()).getClientId(fc); - fc.addMessage(formId + ':' + getPropertiesPanelId(), facesMsg); - - getNode().reset(); - return null; - } - }; - txnHelper.doInTransaction(callback); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - fc, Repository.ERROR_GENERIC), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } - - /** - * @return id of the properties panel component - */ - protected abstract String getPropertiesPanelId(); - - /** - * Save the state of the panel that was expanded/collapsed - */ - public void expandPanel(ActionEvent event) - { - if (event instanceof ExpandedEvent) - { - String id = event.getComponent().getId(); - // we prefix some panels with "no-" which we remove to give consistent behaviour in the UI - if (id.startsWith("no-") == true) - { - id = id.substring(3); - } - this.panels.put(id, ((ExpandedEvent)event).State); - } - } -} +package org.alfresco.web.bean; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.application.FacesMessage; +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.repo.web.scripts.FileTypeImageUtils; +import org.alfresco.service.cmr.repository.CopyService; +import org.alfresco.service.cmr.repository.FileTypeImageSize; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.TemplateImageResolver; +import org.alfresco.service.cmr.security.AccessStatus; +import org.alfresco.service.cmr.security.OwnableService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.bean.actions.handlers.SimpleWorkflowHandler; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.workflow.WorkflowUtil; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.Utils.URLMode; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.alfresco.web.ui.common.component.UIPanel.ExpandedEvent; + +/** + * Backing bean provided access to the details of a Node + * + * @author Kevin Roast + */ +public abstract class BaseDetailsBean extends BaseDialogBean +{ + private static final String MSG_SUCCESS_OWNERSHIP = "success_ownership"; + + /** OwnableService bean reference */ + transient private OwnableService ownableService; + + /** CopyService bean reference */ + transient private CopyService copyService; + + /** The PermissionService reference */ + transient private PermissionService permissionService; + + /** Selected template Id */ + protected String template; + + /** The map of workflow properties */ + protected Map workflowProperties; + + protected Map panels = new HashMap(4, 1.0f); + + private static final String MSG_ERROR_WORKFLOW_REJECT = "error_workflow_reject"; + private static final String MSG_ERROR_WORKFLOW_APPROVE = "error_workflow_approve"; + private static final String MSG_ERROR_UPDATE_SIMPLEWORKFLOW = "error_update_simpleworkflow"; + + public BaseDetailsBean() + { + // initial state of some panels that don't use the default + panels.put("workflow-panel", false); + panels.put("category-panel", false); + } + + // ------------------------------------------------------------------------------ + // Bean property getters and setters + + /** + * Sets the ownable service instance the bean should use + * + * @param ownableService The OwnableService + */ + public void setOwnableService(OwnableService ownableService) + { + this.ownableService = ownableService; + } + + protected OwnableService getOwnableService() + { + if (ownableService == null) + { + ownableService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getOwnableService(); + } + return ownableService; + } + + /** + * Sets the copy service instance the bean should use + * + * @param copyService The CopyService + */ + public void setCopyService(CopyService copyService) + { + this.copyService = copyService; + } + + protected CopyService getCopyService() + { + if (copyService == null) + { + copyService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCopyService(); + } + return copyService; + } + + /** + * @param permissionService The PermissionService to set. + */ + public void setPermissionService(PermissionService permissionService) + { + this.permissionService = permissionService; + } + + protected PermissionService getPermissionService() + { + if (permissionService == null) + { + permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); + } + return permissionService; + } + + /** + * @return Returns the panels expanded state map. + */ + public Map getPanels() + { + return this.panels; + } + + /** + * @param panels The panels expanded state map. + */ + public void setPanels(Map panels) + { + this.panels = panels; + } + + /** + * Returns the Node this bean is currently representing + * + * @return The Node + */ + public abstract Node getNode(); + + /** + * Returns the id of the current node + * + * @return The id + */ + public String getId() + { + return getNode().getId(); + } + + /** + * Returns the name of the current node + * + * @return Name of the current + */ + public String getName() + { + return getNode().getName(); + } + + /** + * Return the Alfresco NodeRef URL for the current node + * + * @return the Alfresco NodeRef URL + */ + public String getNodeRefUrl() + { + return getNode().getNodeRef().toString(); + } + + /** + * Returns the WebDAV URL for the current node + * + * @return The WebDAV url + */ + public String getWebdavUrl() + { + Node node = getLinkResolvedNode(); + return Utils.generateURL(FacesContext.getCurrentInstance(), node, URLMode.WEBDAV); + } + + /** + * Returns the CIFS path for the current node + * + * @return The CIFS path + */ + public String getCifsPath() + { + Node node = getLinkResolvedNode(); + return Utils.generateURL(FacesContext.getCurrentInstance(), node, URLMode.CIFS); + } + + /** + * Returns the URL to access the details page for the current node + * + * @return The bookmark URL + */ + public String getBookmarkUrl() + { + return Utils.generateURL(FacesContext.getCurrentInstance(), getNode(), URLMode.SHOW_DETAILS); + } + + /** + * Resolve the actual Node from any Link object that may be proxying it + * + * @return current Node or Node resolved from any Link object + */ + protected abstract Node getLinkResolvedNode(); + + /** + * @return Returns the template Id. + */ + public String getTemplate() + { + // return current template if it exists + NodeRef ref = (NodeRef)getNode().getProperties().get(ContentModel.PROP_TEMPLATE); + return ref != null ? ref.getId() : this.template; + } + + /** + * @param template The template Id to set. + */ + public void setTemplate(String template) + { + this.template = template; + } + + /** + * @return true if the current node has a custom Template or Webscript view applied and + * references a template/webscript that currently exists in the system. + */ + public boolean getHasCustomView() + { + return getHasWebscriptView() || getHasTemplateView(); + } + + /** + * @return true if the current node has a Template based custom view available + */ + public boolean getHasTemplateView() + { + if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE)) + { + NodeRef templateRef = (NodeRef)getNode().getProperties().get(ContentModel.PROP_TEMPLATE); + return (templateRef != null && this.getNodeService().exists(templateRef) && + this.getPermissionService().hasPermission(templateRef, PermissionService.READ) == AccessStatus.ALLOWED); + } + return false; + } + + /** + * @return true if the current node has a Webscript based custom view available + */ + public boolean getHasWebscriptView() + { + if (getNode().hasAspect(ContentModel.ASPECT_WEBSCRIPTABLE)) + { + return (getNode().getProperties().get(ContentModel.PROP_WEBSCRIPT) != null); + } + return false; + } + + /** + * @return String of the NodeRef for the custom view for the node + */ + public String getTemplateRef() + { + NodeRef ref = (NodeRef)getNode().getProperties().get(ContentModel.PROP_TEMPLATE); + return ref != null ? ref.toString() : null; + } + + /** + * @return Webscript URL for the custom view for the node + */ + public String getWebscriptUrl() + { + return (String)getNode().getProperties().get(ContentModel.PROP_WEBSCRIPT); + } + + /** + * Returns a model for use by a template on the Details page. + * + * @return model containing current current node info. + */ + public abstract Map getTemplateModel(); + + /** Template Image resolver helper */ + protected TemplateImageResolver imageResolver = new TemplateImageResolver() + { + private static final long serialVersionUID = 1539708282743314697L; + + public String resolveImagePathForName(String filename, FileTypeImageSize size) + { + return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); + } + }; + + /** + * Returns the properties for the attached workflow as a map + * + * @return Properties of the attached workflow, null if there is no workflow + */ + public Map getWorkflowProperties() + { + if (this.workflowProperties == null && + getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) + { + // get the exisiting properties for the node + Map props = getNode().getProperties(); + + String approveStepName = (String)props.get( + ApplicationModel.PROP_APPROVE_STEP.toString()); + String rejectStepName = (String)props.get( + ApplicationModel.PROP_REJECT_STEP.toString()); + + Boolean approveMove = (Boolean)props.get( + ApplicationModel.PROP_APPROVE_MOVE.toString()); + Boolean rejectMove = (Boolean)props.get( + ApplicationModel.PROP_REJECT_MOVE.toString()); + + NodeRef approveFolder = (NodeRef)props.get( + ApplicationModel.PROP_APPROVE_FOLDER.toString()); + NodeRef rejectFolder = (NodeRef)props.get( + ApplicationModel.PROP_REJECT_FOLDER.toString()); + + // put the workflow properties in a separate map for use by the JSP + this.workflowProperties = new HashMap(7); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME, + approveStepName); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_ACTION, + approveMove ? "move" : "copy"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_FOLDER, approveFolder); + + if (rejectStepName == null || rejectMove == null || rejectFolder == null) + { + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "no"); + } + else + { + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, + "yes"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME, + rejectStepName); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_ACTION, + rejectMove ? "move" : "copy"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_FOLDER, + rejectFolder); + } + } + + return this.workflowProperties; + } + + /** + * Cancel Workflow Edit dialog + */ + public String cancelWorkflowEdit() + { + // resets the workflow properties map so any changes made + // don't appear to be persisted + this.workflowProperties.clear(); + this.workflowProperties = null; + return "cancel"; + } + + /** + * Saves the details of the workflow stored in workflowProperties + * to the current node + * + * @return The outcome string + */ + public String saveWorkflow() + { + String outcome = "cancel"; + + try + { + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // firstly retrieve all the properties for the current node + Map updateProps = getNodeService().getProperties( + getNode().getNodeRef()); + + // update the simple workflow properties + + // set the approve step name + updateProps.put(ApplicationModel.PROP_APPROVE_STEP, + workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME)); + + // specify whether the approve step will copy or move the content + boolean approveMove = true; + String approveAction = (String)workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_ACTION); + if (approveAction != null && approveAction.equals("copy")) + { + approveMove = false; + } + updateProps.put(ApplicationModel.PROP_APPROVE_MOVE, Boolean.valueOf(approveMove)); + + // create node ref representation of the destination folder + updateProps.put(ApplicationModel.PROP_APPROVE_FOLDER, + workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_FOLDER)); + + // determine whether there should be a reject step + boolean requireReject = true; + String rejectStepPresent = (String)workflowProperties.get( + SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT); + if (rejectStepPresent != null && rejectStepPresent.equals("no")) + { + requireReject = false; + } + + if (requireReject) + { + // set the reject step name + updateProps.put(ApplicationModel.PROP_REJECT_STEP, + workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME)); + + // specify whether the reject step will copy or move the content + boolean rejectMove = true; + String rejectAction = (String)workflowProperties.get( + SimpleWorkflowHandler.PROP_REJECT_ACTION); + if (rejectAction != null && rejectAction.equals("copy")) + { + rejectMove = false; + } + updateProps.put(ApplicationModel.PROP_REJECT_MOVE, Boolean.valueOf(rejectMove)); + + // create node ref representation of the destination folder + updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, + workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_FOLDER)); + } + else + { + // set all the reject properties to null to signify there should + // be no reject step + updateProps.put(ApplicationModel.PROP_REJECT_STEP, null); + updateProps.put(ApplicationModel.PROP_REJECT_MOVE, null); + updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, null); + } + + // set the properties on the node + getNodeService().setProperties(getNode().getNodeRef(), updateProps); + return null; + } + }; + txnHelper.doInTransaction(callback); + + // reset the state of the current node so it reflects the changes just made + getNode().reset(); + + outcome = "finish"; + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), MSG_ERROR_UPDATE_SIMPLEWORKFLOW), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + + return outcome; + } + + /** + * Returns the name of the approve step of the attached workflow + * + * @return The name of the approve step or null if there is no workflow + */ + public String getApproveStepName() + { + String approveStepName = null; + + if (getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) + { + approveStepName = (String)getNode().getProperties().get( + ApplicationModel.PROP_APPROVE_STEP.toString()); + } + + return approveStepName; + } + + /** + * Event handler called to handle the approve step of the simple workflow + * + * @param event The event that was triggered + */ + public void approve(ActionEvent event) + { + UIActionLink link = (UIActionLink)event.getComponent(); + Map params = link.getParameterMap(); + String id = params.get("id"); + if (id == null || id.length() == 0) + { + throw new AlfrescoRuntimeException("approve called without an id"); + } + + final NodeRef docNodeRef = new NodeRef(Repository.getStoreRef(), id); + + try + { + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // call the service to perform the approve + WorkflowUtil.approve(docNodeRef, getNodeService(), getCopyService()); + return null; + } + }; + txnHelper.doInTransaction(callback); + + // if this was called via the node details dialog we need to reset the node + if (getNode() != null) + { + getNode().reset(); + } + + // also make sure the UI will get refreshed + UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), MSG_ERROR_WORKFLOW_APPROVE), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } + + /** + * Returns the name of the reject step of the attached workflow + * + * @return The name of the reject step or null if there is no workflow + */ + public String getRejectStepName() + { + String approveStepName = null; + + if (getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) + { + approveStepName = (String)getNode().getProperties().get( + ApplicationModel.PROP_REJECT_STEP.toString()); + } + + return approveStepName; + } + + /** + * Event handler called to handle the approve step of the simple workflow + * + * @param event The event that was triggered + */ + public void reject(ActionEvent event) + { + UIActionLink link = (UIActionLink)event.getComponent(); + Map params = link.getParameterMap(); + String id = params.get("id"); + if (id == null || id.length() == 0) + { + throw new AlfrescoRuntimeException("reject called without an id"); + } + + final NodeRef docNodeRef = new NodeRef(Repository.getStoreRef(), id); + + try + { + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // call the service to perform the reject + WorkflowUtil.reject(docNodeRef, getNodeService(), getCopyService()); + return null; + } + }; + txnHelper.doInTransaction(callback); + + // if this was called via the node details dialog we need to reset the node + if (getNode() != null) + { + getNode().reset(); + } + + // also make sure the UI will get refreshed + UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); + } + catch (Throwable e) + { + // rollback the transaction + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), MSG_ERROR_WORKFLOW_REJECT), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } + + // ------------------------------------------------------------------------------ + // Action event handlers + + /** + * Action handler to apply the selected Template and Templatable aspect to the current node + */ + public void applyTemplate(ActionEvent event) + { + if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) + { + try + { + // apply the templatable aspect if required + if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE) == false) + { + this.getNodeService().addAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE, null); + } + + // get the selected template from the Template Picker + NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); + + // set the template NodeRef into the templatable aspect property + this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, templateRef); + + // reset node details for next refresh of details page + getNode().reset(); + } + catch (Exception e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); + } + } + } + + /** + * Action handler to remove a custom view template from the current node + */ + public void removeTemplate(ActionEvent event) + { + try + { + // clear template property + this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, null); + this.getNodeService().removeAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE); + this.getNodeService().removeAspect(getNode().getNodeRef(), ContentModel.ASPECT_WEBSCRIPTABLE); + + // reset node details for next refresh of details page + getNode().reset(); + } + catch (Exception e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); + } + } + + /** + * Action Handler to take Ownership of the current node + */ + public void takeOwnership(final ActionEvent event) + { + final FacesContext fc = FacesContext.getCurrentInstance(); + + try + { + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + getOwnableService().takeOwnership(getNode().getNodeRef()); + + String msg = Application.getMessage(fc, MSG_SUCCESS_OWNERSHIP); + FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_INFO, msg, msg); + String formId = Utils.getParentForm(fc, event.getComponent()).getClientId(fc); + fc.addMessage(formId + ':' + getPropertiesPanelId(), facesMsg); + + getNode().reset(); + return null; + } + }; + txnHelper.doInTransaction(callback); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + fc, Repository.ERROR_GENERIC), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } + + /** + * @return id of the properties panel component + */ + protected abstract String getPropertiesPanelId(); + + /** + * Save the state of the panel that was expanded/collapsed + */ + public void expandPanel(ActionEvent event) + { + if (event instanceof ExpandedEvent) + { + String id = event.getComponent().getId(); + // we prefix some panels with "no-" which we remove to give consistent behaviour in the UI + if (id.startsWith("no-") == true) + { + id = id.substring(3); + } + this.panels.put(id, ((ExpandedEvent)event).State); + } + } +} diff --git a/source/java/org/alfresco/web/bean/CategoriesProperties.java b/source/java/org/alfresco/web/bean/CategoriesProperties.java index d54c7cc1e1..aa7f4555c4 100644 --- a/source/java/org/alfresco/web/bean/CategoriesProperties.java +++ b/source/java/org/alfresco/web/bean/CategoriesProperties.java @@ -1,144 +1,144 @@ -package org.alfresco.web.bean; - -import java.util.Collection; -import java.util.List; - -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; - -import org.alfresco.service.cmr.search.CategoryService; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.component.IBreadcrumbHandler; -import org.alfresco.web.ui.common.component.data.UIRichList; - -public class CategoriesProperties -{ - - protected CategoryService categoryService; - - /** Component references */ - protected UIRichList categoriesRichList; - - /** Currently visible category Node */ - private Node category = null; - - /** Current category ref */ - private NodeRef categoryRef = null; - - /** Action category node */ - private Node actionCategory = null; - - /** Members of the linked items of a category */ - private Collection members = null; - - /** Dialog properties */ - private String name = null; - private String description = null; - - /** RichList view mode */ - private String viewMode = "icons"; - - /** Category path breadcrumb location */ - private List location = null; - - public CategoryService getCategoryService() - { - return categoryService; - } - - public void setCategoryService(CategoryService categoryService) - { - this.categoryService = categoryService; - } - - public UIRichList getCategoriesRichList() - { - return categoriesRichList; - } - - public void setCategoriesRichList(UIRichList categoriesRichList) - { - this.categoriesRichList = categoriesRichList; - } - - public Node getCategory() - { - return category; - } - - public void setCategory(Node category) - { - this.category = category; - } - - public NodeRef getCategoryRef() - { - return categoryRef; - } - - public void setCategoryRef(NodeRef categoryRef) - { - this.categoryRef = categoryRef; - } - - public Node getActionCategory() - { - return actionCategory; - } - - public void setActionCategory(Node actionCategory) - { - this.actionCategory = actionCategory; - } - - public Collection getMembers() - { - return members; - } - - public void setMembers(Collection members) - { - this.members = members; - } - - public String getName() - { - return name; - } - - public void setName(String name) - { - this.name = name; - } - - public String getDescription() - { - return description; - } - - public void setDescription(String description) - { - this.description = description; - } - - public String getViewMode() - { - return viewMode; - } - - public void setViewMode(String viewMode) - { - this.viewMode = viewMode; - } - - public List getLocation() - { - return location; - } - - public void setLocation(List location) - { - this.location = location; - } - -} +package org.alfresco.web.bean; + +import java.util.Collection; +import java.util.List; + +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; + +import org.alfresco.service.cmr.search.CategoryService; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.component.IBreadcrumbHandler; +import org.alfresco.web.ui.common.component.data.UIRichList; + +public class CategoriesProperties +{ + + protected CategoryService categoryService; + + /** Component references */ + protected UIRichList categoriesRichList; + + /** Currently visible category Node */ + private Node category = null; + + /** Current category ref */ + private NodeRef categoryRef = null; + + /** Action category node */ + private Node actionCategory = null; + + /** Members of the linked items of a category */ + private Collection members = null; + + /** Dialog properties */ + private String name = null; + private String description = null; + + /** RichList view mode */ + private String viewMode = "icons"; + + /** Category path breadcrumb location */ + private List location = null; + + public CategoryService getCategoryService() + { + return categoryService; + } + + public void setCategoryService(CategoryService categoryService) + { + this.categoryService = categoryService; + } + + public UIRichList getCategoriesRichList() + { + return categoriesRichList; + } + + public void setCategoriesRichList(UIRichList categoriesRichList) + { + this.categoriesRichList = categoriesRichList; + } + + public Node getCategory() + { + return category; + } + + public void setCategory(Node category) + { + this.category = category; + } + + public NodeRef getCategoryRef() + { + return categoryRef; + } + + public void setCategoryRef(NodeRef categoryRef) + { + this.categoryRef = categoryRef; + } + + public Node getActionCategory() + { + return actionCategory; + } + + public void setActionCategory(Node actionCategory) + { + this.actionCategory = actionCategory; + } + + public Collection getMembers() + { + return members; + } + + public void setMembers(Collection members) + { + this.members = members; + } + + public String getName() + { + return name; + } + + public void setName(String name) + { + this.name = name; + } + + public String getDescription() + { + return description; + } + + public void setDescription(String description) + { + this.description = description; + } + + public String getViewMode() + { + return viewMode; + } + + public void setViewMode(String viewMode) + { + this.viewMode = viewMode; + } + + public List getLocation() + { + return location; + } + + public void setLocation(List location) + { + this.location = location; + } + +} diff --git a/source/java/org/alfresco/web/bean/CategoryBrowserBean.java b/source/java/org/alfresco/web/bean/CategoryBrowserBean.java index fe6fc9515f..a7a637ada1 100644 --- a/source/java/org/alfresco/web/bean/CategoryBrowserBean.java +++ b/source/java/org/alfresco/web/bean/CategoryBrowserBean.java @@ -1,59 +1,59 @@ -package org.alfresco.web.bean; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.web.bean.search.SearchContext; - -public class CategoryBrowserBean -{ - public static String BEAN_NAME = "CategoryBrowserBean"; - - private NodeService nodeService; - - private NodeRef currentCategory = null; - - private boolean includeSubcategories = false; - - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - public void setCurrentCategory(NodeRef currentCategory) - { - this.currentCategory = currentCategory; - } - - public String getCurrentCategoryName() - { - String currentCategoryName = null; - if (currentCategory != null) - currentCategoryName = (String) this.nodeService.getProperty(currentCategory, ContentModel.PROP_NAME); - - return currentCategoryName; - } - - public boolean isIncludeSubcategories() - { - return includeSubcategories; - } - - public void setIncludeSubcategories(boolean includeSubcategories) - { - this.includeSubcategories = includeSubcategories; - } - - public SearchContext generateCategorySearchContext() - { - SearchContext categorySearch = new SearchContext(); - - String[] categories = new String[1]; - categories[0] = SearchContext.getPathFromSpaceRef(currentCategory, includeSubcategories); - - categorySearch.setText(""); - categorySearch.setCategories(categories); - - return categorySearch; - } -} +package org.alfresco.web.bean; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.web.bean.search.SearchContext; + +public class CategoryBrowserBean +{ + public static String BEAN_NAME = "CategoryBrowserBean"; + + private NodeService nodeService; + + private NodeRef currentCategory = null; + + private boolean includeSubcategories = false; + + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + public void setCurrentCategory(NodeRef currentCategory) + { + this.currentCategory = currentCategory; + } + + public String getCurrentCategoryName() + { + String currentCategoryName = null; + if (currentCategory != null) + currentCategoryName = (String) this.nodeService.getProperty(currentCategory, ContentModel.PROP_NAME); + + return currentCategoryName; + } + + public boolean isIncludeSubcategories() + { + return includeSubcategories; + } + + public void setIncludeSubcategories(boolean includeSubcategories) + { + this.includeSubcategories = includeSubcategories; + } + + public SearchContext generateCategorySearchContext() + { + SearchContext categorySearch = new SearchContext(); + + String[] categories = new String[1]; + categories[0] = SearchContext.getPathFromSpaceRef(currentCategory, includeSubcategories); + + categorySearch.setText(""); + categorySearch.setCategories(categories); + + return categorySearch; + } +} diff --git a/source/java/org/alfresco/web/bean/LinkPropertiesDialog.java b/source/java/org/alfresco/web/bean/LinkPropertiesDialog.java index 723af4f93e..dae8863801 100644 --- a/source/java/org/alfresco/web/bean/LinkPropertiesDialog.java +++ b/source/java/org/alfresco/web/bean/LinkPropertiesDialog.java @@ -1,229 +1,229 @@ -package org.alfresco.web.bean; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.Iterator; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DataTypeDefinition; -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.Utils.URLMode; - -/** - * Backing bean for the edit link properties dialog - * - * @author kevinr - * @author YanO - */ -public class LinkPropertiesDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -167326851073011187L; - - private Node editableNode = null; - - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // reset node instance for next dialog invocation - this.editableNode = null; - } - - public Map getProperties() - { - return getEditableNode().getProperties(); - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - /** - * Returns the node being edited - * - * @return The node being edited - */ - public Node getEditableNode() - { - if (this.editableNode == null) - { - if (this.parameters.containsKey("nodeRef")) - { - this.editableNode = new Node(new NodeRef(this.parameters.get("nodeRef"))); - } - else - { - throw new IllegalArgumentException("Dialog has not been initialised with noderef or setup action event called."); - } - } - return this.editableNode; - } - - /** - * Event handler called to setup the link object for property editing - * - * @param event The event - */ - public void setupFileLinkForAction(ActionEvent event) - { - this.editableNode = new Node(this.browseBean.getDocument().getNodeRef()); - } - - /** - * Event handler called to setup the link object for property editing - * - * @param event The event - */ - public void setupFolderLinkForAction(ActionEvent event) - { - this.editableNode = new Node(this.browseBean.getActionSpace().getNodeRef()); - } - - /** - * @return Human readable version of the Path to the destination object - */ - public String getDestinationPath() - { - NodeRef destRef = (NodeRef)getEditableNode().getProperties().get(ContentModel.PROP_LINK_DESTINATION); - return Repository.getNamePath( - this.getNodeService(), this.getNodeService().getPath(destRef), null, "/", null); - } - - /** - * Returns the URL to access the details page for the current document link object - * - * @return The bookmark URL - */ - public String getFileLinkBookmarkUrl() - { - NodeRef destRef = (NodeRef)this.browseBean.getDocument().getProperties().get(ContentModel.PROP_LINK_DESTINATION); - return Utils.generateURL(FacesContext.getCurrentInstance(), new Node(destRef), URLMode.SHOW_DETAILS); - } - - /** - * Returns the URL to access the details page for the current document link object - * - * @return The bookmark URL - */ - public String getSpaceLinkDestinationUrl() - { - NodeRef destRef = (NodeRef)this.browseBean.getActionSpace().getProperties().get(ContentModel.PROP_LINK_DESTINATION); - return Utils.generateURL(FacesContext.getCurrentInstance(), new Node(destRef), URLMode.SHOW_DETAILS); - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - try - { - NodeRef nodeRef = getEditableNode().getNodeRef(); - Map props = getEditableNode().getProperties(); - - //get the name and move the node as necessary - String name = (String) props.get(ContentModel.PROP_NAME); - if (name != null) - { - getFileFolderService().rename(nodeRef, name); - } - - Map properties = this.getNodeService().getProperties(nodeRef); - - // we need to put all the properties from the editable bag back into - // the format expected by the repository - - // deal with adding the "titled" aspect if required - String title = (String)props.get(ContentModel.PROP_TITLE); - String description = (String)props.get(ContentModel.PROP_DESCRIPTION); - if (title != null || description != null) - { - // add the aspect to be sure it's present - getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TITLED, null); - // other props will get added later in setProperties() - } - - // add the remaining properties - Iterator iterProps = props.keySet().iterator(); - while (iterProps.hasNext()) - { - String propName = iterProps.next(); - QName qname = QName.createQName(propName); - - // make sure the property is represented correctly - Serializable propValue = (Serializable)props.get(propName); - - // check for empty strings when using number types, set to null in this case - if ((propValue != null) && (propValue instanceof String) && - (propValue.toString().length() == 0)) - { - PropertyDefinition propDef = this.getDictionaryService().getProperty(qname); - if (propDef != null) - { - if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || - propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || - propDef.getDataType().getName().equals(DataTypeDefinition.INT) || - propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) - { - propValue = null; - } - } - } - - properties.put(qname, propValue); - } - - // send the properties back to the repository - this.getNodeService().setProperties(nodeRef, properties); - } - catch (InvalidNodeRefException err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - context, Repository.ERROR_NODEREF), new Object[] {this.browseBean.getDocument().getId()})); - - // this failure means the node no longer exists - we cannot show the doc properties screen - outcome = AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "browse"; - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - context, Repository.ERROR_GENERIC), e.getMessage()), e); - outcome = null; - ReportedException.throwIfNecessary(e); - } - - return outcome; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - if (this.browseBean.getDocument() != null) - { - this.browseBean.getDocument().reset(); - } - else if (this.browseBean.getActionSpace() != null) - { - this.browseBean.getActionSpace().reset(); - } - - return outcome; - } -} +package org.alfresco.web.bean; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.Iterator; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DataTypeDefinition; +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.Utils.URLMode; + +/** + * Backing bean for the edit link properties dialog + * + * @author kevinr + * @author YanO + */ +public class LinkPropertiesDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -167326851073011187L; + + private Node editableNode = null; + + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // reset node instance for next dialog invocation + this.editableNode = null; + } + + public Map getProperties() + { + return getEditableNode().getProperties(); + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + /** + * Returns the node being edited + * + * @return The node being edited + */ + public Node getEditableNode() + { + if (this.editableNode == null) + { + if (this.parameters.containsKey("nodeRef")) + { + this.editableNode = new Node(new NodeRef(this.parameters.get("nodeRef"))); + } + else + { + throw new IllegalArgumentException("Dialog has not been initialised with noderef or setup action event called."); + } + } + return this.editableNode; + } + + /** + * Event handler called to setup the link object for property editing + * + * @param event The event + */ + public void setupFileLinkForAction(ActionEvent event) + { + this.editableNode = new Node(this.browseBean.getDocument().getNodeRef()); + } + + /** + * Event handler called to setup the link object for property editing + * + * @param event The event + */ + public void setupFolderLinkForAction(ActionEvent event) + { + this.editableNode = new Node(this.browseBean.getActionSpace().getNodeRef()); + } + + /** + * @return Human readable version of the Path to the destination object + */ + public String getDestinationPath() + { + NodeRef destRef = (NodeRef)getEditableNode().getProperties().get(ContentModel.PROP_LINK_DESTINATION); + return Repository.getNamePath( + this.getNodeService(), this.getNodeService().getPath(destRef), null, "/", null); + } + + /** + * Returns the URL to access the details page for the current document link object + * + * @return The bookmark URL + */ + public String getFileLinkBookmarkUrl() + { + NodeRef destRef = (NodeRef)this.browseBean.getDocument().getProperties().get(ContentModel.PROP_LINK_DESTINATION); + return Utils.generateURL(FacesContext.getCurrentInstance(), new Node(destRef), URLMode.SHOW_DETAILS); + } + + /** + * Returns the URL to access the details page for the current document link object + * + * @return The bookmark URL + */ + public String getSpaceLinkDestinationUrl() + { + NodeRef destRef = (NodeRef)this.browseBean.getActionSpace().getProperties().get(ContentModel.PROP_LINK_DESTINATION); + return Utils.generateURL(FacesContext.getCurrentInstance(), new Node(destRef), URLMode.SHOW_DETAILS); + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + try + { + NodeRef nodeRef = getEditableNode().getNodeRef(); + Map props = getEditableNode().getProperties(); + + //get the name and move the node as necessary + String name = (String) props.get(ContentModel.PROP_NAME); + if (name != null) + { + getFileFolderService().rename(nodeRef, name); + } + + Map properties = this.getNodeService().getProperties(nodeRef); + + // we need to put all the properties from the editable bag back into + // the format expected by the repository + + // deal with adding the "titled" aspect if required + String title = (String)props.get(ContentModel.PROP_TITLE); + String description = (String)props.get(ContentModel.PROP_DESCRIPTION); + if (title != null || description != null) + { + // add the aspect to be sure it's present + getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TITLED, null); + // other props will get added later in setProperties() + } + + // add the remaining properties + Iterator iterProps = props.keySet().iterator(); + while (iterProps.hasNext()) + { + String propName = iterProps.next(); + QName qname = QName.createQName(propName); + + // make sure the property is represented correctly + Serializable propValue = (Serializable)props.get(propName); + + // check for empty strings when using number types, set to null in this case + if ((propValue != null) && (propValue instanceof String) && + (propValue.toString().length() == 0)) + { + PropertyDefinition propDef = this.getDictionaryService().getProperty(qname); + if (propDef != null) + { + if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || + propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || + propDef.getDataType().getName().equals(DataTypeDefinition.INT) || + propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) + { + propValue = null; + } + } + } + + properties.put(qname, propValue); + } + + // send the properties back to the repository + this.getNodeService().setProperties(nodeRef, properties); + } + catch (InvalidNodeRefException err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + context, Repository.ERROR_NODEREF), new Object[] {this.browseBean.getDocument().getId()})); + + // this failure means the node no longer exists - we cannot show the doc properties screen + outcome = AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "browse"; + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + context, Repository.ERROR_GENERIC), e.getMessage()), e); + outcome = null; + ReportedException.throwIfNecessary(e); + } + + return outcome; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + if (this.browseBean.getDocument() != null) + { + this.browseBean.getDocument().reset(); + } + else if (this.browseBean.getActionSpace() != null) + { + this.browseBean.getActionSpace().reset(); + } + + return outcome; + } +} diff --git a/source/java/org/alfresco/web/bean/MultiValueEditorBean.java b/source/java/org/alfresco/web/bean/MultiValueEditorBean.java index 21ad3cb967..99bdf77769 100644 --- a/source/java/org/alfresco/web/bean/MultiValueEditorBean.java +++ b/source/java/org/alfresco/web/bean/MultiValueEditorBean.java @@ -1,26 +1,26 @@ -package org.alfresco.web.bean; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Map; - -/** - * Helper bean used to temporarily store the last item added in a multi - * value editor component. - * - * A Map is used so that multiple components on the same page can use the - * same backing bean. - * - * @author gavinc - */ -public class MultiValueEditorBean implements Serializable -{ - private static final long serialVersionUID = -5180578793877515158L; - - private Map lastItemsAdded = new HashMap(10); - - public Map getLastItemsAdded() - { - return lastItemsAdded; - } -} +package org.alfresco.web.bean; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; + +/** + * Helper bean used to temporarily store the last item added in a multi + * value editor component. + * + * A Map is used so that multiple components on the same page can use the + * same backing bean. + * + * @author gavinc + */ +public class MultiValueEditorBean implements Serializable +{ + private static final long serialVersionUID = -5180578793877515158L; + + private Map lastItemsAdded = new HashMap(10); + + public Map getLastItemsAdded() + { + return lastItemsAdded; + } +} diff --git a/source/java/org/alfresco/web/bean/NodeEventListener.java b/source/java/org/alfresco/web/bean/NodeEventListener.java index 17d04ecf7d..32c1fb2e1a 100644 --- a/source/java/org/alfresco/web/bean/NodeEventListener.java +++ b/source/java/org/alfresco/web/bean/NodeEventListener.java @@ -1,21 +1,21 @@ -package org.alfresco.web.bean; - -import java.io.Serializable; - -import org.alfresco.service.namespace.QName; -import org.alfresco.web.bean.repository.Node; - -/** - * @author Kevin Roast - */ -public interface NodeEventListener extends Serializable -{ - /** - * Callback executed when a Node wrapped object is created. This is generally used - * to add additional property resolvers to the Node for a specific model type. - * - * @param node The Node wrapper that has been created - * @param type Type of the Node that has been created - */ - public void created(Node node, QName type); -} +package org.alfresco.web.bean; + +import java.io.Serializable; + +import org.alfresco.service.namespace.QName; +import org.alfresco.web.bean.repository.Node; + +/** + * @author Kevin Roast + */ +public interface NodeEventListener extends Serializable +{ + /** + * Callback executed when a Node wrapped object is created. This is generally used + * to add additional property resolvers to the Node for a specific model type. + * + * @param node The Node wrapper that has been created + * @param type Type of the Node that has been created + */ + public void created(Node node, QName type); +} diff --git a/source/java/org/alfresco/web/bean/TemplateMailHelperBean.java b/source/java/org/alfresco/web/bean/TemplateMailHelperBean.java index 13eb14d45b..43d5f9f8e5 100644 --- a/source/java/org/alfresco/web/bean/TemplateMailHelperBean.java +++ b/source/java/org/alfresco/web/bean/TemplateMailHelperBean.java @@ -1,292 +1,292 @@ -package org.alfresco.web.bean; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.mail.MessagingException; -import javax.mail.internet.MimeMessage; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.action.executer.MailActionExecuter; -import org.alfresco.repo.template.I18NMessageMethod; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.ContentReader; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.util.UrlUtil; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.BaseTemplateContentServlet; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.repo.component.template.DefaultModelHelper; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.mail.javamail.JavaMailSender; -import org.springframework.mail.javamail.MimeMessageHelper; -import org.springframework.mail.javamail.MimeMessagePreparator; - -/** - * @author Kevin Roast - */ -public class TemplateMailHelperBean implements Serializable -{ - private static final long serialVersionUID = 9117248002321651339L; - - private static Log logger = LogFactory.getLog(TemplateMailHelperBean.class); - - /** JavaMailSender bean reference */ - transient private JavaMailSender mailSender; - - /** NodeService bean reference */ - transient private NodeService nodeService; - - /** dialog state */ - private String subject = null; - private String body = null; - private String automaticText = null; - private String template = null; - private String usingTemplate = null; - private String finalBody; - - /** - * @param mailSender The JavaMailSender to set. - */ - public void setMailSender(JavaMailSender mailSender) - { - this.mailSender = mailSender; - } - - protected JavaMailSender getMailSender() - { - if (mailSender == null) - { - mailSender = (JavaMailSender) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "mailService"); - } - return mailSender; - } - - /** - * @param nodeService The nodeService to set. - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - protected NodeService getNodeService() - { - if (nodeService == null) - { - nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return nodeService; - } - - /** - * Initialises the bean - */ - public TemplateMailHelperBean() - { - subject = ""; - body = ""; - automaticText = ""; - template = null; - usingTemplate = null; - } - - /** - * Send an email notification to the specified User authority - * - * @param person Person node representing the user - * @param node Node they are invited too - * @param from From text message - * @param roleText The role display label for the user invite notification - */ - public void notifyUser(NodeRef person, NodeRef node, final String from, String roleText) - { - final String to = (String)this.getNodeService().getProperty(person, ContentModel.PROP_EMAIL); - - if (to != null && to.length() != 0) - { - String body = this.body; - if (this.usingTemplate != null) - { - FacesContext fc = FacesContext.getCurrentInstance(); - - // use template service to format the email - NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.usingTemplate); - ServiceRegistry services = Repository.getServiceRegistry(fc); - Map model = DefaultModelHelper.buildDefaultModel( - services, Application.getCurrentUser(fc), templateRef); - model.put("role", roleText); - model.put("space", node); - // object to allow client urls to be generated in emails - model.put("url", new BaseTemplateContentServlet.URLHelper(fc)); - model.put("msg", new I18NMessageMethod()); - model.put("document", node); - if (nodeService.getType(node).equals(ContentModel.TYPE_CONTENT)) - { - NodeRef parentNodeRef = nodeService.getParentAssocs(node).get(0).getParentRef(); - if (parentNodeRef == null) - { - throw new IllegalArgumentException("Parent folder doesn't exists for node: " + node); - } - model.put("space", parentNodeRef); - } - model.put("shareUrl", UrlUtil.getShareUrl(services.getSysAdminParams())); - - body = services.getTemplateService().processTemplate("freemarker", templateRef.toString(), model); - } - this.finalBody = body; - - MimeMessagePreparator mailPreparer = new MimeMessagePreparator() - { - public void prepare(MimeMessage mimeMessage) throws MessagingException - { - MimeMessageHelper message = new MimeMessageHelper(mimeMessage); - message.setTo(to); - message.setSubject(subject); - message.setText(finalBody, MailActionExecuter.isHTML(finalBody)); - message.setFrom(from); - } - }; - - if (logger.isDebugEnabled()) - logger.debug("Sending notification email to: " + to + "\n...with subject:\n" + subject + "\n...with body:\n" + body); - - try - { - // Send the message - this.getMailSender().send(mailPreparer); - } - catch (Throwable e) - { - // don't stop the action but let admins know email is not getting sent - logger.error("Failed to send email to " + to, e); - } - } - } - - /** - * Action handler called to insert a template as the email body - */ - public void insertTemplate(ActionEvent event) - { - if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) - { - // get the content of the template so the user can get a basic preview of it - try - { - NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); - ContentService cs = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); - ContentReader reader = cs.getReader(templateRef, ContentModel.PROP_CONTENT); - if (reader != null && reader.exists()) - { - this.body = reader.getContentString(); - - this.usingTemplate = this.template; - } - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); - } - } - } - - /** - * Action handler called to discard the template from the email body - */ - public void discardTemplate(ActionEvent event) - { - this.body = this.automaticText; - usingTemplate = null; - } - - /** - * @return Returns the email body text. - */ - public String getBody() - { - return this.body; - } - - /** - * @param body The email body text to set. - */ - public void setBody(String body) - { - this.body = body; - } - - /** - * @return Returns the email subject text. - */ - public String getSubject() - { - return this.subject; - } - - /** - * @param subject The email subject text to set. - */ - public void setSubject(String subject) - { - this.subject = subject; - } - - /** - * @return Returns the automatic text. - */ - public String getAutomaticText() - { - return this.automaticText; - } - - /** - * @param automaticText The automatic text to set. - */ - public void setAutomaticText(String automaticText) - { - this.automaticText = automaticText; - } - - /** - * @return Returns the email template Id - */ - public String getTemplate() - { - return this.template; - } - - /** - * @param template The email template to set. - */ - public void setTemplate(String template) - { - this.template = template; - } - - /** - * @return Returns if a template has been inserted by a user for email body. - */ - public String getUsingTemplate() - { - return this.usingTemplate; - } - - /** - * @param usingTemplate Template that has been inserted by a user for the email body. - */ - public void setUsingTemplate(String usingTemplate) - { - this.usingTemplate = usingTemplate; - } - -} +package org.alfresco.web.bean; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.mail.MessagingException; +import javax.mail.internet.MimeMessage; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.action.executer.MailActionExecuter; +import org.alfresco.repo.template.I18NMessageMethod; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.ContentReader; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.util.UrlUtil; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.BaseTemplateContentServlet; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.repo.component.template.DefaultModelHelper; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.mail.javamail.JavaMailSender; +import org.springframework.mail.javamail.MimeMessageHelper; +import org.springframework.mail.javamail.MimeMessagePreparator; + +/** + * @author Kevin Roast + */ +public class TemplateMailHelperBean implements Serializable +{ + private static final long serialVersionUID = 9117248002321651339L; + + private static Log logger = LogFactory.getLog(TemplateMailHelperBean.class); + + /** JavaMailSender bean reference */ + transient private JavaMailSender mailSender; + + /** NodeService bean reference */ + transient private NodeService nodeService; + + /** dialog state */ + private String subject = null; + private String body = null; + private String automaticText = null; + private String template = null; + private String usingTemplate = null; + private String finalBody; + + /** + * @param mailSender The JavaMailSender to set. + */ + public void setMailSender(JavaMailSender mailSender) + { + this.mailSender = mailSender; + } + + protected JavaMailSender getMailSender() + { + if (mailSender == null) + { + mailSender = (JavaMailSender) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "mailService"); + } + return mailSender; + } + + /** + * @param nodeService The nodeService to set. + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + protected NodeService getNodeService() + { + if (nodeService == null) + { + nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return nodeService; + } + + /** + * Initialises the bean + */ + public TemplateMailHelperBean() + { + subject = ""; + body = ""; + automaticText = ""; + template = null; + usingTemplate = null; + } + + /** + * Send an email notification to the specified User authority + * + * @param person Person node representing the user + * @param node Node they are invited too + * @param from From text message + * @param roleText The role display label for the user invite notification + */ + public void notifyUser(NodeRef person, NodeRef node, final String from, String roleText) + { + final String to = (String)this.getNodeService().getProperty(person, ContentModel.PROP_EMAIL); + + if (to != null && to.length() != 0) + { + String body = this.body; + if (this.usingTemplate != null) + { + FacesContext fc = FacesContext.getCurrentInstance(); + + // use template service to format the email + NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.usingTemplate); + ServiceRegistry services = Repository.getServiceRegistry(fc); + Map model = DefaultModelHelper.buildDefaultModel( + services, Application.getCurrentUser(fc), templateRef); + model.put("role", roleText); + model.put("space", node); + // object to allow client urls to be generated in emails + model.put("url", new BaseTemplateContentServlet.URLHelper(fc)); + model.put("msg", new I18NMessageMethod()); + model.put("document", node); + if (nodeService.getType(node).equals(ContentModel.TYPE_CONTENT)) + { + NodeRef parentNodeRef = nodeService.getParentAssocs(node).get(0).getParentRef(); + if (parentNodeRef == null) + { + throw new IllegalArgumentException("Parent folder doesn't exists for node: " + node); + } + model.put("space", parentNodeRef); + } + model.put("shareUrl", UrlUtil.getShareUrl(services.getSysAdminParams())); + + body = services.getTemplateService().processTemplate("freemarker", templateRef.toString(), model); + } + this.finalBody = body; + + MimeMessagePreparator mailPreparer = new MimeMessagePreparator() + { + public void prepare(MimeMessage mimeMessage) throws MessagingException + { + MimeMessageHelper message = new MimeMessageHelper(mimeMessage); + message.setTo(to); + message.setSubject(subject); + message.setText(finalBody, MailActionExecuter.isHTML(finalBody)); + message.setFrom(from); + } + }; + + if (logger.isDebugEnabled()) + logger.debug("Sending notification email to: " + to + "\n...with subject:\n" + subject + "\n...with body:\n" + body); + + try + { + // Send the message + this.getMailSender().send(mailPreparer); + } + catch (Throwable e) + { + // don't stop the action but let admins know email is not getting sent + logger.error("Failed to send email to " + to, e); + } + } + } + + /** + * Action handler called to insert a template as the email body + */ + public void insertTemplate(ActionEvent event) + { + if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) + { + // get the content of the template so the user can get a basic preview of it + try + { + NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); + ContentService cs = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); + ContentReader reader = cs.getReader(templateRef, ContentModel.PROP_CONTENT); + if (reader != null && reader.exists()) + { + this.body = reader.getContentString(); + + this.usingTemplate = this.template; + } + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); + } + } + } + + /** + * Action handler called to discard the template from the email body + */ + public void discardTemplate(ActionEvent event) + { + this.body = this.automaticText; + usingTemplate = null; + } + + /** + * @return Returns the email body text. + */ + public String getBody() + { + return this.body; + } + + /** + * @param body The email body text to set. + */ + public void setBody(String body) + { + this.body = body; + } + + /** + * @return Returns the email subject text. + */ + public String getSubject() + { + return this.subject; + } + + /** + * @param subject The email subject text to set. + */ + public void setSubject(String subject) + { + this.subject = subject; + } + + /** + * @return Returns the automatic text. + */ + public String getAutomaticText() + { + return this.automaticText; + } + + /** + * @param automaticText The automatic text to set. + */ + public void setAutomaticText(String automaticText) + { + this.automaticText = automaticText; + } + + /** + * @return Returns the email template Id + */ + public String getTemplate() + { + return this.template; + } + + /** + * @param template The email template to set. + */ + public void setTemplate(String template) + { + this.template = template; + } + + /** + * @return Returns if a template has been inserted by a user for email body. + */ + public String getUsingTemplate() + { + return this.usingTemplate; + } + + /** + * @param usingTemplate Template that has been inserted by a user for the email body. + */ + public void setUsingTemplate(String usingTemplate) + { + this.usingTemplate = usingTemplate; + } + +} diff --git a/source/java/org/alfresco/web/bean/TemplateSupportBean.java b/source/java/org/alfresco/web/bean/TemplateSupportBean.java index 605859d3c5..dbe1261ec4 100644 --- a/source/java/org/alfresco/web/bean/TemplateSupportBean.java +++ b/source/java/org/alfresco/web/bean/TemplateSupportBean.java @@ -1,272 +1,272 @@ -package org.alfresco.web.bean; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.List; - -import javax.faces.context.FacesContext; -import javax.faces.model.SelectItem; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.security.permissions.AccessDeniedException; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.repository.ContentData; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.search.SearchService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.util.ExpiringValueCache; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; - -/** - * Provide access to commonly used lists of templates and script files. - *

- * The lists are cached for a small period of time to help performance in the client, - * as generally the contents of the template folders are not changed frequently. - * - * @author Kevin Roast - */ -public class TemplateSupportBean implements Serializable -{ - private static final long serialVersionUID = 6698338879903536081L; - - private static final String MSG_SELECT_TEMPLATE = "select_a_template"; - private static final String MSG_SELECT_SCRIPT = "select_a_script"; - - /** "no selection" marker for SelectItem lists */ - public static final String NO_SELECTION = "none"; - - /** NodeService instance */ - transient private NodeService nodeService; - - /** The SearchService instance */ - transient private SearchService searchService; - - /** cache of content templates that lasts 30 seconds - enough for a couple of page refreshes */ - private ExpiringValueCache> contentTemplates = new ExpiringValueCache>(1000*30); - - /** cache of email templates that lasts 30 seconds - enough for a few page refreshes */ - private ExpiringValueCache> emailTemplates = new ExpiringValueCache>(1000*30); - - /** cache of RSS templates that lasts 30 seconds - enough for a few page refreshes */ - private ExpiringValueCache> rssTemplates = new ExpiringValueCache>(1000*30); - - /** cache of JavaScript files that lasts 30 seconds - enough for a few page refreshes */ - private ExpiringValueCache> scriptFiles = new ExpiringValueCache>(1000*30); - - - /** - * @param nodeService The NodeService to set. - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - private NodeService getNodeService() - { - if (nodeService == null) - { - nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return nodeService; - } - - /** - * @param searchService The SearchService to set. - */ - public void setSearchService(SearchService searchService) - { - this.searchService = searchService; - } - - private SearchService getSearchService() - { - if (searchService == null) - { - searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); - } - return searchService; - } - - /** - * @return the list of available Content Templates that can be applied to the current document. - */ - public List getContentTemplates() - { - List templates = contentTemplates.get(); - if (templates == null) - { - // get the template from the special Content Templates folder - FacesContext fc = FacesContext.getCurrentInstance(); - String xpath = Application.getRootPath(fc) + "/" + - Application.getGlossaryFolderName(fc) + "/" + - Application.getContentTemplatesFolderName(fc) + "//*"; - - templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); - - contentTemplates.put(templates); - } - - return templates; - } - - /** - * @return the list of available Email Templates. - */ - public List getEmailTemplates() - { - List templates = emailTemplates.get(); - if (templates == null) - { - // get the template from the special Email Templates folder - FacesContext fc = FacesContext.getCurrentInstance(); - String xpath = Application.getRootPath(fc) + "/" + - Application.getGlossaryFolderName(fc) + "/" + - Application.getEmailTemplatesFolderName(fc) + "//*"; - - templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); - - emailTemplates.put(templates); - } - - return templates; - } - - /** - * @return the list of available Notify Email Templates. - */ - public List getNotifyEmailTemplates() - { - List templates = null; - - // get the template from the special Email Templates folder - FacesContext fc = FacesContext.getCurrentInstance(); - String xpath = Application.getRootPath(fc) + "/" + - Application.getGlossaryFolderName(fc) + "/" + - Application.getEmailTemplatesFolderName(fc) + "/" + - Application.getNotifyEmailTemplatesFolderName(fc) + "//*"; - - templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); - - return templates; - } - - /** - * @return the list of available RSS Templates. - */ - public List getRSSTemplates() - { - List templates = rssTemplates.get(); - if (templates == null) - { - // get the template from the special Email Templates folder - FacesContext fc = FacesContext.getCurrentInstance(); - String xpath = Application.getRootPath(fc) + "/" + - Application.getGlossaryFolderName(fc) + "/" + - Application.getRSSTemplatesFolderName(fc) + "//*"; - - templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); - - rssTemplates.put(templates); - } - - return templates; - } - - /** - * @return the list of available JavaScript files that can be applied to the current document. - */ - public List getScriptFiles() - { - List scripts = this.scriptFiles.get(); - if (scripts == null) - { - // get the scripts from the special Scripts folder - FacesContext fc = FacesContext.getCurrentInstance(); - String xpath = Application.getRootPath(fc) + "/" + - Application.getGlossaryFolderName(fc) + "/" + - Application.getScriptsFolderName(fc) + "//*"; - - scripts = selectDictionaryNodes(fc, xpath, MSG_SELECT_SCRIPT, MimetypeMap.MIMETYPE_JAVASCRIPT); - - scriptFiles.put(scripts); - } - - return scripts; - } - - /** - * @param fc FacesContext - * @param xpath XPath to the nodes to select - * @param noSelectionLabel Label to add to the list if no items are found in the search - * - * @return List of SelectItem wrapper objects for the nodes found at the XPath - */ - private List selectDictionaryNodes(FacesContext fc, String xpath, String noSelectionLabel) - { - return selectDictionaryNodes(fc, xpath, noSelectionLabel, null); - } - - /** - * @param fc FacesContext - * @param xpath XPath to the nodes to select - * @param noSelectionLabel Label to add to the list if no items are found in the search - * @param mimetype Optional mimetype of items to add, will not add to list if mimetype does not match - * - * @return List of SelectItem wrapper objects for the nodes found at the XPath - */ - private List selectDictionaryNodes(FacesContext fc, String xpath, String noSelectionLabel, String mimetype) - { - List wrappers = null; - - try - { - NodeRef rootNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); - NamespaceService resolver = Repository.getServiceRegistry(fc).getNamespaceService(); - List results = this.getSearchService().selectNodes(rootNodeRef, xpath, null, resolver, false); - - wrappers = new ArrayList(results.size() + 1); - if (results.size() != 0) - { - DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); - for (NodeRef ref : results) - { - if (this.getNodeService().exists(ref) == true) - { - Node childNode = new Node(ref); - ContentData content = (ContentData)childNode.getProperties().get(ContentModel.PROP_CONTENT); - if (dd.isSubClass(childNode.getType(), ContentModel.TYPE_CONTENT) && - (mimetype == null || mimetype.equals(content.getMimetype()))) - { - wrappers.add(new SelectItem(childNode.getId(), childNode.getName())); - } - } - } - - // make sure the list is sorted by the label - QuickSort sorter = new QuickSort(wrappers, "label", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - } - } - catch (AccessDeniedException accessErr) - { - // ignore the result if we cannot access the root - } - - // add an entry (at the start) to instruct the user to select an item - if (wrappers == null) - { - wrappers = new ArrayList(1); - } - wrappers.add(0, new SelectItem(NO_SELECTION, Application.getMessage(FacesContext.getCurrentInstance(), noSelectionLabel))); - - return wrappers; - } - -} +package org.alfresco.web.bean; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; + +import javax.faces.context.FacesContext; +import javax.faces.model.SelectItem; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.security.permissions.AccessDeniedException; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.repository.ContentData; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.search.SearchService; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.util.ExpiringValueCache; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; + +/** + * Provide access to commonly used lists of templates and script files. + *

+ * The lists are cached for a small period of time to help performance in the client, + * as generally the contents of the template folders are not changed frequently. + * + * @author Kevin Roast + */ +public class TemplateSupportBean implements Serializable +{ + private static final long serialVersionUID = 6698338879903536081L; + + private static final String MSG_SELECT_TEMPLATE = "select_a_template"; + private static final String MSG_SELECT_SCRIPT = "select_a_script"; + + /** "no selection" marker for SelectItem lists */ + public static final String NO_SELECTION = "none"; + + /** NodeService instance */ + transient private NodeService nodeService; + + /** The SearchService instance */ + transient private SearchService searchService; + + /** cache of content templates that lasts 30 seconds - enough for a couple of page refreshes */ + private ExpiringValueCache> contentTemplates = new ExpiringValueCache>(1000*30); + + /** cache of email templates that lasts 30 seconds - enough for a few page refreshes */ + private ExpiringValueCache> emailTemplates = new ExpiringValueCache>(1000*30); + + /** cache of RSS templates that lasts 30 seconds - enough for a few page refreshes */ + private ExpiringValueCache> rssTemplates = new ExpiringValueCache>(1000*30); + + /** cache of JavaScript files that lasts 30 seconds - enough for a few page refreshes */ + private ExpiringValueCache> scriptFiles = new ExpiringValueCache>(1000*30); + + + /** + * @param nodeService The NodeService to set. + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + private NodeService getNodeService() + { + if (nodeService == null) + { + nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return nodeService; + } + + /** + * @param searchService The SearchService to set. + */ + public void setSearchService(SearchService searchService) + { + this.searchService = searchService; + } + + private SearchService getSearchService() + { + if (searchService == null) + { + searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); + } + return searchService; + } + + /** + * @return the list of available Content Templates that can be applied to the current document. + */ + public List getContentTemplates() + { + List templates = contentTemplates.get(); + if (templates == null) + { + // get the template from the special Content Templates folder + FacesContext fc = FacesContext.getCurrentInstance(); + String xpath = Application.getRootPath(fc) + "/" + + Application.getGlossaryFolderName(fc) + "/" + + Application.getContentTemplatesFolderName(fc) + "//*"; + + templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); + + contentTemplates.put(templates); + } + + return templates; + } + + /** + * @return the list of available Email Templates. + */ + public List getEmailTemplates() + { + List templates = emailTemplates.get(); + if (templates == null) + { + // get the template from the special Email Templates folder + FacesContext fc = FacesContext.getCurrentInstance(); + String xpath = Application.getRootPath(fc) + "/" + + Application.getGlossaryFolderName(fc) + "/" + + Application.getEmailTemplatesFolderName(fc) + "//*"; + + templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); + + emailTemplates.put(templates); + } + + return templates; + } + + /** + * @return the list of available Notify Email Templates. + */ + public List getNotifyEmailTemplates() + { + List templates = null; + + // get the template from the special Email Templates folder + FacesContext fc = FacesContext.getCurrentInstance(); + String xpath = Application.getRootPath(fc) + "/" + + Application.getGlossaryFolderName(fc) + "/" + + Application.getEmailTemplatesFolderName(fc) + "/" + + Application.getNotifyEmailTemplatesFolderName(fc) + "//*"; + + templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); + + return templates; + } + + /** + * @return the list of available RSS Templates. + */ + public List getRSSTemplates() + { + List templates = rssTemplates.get(); + if (templates == null) + { + // get the template from the special Email Templates folder + FacesContext fc = FacesContext.getCurrentInstance(); + String xpath = Application.getRootPath(fc) + "/" + + Application.getGlossaryFolderName(fc) + "/" + + Application.getRSSTemplatesFolderName(fc) + "//*"; + + templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN); + + rssTemplates.put(templates); + } + + return templates; + } + + /** + * @return the list of available JavaScript files that can be applied to the current document. + */ + public List getScriptFiles() + { + List scripts = this.scriptFiles.get(); + if (scripts == null) + { + // get the scripts from the special Scripts folder + FacesContext fc = FacesContext.getCurrentInstance(); + String xpath = Application.getRootPath(fc) + "/" + + Application.getGlossaryFolderName(fc) + "/" + + Application.getScriptsFolderName(fc) + "//*"; + + scripts = selectDictionaryNodes(fc, xpath, MSG_SELECT_SCRIPT, MimetypeMap.MIMETYPE_JAVASCRIPT); + + scriptFiles.put(scripts); + } + + return scripts; + } + + /** + * @param fc FacesContext + * @param xpath XPath to the nodes to select + * @param noSelectionLabel Label to add to the list if no items are found in the search + * + * @return List of SelectItem wrapper objects for the nodes found at the XPath + */ + private List selectDictionaryNodes(FacesContext fc, String xpath, String noSelectionLabel) + { + return selectDictionaryNodes(fc, xpath, noSelectionLabel, null); + } + + /** + * @param fc FacesContext + * @param xpath XPath to the nodes to select + * @param noSelectionLabel Label to add to the list if no items are found in the search + * @param mimetype Optional mimetype of items to add, will not add to list if mimetype does not match + * + * @return List of SelectItem wrapper objects for the nodes found at the XPath + */ + private List selectDictionaryNodes(FacesContext fc, String xpath, String noSelectionLabel, String mimetype) + { + List wrappers = null; + + try + { + NodeRef rootNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); + NamespaceService resolver = Repository.getServiceRegistry(fc).getNamespaceService(); + List results = this.getSearchService().selectNodes(rootNodeRef, xpath, null, resolver, false); + + wrappers = new ArrayList(results.size() + 1); + if (results.size() != 0) + { + DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService(); + for (NodeRef ref : results) + { + if (this.getNodeService().exists(ref) == true) + { + Node childNode = new Node(ref); + ContentData content = (ContentData)childNode.getProperties().get(ContentModel.PROP_CONTENT); + if (dd.isSubClass(childNode.getType(), ContentModel.TYPE_CONTENT) && + (mimetype == null || mimetype.equals(content.getMimetype()))) + { + wrappers.add(new SelectItem(childNode.getId(), childNode.getName())); + } + } + } + + // make sure the list is sorted by the label + QuickSort sorter = new QuickSort(wrappers, "label", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + } + } + catch (AccessDeniedException accessErr) + { + // ignore the result if we cannot access the root + } + + // add an entry (at the start) to instruct the user to select an item + if (wrappers == null) + { + wrappers = new ArrayList(1); + } + wrappers.add(0, new SelectItem(NO_SELECTION, Application.getMessage(FacesContext.getCurrentInstance(), noSelectionLabel))); + + return wrappers; + } + +} diff --git a/source/java/org/alfresco/web/bean/admin/AdminConsoleDialog.java b/source/java/org/alfresco/web/bean/admin/AdminConsoleDialog.java index 6d0f2e44bc..aa3df5b76d 100644 --- a/source/java/org/alfresco/web/bean/admin/AdminConsoleDialog.java +++ b/source/java/org/alfresco/web/bean/admin/AdminConsoleDialog.java @@ -1,25 +1,25 @@ -package org.alfresco.web.bean.admin; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; - -public class AdminConsoleDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -2520599525975495006L; - - private static final String BUTTON_CLOSE = "close"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return outcome; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_CLOSE); - } -} +package org.alfresco.web.bean.admin; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; + +public class AdminConsoleDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -2520599525975495006L; + + private static final String BUTTON_CLOSE = "close"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return outcome; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_CLOSE); + } +} diff --git a/source/java/org/alfresco/web/bean/admin/ShowSystemInfoDialog.java b/source/java/org/alfresco/web/bean/admin/ShowSystemInfoDialog.java index 53d677fc5e..53537f22cc 100644 --- a/source/java/org/alfresco/web/bean/admin/ShowSystemInfoDialog.java +++ b/source/java/org/alfresco/web/bean/admin/ShowSystemInfoDialog.java @@ -1,61 +1,61 @@ -package org.alfresco.web.bean.admin; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.AboutBean; -import org.alfresco.web.bean.dialog.BaseDialogBean; - -/** - * Implementation for the SystemInfo dialog. - * - * @author gavinc - */ -public class ShowSystemInfoDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 1328587489092603676L; - - private static final String MSG_CURRENT_USER = "current_user"; - private static final String MSG_CLOSE = "close"; - private static final String MSG_VERSION = "version"; - - protected AboutBean aboutBean; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return null; - } - - public void setAboutBean(AboutBean aboutBean) - { - this.aboutBean = aboutBean; - } - - @Override - public String getContainerSubTitle() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CURRENT_USER) + ": " + - this.navigator.getCurrentUser().getUserName(); - } - - @Override - public String getContainerDescription() - { - StringBuilder builder = new StringBuilder(Application.getMessage( - FacesContext.getCurrentInstance(), MSG_VERSION)); - builder.append(": "); - builder.append(this.aboutBean.getEdition()); - builder.append(" - v"); - builder.append(this.aboutBean.getVersion()); - - return builder.toString(); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } - -} +package org.alfresco.web.bean.admin; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.AboutBean; +import org.alfresco.web.bean.dialog.BaseDialogBean; + +/** + * Implementation for the SystemInfo dialog. + * + * @author gavinc + */ +public class ShowSystemInfoDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 1328587489092603676L; + + private static final String MSG_CURRENT_USER = "current_user"; + private static final String MSG_CLOSE = "close"; + private static final String MSG_VERSION = "version"; + + protected AboutBean aboutBean; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return null; + } + + public void setAboutBean(AboutBean aboutBean) + { + this.aboutBean = aboutBean; + } + + @Override + public String getContainerSubTitle() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CURRENT_USER) + ": " + + this.navigator.getCurrentUser().getUserName(); + } + + @Override + public String getContainerDescription() + { + StringBuilder builder = new StringBuilder(Application.getMessage( + FacesContext.getCurrentInstance(), MSG_VERSION)); + builder.append(": "); + builder.append(this.aboutBean.getEdition()); + builder.append(" - v"); + builder.append(this.aboutBean.getVersion()); + + return builder.toString(); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } + +} diff --git a/source/java/org/alfresco/web/bean/ajax/CategoryBrowserPluginBean.java b/source/java/org/alfresco/web/bean/ajax/CategoryBrowserPluginBean.java index 56c8f18601..891f1c47e1 100644 --- a/source/java/org/alfresco/web/bean/ajax/CategoryBrowserPluginBean.java +++ b/source/java/org/alfresco/web/bean/ajax/CategoryBrowserPluginBean.java @@ -1,329 +1,329 @@ -package org.alfresco.web.bean.ajax; - -import java.io.IOException; -import java.io.Serializable; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.search.CategoryService; -import org.alfresco.service.namespace.RegexQNamePattern; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.repo.component.UITree.TreeNode; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -public class CategoryBrowserPluginBean implements Serializable -{ - private static final long serialVersionUID = -1493808456969763500L; - - public static final String BEAN_NAME = "CategoryBrowserPluginBean"; - - private static final Log logger = LogFactory.getLog(CategoryBrowserPluginBean.class); - - transient private CategoryService categoryService; - transient private NodeService nodeService; - - private List categoryRootNodes; - private Map categoryNodes; - protected NodeRef previouslySelectedNode; - - /** - * @param categoryService - * the categoryService to set - */ - public void setCategoryService(CategoryService categoryService) - { - this.categoryService = categoryService; - } - - /** - * @return the categoryService - */ - private CategoryService getCategoryService() - { - //check for null in cluster environment - if(categoryService == null) - { - categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); - } - return categoryService; - } - - /** - * @param nodeService - * the nodeService to set - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - /** - * @return the nodeService - */ - private NodeService getNodeService() - { - //check for null in cluster environment - if(nodeService == null) - { - nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return nodeService; - } - - public List getCategoryRootNodes() - { - if (this.categoryRootNodes == null) - { - this.categoryRootNodes = new ArrayList(); - this.categoryNodes = new HashMap(); - - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(FacesContext.getCurrentInstance(), true); - tx.begin(); - - Collection childRefs = this.getCategoryService().getRootCategories( - Repository.getStoreRef(), ContentModel.ASPECT_GEN_CLASSIFIABLE); - - for (ChildAssociationRef ref : childRefs) - { - NodeRef child = ref.getChildRef(); - TreeNode node = createTreeNode(child); - this.categoryRootNodes.add(node); - this.categoryNodes.put(node.getNodeRef(), node); - } - - tx.commit(); - } - catch (Throwable err) - { - Utils.addErrorMessage("NavigatorPluginBean exception in getCompanyHomeRootNodes()", err); - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception tex) - { - } - } - } - - return this.categoryRootNodes; - } - - protected Map getNodesMap() - { - return this.categoryNodes; - } - - /** - * Retrieves the child folders for the noderef given in the 'noderef' parameter and caches the nodes against the area - * in the 'area' parameter. - */ - public void retrieveChildren() throws IOException - { - FacesContext context = FacesContext.getCurrentInstance(); - ResponseWriter out = context.getResponseWriter(); - - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - Map params = context.getExternalContext().getRequestParameterMap(); - String nodeRefStr = (String) params.get("nodeRef"); - - // work out which list to cache the nodes in - Map currentNodes = getNodesMap(); - - if (nodeRefStr != null && currentNodes != null) - { - // get the given node's details - NodeRef parentNodeRef = new NodeRef(nodeRefStr); - TreeNode parentNode = currentNodes.get(parentNodeRef.toString()); - parentNode.setExpanded(true); - - if (logger.isDebugEnabled()) - logger.debug("retrieving children for noderef: " + parentNodeRef); - - // remove any existing children as the latest ones will be added - // below - parentNode.removeChildren(); - - // get all the child folder objects for the parent - List childRefs = this.getNodeService().getChildAssocs(parentNodeRef, - ContentModel.ASSOC_SUBCATEGORIES, RegexQNamePattern.MATCH_ALL); - List sortedNodes = new ArrayList(); - for (ChildAssociationRef ref : childRefs) - { - NodeRef nodeRef = ref.getChildRef(); - logger.debug("retrieving child : " + nodeRef); - // build the XML representation of the child node - TreeNode childNode = createTreeNode(nodeRef); - parentNode.addChild(childNode); - currentNodes.put(childNode.getNodeRef(), childNode); - sortedNodes.add(childNode); - } - - // order the tree nodes by the tree label - if (sortedNodes.size() > 1) - { - QuickSort sorter = new QuickSort(sortedNodes, "name", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - } - - // generate the XML representation - StringBuilder xml = new StringBuilder( - ""); - for (TreeNode childNode : sortedNodes) - { - xml.append(childNode.toXML()); - } - xml.append(""); - - // send the generated XML back to the tree - out.write(xml.toString()); - - if (logger.isDebugEnabled()) - logger.debug("returning XML: " + xml.toString()); - } - - // commit the transaction - tx.commit(); - } - catch (Throwable err) - { - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception tex) - { - } - } - } - - /** - * Sets the state of the node given in the 'nodeRef' parameter to collapsed - */ - public void nodeCollapsed() throws IOException - { - FacesContext context = FacesContext.getCurrentInstance(); - ResponseWriter out = context.getResponseWriter(); - Map params = context.getExternalContext().getRequestParameterMap(); - String nodeRefStr = (String) params.get("nodeRef"); - - // work out which list to cache the nodes in - Map currentNodes = getNodesMap(); - - if (nodeRefStr != null && currentNodes != null) - { - TreeNode treeNode = currentNodes.get(nodeRefStr); - if (treeNode != null) - { - treeNode.setExpanded(false); - - // we need to return something for the client to be happy! - out.write(""); - - if (logger.isDebugEnabled()) - logger.debug("Set node " + treeNode + " to collapsed state"); - } - } - } - - public void selectNode(NodeRef selectedNode, String area) - { - // if there is a currently selected node, get hold of - // it (from any of the areas) and reset to unselected - if (this.previouslySelectedNode != null) - { - TreeNode node = this.categoryNodes.get(this.previouslySelectedNode.toString()); - if (node != null) - { - node.setSelected(false); - } - } - - // find the node just selected and set its state to selected - if (selectedNode != null) - { - TreeNode node = this.categoryNodes.get(selectedNode.toString()); - if (node != null) - { - node.setSelected(true); - } - } - - this.previouslySelectedNode = selectedNode; - - if (logger.isDebugEnabled()) - logger.debug("Selected node: " + selectedNode); - } - - /** - * Resets the selected node - */ - public void resetSelectedNode() - { - if (this.previouslySelectedNode != null) - { - TreeNode node = this.categoryNodes.get(this.previouslySelectedNode.toString()); - if (node != null) - { - node.setSelected(false); - } - } - if (logger.isDebugEnabled()) - logger.debug("Reset selected node: " + this.previouslySelectedNode); - } - - /** - * Resets all the caches held by the bean. - */ - public void reset() - { - this.categoryNodes = null; - this.categoryRootNodes = null; - - resetSelectedNode(); - } - - /** - * Creates a TreeNode object from the given NodeRef - * - * @param nodeRef - * The NodeRef to create the TreeNode from - */ - protected TreeNode createTreeNode(NodeRef nodeRef) - { - TreeNode node = new TreeNode(nodeRef.toString(), Repository.getNameForNode(this.getNodeService(), nodeRef), - (String) this.getNodeService().getProperty(nodeRef, ApplicationModel.PROP_ICON)); - - return node; - } -} +package org.alfresco.web.bean.ajax; + +import java.io.IOException; +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.search.CategoryService; +import org.alfresco.service.namespace.RegexQNamePattern; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.repo.component.UITree.TreeNode; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class CategoryBrowserPluginBean implements Serializable +{ + private static final long serialVersionUID = -1493808456969763500L; + + public static final String BEAN_NAME = "CategoryBrowserPluginBean"; + + private static final Log logger = LogFactory.getLog(CategoryBrowserPluginBean.class); + + transient private CategoryService categoryService; + transient private NodeService nodeService; + + private List categoryRootNodes; + private Map categoryNodes; + protected NodeRef previouslySelectedNode; + + /** + * @param categoryService + * the categoryService to set + */ + public void setCategoryService(CategoryService categoryService) + { + this.categoryService = categoryService; + } + + /** + * @return the categoryService + */ + private CategoryService getCategoryService() + { + //check for null in cluster environment + if(categoryService == null) + { + categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); + } + return categoryService; + } + + /** + * @param nodeService + * the nodeService to set + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + /** + * @return the nodeService + */ + private NodeService getNodeService() + { + //check for null in cluster environment + if(nodeService == null) + { + nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return nodeService; + } + + public List getCategoryRootNodes() + { + if (this.categoryRootNodes == null) + { + this.categoryRootNodes = new ArrayList(); + this.categoryNodes = new HashMap(); + + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(FacesContext.getCurrentInstance(), true); + tx.begin(); + + Collection childRefs = this.getCategoryService().getRootCategories( + Repository.getStoreRef(), ContentModel.ASPECT_GEN_CLASSIFIABLE); + + for (ChildAssociationRef ref : childRefs) + { + NodeRef child = ref.getChildRef(); + TreeNode node = createTreeNode(child); + this.categoryRootNodes.add(node); + this.categoryNodes.put(node.getNodeRef(), node); + } + + tx.commit(); + } + catch (Throwable err) + { + Utils.addErrorMessage("NavigatorPluginBean exception in getCompanyHomeRootNodes()", err); + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception tex) + { + } + } + } + + return this.categoryRootNodes; + } + + protected Map getNodesMap() + { + return this.categoryNodes; + } + + /** + * Retrieves the child folders for the noderef given in the 'noderef' parameter and caches the nodes against the area + * in the 'area' parameter. + */ + public void retrieveChildren() throws IOException + { + FacesContext context = FacesContext.getCurrentInstance(); + ResponseWriter out = context.getResponseWriter(); + + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + Map params = context.getExternalContext().getRequestParameterMap(); + String nodeRefStr = (String) params.get("nodeRef"); + + // work out which list to cache the nodes in + Map currentNodes = getNodesMap(); + + if (nodeRefStr != null && currentNodes != null) + { + // get the given node's details + NodeRef parentNodeRef = new NodeRef(nodeRefStr); + TreeNode parentNode = currentNodes.get(parentNodeRef.toString()); + parentNode.setExpanded(true); + + if (logger.isDebugEnabled()) + logger.debug("retrieving children for noderef: " + parentNodeRef); + + // remove any existing children as the latest ones will be added + // below + parentNode.removeChildren(); + + // get all the child folder objects for the parent + List childRefs = this.getNodeService().getChildAssocs(parentNodeRef, + ContentModel.ASSOC_SUBCATEGORIES, RegexQNamePattern.MATCH_ALL); + List sortedNodes = new ArrayList(); + for (ChildAssociationRef ref : childRefs) + { + NodeRef nodeRef = ref.getChildRef(); + logger.debug("retrieving child : " + nodeRef); + // build the XML representation of the child node + TreeNode childNode = createTreeNode(nodeRef); + parentNode.addChild(childNode); + currentNodes.put(childNode.getNodeRef(), childNode); + sortedNodes.add(childNode); + } + + // order the tree nodes by the tree label + if (sortedNodes.size() > 1) + { + QuickSort sorter = new QuickSort(sortedNodes, "name", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + } + + // generate the XML representation + StringBuilder xml = new StringBuilder( + ""); + for (TreeNode childNode : sortedNodes) + { + xml.append(childNode.toXML()); + } + xml.append(""); + + // send the generated XML back to the tree + out.write(xml.toString()); + + if (logger.isDebugEnabled()) + logger.debug("returning XML: " + xml.toString()); + } + + // commit the transaction + tx.commit(); + } + catch (Throwable err) + { + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception tex) + { + } + } + } + + /** + * Sets the state of the node given in the 'nodeRef' parameter to collapsed + */ + public void nodeCollapsed() throws IOException + { + FacesContext context = FacesContext.getCurrentInstance(); + ResponseWriter out = context.getResponseWriter(); + Map params = context.getExternalContext().getRequestParameterMap(); + String nodeRefStr = (String) params.get("nodeRef"); + + // work out which list to cache the nodes in + Map currentNodes = getNodesMap(); + + if (nodeRefStr != null && currentNodes != null) + { + TreeNode treeNode = currentNodes.get(nodeRefStr); + if (treeNode != null) + { + treeNode.setExpanded(false); + + // we need to return something for the client to be happy! + out.write(""); + + if (logger.isDebugEnabled()) + logger.debug("Set node " + treeNode + " to collapsed state"); + } + } + } + + public void selectNode(NodeRef selectedNode, String area) + { + // if there is a currently selected node, get hold of + // it (from any of the areas) and reset to unselected + if (this.previouslySelectedNode != null) + { + TreeNode node = this.categoryNodes.get(this.previouslySelectedNode.toString()); + if (node != null) + { + node.setSelected(false); + } + } + + // find the node just selected and set its state to selected + if (selectedNode != null) + { + TreeNode node = this.categoryNodes.get(selectedNode.toString()); + if (node != null) + { + node.setSelected(true); + } + } + + this.previouslySelectedNode = selectedNode; + + if (logger.isDebugEnabled()) + logger.debug("Selected node: " + selectedNode); + } + + /** + * Resets the selected node + */ + public void resetSelectedNode() + { + if (this.previouslySelectedNode != null) + { + TreeNode node = this.categoryNodes.get(this.previouslySelectedNode.toString()); + if (node != null) + { + node.setSelected(false); + } + } + if (logger.isDebugEnabled()) + logger.debug("Reset selected node: " + this.previouslySelectedNode); + } + + /** + * Resets all the caches held by the bean. + */ + public void reset() + { + this.categoryNodes = null; + this.categoryRootNodes = null; + + resetSelectedNode(); + } + + /** + * Creates a TreeNode object from the given NodeRef + * + * @param nodeRef + * The NodeRef to create the TreeNode from + */ + protected TreeNode createTreeNode(NodeRef nodeRef) + { + TreeNode node = new TreeNode(nodeRef.toString(), Repository.getNameForNode(this.getNodeService(), nodeRef), + (String) this.getNodeService().getProperty(nodeRef, ApplicationModel.PROP_ICON)); + + return node; + } +} diff --git a/source/java/org/alfresco/web/bean/ajax/ContentUpdateBean.java b/source/java/org/alfresco/web/bean/ajax/ContentUpdateBean.java index 03e145fb57..db05c28916 100644 --- a/source/java/org/alfresco/web/bean/ajax/ContentUpdateBean.java +++ b/source/java/org/alfresco/web/bean/ajax/ContentUpdateBean.java @@ -1,126 +1,126 @@ -package org.alfresco.web.bean.ajax; - -import java.io.File; -import java.io.Serializable; -import java.util.List; - -import javax.faces.context.ExternalContext; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.servlet.http.HttpServletRequest; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.util.TempFileProvider; -import org.alfresco.web.app.servlet.ajax.InvokeCommand; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.util.XMLUtil; -import org.apache.commons.fileupload.FileItem; -import org.apache.commons.fileupload.disk.DiskFileItemFactory; -import org.apache.commons.fileupload.servlet.ServletFileUpload; -import org.apache.commons.io.FilenameUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; - -/** - * Bean managing the ajax servlet upload of a multi-part form containing file content - * to replace the content of a node within the repository. - * - * @author Mike Hatfield - */ -public class ContentUpdateBean implements Serializable -{ - private static final long serialVersionUID = -7209326198823950952L; - - private static Log logger = LogFactory.getLog(ContentUpdateBean.class); - - /** - * Ajax method to update file content. A multi-part form is required as the input. - * - * "return-page" = javascript to execute on return from the upload request - * "nodeRef" = the nodeRef of the item to update the content of - * - * @throws Exception - */ - @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) - public void updateFile() throws Exception - { - FacesContext fc = FacesContext.getCurrentInstance(); - ExternalContext externalContext = fc.getExternalContext(); - HttpServletRequest request = (HttpServletRequest)externalContext.getRequest(); - - ServletFileUpload upload = new ServletFileUpload(new DiskFileItemFactory()); - upload.setHeaderEncoding("UTF-8"); - - List fileItems = upload.parseRequest(request); - String strNodeRef = null; - String strFilename = null; - String strReturnPage = null; - File file = null; - - for (FileItem item : fileItems) - { - if (item.isFormField() && item.getFieldName().equals("return-page")) - { - strReturnPage = item.getString(); - } - else if (item.isFormField() && item.getFieldName().equals("nodeRef")) - { - strNodeRef = item.getString(); - } - else - { - strFilename = FilenameUtils.getName(item.getName()); - file = TempFileProvider.createTempFile("alfresco", ".upload"); - item.write(file); - } - } - - if (logger.isDebugEnabled()) - logger.debug("Ajax content update request: " + strFilename + " to nodeRef: " + strNodeRef + " return page: " + strReturnPage); - - try - { - if (file != null && strNodeRef != null && strNodeRef.length() != 0) - { - NodeRef nodeRef = new NodeRef(strNodeRef); - if (nodeRef != null) - { - ServiceRegistry services = Repository.getServiceRegistry(fc); - - // get a writer for the content and put the file - ContentWriter writer = services.getContentService().getWriter(nodeRef, ContentModel.PROP_CONTENT, true); - writer.putContent(file); - } - } - } - catch (Exception e) - { - strReturnPage = strReturnPage.replace("${UPLOAD_ERROR}", e.getMessage()); - } - - Document result = XMLUtil.newDocument(); - Element htmlEl = result.createElement("html"); - result.appendChild(htmlEl); - Element bodyEl = result.createElement("body"); - htmlEl.appendChild(bodyEl); - - Element scriptEl = result.createElement("script"); - bodyEl.appendChild(scriptEl); - scriptEl.setAttribute("type", "text/javascript"); - Node scriptText = result.createTextNode(strReturnPage); - scriptEl.appendChild(scriptText); - - if (logger.isDebugEnabled()) - logger.debug("Content update request complete."); - - ResponseWriter out = fc.getResponseWriter(); - XMLUtil.print(result, out); - } -} +package org.alfresco.web.bean.ajax; + +import java.io.File; +import java.io.Serializable; +import java.util.List; + +import javax.faces.context.ExternalContext; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.servlet.http.HttpServletRequest; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.util.TempFileProvider; +import org.alfresco.web.app.servlet.ajax.InvokeCommand; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.util.XMLUtil; +import org.apache.commons.fileupload.FileItem; +import org.apache.commons.fileupload.disk.DiskFileItemFactory; +import org.apache.commons.fileupload.servlet.ServletFileUpload; +import org.apache.commons.io.FilenameUtils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.Node; + +/** + * Bean managing the ajax servlet upload of a multi-part form containing file content + * to replace the content of a node within the repository. + * + * @author Mike Hatfield + */ +public class ContentUpdateBean implements Serializable +{ + private static final long serialVersionUID = -7209326198823950952L; + + private static Log logger = LogFactory.getLog(ContentUpdateBean.class); + + /** + * Ajax method to update file content. A multi-part form is required as the input. + * + * "return-page" = javascript to execute on return from the upload request + * "nodeRef" = the nodeRef of the item to update the content of + * + * @throws Exception + */ + @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) + public void updateFile() throws Exception + { + FacesContext fc = FacesContext.getCurrentInstance(); + ExternalContext externalContext = fc.getExternalContext(); + HttpServletRequest request = (HttpServletRequest)externalContext.getRequest(); + + ServletFileUpload upload = new ServletFileUpload(new DiskFileItemFactory()); + upload.setHeaderEncoding("UTF-8"); + + List fileItems = upload.parseRequest(request); + String strNodeRef = null; + String strFilename = null; + String strReturnPage = null; + File file = null; + + for (FileItem item : fileItems) + { + if (item.isFormField() && item.getFieldName().equals("return-page")) + { + strReturnPage = item.getString(); + } + else if (item.isFormField() && item.getFieldName().equals("nodeRef")) + { + strNodeRef = item.getString(); + } + else + { + strFilename = FilenameUtils.getName(item.getName()); + file = TempFileProvider.createTempFile("alfresco", ".upload"); + item.write(file); + } + } + + if (logger.isDebugEnabled()) + logger.debug("Ajax content update request: " + strFilename + " to nodeRef: " + strNodeRef + " return page: " + strReturnPage); + + try + { + if (file != null && strNodeRef != null && strNodeRef.length() != 0) + { + NodeRef nodeRef = new NodeRef(strNodeRef); + if (nodeRef != null) + { + ServiceRegistry services = Repository.getServiceRegistry(fc); + + // get a writer for the content and put the file + ContentWriter writer = services.getContentService().getWriter(nodeRef, ContentModel.PROP_CONTENT, true); + writer.putContent(file); + } + } + } + catch (Exception e) + { + strReturnPage = strReturnPage.replace("${UPLOAD_ERROR}", e.getMessage()); + } + + Document result = XMLUtil.newDocument(); + Element htmlEl = result.createElement("html"); + result.appendChild(htmlEl); + Element bodyEl = result.createElement("body"); + htmlEl.appendChild(bodyEl); + + Element scriptEl = result.createElement("script"); + bodyEl.appendChild(scriptEl); + scriptEl.setAttribute("type", "text/javascript"); + Node scriptText = result.createTextNode(strReturnPage); + scriptEl.appendChild(scriptText); + + if (logger.isDebugEnabled()) + logger.debug("Content update request complete."); + + ResponseWriter out = fc.getResponseWriter(); + XMLUtil.print(result, out); + } +} diff --git a/source/java/org/alfresco/web/bean/ajax/FileUploadBean.java b/source/java/org/alfresco/web/bean/ajax/FileUploadBean.java index 7aa24f1524..97b7970a89 100644 --- a/source/java/org/alfresco/web/bean/ajax/FileUploadBean.java +++ b/source/java/org/alfresco/web/bean/ajax/FileUploadBean.java @@ -1,229 +1,229 @@ -package org.alfresco.web.bean.ajax; - -import java.io.BufferedInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.InputStream; -import java.io.Serializable; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.StringTokenizer; - -import javax.faces.context.ExternalContext; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.servlet.http.HttpServletRequest; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.content.filestore.FileContentReader; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.model.FileInfo; -import org.alfresco.service.cmr.repository.ContentReader; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; -import org.alfresco.service.namespace.QName; -import org.alfresco.util.TempFileProvider; -import org.springframework.extensions.surf.util.URLDecoder; -import org.alfresco.web.app.servlet.BaseServlet; -import org.alfresco.web.app.servlet.ajax.InvokeCommand; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.util.XMLUtil; -import org.apache.commons.fileupload.FileItem; -import org.apache.commons.fileupload.disk.DiskFileItemFactory; -import org.apache.commons.fileupload.servlet.ServletFileUpload; -import org.apache.commons.io.FilenameUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; - -/** - * Bean managing the ajax servlet upload of a multi-part form containing file content - * to be added at a specific path in the server. - * - * @author Kevin Roast - */ -public class FileUploadBean implements Serializable -{ - private static final long serialVersionUID = 4555828718375916674L; - - private static Log logger = LogFactory.getLog(FileUploadBean.class); - - /** - * Ajax method to upload file content. A multi-part form is required as the input. - * - * "return-page" = javascript to execute on return from the upload request - * "currentPath" = the cm:name based server path to upload the content into - * and the file item content. - * - * @throws Exception - */ - @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) - public void uploadFile() throws Exception - { - FacesContext fc = FacesContext.getCurrentInstance(); - ExternalContext externalContext = fc.getExternalContext(); - HttpServletRequest request = (HttpServletRequest)externalContext.getRequest(); - - ServletFileUpload upload = new ServletFileUpload(new DiskFileItemFactory()); - upload.setHeaderEncoding("UTF-8"); - - List fileItems = upload.parseRequest(request); - FileUploadBean bean = new FileUploadBean(); - String currentPath = null; - String filename = null; - String returnPage = null; - File file = null; - - for (FileItem item : fileItems) - { - if (item.isFormField() && item.getFieldName().equals("return-page")) - { - returnPage = item.getString(); - } - else if (item.isFormField() && item.getFieldName().equals("currentPath")) - { - currentPath = URLDecoder.decode(item.getString()); - } - else - { - filename = FilenameUtils.getName(item.getName()); - file = TempFileProvider.createTempFile("alfresco", ".upload"); - item.write(file); - } - } - - if (logger.isDebugEnabled()) - logger.debug("Ajax file upload request: " + filename + " to path: " + currentPath + " return page: " + returnPage); - - try - { - if (file != null && currentPath != null && currentPath.length() != 0) - { - NodeRef containerRef = pathToNodeRef(fc, currentPath); - if (containerRef != null) - { - // Guess the mimetype - String mimetype = Repository.getMimeTypeForFileName(fc, filename); - - // Now guess the encoding - String encoding = "UTF-8"; - InputStream is = null; - try - { - is = new BufferedInputStream(new FileInputStream(file)); - encoding = Repository.guessEncoding(fc, is, mimetype); - } - catch (Throwable e) - { - // Bad as it is, it's not terminal - logger.error("Failed to guess character encoding of file: " + file, e); - } - finally - { - if (is != null) - { - try { is.close(); } catch (Throwable e) {} - } - } - - // Try and extract metadata from the file - ContentReader cr = new FileContentReader(file); - cr.setMimetype(mimetype); - - // create properties for content type - String author = null; - String title = null; - String description = null; - Map contentProps = new HashMap(5, 1.0f); - if (Repository.extractMetadata(fc, cr, contentProps)) - { - author = (String)(contentProps.get(ContentModel.PROP_AUTHOR)); - title = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_TITLE)); - description = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_DESCRIPTION)); - } - - // default the title to the file name if not set - if (title == null) - { - title = filename; - } - - ServiceRegistry services = Repository.getServiceRegistry(fc); - FileInfo fileInfo = services.getFileFolderService().create( - containerRef, filename, ContentModel.TYPE_CONTENT); - NodeRef fileNodeRef = fileInfo.getNodeRef(); - - // set the author aspect - if (author != null) - { - Map authorProps = new HashMap(1, 1.0f); - authorProps.put(ContentModel.PROP_AUTHOR, author); - services.getNodeService().addAspect(fileNodeRef, ContentModel.ASPECT_AUTHOR, authorProps); - } - - // apply the titled aspect - title and description - Map titledProps = new HashMap(2, 1.0f); - titledProps.put(ContentModel.PROP_TITLE, title); - titledProps.put(ContentModel.PROP_DESCRIPTION, description); - services.getNodeService().addAspect(fileNodeRef, ContentModel.ASPECT_TITLED, titledProps); - - // get a writer for the content and put the file - ContentWriter writer = services.getContentService().getWriter(fileNodeRef, ContentModel.PROP_CONTENT, true); - writer.setMimetype(mimetype); - writer.setEncoding(encoding); - writer.putContent(file); - } - } - } - catch (Exception e) - { - returnPage = returnPage.replace("${UPLOAD_ERROR}", e.getMessage()); - } - finally - { - if(file != null) - { - logger.debug("delete temporary file:" + file.getPath()); - // Delete the temporary file - file.delete(); - } - } - - Document result = XMLUtil.newDocument(); - Element htmlEl = result.createElement("html"); - result.appendChild(htmlEl); - Element bodyEl = result.createElement("body"); - htmlEl.appendChild(bodyEl); - - Element scriptEl = result.createElement("script"); - bodyEl.appendChild(scriptEl); - scriptEl.setAttribute("type", "text/javascript"); - Node scriptText = result.createTextNode(returnPage); - scriptEl.appendChild(scriptText); - - if (logger.isDebugEnabled()) - { - logger.debug("File upload request complete."); - } - ResponseWriter out = fc.getResponseWriter(); - XMLUtil.print(result, out); - } - - static NodeRef pathToNodeRef(FacesContext fc, String path) - { - // convert cm:name based path to a NodeRef - StringTokenizer t = new StringTokenizer(path, "/"); - int tokenCount = t.countTokens(); - String[] elements = new String[tokenCount]; - for (int i=0; i fileItems = upload.parseRequest(request); + FileUploadBean bean = new FileUploadBean(); + String currentPath = null; + String filename = null; + String returnPage = null; + File file = null; + + for (FileItem item : fileItems) + { + if (item.isFormField() && item.getFieldName().equals("return-page")) + { + returnPage = item.getString(); + } + else if (item.isFormField() && item.getFieldName().equals("currentPath")) + { + currentPath = URLDecoder.decode(item.getString()); + } + else + { + filename = FilenameUtils.getName(item.getName()); + file = TempFileProvider.createTempFile("alfresco", ".upload"); + item.write(file); + } + } + + if (logger.isDebugEnabled()) + logger.debug("Ajax file upload request: " + filename + " to path: " + currentPath + " return page: " + returnPage); + + try + { + if (file != null && currentPath != null && currentPath.length() != 0) + { + NodeRef containerRef = pathToNodeRef(fc, currentPath); + if (containerRef != null) + { + // Guess the mimetype + String mimetype = Repository.getMimeTypeForFileName(fc, filename); + + // Now guess the encoding + String encoding = "UTF-8"; + InputStream is = null; + try + { + is = new BufferedInputStream(new FileInputStream(file)); + encoding = Repository.guessEncoding(fc, is, mimetype); + } + catch (Throwable e) + { + // Bad as it is, it's not terminal + logger.error("Failed to guess character encoding of file: " + file, e); + } + finally + { + if (is != null) + { + try { is.close(); } catch (Throwable e) {} + } + } + + // Try and extract metadata from the file + ContentReader cr = new FileContentReader(file); + cr.setMimetype(mimetype); + + // create properties for content type + String author = null; + String title = null; + String description = null; + Map contentProps = new HashMap(5, 1.0f); + if (Repository.extractMetadata(fc, cr, contentProps)) + { + author = (String)(contentProps.get(ContentModel.PROP_AUTHOR)); + title = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_TITLE)); + description = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_DESCRIPTION)); + } + + // default the title to the file name if not set + if (title == null) + { + title = filename; + } + + ServiceRegistry services = Repository.getServiceRegistry(fc); + FileInfo fileInfo = services.getFileFolderService().create( + containerRef, filename, ContentModel.TYPE_CONTENT); + NodeRef fileNodeRef = fileInfo.getNodeRef(); + + // set the author aspect + if (author != null) + { + Map authorProps = new HashMap(1, 1.0f); + authorProps.put(ContentModel.PROP_AUTHOR, author); + services.getNodeService().addAspect(fileNodeRef, ContentModel.ASPECT_AUTHOR, authorProps); + } + + // apply the titled aspect - title and description + Map titledProps = new HashMap(2, 1.0f); + titledProps.put(ContentModel.PROP_TITLE, title); + titledProps.put(ContentModel.PROP_DESCRIPTION, description); + services.getNodeService().addAspect(fileNodeRef, ContentModel.ASPECT_TITLED, titledProps); + + // get a writer for the content and put the file + ContentWriter writer = services.getContentService().getWriter(fileNodeRef, ContentModel.PROP_CONTENT, true); + writer.setMimetype(mimetype); + writer.setEncoding(encoding); + writer.putContent(file); + } + } + } + catch (Exception e) + { + returnPage = returnPage.replace("${UPLOAD_ERROR}", e.getMessage()); + } + finally + { + if(file != null) + { + logger.debug("delete temporary file:" + file.getPath()); + // Delete the temporary file + file.delete(); + } + } + + Document result = XMLUtil.newDocument(); + Element htmlEl = result.createElement("html"); + result.appendChild(htmlEl); + Element bodyEl = result.createElement("body"); + htmlEl.appendChild(bodyEl); + + Element scriptEl = result.createElement("script"); + bodyEl.appendChild(scriptEl); + scriptEl.setAttribute("type", "text/javascript"); + Node scriptText = result.createTextNode(returnPage); + scriptEl.appendChild(scriptText); + + if (logger.isDebugEnabled()) + { + logger.debug("File upload request complete."); + } + ResponseWriter out = fc.getResponseWriter(); + XMLUtil.print(result, out); + } + + static NodeRef pathToNodeRef(FacesContext fc, String path) + { + // convert cm:name based path to a NodeRef + StringTokenizer t = new StringTokenizer(path, "/"); + int tokenCount = t.countTokens(); + String[] elements = new String[tokenCount]; + for (int i=0; i requestMap = fc.getExternalContext().getRequestParameterMap(); - String path = (String)requestMap.get("path"); - String name = (String)requestMap.get("name"); - String title = (String)requestMap.get("title"); - String description = (String)requestMap.get("description"); - - if (logger.isDebugEnabled()) - logger.debug("MySpacesBean.createSpace() path=" + path + " name=" + name + - " title=" + title + " description=" + description); - - try - { - if (path != null && name != null) - { - NodeRef containerRef = FileUploadBean.pathToNodeRef(fc, path); - if (containerRef != null) - { - NodeService nodeService = Repository.getServiceRegistry(fc).getNodeService(); - FileFolderService ffService = Repository.getServiceRegistry(fc).getFileFolderService(); - FileInfo folderInfo = ffService.create(containerRef, name, ContentModel.TYPE_FOLDER); - if (logger.isDebugEnabled()) - logger.debug("Created new folder: " + folderInfo.getNodeRef().toString()); - - // apply the uifacets aspect - icon, title and description properties - Map uiFacetsProps = new HashMap(4, 1.0f); - uiFacetsProps.put(ApplicationModel.PROP_ICON, CreateSpaceWizard.DEFAULT_SPACE_ICON_NAME); - uiFacetsProps.put(ContentModel.PROP_TITLE, title); - uiFacetsProps.put(ContentModel.PROP_DESCRIPTION, description); - nodeService.addAspect(folderInfo.getNodeRef(), ApplicationModel.ASPECT_UIFACETS, uiFacetsProps); - - out.write("OK: " + folderInfo.getNodeRef().toString()); - } - } - } - catch (FileExistsException ferr) - { - out.write("ERROR: A file with that name already exists."); - } - catch (Throwable err) - { - out.write("ERROR: " + err.getMessage()); - } - } -} +package org.alfresco.web.bean.ajax; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.service.cmr.model.FileExistsException; +import org.alfresco.service.cmr.model.FileFolderService; +import org.alfresco.service.cmr.model.FileInfo; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.servlet.ajax.InvokeCommand; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.spaces.CreateSpaceWizard; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean backing the ajax requests from the MySpaces portlet webscript. + * + * @author Kevin Roast + */ +public class MySpacesBean implements Serializable +{ + private static final long serialVersionUID = -5684182834188359483L; + + private static Log logger = LogFactory.getLog(MySpacesBean.class); + + @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) + public void createSpace() throws Exception + { + FacesContext fc = FacesContext.getCurrentInstance(); + ResponseWriter out = fc.getResponseWriter(); + + Map requestMap = fc.getExternalContext().getRequestParameterMap(); + String path = (String)requestMap.get("path"); + String name = (String)requestMap.get("name"); + String title = (String)requestMap.get("title"); + String description = (String)requestMap.get("description"); + + if (logger.isDebugEnabled()) + logger.debug("MySpacesBean.createSpace() path=" + path + " name=" + name + + " title=" + title + " description=" + description); + + try + { + if (path != null && name != null) + { + NodeRef containerRef = FileUploadBean.pathToNodeRef(fc, path); + if (containerRef != null) + { + NodeService nodeService = Repository.getServiceRegistry(fc).getNodeService(); + FileFolderService ffService = Repository.getServiceRegistry(fc).getFileFolderService(); + FileInfo folderInfo = ffService.create(containerRef, name, ContentModel.TYPE_FOLDER); + if (logger.isDebugEnabled()) + logger.debug("Created new folder: " + folderInfo.getNodeRef().toString()); + + // apply the uifacets aspect - icon, title and description properties + Map uiFacetsProps = new HashMap(4, 1.0f); + uiFacetsProps.put(ApplicationModel.PROP_ICON, CreateSpaceWizard.DEFAULT_SPACE_ICON_NAME); + uiFacetsProps.put(ContentModel.PROP_TITLE, title); + uiFacetsProps.put(ContentModel.PROP_DESCRIPTION, description); + nodeService.addAspect(folderInfo.getNodeRef(), ApplicationModel.ASPECT_UIFACETS, uiFacetsProps); + + out.write("OK: " + folderInfo.getNodeRef().toString()); + } + } + } + catch (FileExistsException ferr) + { + out.write("ERROR: A file with that name already exists."); + } + catch (Throwable err) + { + out.write("ERROR: " + err.getMessage()); + } + } +} diff --git a/source/java/org/alfresco/web/bean/ajax/NodeInfoBean.java b/source/java/org/alfresco/web/bean/ajax/NodeInfoBean.java index 714e23134c..b10272464f 100644 --- a/source/java/org/alfresco/web/bean/ajax/NodeInfoBean.java +++ b/source/java/org/alfresco/web/bean/ajax/NodeInfoBean.java @@ -1,160 +1,160 @@ -package org.alfresco.web.bean.ajax; - -import java.io.IOException; -import java.io.Serializable; -import java.util.Date; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.springframework.extensions.surf.util.I18NUtil; -import org.alfresco.repo.content.transform.TransformerInfoException; -import org.alfresco.repo.template.I18NMessageMethod; -import org.alfresco.repo.template.TemplateNode; -import org.alfresco.repo.web.scripts.FileTypeImageUtils; -import org.alfresco.service.cmr.repository.ContentIOException; -import org.alfresco.service.cmr.repository.FileTypeImageSize; -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.web.app.servlet.BaseTemplateContentServlet; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean used by an AJAX control to send information back on the - * requested node. - * - * @author gavinc - */ -public class NodeInfoBean implements Serializable -{ - private static final long serialVersionUID = 137294178658919187L; - - transient private NodeService nodeService; - - private static final Log logger = LogFactory.getLog(NodeInfoBean.class); - - /** - * Returns information on the node identified by the 'noderef' - * parameter found in the ExternalContext. If no noderef is supplied, then the template - * is executed without context. - *

- * The result is the formatted HTML to show on the client. - */ - public void sendNodeInfo() throws IOException - { - FacesContext context = FacesContext.getCurrentInstance(); - ResponseWriter out = context.getResponseWriter(); - - Map requestMap = context.getExternalContext().getRequestParameterMap(); - String strNodeRef = (String)requestMap.get("noderef"); - String strTemplate = (String)requestMap.get("template"); - if (strTemplate == null || strTemplate.length() == 0) - { - strTemplate = "node_summary_panel.ftl"; - } - - NodeRef nodeRef = null; - if (strNodeRef != null && strNodeRef.length() != 0) - { - nodeRef = new NodeRef(strNodeRef); - if (this.getNodeService().exists(nodeRef) == false) - { - out.write("Node could not be found in the repository!"); - return; - } - } - try - { - Repository.getServiceRegistry(context).getTemplateService().processTemplate( - "/alfresco/templates/client/" + strTemplate, getModel(nodeRef, requestMap), out); - } - catch (TemplateException ex) - { - // Try to catch TransformerInfoException to display it in NodeInfo pane. - // Fix bug reported in https://issues.alfresco.com/jira/browse/ETWOTWO-440 - Throwable cause = ex.getCause(); - while (cause != null) - { - cause = cause.getCause(); - if (cause instanceof TransformerInfoException) - { - out.write("" + cause.getMessage() + ""); - return; - } - } - - throw ex; - } - } - - - // ------------------------------------------------------------------------------ - // Bean getters and setters - - /** - * @param nodeService The NodeService to set. - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - private NodeService getNodeService() - { - if (nodeService == null) - { - nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return nodeService; - } - - - // ------------------------------------------------------------------------------ - // Helper methods - - private Map getModel(NodeRef nodeRef, Map requestMap) throws ContentIOException - { - FacesContext context = FacesContext.getCurrentInstance(); - Map model = new HashMap(8, 1.0f); - - I18NUtil.registerResourceBundle("alfresco.messages.webclient"); - // create api methods - model.put("date", new Date()); - model.put("msg", new I18NMessageMethod()); - model.put("url", new BaseTemplateContentServlet.URLHelper(context)); - model.put("locale", I18NUtil.getLocale()); - if (nodeRef != null) - { - model.put("node", new TemplateNode( - nodeRef, - Repository.getServiceRegistry(context), - this.imageResolver)); - } - - // add URL arguments as a map called 'args' to the root of the model - Map args = new HashMap(4, 1.0f); - for (String name : requestMap.keySet()) - { - args.put(name, requestMap.get(name)); - } - model.put("args", args); - - return model; - } - - /** Template Image resolver helper */ - private TemplateImageResolver imageResolver = new TemplateImageResolver() - { - public String resolveImagePathForName(String filename, FileTypeImageSize size) - { - return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); - } - }; - -} +package org.alfresco.web.bean.ajax; + +import java.io.IOException; +import java.io.Serializable; +import java.util.Date; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.springframework.extensions.surf.util.I18NUtil; +import org.alfresco.repo.content.transform.TransformerInfoException; +import org.alfresco.repo.template.I18NMessageMethod; +import org.alfresco.repo.template.TemplateNode; +import org.alfresco.repo.web.scripts.FileTypeImageUtils; +import org.alfresco.service.cmr.repository.ContentIOException; +import org.alfresco.service.cmr.repository.FileTypeImageSize; +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.web.app.servlet.BaseTemplateContentServlet; +import org.alfresco.web.bean.repository.Repository; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean used by an AJAX control to send information back on the + * requested node. + * + * @author gavinc + */ +public class NodeInfoBean implements Serializable +{ + private static final long serialVersionUID = 137294178658919187L; + + transient private NodeService nodeService; + + private static final Log logger = LogFactory.getLog(NodeInfoBean.class); + + /** + * Returns information on the node identified by the 'noderef' + * parameter found in the ExternalContext. If no noderef is supplied, then the template + * is executed without context. + *

+ * The result is the formatted HTML to show on the client. + */ + public void sendNodeInfo() throws IOException + { + FacesContext context = FacesContext.getCurrentInstance(); + ResponseWriter out = context.getResponseWriter(); + + Map requestMap = context.getExternalContext().getRequestParameterMap(); + String strNodeRef = (String)requestMap.get("noderef"); + String strTemplate = (String)requestMap.get("template"); + if (strTemplate == null || strTemplate.length() == 0) + { + strTemplate = "node_summary_panel.ftl"; + } + + NodeRef nodeRef = null; + if (strNodeRef != null && strNodeRef.length() != 0) + { + nodeRef = new NodeRef(strNodeRef); + if (this.getNodeService().exists(nodeRef) == false) + { + out.write("Node could not be found in the repository!"); + return; + } + } + try + { + Repository.getServiceRegistry(context).getTemplateService().processTemplate( + "/alfresco/templates/client/" + strTemplate, getModel(nodeRef, requestMap), out); + } + catch (TemplateException ex) + { + // Try to catch TransformerInfoException to display it in NodeInfo pane. + // Fix bug reported in https://issues.alfresco.com/jira/browse/ETWOTWO-440 + Throwable cause = ex.getCause(); + while (cause != null) + { + cause = cause.getCause(); + if (cause instanceof TransformerInfoException) + { + out.write("" + cause.getMessage() + ""); + return; + } + } + + throw ex; + } + } + + + // ------------------------------------------------------------------------------ + // Bean getters and setters + + /** + * @param nodeService The NodeService to set. + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + private NodeService getNodeService() + { + if (nodeService == null) + { + nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return nodeService; + } + + + // ------------------------------------------------------------------------------ + // Helper methods + + private Map getModel(NodeRef nodeRef, Map requestMap) throws ContentIOException + { + FacesContext context = FacesContext.getCurrentInstance(); + Map model = new HashMap(8, 1.0f); + + I18NUtil.registerResourceBundle("alfresco.messages.webclient"); + // create api methods + model.put("date", new Date()); + model.put("msg", new I18NMessageMethod()); + model.put("url", new BaseTemplateContentServlet.URLHelper(context)); + model.put("locale", I18NUtil.getLocale()); + if (nodeRef != null) + { + model.put("node", new TemplateNode( + nodeRef, + Repository.getServiceRegistry(context), + this.imageResolver)); + } + + // add URL arguments as a map called 'args' to the root of the model + Map args = new HashMap(4, 1.0f); + for (String name : requestMap.keySet()) + { + args.put(name, requestMap.get(name)); + } + model.put("args", args); + + return model; + } + + /** Template Image resolver helper */ + private TemplateImageResolver imageResolver = new TemplateImageResolver() + { + public String resolveImagePathForName(String filename, FileTypeImageSize size) + { + return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); + } + }; + +} diff --git a/source/java/org/alfresco/web/bean/ajax/PortletActionsBean.java b/source/java/org/alfresco/web/bean/ajax/PortletActionsBean.java index 9860d417d3..40b5c8b01f 100644 --- a/source/java/org/alfresco/web/bean/ajax/PortletActionsBean.java +++ b/source/java/org/alfresco/web/bean/ajax/PortletActionsBean.java @@ -1,99 +1,99 @@ -package org.alfresco.web.bean.ajax; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.version.VersionModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.version.Version; -import org.alfresco.service.cmr.version.VersionType; -import org.alfresco.web.app.servlet.ajax.InvokeCommand; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean backing the ajax requests from various Portlet webscripts. - * - * @author Mike Hatfield - */ -public class PortletActionsBean implements Serializable -{ - private static final long serialVersionUID = -8230154592621310289L; - - private static Log logger = LogFactory.getLog(PortletActionsBean.class); - - @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) - public void deleteItem() throws Exception - { - FacesContext fc = FacesContext.getCurrentInstance(); - ResponseWriter out = fc.getResponseWriter(); - - Map requestMap = fc.getExternalContext().getRequestParameterMap(); - String strNodeRef = (String)requestMap.get("noderef"); - if (strNodeRef != null && strNodeRef.length() != 0) - { - try - { - Repository.getServiceRegistry(fc).getFileFolderService().delete(new NodeRef(strNodeRef)); - out.write("OK: " + strNodeRef); - } - catch (Throwable err) - { - out.write("ERROR: " + err.getMessage()); - } - } - } - - @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) - public void checkoutItem() throws Exception - { - FacesContext fc = FacesContext.getCurrentInstance(); - ResponseWriter out = fc.getResponseWriter(); - - Map requestMap = fc.getExternalContext().getRequestParameterMap(); - String strNodeRef = (String)requestMap.get("noderef"); - if (strNodeRef != null && strNodeRef.length() != 0) - { - try - { - Repository.getServiceRegistry(fc).getCheckOutCheckInService().checkout(new NodeRef(strNodeRef)); - out.write("OK: " + strNodeRef); - } - catch (Throwable err) - { - out.write("ERROR: " + err.getMessage()); - } - } - } - - @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) - public void checkinItem() throws Exception - { - FacesContext fc = FacesContext.getCurrentInstance(); - ResponseWriter out = fc.getResponseWriter(); - - Map requestMap = fc.getExternalContext().getRequestParameterMap(); - String strNodeRef = (String)requestMap.get("noderef"); - if (strNodeRef != null && strNodeRef.length() != 0) - { - try - { - Map props = new HashMap(2, 1.0f); - props.put(Version.PROP_DESCRIPTION, ""); - props.put(VersionModel.PROP_VERSION_TYPE, VersionType.MINOR); - Repository.getServiceRegistry(fc).getCheckOutCheckInService().checkin(new NodeRef(strNodeRef), props); - out.write("OK: " + strNodeRef); - } - catch (Throwable err) - { - out.write("ERROR: " + err.getMessage()); - } - } - } +package org.alfresco.web.bean.ajax; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.version.VersionModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.version.Version; +import org.alfresco.service.cmr.version.VersionType; +import org.alfresco.web.app.servlet.ajax.InvokeCommand; +import org.alfresco.web.bean.repository.Repository; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean backing the ajax requests from various Portlet webscripts. + * + * @author Mike Hatfield + */ +public class PortletActionsBean implements Serializable +{ + private static final long serialVersionUID = -8230154592621310289L; + + private static Log logger = LogFactory.getLog(PortletActionsBean.class); + + @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) + public void deleteItem() throws Exception + { + FacesContext fc = FacesContext.getCurrentInstance(); + ResponseWriter out = fc.getResponseWriter(); + + Map requestMap = fc.getExternalContext().getRequestParameterMap(); + String strNodeRef = (String)requestMap.get("noderef"); + if (strNodeRef != null && strNodeRef.length() != 0) + { + try + { + Repository.getServiceRegistry(fc).getFileFolderService().delete(new NodeRef(strNodeRef)); + out.write("OK: " + strNodeRef); + } + catch (Throwable err) + { + out.write("ERROR: " + err.getMessage()); + } + } + } + + @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) + public void checkoutItem() throws Exception + { + FacesContext fc = FacesContext.getCurrentInstance(); + ResponseWriter out = fc.getResponseWriter(); + + Map requestMap = fc.getExternalContext().getRequestParameterMap(); + String strNodeRef = (String)requestMap.get("noderef"); + if (strNodeRef != null && strNodeRef.length() != 0) + { + try + { + Repository.getServiceRegistry(fc).getCheckOutCheckInService().checkout(new NodeRef(strNodeRef)); + out.write("OK: " + strNodeRef); + } + catch (Throwable err) + { + out.write("ERROR: " + err.getMessage()); + } + } + } + + @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) + public void checkinItem() throws Exception + { + FacesContext fc = FacesContext.getCurrentInstance(); + ResponseWriter out = fc.getResponseWriter(); + + Map requestMap = fc.getExternalContext().getRequestParameterMap(); + String strNodeRef = (String)requestMap.get("noderef"); + if (strNodeRef != null && strNodeRef.length() != 0) + { + try + { + Map props = new HashMap(2, 1.0f); + props.put(Version.PROP_DESCRIPTION, ""); + props.put(VersionModel.PROP_VERSION_TYPE, VersionType.MINOR); + Repository.getServiceRegistry(fc).getCheckOutCheckInService().checkin(new NodeRef(strNodeRef), props); + out.write("OK: " + strNodeRef); + } + catch (Throwable err) + { + out.write("ERROR: " + err.getMessage()); + } + } + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/bean/ajax/PresenceProxyBean.java b/source/java/org/alfresco/web/bean/ajax/PresenceProxyBean.java index 40bcb27505..e9c95a253d 100644 --- a/source/java/org/alfresco/web/bean/ajax/PresenceProxyBean.java +++ b/source/java/org/alfresco/web/bean/ajax/PresenceProxyBean.java @@ -1,90 +1,90 @@ -package org.alfresco.web.bean.ajax; - -import java.io.IOException; -import java.io.Serializable; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.web.app.servlet.ajax.InvokeCommand; -import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler; -import org.apache.commons.httpclient.HttpClient; -import org.apache.commons.httpclient.HttpException; -import org.apache.commons.httpclient.HttpMethod; -import org.apache.commons.httpclient.HttpStatus; -import org.apache.commons.httpclient.methods.GetMethod; -import org.apache.commons.httpclient.params.HttpMethodParams; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean which proxies requests to online presence servers. - * - * @author Mike Hatfield - */ -public class PresenceProxyBean implements Serializable -{ - private static final long serialVersionUID = -3041576848188629589L; - - private static Log logger = LogFactory.getLog(PresenceProxyBean.class); - - @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) - public void proxyRequest() throws Exception - { - FacesContext fc = FacesContext.getCurrentInstance(); - ResponseWriter out = fc.getResponseWriter(); - - Map requestMap = fc.getExternalContext().getRequestParameterMap(); - String url = (String)requestMap.get("url"); - - if (logger.isDebugEnabled()) - logger.debug("PresenceProxyBean.proxyRequest() url=" + url); - - if (url != null) - { - String response = getUrlResponse(url); - out.write(response); - } - } - - /** - * Perform request - */ - public String getUrlResponse(String requestUrl) - { - String response = ""; - HttpClient client = new HttpClient(); - HttpMethod method = new GetMethod(requestUrl); - method.setRequestHeader("Accept", "*/*"); - client.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, new DefaultHttpMethodRetryHandler()); - try - { - int statusCode = client.executeMethod(method); - if (statusCode == HttpStatus.SC_OK) - { - response = method.getResponseBodyAsString(); - } - else - { - response = method.getStatusText(); - } - } - catch (HttpException e) - { - response = e.getMessage(); - } - catch (IOException e) - { - response = e.getMessage(); - } - finally - { - // Release the connection. - method.releaseConnection(); - } - - return response; - } -} +package org.alfresco.web.bean.ajax; + +import java.io.IOException; +import java.io.Serializable; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.web.app.servlet.ajax.InvokeCommand; +import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler; +import org.apache.commons.httpclient.HttpClient; +import org.apache.commons.httpclient.HttpException; +import org.apache.commons.httpclient.HttpMethod; +import org.apache.commons.httpclient.HttpStatus; +import org.apache.commons.httpclient.methods.GetMethod; +import org.apache.commons.httpclient.params.HttpMethodParams; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean which proxies requests to online presence servers. + * + * @author Mike Hatfield + */ +public class PresenceProxyBean implements Serializable +{ + private static final long serialVersionUID = -3041576848188629589L; + + private static Log logger = LogFactory.getLog(PresenceProxyBean.class); + + @InvokeCommand.ResponseMimetype(value=MimetypeMap.MIMETYPE_HTML) + public void proxyRequest() throws Exception + { + FacesContext fc = FacesContext.getCurrentInstance(); + ResponseWriter out = fc.getResponseWriter(); + + Map requestMap = fc.getExternalContext().getRequestParameterMap(); + String url = (String)requestMap.get("url"); + + if (logger.isDebugEnabled()) + logger.debug("PresenceProxyBean.proxyRequest() url=" + url); + + if (url != null) + { + String response = getUrlResponse(url); + out.write(response); + } + } + + /** + * Perform request + */ + public String getUrlResponse(String requestUrl) + { + String response = ""; + HttpClient client = new HttpClient(); + HttpMethod method = new GetMethod(requestUrl); + method.setRequestHeader("Accept", "*/*"); + client.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, new DefaultHttpMethodRetryHandler()); + try + { + int statusCode = client.executeMethod(method); + if (statusCode == HttpStatus.SC_OK) + { + response = method.getResponseBodyAsString(); + } + else + { + response = method.getStatusText(); + } + } + catch (HttpException e) + { + response = e.getMessage(); + } + catch (IOException e) + { + response = e.getMessage(); + } + finally + { + // Release the connection. + method.releaseConnection(); + } + + return response; + } +} diff --git a/source/java/org/alfresco/web/bean/ajax/TaskInfoBean.java b/source/java/org/alfresco/web/bean/ajax/TaskInfoBean.java index 4aaeb1ecc3..fce81f56f6 100644 --- a/source/java/org/alfresco/web/bean/ajax/TaskInfoBean.java +++ b/source/java/org/alfresco/web/bean/ajax/TaskInfoBean.java @@ -1,144 +1,144 @@ -package org.alfresco.web.bean.ajax; - -import java.io.IOException; -import java.io.Serializable; -import java.util.Date; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.repo.template.I18NMessageMethod; -import org.alfresco.repo.template.Workflow; -import org.alfresco.repo.web.scripts.FileTypeImageUtils; -import org.alfresco.service.cmr.repository.FileTypeImageSize; -import org.alfresco.service.cmr.repository.TemplateImageResolver; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.web.app.servlet.BaseTemplateContentServlet; -import org.alfresco.web.bean.repository.Repository; -import org.springframework.extensions.surf.util.I18NUtil; - -/** - * Bean used by an AJAX control to send information back on the requested workflow task. - * - * @author Kevin Roast - */ -public class TaskInfoBean implements Serializable -{ - private static final long serialVersionUID = -6627537519541525897L; - - transient private WorkflowService workflowService; - - /** - * Returns information for the workflow task identified by the 'taskId' - * parameter found in the ExternalContext. - *

- * The result is the formatted HTML to show on the client. - */ - public void sendTaskInfo() throws IOException - { - FacesContext context = FacesContext.getCurrentInstance(); - ResponseWriter out = context.getResponseWriter(); - - String taskId = (String)context.getExternalContext().getRequestParameterMap().get("taskId"); - if (taskId == null || taskId.length() == 0) - { - throw new IllegalArgumentException("'taskId' parameter is missing"); - } - - WorkflowTask task = this.getWorkflowService().getTaskById(taskId); - if (task != null) - { - Repository.getServiceRegistry(context).getTemplateService().processTemplate( - "/alfresco/templates/client/task_summary_panel.ftl", getModel(task), out); - } - else - { - out.write("Task could not be found."); - } - } - - /** - * Returns the resource list for the workflow task identified by the 'taskId' - * parameter found in the ExternalContext. - *

- * The result is the formatted HTML to show on the client. - */ - public void sendTaskResources() throws IOException - { - FacesContext context = FacesContext.getCurrentInstance(); - ResponseWriter out = context.getResponseWriter(); - - String taskId = (String)context.getExternalContext().getRequestParameterMap().get("taskId"); - if (taskId == null || taskId.length() == 0) - { - throw new IllegalArgumentException("'taskId' parameter is missing"); - } - - WorkflowTask task = this.getWorkflowService().getTaskById(taskId); - if (task != null) - { - Repository.getServiceRegistry(context).getTemplateService().processTemplate( - "/alfresco/templates/client/task_resource_panel.ftl", getModel(task), out); - } - else - { - out.write("Task could not be found."); - } - } - - - // ------------------------------------------------------------------------------ - // Bean getters and setters - - /** - * @param workflowService The WorkflowService to set. - */ - public void setWorkflowService(WorkflowService workflowService) - { - this.workflowService = workflowService; - } - - private WorkflowService getWorkflowService() - { - if (workflowService == null) - { - workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); - } - return workflowService; - } - - - // ------------------------------------------------------------------------------ - // Helper methods - - private Map getModel(WorkflowTask task) - { - FacesContext context = FacesContext.getCurrentInstance(); - Map model = new HashMap(8, 1.0f); - - I18NUtil.registerResourceBundle("alfresco.messages.webclient"); - // create template api methods and objects - model.put("date", new Date()); - model.put("msg", new I18NMessageMethod()); - model.put("url", new BaseTemplateContentServlet.URLHelper(context)); - model.put("locale", I18NUtil.getLocale()); - model.put("task", new Workflow.WorkflowTaskItem( - Repository.getServiceRegistry(context), - this.imageResolver, - task)); - - return model; - } - - /** Template Image resolver helper */ - private TemplateImageResolver imageResolver = new TemplateImageResolver() - { - public String resolveImagePathForName(String filename, FileTypeImageSize size) - { - return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); - } - }; -} +package org.alfresco.web.bean.ajax; + +import java.io.IOException; +import java.io.Serializable; +import java.util.Date; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.repo.template.I18NMessageMethod; +import org.alfresco.repo.template.Workflow; +import org.alfresco.repo.web.scripts.FileTypeImageUtils; +import org.alfresco.service.cmr.repository.FileTypeImageSize; +import org.alfresco.service.cmr.repository.TemplateImageResolver; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.web.app.servlet.BaseTemplateContentServlet; +import org.alfresco.web.bean.repository.Repository; +import org.springframework.extensions.surf.util.I18NUtil; + +/** + * Bean used by an AJAX control to send information back on the requested workflow task. + * + * @author Kevin Roast + */ +public class TaskInfoBean implements Serializable +{ + private static final long serialVersionUID = -6627537519541525897L; + + transient private WorkflowService workflowService; + + /** + * Returns information for the workflow task identified by the 'taskId' + * parameter found in the ExternalContext. + *

+ * The result is the formatted HTML to show on the client. + */ + public void sendTaskInfo() throws IOException + { + FacesContext context = FacesContext.getCurrentInstance(); + ResponseWriter out = context.getResponseWriter(); + + String taskId = (String)context.getExternalContext().getRequestParameterMap().get("taskId"); + if (taskId == null || taskId.length() == 0) + { + throw new IllegalArgumentException("'taskId' parameter is missing"); + } + + WorkflowTask task = this.getWorkflowService().getTaskById(taskId); + if (task != null) + { + Repository.getServiceRegistry(context).getTemplateService().processTemplate( + "/alfresco/templates/client/task_summary_panel.ftl", getModel(task), out); + } + else + { + out.write("Task could not be found."); + } + } + + /** + * Returns the resource list for the workflow task identified by the 'taskId' + * parameter found in the ExternalContext. + *

+ * The result is the formatted HTML to show on the client. + */ + public void sendTaskResources() throws IOException + { + FacesContext context = FacesContext.getCurrentInstance(); + ResponseWriter out = context.getResponseWriter(); + + String taskId = (String)context.getExternalContext().getRequestParameterMap().get("taskId"); + if (taskId == null || taskId.length() == 0) + { + throw new IllegalArgumentException("'taskId' parameter is missing"); + } + + WorkflowTask task = this.getWorkflowService().getTaskById(taskId); + if (task != null) + { + Repository.getServiceRegistry(context).getTemplateService().processTemplate( + "/alfresco/templates/client/task_resource_panel.ftl", getModel(task), out); + } + else + { + out.write("Task could not be found."); + } + } + + + // ------------------------------------------------------------------------------ + // Bean getters and setters + + /** + * @param workflowService The WorkflowService to set. + */ + public void setWorkflowService(WorkflowService workflowService) + { + this.workflowService = workflowService; + } + + private WorkflowService getWorkflowService() + { + if (workflowService == null) + { + workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); + } + return workflowService; + } + + + // ------------------------------------------------------------------------------ + // Helper methods + + private Map getModel(WorkflowTask task) + { + FacesContext context = FacesContext.getCurrentInstance(); + Map model = new HashMap(8, 1.0f); + + I18NUtil.registerResourceBundle("alfresco.messages.webclient"); + // create template api methods and objects + model.put("date", new Date()); + model.put("msg", new I18NMessageMethod()); + model.put("url", new BaseTemplateContentServlet.URLHelper(context)); + model.put("locale", I18NUtil.getLocale()); + model.put("task", new Workflow.WorkflowTaskItem( + Repository.getServiceRegistry(context), + this.imageResolver, + task)); + + return model; + } + + /** Template Image resolver helper */ + private TemplateImageResolver imageResolver = new TemplateImageResolver() + { + public String resolveImagePathForName(String filename, FileTypeImageSize size) + { + return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); + } + }; +} diff --git a/source/java/org/alfresco/web/bean/categories/CreateCategoryDialog.java b/source/java/org/alfresco/web/bean/categories/CreateCategoryDialog.java index 0ae604bb87..e4c3107fd4 100644 --- a/source/java/org/alfresco/web/bean/categories/CreateCategoryDialog.java +++ b/source/java/org/alfresco/web/bean/categories/CreateCategoryDialog.java @@ -1,166 +1,166 @@ -package org.alfresco.web.bean.categories; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.search.CategoryService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class CreateCategoryDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 1905920932992642119L; - - private static final String DEFAULT_OUTCOME = "finish"; - - transient protected CategoryService categoryService; - - /** Current category ref */ - private NodeRef categoryRef = null; - - /** Dialog properties */ - private String name = null; - private String description = null; - - @Override - public void init(Map parameters) - { - this.isFinished = false; - - // retrieve parameters - String ref = parameters.get(CategoriesDialog.PARAM_CATEGORY_REF); - - this.name = null; - this.description = null; - - if (ref != null) - { - categoryRef = new NodeRef(ref); - } - else - { - categoryRef = null; - } - } - - /** - * @return the categoryService - */ - private CategoryService getCategoryService() - { - //check for null in cluster environment - if(categoryService == null) - { - categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); - } - return categoryService; - } - - public void setCategoryService(CategoryService categoryService) - { - this.categoryService = categoryService; - } - - public NodeRef getCategoryRef() - { - return categoryRef; - } - - public void setCategoryRef(NodeRef categoryRef) - { - this.categoryRef = categoryRef; - } - - public String getName() - { - return name; - } - - public void setName(String name) - { - this.name = name; - } - - public String getDescription() - { - return description; - } - - public void setDescription(String description) - { - this.description = description; - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - finishCreate(); - return outcome; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "new_category"); - } - - public String finishCreate() - { - String outcome = DEFAULT_OUTCOME; - - try - { - FacesContext context = FacesContext.getCurrentInstance(); - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // create category using categoryservice - NodeRef ref; - if (getCategoryRef() == null || getCategoryRef().getId().equals("null")) - { - ref = getCategoryService().createRootCategory(Repository.getStoreRef(), ContentModel.ASPECT_GEN_CLASSIFIABLE, getName()); - } - else - { - ref = getCategoryService().createCategory(getCategoryRef(), getName()); - } - - // apply the titled aspect - for description - Map titledProps = new HashMap(1, 1.0f); - titledProps.put(ContentModel.PROP_DESCRIPTION, getDescription()); - getNodeService().addAspect(ref, ContentModel.ASPECT_TITLED, titledProps); - return null; - } - }; - txnHelper.doInTransaction(callback); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); - outcome = null; - ReportedException.throwIfNecessary(err); - } - - return outcome; - } -} +package org.alfresco.web.bean.categories; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.search.CategoryService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class CreateCategoryDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 1905920932992642119L; + + private static final String DEFAULT_OUTCOME = "finish"; + + transient protected CategoryService categoryService; + + /** Current category ref */ + private NodeRef categoryRef = null; + + /** Dialog properties */ + private String name = null; + private String description = null; + + @Override + public void init(Map parameters) + { + this.isFinished = false; + + // retrieve parameters + String ref = parameters.get(CategoriesDialog.PARAM_CATEGORY_REF); + + this.name = null; + this.description = null; + + if (ref != null) + { + categoryRef = new NodeRef(ref); + } + else + { + categoryRef = null; + } + } + + /** + * @return the categoryService + */ + private CategoryService getCategoryService() + { + //check for null in cluster environment + if(categoryService == null) + { + categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); + } + return categoryService; + } + + public void setCategoryService(CategoryService categoryService) + { + this.categoryService = categoryService; + } + + public NodeRef getCategoryRef() + { + return categoryRef; + } + + public void setCategoryRef(NodeRef categoryRef) + { + this.categoryRef = categoryRef; + } + + public String getName() + { + return name; + } + + public void setName(String name) + { + this.name = name; + } + + public String getDescription() + { + return description; + } + + public void setDescription(String description) + { + this.description = description; + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + finishCreate(); + return outcome; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "new_category"); + } + + public String finishCreate() + { + String outcome = DEFAULT_OUTCOME; + + try + { + FacesContext context = FacesContext.getCurrentInstance(); + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // create category using categoryservice + NodeRef ref; + if (getCategoryRef() == null || getCategoryRef().getId().equals("null")) + { + ref = getCategoryService().createRootCategory(Repository.getStoreRef(), ContentModel.ASPECT_GEN_CLASSIFIABLE, getName()); + } + else + { + ref = getCategoryService().createCategory(getCategoryRef(), getName()); + } + + // apply the titled aspect - for description + Map titledProps = new HashMap(1, 1.0f); + titledProps.put(ContentModel.PROP_DESCRIPTION, getDescription()); + getNodeService().addAspect(ref, ContentModel.ASPECT_TITLED, titledProps); + return null; + } + }; + txnHelper.doInTransaction(callback); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); + outcome = null; + ReportedException.throwIfNecessary(err); + } + + return outcome; + } +} diff --git a/source/java/org/alfresco/web/bean/categories/DeleteCategoryDialog.java b/source/java/org/alfresco/web/bean/categories/DeleteCategoryDialog.java index b1c454be40..db6b3e13b5 100644 --- a/source/java/org/alfresco/web/bean/categories/DeleteCategoryDialog.java +++ b/source/java/org/alfresco/web/bean/categories/DeleteCategoryDialog.java @@ -1,395 +1,395 @@ -package org.alfresco.web.bean.categories; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.search.CategoryService; -import org.alfresco.service.cmr.search.CategoryService.Depth; -import org.alfresco.service.cmr.search.CategoryService.Mode; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.bean.categories.CategoriesDialog.CategoryBreadcrumbHandler; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.IBreadcrumbHandler; -import org.alfresco.web.ui.common.component.data.UIRichList; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.extensions.surf.util.ParameterCheck; - -public class DeleteCategoryDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -8929785826091612856L; - - private static Log logger = LogFactory.getLog(DeleteCategoryDialog.class); - - private static final String DEFAULT_OUTCOME = "finish"; - private final static String MSG_DELETE_CATEGORY = "delete_category"; - private final static String MSG_DELETE = "delete"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - private static final String MSG_CATEGORIES = "categories"; - - transient protected CategoryService categoryService; - - /** Dialog properties */ - private String name = null; - private String description = null; - - /** Category path breadcrumb location */ - private List location = null; - - /** Members of the linked items of a category */ - private Collection members = null; - - /** Current category ref */ - private NodeRef categoryRef = null; - - /** Action category node */ - private Node actionCategory = null; - - /** Component references */ - protected UIRichList categoriesRichList; - - /** Currently visible category Node */ - private Node category = null; - - private Boolean categoryFlag = false; - - - @Override - public void init(Map parameters) - { - this.isFinished = false; - this.categoryFlag = false; - - // retrieve parameters - String categoryRef = parameters.get(CategoriesDialog.PARAM_CATEGORY_REF); - - // make sure nodeRef was supplied - ParameterCheck.mandatoryString(CategoriesDialog.PARAM_CATEGORY_REF, categoryRef); - - // create the node - this.category = new Node(new NodeRef(categoryRef)); - - setActionCategory(category); - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - // add the category to the request object so it gets picked up by - // category dialog, this will allow it to be removed from the breadcrumb - context.getExternalContext().getRequestMap().put( - CategoriesDialog.KEY_CATEGORY, this.category.getName()); - context.getExternalContext().getRequestMap().put( - CategoriesDialog.KEY_CATEGORY_FLAG, this.categoryFlag.toString()); - - return outcome; - } - - public Collection getMembers() - { - return members; - } - - public void setMembers(Collection members) - { - this.members = members; - } - - public int getMembersSize() - { - return getMembers().size(); - } - - public String getName() - { - return name; - } - - public void setName(String name) - { - this.name = name; - } - - public String getDescription() - { - return description; - } - - public void setDescription(String description) - { - this.description = description; - } - - /** - * @return the categoryService - */ - private CategoryService getCategoryService() - { - //check for null in cluster environment - if(categoryService == null) - { - categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); - } - return categoryService; - } - - public void setCategoryService(CategoryService categoryService) - { - this.categoryService = categoryService; - } - - public NodeRef getCategoryRef() - { - return categoryRef; - } - - public void setCategoryRef(NodeRef categoryRef) - { - this.categoryRef = categoryRef; - } - - public Node getCategory() - { - return category; - } - - public void setCategory(Node category) - { - this.category = category; - } - - public Boolean getCategoryFlag() - { - return categoryFlag; - } - - public void setCategoryFlag(Boolean categoryFlag) - { - this.categoryFlag = categoryFlag; - } - - /** - * @param node Set the Node to be used for the current category screen action. - */ - @SuppressWarnings("unchecked") - public void setActionCategory(Node node) - { - this.actionCategory = node; - - if (node != null) - { - // setup form properties - setName(node.getName()); - setDescription((String)node.getProperties().get(ContentModel.PROP_DESCRIPTION)); - setMembers(getCategoryService().getChildren(node.getNodeRef(), Mode.MEMBERS, Depth.ANY)); - } - else - { - setName(null); - setDescription(null); - Object emptyCollection = Collections.emptyList(); - setMembers((Collection) emptyCollection); - } - } - - public Node getActionCategory() - { - return actionCategory; - } - - public void setLocation(List location) - { - this.location = location; - } - - /** - * @return Breadcrumb location list - */ - public List getLocation() - { - return this.location; - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - finishDelete(); - return outcome; - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_DELETE_CATEGORY) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + getActionCategory().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getFinishButtonLabel() - { - - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_DELETE); - } - - public UIRichList getCategoriesRichList() - { - return categoriesRichList; - } - - public void setCategoriesRichList(UIRichList categoriesRichList) - { - this.categoriesRichList = categoriesRichList; - } - - /** - * @see org.alfresco.web.app.context.IContextListener#contextUpdated() - */ - public void contextUpdated() - { - if (logger.isDebugEnabled()) - logger.debug("Invalidating Category Management Components..."); - - // force a requery of the current category ref properties - setCategory(null); - - // force a requery of the richlist dataset - if (this.categoriesRichList != null) - { - this.categoriesRichList.setValue(null); - } - - } - - /** - * @return The ID of the currently displayed category or null if at the root. - */ - public String getCurrentCategoryId() - { - if (getCategoryRef() != null) - { - return getCategoryRef().getId(); - } - else - { - return null; - } - } - - /** - * Set the current category node. - *

- * Setting this value causes the UI to update and display the specified node as current. - * - * @param ref The current category node. - */ - public void setCurrentCategory(NodeRef ref) - { - if (logger.isDebugEnabled()) - logger.debug("Setting current category: " + ref); - - // set the current NodeRef for our UI context operations - setCategoryRef(ref); - - // clear current node context - setCategory(null); - - // inform that the UI needs updating after this change - contextUpdated(); - } - - - public String finishDelete() - { - String outcome = DEFAULT_OUTCOME; - - if (getActionCategory() != null) - { - try - { - FacesContext context = FacesContext.getCurrentInstance(); - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - @SuppressWarnings("unchecked") - public NodeRef execute() throws Throwable - { - // delete the category node using the nodeservice - NodeRef categoryNodeRef = getActionCategory().getNodeRef(); - getCategoryService().deleteCategory(categoryNodeRef); - - // if there are other items in the repository using this category - // all the associations to the category should be removed too - if (getMembers() != null && getMembers().size() > 0) - { - for (ChildAssociationRef childRef : getMembers()) - { - List list = new ArrayList(getMembers().size()); - - NodeRef member = childRef.getChildRef(); - Collection categories = (Collection)getNodeService().getProperty(member, ContentModel.PROP_CATEGORIES); - - for (NodeRef category : categories) - { - if (category.equals(categoryNodeRef) == false) - { - list.add(category); - } - } - - // persist the list back to the repository - getNodeService().setProperty(member, ContentModel.PROP_CATEGORIES, (Serializable) list); - } - } - return categoryNodeRef; - } - }; - NodeRef categoryNodeRef = txnHelper.doInTransaction(callback); - - // Figure out if the deletion is made by an icon or by a list of actions - CategoriesDialog categoriesDialog = (CategoriesDialog) UIContextService.getInstance(FacesContext.getCurrentInstance()) - .getRegisteredBean(CategoriesDialog.CATEGORIES_DIALOG_CLASS_NAME); - setLocation(categoriesDialog.getLocation()); - List location = getLocation(); - CategoryBreadcrumbHandler handler = (CategoryBreadcrumbHandler) location.get(location.size() - 1); - setCategoryFlag(!handler.toString().equals(getCategory().getName())); - - // clear action context - setActionCategory(null); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); - outcome = null; - ReportedException.throwIfNecessary(err); - } - } - - return outcome; - } - -} +package org.alfresco.web.bean.categories; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.search.CategoryService; +import org.alfresco.service.cmr.search.CategoryService.Depth; +import org.alfresco.service.cmr.search.CategoryService.Mode; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.bean.categories.CategoriesDialog.CategoryBreadcrumbHandler; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.IBreadcrumbHandler; +import org.alfresco.web.ui.common.component.data.UIRichList; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.extensions.surf.util.ParameterCheck; + +public class DeleteCategoryDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -8929785826091612856L; + + private static Log logger = LogFactory.getLog(DeleteCategoryDialog.class); + + private static final String DEFAULT_OUTCOME = "finish"; + private final static String MSG_DELETE_CATEGORY = "delete_category"; + private final static String MSG_DELETE = "delete"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + private static final String MSG_CATEGORIES = "categories"; + + transient protected CategoryService categoryService; + + /** Dialog properties */ + private String name = null; + private String description = null; + + /** Category path breadcrumb location */ + private List location = null; + + /** Members of the linked items of a category */ + private Collection members = null; + + /** Current category ref */ + private NodeRef categoryRef = null; + + /** Action category node */ + private Node actionCategory = null; + + /** Component references */ + protected UIRichList categoriesRichList; + + /** Currently visible category Node */ + private Node category = null; + + private Boolean categoryFlag = false; + + + @Override + public void init(Map parameters) + { + this.isFinished = false; + this.categoryFlag = false; + + // retrieve parameters + String categoryRef = parameters.get(CategoriesDialog.PARAM_CATEGORY_REF); + + // make sure nodeRef was supplied + ParameterCheck.mandatoryString(CategoriesDialog.PARAM_CATEGORY_REF, categoryRef); + + // create the node + this.category = new Node(new NodeRef(categoryRef)); + + setActionCategory(category); + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + // add the category to the request object so it gets picked up by + // category dialog, this will allow it to be removed from the breadcrumb + context.getExternalContext().getRequestMap().put( + CategoriesDialog.KEY_CATEGORY, this.category.getName()); + context.getExternalContext().getRequestMap().put( + CategoriesDialog.KEY_CATEGORY_FLAG, this.categoryFlag.toString()); + + return outcome; + } + + public Collection getMembers() + { + return members; + } + + public void setMembers(Collection members) + { + this.members = members; + } + + public int getMembersSize() + { + return getMembers().size(); + } + + public String getName() + { + return name; + } + + public void setName(String name) + { + this.name = name; + } + + public String getDescription() + { + return description; + } + + public void setDescription(String description) + { + this.description = description; + } + + /** + * @return the categoryService + */ + private CategoryService getCategoryService() + { + //check for null in cluster environment + if(categoryService == null) + { + categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); + } + return categoryService; + } + + public void setCategoryService(CategoryService categoryService) + { + this.categoryService = categoryService; + } + + public NodeRef getCategoryRef() + { + return categoryRef; + } + + public void setCategoryRef(NodeRef categoryRef) + { + this.categoryRef = categoryRef; + } + + public Node getCategory() + { + return category; + } + + public void setCategory(Node category) + { + this.category = category; + } + + public Boolean getCategoryFlag() + { + return categoryFlag; + } + + public void setCategoryFlag(Boolean categoryFlag) + { + this.categoryFlag = categoryFlag; + } + + /** + * @param node Set the Node to be used for the current category screen action. + */ + @SuppressWarnings("unchecked") + public void setActionCategory(Node node) + { + this.actionCategory = node; + + if (node != null) + { + // setup form properties + setName(node.getName()); + setDescription((String)node.getProperties().get(ContentModel.PROP_DESCRIPTION)); + setMembers(getCategoryService().getChildren(node.getNodeRef(), Mode.MEMBERS, Depth.ANY)); + } + else + { + setName(null); + setDescription(null); + Object emptyCollection = Collections.emptyList(); + setMembers((Collection) emptyCollection); + } + } + + public Node getActionCategory() + { + return actionCategory; + } + + public void setLocation(List location) + { + this.location = location; + } + + /** + * @return Breadcrumb location list + */ + public List getLocation() + { + return this.location; + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + finishDelete(); + return outcome; + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_DELETE_CATEGORY) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + getActionCategory().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getFinishButtonLabel() + { + + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_DELETE); + } + + public UIRichList getCategoriesRichList() + { + return categoriesRichList; + } + + public void setCategoriesRichList(UIRichList categoriesRichList) + { + this.categoriesRichList = categoriesRichList; + } + + /** + * @see org.alfresco.web.app.context.IContextListener#contextUpdated() + */ + public void contextUpdated() + { + if (logger.isDebugEnabled()) + logger.debug("Invalidating Category Management Components..."); + + // force a requery of the current category ref properties + setCategory(null); + + // force a requery of the richlist dataset + if (this.categoriesRichList != null) + { + this.categoriesRichList.setValue(null); + } + + } + + /** + * @return The ID of the currently displayed category or null if at the root. + */ + public String getCurrentCategoryId() + { + if (getCategoryRef() != null) + { + return getCategoryRef().getId(); + } + else + { + return null; + } + } + + /** + * Set the current category node. + *

+ * Setting this value causes the UI to update and display the specified node as current. + * + * @param ref The current category node. + */ + public void setCurrentCategory(NodeRef ref) + { + if (logger.isDebugEnabled()) + logger.debug("Setting current category: " + ref); + + // set the current NodeRef for our UI context operations + setCategoryRef(ref); + + // clear current node context + setCategory(null); + + // inform that the UI needs updating after this change + contextUpdated(); + } + + + public String finishDelete() + { + String outcome = DEFAULT_OUTCOME; + + if (getActionCategory() != null) + { + try + { + FacesContext context = FacesContext.getCurrentInstance(); + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + @SuppressWarnings("unchecked") + public NodeRef execute() throws Throwable + { + // delete the category node using the nodeservice + NodeRef categoryNodeRef = getActionCategory().getNodeRef(); + getCategoryService().deleteCategory(categoryNodeRef); + + // if there are other items in the repository using this category + // all the associations to the category should be removed too + if (getMembers() != null && getMembers().size() > 0) + { + for (ChildAssociationRef childRef : getMembers()) + { + List list = new ArrayList(getMembers().size()); + + NodeRef member = childRef.getChildRef(); + Collection categories = (Collection)getNodeService().getProperty(member, ContentModel.PROP_CATEGORIES); + + for (NodeRef category : categories) + { + if (category.equals(categoryNodeRef) == false) + { + list.add(category); + } + } + + // persist the list back to the repository + getNodeService().setProperty(member, ContentModel.PROP_CATEGORIES, (Serializable) list); + } + } + return categoryNodeRef; + } + }; + NodeRef categoryNodeRef = txnHelper.doInTransaction(callback); + + // Figure out if the deletion is made by an icon or by a list of actions + CategoriesDialog categoriesDialog = (CategoriesDialog) UIContextService.getInstance(FacesContext.getCurrentInstance()) + .getRegisteredBean(CategoriesDialog.CATEGORIES_DIALOG_CLASS_NAME); + setLocation(categoriesDialog.getLocation()); + List location = getLocation(); + CategoryBreadcrumbHandler handler = (CategoryBreadcrumbHandler) location.get(location.size() - 1); + setCategoryFlag(!handler.toString().equals(getCategory().getName())); + + // clear action context + setActionCategory(null); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); + outcome = null; + ReportedException.throwIfNecessary(err); + } + } + + return outcome; + } + +} diff --git a/source/java/org/alfresco/web/bean/categories/EditCategoryDialog.java b/source/java/org/alfresco/web/bean/categories/EditCategoryDialog.java index a202d1cbfb..ce1865d95f 100644 --- a/source/java/org/alfresco/web/bean/categories/EditCategoryDialog.java +++ b/source/java/org/alfresco/web/bean/categories/EditCategoryDialog.java @@ -1,307 +1,307 @@ -package org.alfresco.web.bean.categories; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.search.CategoryService; -import org.alfresco.service.cmr.search.CategoryService.Depth; -import org.alfresco.service.cmr.search.CategoryService.Mode; -import org.alfresco.service.namespace.QName; -import org.springframework.extensions.surf.util.ParameterCheck; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.bean.categories.CategoriesDialog.CategoryBreadcrumbHandler; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.IBreadcrumbHandler; -import org.alfresco.web.ui.common.component.data.UIRichList; -import org.alfresco.web.ui.repo.component.IRepoBreadcrumbHandler; - -public class EditCategoryDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 3316665625854694278L; - - private static final String DEFAULT_OUTCOME = "finish"; - private final static String MSG_EDIT_CATEGORY = "edit_category"; - private final static String MSG_FINISH = "finish_button"; - private static final String MSG_CATEGORIES = "categories"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - transient protected CategoryService categoryService; - - /** Action category node */ - private Node actionCategory = null; - - /** Currently visible category Node */ - private Node category = null; - - private Boolean categoryFlag = false; - - String categoryRef = null; - - /** Category path breadcrumb location */ - private List location = null; - - /** Members of the linked items of a category */ - private Collection members = null; - - /** Component references */ - protected UIRichList categoriesRichList; - - /** Dialog properties */ - private String name = null; - private String description = null; - - @Override - public void init(Map parameters) - { - this.isFinished = false; - this.categoryFlag = false; - - // retrieve parameters - categoryRef = parameters.get(CategoriesDialog.PARAM_CATEGORY_REF); - - // make sure nodeRef was supplied - ParameterCheck.mandatoryString(CategoriesDialog.PARAM_CATEGORY_REF, categoryRef); - - // create the node - this.category = new Node(new NodeRef(categoryRef)); - - setActionCategory(category); - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - // add the category to the request object so it gets picked up by - // category dialog, this will allow it to be edited in the breadcrumb - context.getExternalContext().getRequestMap().put( - CategoriesDialog.KEY_CATEGORY, this.category.getName()); - context.getExternalContext().getRequestMap().put( - CategoriesDialog.KEY_CATEGORY_FLAG, this.categoryFlag.toString()); - - return outcome; - } - - public String getName() - { - return name; - } - - public void setName(String name) - { - this.name = name; - } - - public String getDescription() - { - return description; - } - - public void setDescription(String description) - { - this.description = description; - } - - public UIRichList getCategoriesRichList() - { - return categoriesRichList; - } - - public void setCategoriesRichList(UIRichList categoriesRichList) - { - this.categoriesRichList = categoriesRichList; - } - - /** - * @return the categoryService - */ - private CategoryService getCategoryService() - { - //check for null in cluster environment - if(categoryService == null) - { - categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); - } - return categoryService; - } - - public void setCategoryService(CategoryService categoryService) - { - this.categoryService = categoryService; - } - - public Node getCategory() - { - return category; - } - - public void setCategory(Node category) - { - this.category = category; - } - - public Boolean getCategoryFlag() - { - return categoryFlag; - } - - public void setCategoryFlag(Boolean categoryFlag) - { - this.categoryFlag = categoryFlag; - } - - public Collection getMembers() - { - return members; - } - - public void setMembers(Collection members) - { - this.members = members; - } - - @SuppressWarnings("unchecked") - public void setActionCategory(Node node) - { - this.actionCategory = node; - - if (node != null) - { - // setup form properties - setName(node.getName()); - setDescription((String) node.getProperties().get(ContentModel.PROP_DESCRIPTION)); - setMembers(getCategoryService().getChildren(node.getNodeRef(), Mode.MEMBERS, Depth.ANY)); - } - else - { - setName(null); - setDescription(null); - Object emptyCollection = Collections.emptyList(); - setMembers((Collection) emptyCollection); - } - } - - public Node getActionCategory() - { - return actionCategory; - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - - finishEdit(); - return outcome; - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_EDIT_CATEGORY) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + getActionCategory().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getFinishButtonLabel() - { - - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_FINISH); - } - - public void setLocation(List location) - { - this.location = location; - } - - /** - * @return Breadcrumb location list - */ - public List getLocation() - { - return this.location; - } - - public String finishEdit() - { - String outcome = DEFAULT_OUTCOME; - - try - { - - // update the category node - NodeRef nodeRef = getActionCategory().getNodeRef(); - getNodeService().setProperty(nodeRef, ContentModel.PROP_NAME, getName()); - - // ALF-1788 Need to rename the association - ChildAssociationRef assocRef = getNodeService().getPrimaryParent(nodeRef); - QName qname = QName.createQName( - assocRef.getQName().getNamespaceURI(), - QName.createValidLocalName(name)); - getNodeService().moveNode( - assocRef.getChildRef(), - assocRef.getParentRef(), - assocRef.getTypeQName(), - qname); - - // apply the titled aspect - for description - if (getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_TITLED) == false) - { - Map titledProps = new HashMap(1, 1.0f); - titledProps.put(ContentModel.PROP_DESCRIPTION, getDescription()); - getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TITLED, titledProps); - } - else - { - getNodeService().setProperty(nodeRef, ContentModel.PROP_DESCRIPTION, getDescription()); - } - - //Figure out if the editing is made by an icon or by a list of actions - CategoriesDialog categoriesDialog = (CategoriesDialog) UIContextService.getInstance(FacesContext.getCurrentInstance()) - .getRegisteredBean(CategoriesDialog.CATEGORIES_DIALOG_CLASS_NAME); - setLocation(categoriesDialog.getLocation()); - List location = getLocation(); - CategoryBreadcrumbHandler handler = (CategoryBreadcrumbHandler) location.get(location.size() - 1); - if (!handler.toString().equals(getCategory().getName())) - { - setCategoryFlag(true); - } - else - { - setCategoryFlag(false); - } - Node categoryNode = new Node(nodeRef); - setCategory(categoryNode); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); - outcome = null; - ReportedException.throwIfNecessary(err); - } - - return outcome; - } -} +package org.alfresco.web.bean.categories; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.search.CategoryService; +import org.alfresco.service.cmr.search.CategoryService.Depth; +import org.alfresco.service.cmr.search.CategoryService.Mode; +import org.alfresco.service.namespace.QName; +import org.springframework.extensions.surf.util.ParameterCheck; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.bean.categories.CategoriesDialog.CategoryBreadcrumbHandler; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.IBreadcrumbHandler; +import org.alfresco.web.ui.common.component.data.UIRichList; +import org.alfresco.web.ui.repo.component.IRepoBreadcrumbHandler; + +public class EditCategoryDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 3316665625854694278L; + + private static final String DEFAULT_OUTCOME = "finish"; + private final static String MSG_EDIT_CATEGORY = "edit_category"; + private final static String MSG_FINISH = "finish_button"; + private static final String MSG_CATEGORIES = "categories"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + transient protected CategoryService categoryService; + + /** Action category node */ + private Node actionCategory = null; + + /** Currently visible category Node */ + private Node category = null; + + private Boolean categoryFlag = false; + + String categoryRef = null; + + /** Category path breadcrumb location */ + private List location = null; + + /** Members of the linked items of a category */ + private Collection members = null; + + /** Component references */ + protected UIRichList categoriesRichList; + + /** Dialog properties */ + private String name = null; + private String description = null; + + @Override + public void init(Map parameters) + { + this.isFinished = false; + this.categoryFlag = false; + + // retrieve parameters + categoryRef = parameters.get(CategoriesDialog.PARAM_CATEGORY_REF); + + // make sure nodeRef was supplied + ParameterCheck.mandatoryString(CategoriesDialog.PARAM_CATEGORY_REF, categoryRef); + + // create the node + this.category = new Node(new NodeRef(categoryRef)); + + setActionCategory(category); + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + // add the category to the request object so it gets picked up by + // category dialog, this will allow it to be edited in the breadcrumb + context.getExternalContext().getRequestMap().put( + CategoriesDialog.KEY_CATEGORY, this.category.getName()); + context.getExternalContext().getRequestMap().put( + CategoriesDialog.KEY_CATEGORY_FLAG, this.categoryFlag.toString()); + + return outcome; + } + + public String getName() + { + return name; + } + + public void setName(String name) + { + this.name = name; + } + + public String getDescription() + { + return description; + } + + public void setDescription(String description) + { + this.description = description; + } + + public UIRichList getCategoriesRichList() + { + return categoriesRichList; + } + + public void setCategoriesRichList(UIRichList categoriesRichList) + { + this.categoriesRichList = categoriesRichList; + } + + /** + * @return the categoryService + */ + private CategoryService getCategoryService() + { + //check for null in cluster environment + if(categoryService == null) + { + categoryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCategoryService(); + } + return categoryService; + } + + public void setCategoryService(CategoryService categoryService) + { + this.categoryService = categoryService; + } + + public Node getCategory() + { + return category; + } + + public void setCategory(Node category) + { + this.category = category; + } + + public Boolean getCategoryFlag() + { + return categoryFlag; + } + + public void setCategoryFlag(Boolean categoryFlag) + { + this.categoryFlag = categoryFlag; + } + + public Collection getMembers() + { + return members; + } + + public void setMembers(Collection members) + { + this.members = members; + } + + @SuppressWarnings("unchecked") + public void setActionCategory(Node node) + { + this.actionCategory = node; + + if (node != null) + { + // setup form properties + setName(node.getName()); + setDescription((String) node.getProperties().get(ContentModel.PROP_DESCRIPTION)); + setMembers(getCategoryService().getChildren(node.getNodeRef(), Mode.MEMBERS, Depth.ANY)); + } + else + { + setName(null); + setDescription(null); + Object emptyCollection = Collections.emptyList(); + setMembers((Collection) emptyCollection); + } + } + + public Node getActionCategory() + { + return actionCategory; + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + + finishEdit(); + return outcome; + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_EDIT_CATEGORY) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + getActionCategory().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getFinishButtonLabel() + { + + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_FINISH); + } + + public void setLocation(List location) + { + this.location = location; + } + + /** + * @return Breadcrumb location list + */ + public List getLocation() + { + return this.location; + } + + public String finishEdit() + { + String outcome = DEFAULT_OUTCOME; + + try + { + + // update the category node + NodeRef nodeRef = getActionCategory().getNodeRef(); + getNodeService().setProperty(nodeRef, ContentModel.PROP_NAME, getName()); + + // ALF-1788 Need to rename the association + ChildAssociationRef assocRef = getNodeService().getPrimaryParent(nodeRef); + QName qname = QName.createQName( + assocRef.getQName().getNamespaceURI(), + QName.createValidLocalName(name)); + getNodeService().moveNode( + assocRef.getChildRef(), + assocRef.getParentRef(), + assocRef.getTypeQName(), + qname); + + // apply the titled aspect - for description + if (getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_TITLED) == false) + { + Map titledProps = new HashMap(1, 1.0f); + titledProps.put(ContentModel.PROP_DESCRIPTION, getDescription()); + getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TITLED, titledProps); + } + else + { + getNodeService().setProperty(nodeRef, ContentModel.PROP_DESCRIPTION, getDescription()); + } + + //Figure out if the editing is made by an icon or by a list of actions + CategoriesDialog categoriesDialog = (CategoriesDialog) UIContextService.getInstance(FacesContext.getCurrentInstance()) + .getRegisteredBean(CategoriesDialog.CATEGORIES_DIALOG_CLASS_NAME); + setLocation(categoriesDialog.getLocation()); + List location = getLocation(); + CategoryBreadcrumbHandler handler = (CategoryBreadcrumbHandler) location.get(location.size() - 1); + if (!handler.toString().equals(getCategory().getName())) + { + setCategoryFlag(true); + } + else + { + setCategoryFlag(false); + } + Node categoryNode = new Node(nodeRef); + setCategory(categoryNode); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); + outcome = null; + ReportedException.throwIfNecessary(err); + } + + return outcome; + } +} diff --git a/source/java/org/alfresco/web/bean/clipboard/AbstractClipboardItem.java b/source/java/org/alfresco/web/bean/clipboard/AbstractClipboardItem.java index 73bb69b90f..03f39b9b93 100644 --- a/source/java/org/alfresco/web/bean/clipboard/AbstractClipboardItem.java +++ b/source/java/org/alfresco/web/bean/clipboard/AbstractClipboardItem.java @@ -1,193 +1,193 @@ -package org.alfresco.web.bean.clipboard; - -import java.util.List; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.search.QueryParameterDefImpl; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.dictionary.DataTypeDefinition; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.search.QueryParameterDefinition; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Base class representing a single item added to the clipboard. - * - * @author Kevin Roast - */ -abstract class AbstractClipboardItem implements ClipboardItem -{ - protected static Log logger = LogFactory.getLog(ClipboardBean.class); - - protected static final String MSG_COPY_OF = "copy_of"; - - /** Shallow search for nodes with a name pattern */ - private static final String XPATH_QUERY_NODE_MATCH = "./*[like(@cm:name, $cm:name, false)]"; - - transient private ServiceRegistry services = null; - - protected NodeRef ref; - protected NodeRef parent; - protected ClipboardStatus mode; - - // cached values - private String name; - private QName type; - private String icon; - - private List customPasteViewIds; - - - /** - * Constructor - * - * @param ref The ref of the item on the clipboard - * @param mode The ClipboardStatus enum value - */ - public AbstractClipboardItem(NodeRef ref, ClipboardStatus mode, List customPasteViewIds) - { - this.ref = ref; - this.mode = mode; - this.customPasteViewIds = customPasteViewIds; - } - - /** - * Constructor - * - * @param ref The ref of the item on the clipboard - * @param parent The parent of the item on the clipboard - * @param mode The ClipboardStatus enum value - */ - public AbstractClipboardItem(NodeRef ref, NodeRef parent, ClipboardStatus mode, List customPasteViewIds) - { - this.ref = ref; - this.mode = mode; - this.parent = parent; - this.customPasteViewIds = customPasteViewIds; - } - - public ClipboardStatus getMode() - { - return this.mode; - } - - public String getName() - { - if (this.name == null) - { - this.name = (String)getServiceRegistry().getNodeService().getProperty( - this.ref, ContentModel.PROP_NAME); - } - return this.name; - } - - public QName getType() - { - if (this.type == null) - { - this.type = getServiceRegistry().getNodeService().getType(this.ref); - } - return this.type; - } - - public String getIcon() - { - if (this.icon == null) - { - this.icon = (String)getServiceRegistry().getNodeService().getProperty( - this.ref, ApplicationModel.PROP_ICON); - } - return this.icon; - } - - public NodeRef getNodeRef() - { - return this.ref; - } - - public NodeRef getParent() - { - return this.parent; - } - - /** - * Override equals() to compare NodeRefs - */ - public boolean equals(Object obj) - { - if (obj == this) - { - return true; - } - if (obj instanceof ClipboardItem) - { - return ((ClipboardItem)obj).getNodeRef().equals(this.ref); - } - else - { - return false; - } - } - - /** - * Override hashCode() to use the internal NodeRef hashcode instead - */ - public int hashCode() - { - return ref.hashCode(); - } - - protected ServiceRegistry getServiceRegistry() - { - if (services == null) - { - services = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); - } - return services; - } - - public boolean canCopyToViewId(String viewId) - { - if (this.customPasteViewIds != null) - { - return this.customPasteViewIds.contains(viewId); - } - return false; - } - - public boolean canMoveToViewId(String viewId) - { - if (this.customPasteViewIds != null) - { - return this.customPasteViewIds.contains(viewId); - } - return false; - } - - protected boolean checkExists(String name, NodeRef parent) - { - QueryParameterDefinition[] params = new QueryParameterDefinition[1]; - params[0] = new QueryParameterDefImpl( - ContentModel.PROP_NAME, - getServiceRegistry().getDictionaryService().getDataType( - DataTypeDefinition.TEXT), - true, - name); - - // execute the query - List nodeRefs = getServiceRegistry().getSearchService().selectNodes( - parent, - XPATH_QUERY_NODE_MATCH, - params, - getServiceRegistry().getNamespaceService(), - false); - - return (nodeRefs.size() != 0); - } -} +package org.alfresco.web.bean.clipboard; + +import java.util.List; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.search.QueryParameterDefImpl; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.dictionary.DataTypeDefinition; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.search.QueryParameterDefinition; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.bean.repository.Repository; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Base class representing a single item added to the clipboard. + * + * @author Kevin Roast + */ +abstract class AbstractClipboardItem implements ClipboardItem +{ + protected static Log logger = LogFactory.getLog(ClipboardBean.class); + + protected static final String MSG_COPY_OF = "copy_of"; + + /** Shallow search for nodes with a name pattern */ + private static final String XPATH_QUERY_NODE_MATCH = "./*[like(@cm:name, $cm:name, false)]"; + + transient private ServiceRegistry services = null; + + protected NodeRef ref; + protected NodeRef parent; + protected ClipboardStatus mode; + + // cached values + private String name; + private QName type; + private String icon; + + private List customPasteViewIds; + + + /** + * Constructor + * + * @param ref The ref of the item on the clipboard + * @param mode The ClipboardStatus enum value + */ + public AbstractClipboardItem(NodeRef ref, ClipboardStatus mode, List customPasteViewIds) + { + this.ref = ref; + this.mode = mode; + this.customPasteViewIds = customPasteViewIds; + } + + /** + * Constructor + * + * @param ref The ref of the item on the clipboard + * @param parent The parent of the item on the clipboard + * @param mode The ClipboardStatus enum value + */ + public AbstractClipboardItem(NodeRef ref, NodeRef parent, ClipboardStatus mode, List customPasteViewIds) + { + this.ref = ref; + this.mode = mode; + this.parent = parent; + this.customPasteViewIds = customPasteViewIds; + } + + public ClipboardStatus getMode() + { + return this.mode; + } + + public String getName() + { + if (this.name == null) + { + this.name = (String)getServiceRegistry().getNodeService().getProperty( + this.ref, ContentModel.PROP_NAME); + } + return this.name; + } + + public QName getType() + { + if (this.type == null) + { + this.type = getServiceRegistry().getNodeService().getType(this.ref); + } + return this.type; + } + + public String getIcon() + { + if (this.icon == null) + { + this.icon = (String)getServiceRegistry().getNodeService().getProperty( + this.ref, ApplicationModel.PROP_ICON); + } + return this.icon; + } + + public NodeRef getNodeRef() + { + return this.ref; + } + + public NodeRef getParent() + { + return this.parent; + } + + /** + * Override equals() to compare NodeRefs + */ + public boolean equals(Object obj) + { + if (obj == this) + { + return true; + } + if (obj instanceof ClipboardItem) + { + return ((ClipboardItem)obj).getNodeRef().equals(this.ref); + } + else + { + return false; + } + } + + /** + * Override hashCode() to use the internal NodeRef hashcode instead + */ + public int hashCode() + { + return ref.hashCode(); + } + + protected ServiceRegistry getServiceRegistry() + { + if (services == null) + { + services = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); + } + return services; + } + + public boolean canCopyToViewId(String viewId) + { + if (this.customPasteViewIds != null) + { + return this.customPasteViewIds.contains(viewId); + } + return false; + } + + public boolean canMoveToViewId(String viewId) + { + if (this.customPasteViewIds != null) + { + return this.customPasteViewIds.contains(viewId); + } + return false; + } + + protected boolean checkExists(String name, NodeRef parent) + { + QueryParameterDefinition[] params = new QueryParameterDefinition[1]; + params[0] = new QueryParameterDefImpl( + ContentModel.PROP_NAME, + getServiceRegistry().getDictionaryService().getDataType( + DataTypeDefinition.TEXT), + true, + name); + + // execute the query + List nodeRefs = getServiceRegistry().getSearchService().selectNodes( + parent, + XPATH_QUERY_NODE_MATCH, + params, + getServiceRegistry().getNamespaceService(), + false); + + return (nodeRefs.size() != 0); + } +} diff --git a/source/java/org/alfresco/web/bean/clipboard/WorkspaceClipboardItem.java b/source/java/org/alfresco/web/bean/clipboard/WorkspaceClipboardItem.java index fa26e2b46f..6f43075af4 100644 --- a/source/java/org/alfresco/web/bean/clipboard/WorkspaceClipboardItem.java +++ b/source/java/org/alfresco/web/bean/clipboard/WorkspaceClipboardItem.java @@ -1,319 +1,319 @@ -package org.alfresco.web.bean.clipboard; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.ml.MultilingualContentService; -import org.alfresco.service.cmr.model.FileExistsException; -import org.alfresco.service.cmr.model.FileFolderService; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.CopyService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.repo.component.shelf.UIClipboardShelfItem; - -/** - * Class representing a 'workspace' store protocol clipboard item - * - * @author Kevin Roast - */ -public class WorkspaceClipboardItem extends AbstractClipboardItem -{ - private static final long serialVersionUID = -1686557602737846009L; - - private static final String WORKSPACE_PASTE_VIEW_ID = "/jsp/browse/browse.jsp"; - private static final String FORUMS_PASTE_VIEW_ID = "/jsp/forums/forums.jsp"; - private static final String FORUM_PASTE_VIEW_ID = "/jsp/forums/forum.jsp"; - - private static final String MSG_LINK_TO = "link_to"; - - // File extension to use for link nodes - private static final String LINK_NODE_EXTENSION = ".url"; - - - /** - * @param ref - * @param mode - */ - public WorkspaceClipboardItem(NodeRef ref, ClipboardStatus mode, List customPasteViewIds) - { - super(ref, mode, customPasteViewIds); - } - - /** - * @param ref - * @param mode - */ - public WorkspaceClipboardItem(NodeRef ref, NodeRef parent, ClipboardStatus mode, List customPasteViewIds) - { - super(ref, parent, mode, customPasteViewIds); - } - - /** - * @see org.alfresco.web.bean.clipboard.ClipboardItem#supportsLink() - */ - public boolean supportsLink() - { - return true; - } - - /** - * @see org.alfresco.web.bean.clipboard.ClipboardItem#canCopyToViewId(java.lang.String) - */ - public boolean canCopyToViewId(String viewId) - { - return super.canCopyToViewId(viewId) || (WORKSPACE_PASTE_VIEW_ID.equals(viewId) || - FORUMS_PASTE_VIEW_ID.equals(viewId) || FORUM_PASTE_VIEW_ID.equals(viewId)); - } - - /** - * @see org.alfresco.web.bean.clipboard.ClipboardItem#canMoveToViewId(java.lang.String) - */ - public boolean canMoveToViewId(String viewId) - { - return super.canMoveToViewId(viewId) || (WORKSPACE_PASTE_VIEW_ID.equals(viewId) || FORUMS_PASTE_VIEW_ID.equals(viewId) || - FORUM_PASTE_VIEW_ID.equals(viewId)); - } - - /** - * @see org.alfresco.web.bean.clipboard.ClipboardItem#paste(javax.faces.context.FacesContext, java.lang.String, int) - */ - public boolean paste(final FacesContext fc, String viewId, final int action) - { - final ServiceRegistry serviceRegistry = getServiceRegistry(); - final RetryingTransactionHelper retryingTransactionHelper = serviceRegistry.getTransactionService().getRetryingTransactionHelper(); - if (super.canCopyToViewId(viewId) || WORKSPACE_PASTE_VIEW_ID.equals(viewId) || FORUMS_PASTE_VIEW_ID.equals(viewId) || - FORUM_PASTE_VIEW_ID.equals(viewId)) - { - NavigationBean navigator = (NavigationBean)FacesHelper.getManagedBean(fc, NavigationBean.BEAN_NAME); - final NodeRef destRef = new NodeRef(Repository.getStoreRef(), navigator.getCurrentNodeId()); - - final DictionaryService dd = serviceRegistry.getDictionaryService(); - final NodeService nodeService = serviceRegistry.getNodeService(); - final FileFolderService fileFolderService = serviceRegistry.getFileFolderService(); - final CopyService copyService = serviceRegistry.getCopyService(); - final MultilingualContentService multilingualContentService = serviceRegistry.getMultilingualContentService(); - - final boolean isPrimaryParent; - - final ChildAssociationRef assocRef; - - if (getParent() == null) - { - assocRef = nodeService.getPrimaryParent(getNodeRef()); - isPrimaryParent = true; - } - else - { - NodeRef parentNodeRef = getParent(); - List assocList = nodeService.getParentAssocs(getNodeRef()); - ChildAssociationRef foundRef = null; - if (assocList != null) - { - for (ChildAssociationRef assocListEntry : assocList) - { - if (parentNodeRef.equals(assocListEntry.getParentRef())) - { - foundRef = assocListEntry; - break; - } - } - } - assocRef = foundRef; - isPrimaryParent = parentNodeRef.equals(nodeService.getPrimaryParent(getNodeRef()).getParentRef()); - } - - // initial name to attempt the copy of the item with - String name = getName(); - String translationPrefix = ""; - - if (action == UIClipboardShelfItem.ACTION_PASTE_LINK) - { - // copy as link was specifically requested by the user - String linkTo = Application.getMessage(fc, MSG_LINK_TO); - name = linkTo + ' ' + name; - } - - // Loop until we find a target name that doesn't exist - for(;;) - { - try - { - final String currentTranslationPrefix = translationPrefix; - final String currentName = name; - - // attempt each copy/paste in its own transaction - retryingTransactionHelper.doInTransaction(new RetryingTransactionCallback() - { - public Void execute() throws Throwable - { - if (getMode() == ClipboardStatus.COPY) - { - if (action == UIClipboardShelfItem.ACTION_PASTE_LINK) - { - // LINK operation - if (logger.isDebugEnabled()) - logger.debug("Attempting to link node ID: " + getNodeRef() + " into node: " + destRef.toString()); - - // we create a special Link Object node that has a property to reference the original - // create the node using the nodeService (can only use FileFolderService for content) - if (checkExists(currentName + LINK_NODE_EXTENSION, destRef) == false) - { - Map props = new HashMap(2, 1.0f); - String newName = currentName + LINK_NODE_EXTENSION; - props.put(ContentModel.PROP_NAME, newName); - props.put(ContentModel.PROP_LINK_DESTINATION, getNodeRef()); - if (dd.isSubClass(getType(), ContentModel.TYPE_CONTENT)) - { - // create File Link node - ChildAssociationRef childRef = nodeService.createNode( - destRef, - ContentModel.ASSOC_CONTAINS, - QName.createQName(assocRef.getQName().getNamespaceURI(), newName), - ApplicationModel.TYPE_FILELINK, - props); - - // apply the titled aspect - title and description - Map titledProps = new HashMap(2, 1.0f); - titledProps.put(ContentModel.PROP_TITLE, currentName); - titledProps.put(ContentModel.PROP_DESCRIPTION, currentName); - nodeService.addAspect(childRef.getChildRef(), ContentModel.ASPECT_TITLED, titledProps); - } - else - { - // create Folder link node - ChildAssociationRef childRef = nodeService.createNode( - destRef, - ContentModel.ASSOC_CONTAINS, - assocRef.getQName(), - ApplicationModel.TYPE_FOLDERLINK, - props); - - // apply the uifacets aspect - icon, title and description props - Map uiFacetsProps = new HashMap(4, 1.0f); - uiFacetsProps.put(ApplicationModel.PROP_ICON, "space-icon-link"); - uiFacetsProps.put(ContentModel.PROP_TITLE, currentName); - uiFacetsProps.put(ContentModel.PROP_DESCRIPTION, currentName); - nodeService.addAspect(childRef.getChildRef(), ApplicationModel.ASPECT_UIFACETS, uiFacetsProps); - } - } - } - else - { - // COPY operation - if (logger.isDebugEnabled()) - logger.debug("Attempting to copy node: " + getNodeRef() + " into node ID: " + destRef.toString()); - - // first check that we are not attempting to copy a duplicate into the same parent - if (destRef.equals(assocRef.getParentRef()) && currentName.equals(getName())) - { - // manually change the name if this occurs - throw new FileExistsException(destRef, currentName); - } - - if (dd.isSubClass(getType(), ContentModel.TYPE_CONTENT) || - dd.isSubClass(getType(), ContentModel.TYPE_FOLDER)) - { - // copy the file/folder - fileFolderService.copy( - getNodeRef(), - destRef, - currentName); - } - else if(dd.isSubClass(getType(), ContentModel.TYPE_MULTILINGUAL_CONTAINER)) - { - // copy the mlContainer and its translations - multilingualContentService.copyTranslationContainer(getNodeRef(), destRef, currentTranslationPrefix); - } - else - { - // copy the node - if (checkExists(currentName, destRef) == false) - { - copyService.copyAndRename( - getNodeRef(), - destRef, - ContentModel.ASSOC_CONTAINS, - assocRef.getQName(), - true); - } - } - } - } - else - { - // MOVE operation - if (logger.isDebugEnabled()) - logger.debug("Attempting to move node: " + getNodeRef() + " into node ID: " + destRef.toString()); - - if (dd.isSubClass(getType(), ContentModel.TYPE_CONTENT) || - dd.isSubClass(getType(), ContentModel.TYPE_FOLDER)) - { - // move the file/folder - fileFolderService.moveFrom(getNodeRef(), getParent(), destRef, currentName); - } - else if(dd.isSubClass(getType(), ContentModel.TYPE_MULTILINGUAL_CONTAINER)) - { - // copy the mlContainer and its translations - multilingualContentService.moveTranslationContainer(getNodeRef(), destRef); - } - else - { - if (isPrimaryParent) - { - // move the node - nodeService.moveNode(getNodeRef(), destRef, ContentModel.ASSOC_CONTAINS, assocRef.getQName()); - } - else - { - nodeService.removeChild(getParent(), getNodeRef()); - nodeService.addChild(destRef, getNodeRef(), assocRef.getTypeQName(), assocRef.getQName()); - } - } - } - return null; - } - }); - - // We got here without error, so no need to loop with a new name - break; - } - catch (FileExistsException fileExistsErr) - { - // If mode is COPY, have another go around the loop with a new name - if (getMode() == ClipboardStatus.COPY) - { - String copyOf = Application.getMessage(fc, MSG_COPY_OF); - name = copyOf + ' ' + name; - translationPrefix = copyOf + ' ' + translationPrefix; - } - else - { - // we should not rename an item when it is being moved - so exit - throw fileExistsErr; - } - } - } - return true; - } - else - { - return false; - } - } -} +package org.alfresco.web.bean.clipboard; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.ml.MultilingualContentService; +import org.alfresco.service.cmr.model.FileExistsException; +import org.alfresco.service.cmr.model.FileFolderService; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.CopyService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.repo.component.shelf.UIClipboardShelfItem; + +/** + * Class representing a 'workspace' store protocol clipboard item + * + * @author Kevin Roast + */ +public class WorkspaceClipboardItem extends AbstractClipboardItem +{ + private static final long serialVersionUID = -1686557602737846009L; + + private static final String WORKSPACE_PASTE_VIEW_ID = "/jsp/browse/browse.jsp"; + private static final String FORUMS_PASTE_VIEW_ID = "/jsp/forums/forums.jsp"; + private static final String FORUM_PASTE_VIEW_ID = "/jsp/forums/forum.jsp"; + + private static final String MSG_LINK_TO = "link_to"; + + // File extension to use for link nodes + private static final String LINK_NODE_EXTENSION = ".url"; + + + /** + * @param ref + * @param mode + */ + public WorkspaceClipboardItem(NodeRef ref, ClipboardStatus mode, List customPasteViewIds) + { + super(ref, mode, customPasteViewIds); + } + + /** + * @param ref + * @param mode + */ + public WorkspaceClipboardItem(NodeRef ref, NodeRef parent, ClipboardStatus mode, List customPasteViewIds) + { + super(ref, parent, mode, customPasteViewIds); + } + + /** + * @see org.alfresco.web.bean.clipboard.ClipboardItem#supportsLink() + */ + public boolean supportsLink() + { + return true; + } + + /** + * @see org.alfresco.web.bean.clipboard.ClipboardItem#canCopyToViewId(java.lang.String) + */ + public boolean canCopyToViewId(String viewId) + { + return super.canCopyToViewId(viewId) || (WORKSPACE_PASTE_VIEW_ID.equals(viewId) || + FORUMS_PASTE_VIEW_ID.equals(viewId) || FORUM_PASTE_VIEW_ID.equals(viewId)); + } + + /** + * @see org.alfresco.web.bean.clipboard.ClipboardItem#canMoveToViewId(java.lang.String) + */ + public boolean canMoveToViewId(String viewId) + { + return super.canMoveToViewId(viewId) || (WORKSPACE_PASTE_VIEW_ID.equals(viewId) || FORUMS_PASTE_VIEW_ID.equals(viewId) || + FORUM_PASTE_VIEW_ID.equals(viewId)); + } + + /** + * @see org.alfresco.web.bean.clipboard.ClipboardItem#paste(javax.faces.context.FacesContext, java.lang.String, int) + */ + public boolean paste(final FacesContext fc, String viewId, final int action) + { + final ServiceRegistry serviceRegistry = getServiceRegistry(); + final RetryingTransactionHelper retryingTransactionHelper = serviceRegistry.getTransactionService().getRetryingTransactionHelper(); + if (super.canCopyToViewId(viewId) || WORKSPACE_PASTE_VIEW_ID.equals(viewId) || FORUMS_PASTE_VIEW_ID.equals(viewId) || + FORUM_PASTE_VIEW_ID.equals(viewId)) + { + NavigationBean navigator = (NavigationBean)FacesHelper.getManagedBean(fc, NavigationBean.BEAN_NAME); + final NodeRef destRef = new NodeRef(Repository.getStoreRef(), navigator.getCurrentNodeId()); + + final DictionaryService dd = serviceRegistry.getDictionaryService(); + final NodeService nodeService = serviceRegistry.getNodeService(); + final FileFolderService fileFolderService = serviceRegistry.getFileFolderService(); + final CopyService copyService = serviceRegistry.getCopyService(); + final MultilingualContentService multilingualContentService = serviceRegistry.getMultilingualContentService(); + + final boolean isPrimaryParent; + + final ChildAssociationRef assocRef; + + if (getParent() == null) + { + assocRef = nodeService.getPrimaryParent(getNodeRef()); + isPrimaryParent = true; + } + else + { + NodeRef parentNodeRef = getParent(); + List assocList = nodeService.getParentAssocs(getNodeRef()); + ChildAssociationRef foundRef = null; + if (assocList != null) + { + for (ChildAssociationRef assocListEntry : assocList) + { + if (parentNodeRef.equals(assocListEntry.getParentRef())) + { + foundRef = assocListEntry; + break; + } + } + } + assocRef = foundRef; + isPrimaryParent = parentNodeRef.equals(nodeService.getPrimaryParent(getNodeRef()).getParentRef()); + } + + // initial name to attempt the copy of the item with + String name = getName(); + String translationPrefix = ""; + + if (action == UIClipboardShelfItem.ACTION_PASTE_LINK) + { + // copy as link was specifically requested by the user + String linkTo = Application.getMessage(fc, MSG_LINK_TO); + name = linkTo + ' ' + name; + } + + // Loop until we find a target name that doesn't exist + for(;;) + { + try + { + final String currentTranslationPrefix = translationPrefix; + final String currentName = name; + + // attempt each copy/paste in its own transaction + retryingTransactionHelper.doInTransaction(new RetryingTransactionCallback() + { + public Void execute() throws Throwable + { + if (getMode() == ClipboardStatus.COPY) + { + if (action == UIClipboardShelfItem.ACTION_PASTE_LINK) + { + // LINK operation + if (logger.isDebugEnabled()) + logger.debug("Attempting to link node ID: " + getNodeRef() + " into node: " + destRef.toString()); + + // we create a special Link Object node that has a property to reference the original + // create the node using the nodeService (can only use FileFolderService for content) + if (checkExists(currentName + LINK_NODE_EXTENSION, destRef) == false) + { + Map props = new HashMap(2, 1.0f); + String newName = currentName + LINK_NODE_EXTENSION; + props.put(ContentModel.PROP_NAME, newName); + props.put(ContentModel.PROP_LINK_DESTINATION, getNodeRef()); + if (dd.isSubClass(getType(), ContentModel.TYPE_CONTENT)) + { + // create File Link node + ChildAssociationRef childRef = nodeService.createNode( + destRef, + ContentModel.ASSOC_CONTAINS, + QName.createQName(assocRef.getQName().getNamespaceURI(), newName), + ApplicationModel.TYPE_FILELINK, + props); + + // apply the titled aspect - title and description + Map titledProps = new HashMap(2, 1.0f); + titledProps.put(ContentModel.PROP_TITLE, currentName); + titledProps.put(ContentModel.PROP_DESCRIPTION, currentName); + nodeService.addAspect(childRef.getChildRef(), ContentModel.ASPECT_TITLED, titledProps); + } + else + { + // create Folder link node + ChildAssociationRef childRef = nodeService.createNode( + destRef, + ContentModel.ASSOC_CONTAINS, + assocRef.getQName(), + ApplicationModel.TYPE_FOLDERLINK, + props); + + // apply the uifacets aspect - icon, title and description props + Map uiFacetsProps = new HashMap(4, 1.0f); + uiFacetsProps.put(ApplicationModel.PROP_ICON, "space-icon-link"); + uiFacetsProps.put(ContentModel.PROP_TITLE, currentName); + uiFacetsProps.put(ContentModel.PROP_DESCRIPTION, currentName); + nodeService.addAspect(childRef.getChildRef(), ApplicationModel.ASPECT_UIFACETS, uiFacetsProps); + } + } + } + else + { + // COPY operation + if (logger.isDebugEnabled()) + logger.debug("Attempting to copy node: " + getNodeRef() + " into node ID: " + destRef.toString()); + + // first check that we are not attempting to copy a duplicate into the same parent + if (destRef.equals(assocRef.getParentRef()) && currentName.equals(getName())) + { + // manually change the name if this occurs + throw new FileExistsException(destRef, currentName); + } + + if (dd.isSubClass(getType(), ContentModel.TYPE_CONTENT) || + dd.isSubClass(getType(), ContentModel.TYPE_FOLDER)) + { + // copy the file/folder + fileFolderService.copy( + getNodeRef(), + destRef, + currentName); + } + else if(dd.isSubClass(getType(), ContentModel.TYPE_MULTILINGUAL_CONTAINER)) + { + // copy the mlContainer and its translations + multilingualContentService.copyTranslationContainer(getNodeRef(), destRef, currentTranslationPrefix); + } + else + { + // copy the node + if (checkExists(currentName, destRef) == false) + { + copyService.copyAndRename( + getNodeRef(), + destRef, + ContentModel.ASSOC_CONTAINS, + assocRef.getQName(), + true); + } + } + } + } + else + { + // MOVE operation + if (logger.isDebugEnabled()) + logger.debug("Attempting to move node: " + getNodeRef() + " into node ID: " + destRef.toString()); + + if (dd.isSubClass(getType(), ContentModel.TYPE_CONTENT) || + dd.isSubClass(getType(), ContentModel.TYPE_FOLDER)) + { + // move the file/folder + fileFolderService.moveFrom(getNodeRef(), getParent(), destRef, currentName); + } + else if(dd.isSubClass(getType(), ContentModel.TYPE_MULTILINGUAL_CONTAINER)) + { + // copy the mlContainer and its translations + multilingualContentService.moveTranslationContainer(getNodeRef(), destRef); + } + else + { + if (isPrimaryParent) + { + // move the node + nodeService.moveNode(getNodeRef(), destRef, ContentModel.ASSOC_CONTAINS, assocRef.getQName()); + } + else + { + nodeService.removeChild(getParent(), getNodeRef()); + nodeService.addChild(destRef, getNodeRef(), assocRef.getTypeQName(), assocRef.getQName()); + } + } + } + return null; + } + }); + + // We got here without error, so no need to loop with a new name + break; + } + catch (FileExistsException fileExistsErr) + { + // If mode is COPY, have another go around the loop with a new name + if (getMode() == ClipboardStatus.COPY) + { + String copyOf = Application.getMessage(fc, MSG_COPY_OF); + name = copyOf + ' ' + name; + translationPrefix = copyOf + ' ' + translationPrefix; + } + else + { + // we should not rename an item when it is being moved - so exit + throw fileExistsErr; + } + } + } + return true; + } + else + { + return false; + } + } +} diff --git a/source/java/org/alfresco/web/bean/coci/CCCheckoutFileDialog.java b/source/java/org/alfresco/web/bean/coci/CCCheckoutFileDialog.java index f651bf253c..f0feb4f610 100644 --- a/source/java/org/alfresco/web/bean/coci/CCCheckoutFileDialog.java +++ b/source/java/org/alfresco/web/bean/coci/CCCheckoutFileDialog.java @@ -1,175 +1,175 @@ -package org.alfresco.web.bean.coci; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.web.scripts.FileTypeImageUtils; -import org.alfresco.repo.workflow.WorkflowModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.DownloadContentServlet; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -public class CCCheckoutFileDialog extends CheckinCheckoutDialog -{ - private static final long serialVersionUID = 1137163500648349730L; - - public static final String LBL_SAVE = "save"; - public static final String LBL_CHECKOUT = "check_out"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private static Log logger = LogFactory.getLog(CCCheckoutFileDialog.class); - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return checkoutFile(context, outcome); - - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getFinishButtonLabel() - { - - return Application.getMessage(FacesContext.getCurrentInstance(), LBL_CHECKOUT); - } - - @Override - public String getContainerTitle() - { - final Node document = property.getDocument(); - if (document != null){ - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, LBL_CHECKOUT) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + document.getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - return null; - } - - /** - * Action called upon completion of the Check Out file page - */ - public String checkoutFile(FacesContext context, String outcome) - { - boolean checkoutSuccessful = false; - final Node node = property.getDocument(); - if (node != null) - { - try - { - if (logger.isDebugEnabled()) - logger.debug("Trying to checkout content node Id: " + node.getId()); - - // checkout the node content to create a working copy - if (logger.isDebugEnabled()) - { - logger.debug("Checkout copy location: " + property.getCopyLocation()); - logger.debug("Selected Space Id: " + property.getSelectedSpaceId()); - } - NodeRef workingCopyRef = null; - if (property.getCopyLocation().equals(CCProperties.COPYLOCATION_OTHER) && property.getSelectedSpaceId() != null) - { - // checkout to a arbituary parent Space - NodeRef destRef = property.getSelectedSpaceId(); - - ChildAssociationRef childAssocRef = getNodeService().getPrimaryParent(destRef); - workingCopyRef = property.getVersionOperationsService().checkout(node.getNodeRef(), destRef, ContentModel.ASSOC_CONTAINS, childAssocRef.getQName()); - } - else - { - // checkout the content to the current space - workingCopyRef = property.getVersionOperationsService().checkout(node.getNodeRef()); - - // if this is a workflow action and there is a task id - // present we need - // to also link the working copy to the workflow package so - // it appears - // in the resources panel in the manage task dialog - if (property.isWorkflowAction() && property.getWorkflowTaskId() != null && (property.getWorkflowTaskId().equals("null") == false)) - { - WorkflowTask task = property.getWorkflowService().getTaskById(property.getWorkflowTaskId()); - if (task != null) - { - NodeRef workflowPackage = (NodeRef) task.properties.get(WorkflowModel.ASSOC_PACKAGE); - if (workflowPackage != null) - { - getNodeService().addChild(workflowPackage, workingCopyRef, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, QName - .createValidLocalName((String) getNodeService().getProperty(workingCopyRef, ContentModel.PROP_NAME)))); - - if (logger.isDebugEnabled()) - logger.debug("Added working copy to workflow package: " + workflowPackage); - } - } - } - } - - // set the working copy Node instance - Node workingCopy = new Node(workingCopyRef); - property.setWorkingDocument(workingCopy); - - // create content URL to the content download servlet with ID - // and expected filename - // the myfile part will be ignored by the servlet but gives the - // browser a hint - String url = DownloadContentServlet.generateDownloadURL(workingCopyRef, workingCopy.getName()); - - workingCopy.getProperties().put("url", url); - workingCopy.getProperties().put("fileType32", FileTypeImageUtils.getFileTypeImage(workingCopy.getName(), false)); - - // mark as successful - checkoutSuccessful = true; - } - catch (Throwable err) - { - Utils.addErrorMessage(Application.getMessage(context, MSG_ERROR_CHECKOUT) + err.getMessage(), err); - ReportedException.throwIfNecessary(err); - } - } - else - { - logger.warn("WARNING: checkoutFile called without a current Document!"); - } - - // determine which page to show next if the checkout was successful. - if (checkoutSuccessful) - { - // If a check-in rule is present in the space - // the document was checked out to the working copy would have - // already disappeared! - if (getNodeService().exists(property.getWorkingDocument().getNodeRef())) - { - // go to the page that allows the user to download the content - // for editing - outcome = "dialog:checkoutFileLink"; // "checkoutFileLink"; - // //checkout-file-link.jsp - // currentAction = Action.CHECKOUT_FILE_LINK; - } - else - { - // show a page telling the user that the content has already - // been checked in - outcome = "dialog:workingCopyMissing";// "workingCopyMissing"; - // // - // working-copy-missing.jsp - // currentAction = Action.WORKING_COPY_MISSING; - } - } - return outcome; - } - -} +package org.alfresco.web.bean.coci; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.web.scripts.FileTypeImageUtils; +import org.alfresco.repo.workflow.WorkflowModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.DownloadContentServlet; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class CCCheckoutFileDialog extends CheckinCheckoutDialog +{ + private static final long serialVersionUID = 1137163500648349730L; + + public static final String LBL_SAVE = "save"; + public static final String LBL_CHECKOUT = "check_out"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private static Log logger = LogFactory.getLog(CCCheckoutFileDialog.class); + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return checkoutFile(context, outcome); + + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getFinishButtonLabel() + { + + return Application.getMessage(FacesContext.getCurrentInstance(), LBL_CHECKOUT); + } + + @Override + public String getContainerTitle() + { + final Node document = property.getDocument(); + if (document != null){ + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, LBL_CHECKOUT) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + document.getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + return null; + } + + /** + * Action called upon completion of the Check Out file page + */ + public String checkoutFile(FacesContext context, String outcome) + { + boolean checkoutSuccessful = false; + final Node node = property.getDocument(); + if (node != null) + { + try + { + if (logger.isDebugEnabled()) + logger.debug("Trying to checkout content node Id: " + node.getId()); + + // checkout the node content to create a working copy + if (logger.isDebugEnabled()) + { + logger.debug("Checkout copy location: " + property.getCopyLocation()); + logger.debug("Selected Space Id: " + property.getSelectedSpaceId()); + } + NodeRef workingCopyRef = null; + if (property.getCopyLocation().equals(CCProperties.COPYLOCATION_OTHER) && property.getSelectedSpaceId() != null) + { + // checkout to a arbituary parent Space + NodeRef destRef = property.getSelectedSpaceId(); + + ChildAssociationRef childAssocRef = getNodeService().getPrimaryParent(destRef); + workingCopyRef = property.getVersionOperationsService().checkout(node.getNodeRef(), destRef, ContentModel.ASSOC_CONTAINS, childAssocRef.getQName()); + } + else + { + // checkout the content to the current space + workingCopyRef = property.getVersionOperationsService().checkout(node.getNodeRef()); + + // if this is a workflow action and there is a task id + // present we need + // to also link the working copy to the workflow package so + // it appears + // in the resources panel in the manage task dialog + if (property.isWorkflowAction() && property.getWorkflowTaskId() != null && (property.getWorkflowTaskId().equals("null") == false)) + { + WorkflowTask task = property.getWorkflowService().getTaskById(property.getWorkflowTaskId()); + if (task != null) + { + NodeRef workflowPackage = (NodeRef) task.properties.get(WorkflowModel.ASSOC_PACKAGE); + if (workflowPackage != null) + { + getNodeService().addChild(workflowPackage, workingCopyRef, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, QName + .createValidLocalName((String) getNodeService().getProperty(workingCopyRef, ContentModel.PROP_NAME)))); + + if (logger.isDebugEnabled()) + logger.debug("Added working copy to workflow package: " + workflowPackage); + } + } + } + } + + // set the working copy Node instance + Node workingCopy = new Node(workingCopyRef); + property.setWorkingDocument(workingCopy); + + // create content URL to the content download servlet with ID + // and expected filename + // the myfile part will be ignored by the servlet but gives the + // browser a hint + String url = DownloadContentServlet.generateDownloadURL(workingCopyRef, workingCopy.getName()); + + workingCopy.getProperties().put("url", url); + workingCopy.getProperties().put("fileType32", FileTypeImageUtils.getFileTypeImage(workingCopy.getName(), false)); + + // mark as successful + checkoutSuccessful = true; + } + catch (Throwable err) + { + Utils.addErrorMessage(Application.getMessage(context, MSG_ERROR_CHECKOUT) + err.getMessage(), err); + ReportedException.throwIfNecessary(err); + } + } + else + { + logger.warn("WARNING: checkoutFile called without a current Document!"); + } + + // determine which page to show next if the checkout was successful. + if (checkoutSuccessful) + { + // If a check-in rule is present in the space + // the document was checked out to the working copy would have + // already disappeared! + if (getNodeService().exists(property.getWorkingDocument().getNodeRef())) + { + // go to the page that allows the user to download the content + // for editing + outcome = "dialog:checkoutFileLink"; // "checkoutFileLink"; + // //checkout-file-link.jsp + // currentAction = Action.CHECKOUT_FILE_LINK; + } + else + { + // show a page telling the user that the content has already + // been checked in + outcome = "dialog:workingCopyMissing";// "workingCopyMissing"; + // // + // working-copy-missing.jsp + // currentAction = Action.WORKING_COPY_MISSING; + } + } + return outcome; + } + +} diff --git a/source/java/org/alfresco/web/bean/coci/CCCheckoutFileLinkDialog.java b/source/java/org/alfresco/web/bean/coci/CCCheckoutFileLinkDialog.java index b33d9fbb23..9f71e497c4 100644 --- a/source/java/org/alfresco/web/bean/coci/CCCheckoutFileLinkDialog.java +++ b/source/java/org/alfresco/web/bean/coci/CCCheckoutFileLinkDialog.java @@ -1,90 +1,90 @@ -package org.alfresco.web.bean.coci; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -public class CCCheckoutFileLinkDialog extends CheckinCheckoutDialog -{ - private static final long serialVersionUID = -4732775752517417543L; - - public static final String MSG_CHECKOUT_OF = "check_out_of"; - public static final String LBL_UNDO_CHECKOUT = "undo_checkout"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private static Log logger = LogFactory.getLog(CCCheckoutFileLinkDialog.class); - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return checkoutFileOK(context, outcome); - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_CHECKOUT_OF) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), LBL_UNDO_CHECKOUT); - } - - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); - } - - @Override - public String cancel() - { - undoCheckout(); - resetState(); - super.cancel(); - return "browse"; - - } - - /** - * Action called upon completion of the Check Out file Link download page - */ - public String checkoutFileOK(FacesContext context, String outcome) - { - Node node = property.getWorkingDocument(); - if (node != null) - { - // reset the underlying node - if (this.browseBean.getDocument() != null) - { - this.browseBean.getDocument().reset(); - } - - // clean up and clear action context - resetState(); - property.setDocument(null); - property.setWorkingDocument(null); - // currentAction = Action.NONE; - outcome = AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + ":browse"; - } - else - { - logger.warn("WARNING: checkoutFileOK called without a current WorkingDocument!"); - } - return outcome; - } -} +package org.alfresco.web.bean.coci; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class CCCheckoutFileLinkDialog extends CheckinCheckoutDialog +{ + private static final long serialVersionUID = -4732775752517417543L; + + public static final String MSG_CHECKOUT_OF = "check_out_of"; + public static final String LBL_UNDO_CHECKOUT = "undo_checkout"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private static Log logger = LogFactory.getLog(CCCheckoutFileLinkDialog.class); + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return checkoutFileOK(context, outcome); + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_CHECKOUT_OF) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), LBL_UNDO_CHECKOUT); + } + + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); + } + + @Override + public String cancel() + { + undoCheckout(); + resetState(); + super.cancel(); + return "browse"; + + } + + /** + * Action called upon completion of the Check Out file Link download page + */ + public String checkoutFileOK(FacesContext context, String outcome) + { + Node node = property.getWorkingDocument(); + if (node != null) + { + // reset the underlying node + if (this.browseBean.getDocument() != null) + { + this.browseBean.getDocument().reset(); + } + + // clean up and clear action context + resetState(); + property.setDocument(null); + property.setWorkingDocument(null); + // currentAction = Action.NONE; + outcome = AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + ":browse"; + } + else + { + logger.warn("WARNING: checkoutFileOK called without a current WorkingDocument!"); + } + return outcome; + } +} diff --git a/source/java/org/alfresco/web/bean/coci/CCEditFileDialog.java b/source/java/org/alfresco/web/bean/coci/CCEditFileDialog.java index 45191e1dac..599f82afbe 100644 --- a/source/java/org/alfresco/web/bean/coci/CCEditFileDialog.java +++ b/source/java/org/alfresco/web/bean/coci/CCEditFileDialog.java @@ -1,44 +1,44 @@ -package org.alfresco.web.bean.coci; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; - -public class CCEditFileDialog extends CheckinCheckoutDialog -{ - private static final long serialVersionUID = -1145049277343144264L; - - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - public static final String LBL_CLOSE = "close"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - - return super.cancel(); - } - - @Override - public String cancel() - { - property.setDocument(null); - property.setWorkingDocument(null); - resetState(); - return super.cancel(); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), LBL_CLOSE); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_LEFT_QUOTE) + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - -} +package org.alfresco.web.bean.coci; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; + +public class CCEditFileDialog extends CheckinCheckoutDialog +{ + private static final long serialVersionUID = -1145049277343144264L; + + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + public static final String LBL_CLOSE = "close"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + + return super.cancel(); + } + + @Override + public String cancel() + { + property.setDocument(null); + property.setWorkingDocument(null); + resetState(); + return super.cancel(); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), LBL_CLOSE); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_LEFT_QUOTE) + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + +} diff --git a/source/java/org/alfresco/web/bean/coci/CCEditHtmlInlineDialog.java b/source/java/org/alfresco/web/bean/coci/CCEditHtmlInlineDialog.java index 20ccccb2dd..7d12bcf549 100644 --- a/source/java/org/alfresco/web/bean/coci/CCEditHtmlInlineDialog.java +++ b/source/java/org/alfresco/web/bean/coci/CCEditHtmlInlineDialog.java @@ -1,39 +1,39 @@ -package org.alfresco.web.bean.coci; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; - -public class CCEditHtmlInlineDialog extends CheckinCheckoutDialog -{ - private static final long serialVersionUID = 5971155828037579931L; - - public static final String LBL_SAVE = "save"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return editInline(context, outcome); - - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getFinishButtonLabel() - { - - return Application.getMessage(FacesContext.getCurrentInstance(), LBL_SAVE); - } - - @Override - public String getContainerTitle() - { - return property.getDocument().getName(); - } - -} +package org.alfresco.web.bean.coci; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; + +public class CCEditHtmlInlineDialog extends CheckinCheckoutDialog +{ + private static final long serialVersionUID = 5971155828037579931L; + + public static final String LBL_SAVE = "save"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return editInline(context, outcome); + + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getFinishButtonLabel() + { + + return Application.getMessage(FacesContext.getCurrentInstance(), LBL_SAVE); + } + + @Override + public String getContainerTitle() + { + return property.getDocument().getName(); + } + +} diff --git a/source/java/org/alfresco/web/bean/coci/CCEditTextInlineDialog.java b/source/java/org/alfresco/web/bean/coci/CCEditTextInlineDialog.java index 4e148e35a1..ed359bc22e 100644 --- a/source/java/org/alfresco/web/bean/coci/CCEditTextInlineDialog.java +++ b/source/java/org/alfresco/web/bean/coci/CCEditTextInlineDialog.java @@ -1,39 +1,39 @@ -package org.alfresco.web.bean.coci; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; - -public class CCEditTextInlineDialog extends CheckinCheckoutDialog -{ - private static final long serialVersionUID = 4657371875928010937L; - - public static final String LBL_SAVE = "save"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return editInline(context, outcome); - - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getFinishButtonLabel() - { - - return Application.getMessage(FacesContext.getCurrentInstance(), LBL_SAVE); - } - - @Override - public String getContainerTitle() - { - return property.getDocument().getName(); - } - -} +package org.alfresco.web.bean.coci; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; + +public class CCEditTextInlineDialog extends CheckinCheckoutDialog +{ + private static final long serialVersionUID = 4657371875928010937L; + + public static final String LBL_SAVE = "save"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return editInline(context, outcome); + + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getFinishButtonLabel() + { + + return Application.getMessage(FacesContext.getCurrentInstance(), LBL_SAVE); + } + + @Override + public String getContainerTitle() + { + return property.getDocument().getName(); + } + +} diff --git a/source/java/org/alfresco/web/bean/coci/CCProperties.java b/source/java/org/alfresco/web/bean/coci/CCProperties.java index 3e40486fbc..31b53b9913 100644 --- a/source/java/org/alfresco/web/bean/coci/CCProperties.java +++ b/source/java/org/alfresco/web/bean/coci/CCProperties.java @@ -1,406 +1,406 @@ -package org.alfresco.web.bean.coci; - -import java.io.File; -import java.io.Serializable; - -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.coci.CheckOutCheckInService; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.version.VersionService; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -public class CCProperties implements Serializable -{ - - private static final long serialVersionUID = -79530354521757202L; - - /** The VersionOperationsService to be used by the bean */ - transient protected CheckOutCheckInService versionOperationsService; - - /** The VersionQueryService to be used by the bean */ - transient protected VersionService versionQueryService; - - /** The ContentService to be used by the bean */ - transient protected ContentService contentService; - - /** The WorkflowService to be used by the bean */ - transient protected WorkflowService workflowService; - - /** Content of the document returned from in-line editing */ - private String editorOutput; - - /** Content of the document used for HTML in-line editing */ - private String documentContent; - - /** The working copy of the document we are checking out */ - private Node workingDocument; - - /** The current document */ - private Node document; - - /** transient form and upload properties */ - private File file; - private String fileName; - private String webdavUrl; - private String cifsPath; - private boolean keepCheckedOut = false; - private boolean minorChange = true; - private boolean isWorkflowAction = false; - private String workflowTaskId; - private NodeRef selectedSpaceId = null; - - /** constants for copy location selection */ - public static final String COPYLOCATION_CURRENT = "current"; - public static final String COPYLOCATION_OTHER = "other"; - - private String versionNotes = ""; - private String copyLocation = COPYLOCATION_CURRENT; - - /** - * @return Returns the VersionOperationsService. - */ - public CheckOutCheckInService getVersionOperationsService() - { - //check for null in cluster environment - if (versionOperationsService == null) - { - versionOperationsService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCheckOutCheckInService(); - } - return versionOperationsService; - } - - /** - * @param versionOperationsService - * The VersionOperationsService to set. - */ - public void setVersionOperationsService(CheckOutCheckInService versionOperationsService) - { - this.versionOperationsService = versionOperationsService; - } - - /** - * @return Returns the VersionQueryService. - */ - public VersionService getVersionQueryService() - { - if (this.versionQueryService == null) - { - this.versionQueryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getVersionService(); - } - - return this.versionQueryService; - } - - /** - * @param versionQueryService - * The VersionQueryService to set. - */ - public void setVersionQueryService(VersionService versionQueryService) - { - this.versionQueryService = versionQueryService; - } - - /** - * @return Returns the ContentService. - */ - public ContentService getContentService() - { - //check for null in cluster environment - if (contentService == null) - { - contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); - } - return contentService; - } - - /** - * @param contentService - * The ContentService to set. - */ - public void setContentService(ContentService contentService) - { - this.contentService = contentService; - } - - /** - * @param workflowService - * The WorkflowService to set. - */ - public void setWorkflowService(WorkflowService workflowService) - { - this.workflowService = workflowService; - } - - /** - * @return the workflowService - */ - public WorkflowService getWorkflowService() - { - //check for null for cluster environment - if (workflowService == null) - { - workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); - } - return workflowService; - } - - /** - * @return Returns output from the in-line editor page. - */ - public String getEditorOutput() - { - return this.editorOutput; - } - - /** - * @param editorOutput - * The output from the in-line editor page - */ - public void setEditorOutput(String editorOutput) - { - this.editorOutput = editorOutput; - } - - /** - * @return Returns the document content used for HTML in-line editing. - */ - public String getDocumentContent() - { - return this.documentContent; - } - - /** - * @param documentContent - * The document content for HTML in-line editing. - */ - public void setDocumentContent(String documentContent) - { - this.documentContent = documentContent; - } - - /** - * @return Returns the working copy Document. - */ - public Node getWorkingDocument() - { - return this.workingDocument; - } - - /** - * @param workingDocument - * The working copy Document to set. - */ - public void setWorkingDocument(Node workingDocument) - { - this.workingDocument = workingDocument; - } - - /** - * @return The document node being used for the current operation - */ - public Node getDocument() - { - return this.document; - } - - /** - * @param document - * The document node to be used for the current operation - */ - public void setDocument(Node document) - { - this.document = document; - } - - /** - * @return Returns the selected Space Id. - */ - public NodeRef getSelectedSpaceId() - { - return this.selectedSpaceId; - } - - /** - * @param selectedSpaceId - * The selected Space Id to set. - */ - public void setSelectedSpaceId(NodeRef selectedSpaceId) - { - this.selectedSpaceId = selectedSpaceId; - } - - /** - * @return the file - */ - public File getFile() - { - return file; - } - - /** - * @param file the file to set - */ - public void setFile(File file) - { - this.file = file; - } - - /** - * @return the fileName - */ - public String getFileName() - { - return fileName; - } - - /** - * @param fileName the fileName to set - */ - public void setFileName(String fileName) - { - this.fileName = fileName; - } - - /** - * @param keepCheckedOut - * The keepCheckedOut to set. - */ - public void setKeepCheckedOut(boolean keepCheckedOut) - { - this.keepCheckedOut = keepCheckedOut; - } - - /** - * @return Returns the keepCheckedOut. - */ - public boolean getKeepCheckedOut() - { - return this.keepCheckedOut; - } - - /** - * @param minorChange - * The minorChange to set. - */ - public void setMinorChange(boolean minorChange) - { - this.minorChange = minorChange; - } - - /** - * @return Returns the minorChange flag. - */ - public boolean getMinorChange() - { - return this.minorChange; - } - - /** - * @return the isWorkflowAction - */ - public boolean isWorkflowAction() - { - return isWorkflowAction; - } - - /** - * @param isWorkflowAction the isWorkflowAction to set - */ - public void setWorkflowAction(boolean isWorkflowAction) - { - this.isWorkflowAction = isWorkflowAction; - } - - /** - * @return the workflowTaskId - */ - public String getWorkflowTaskId() - { - return workflowTaskId; - } - - /** - * @param workflowTaskId the workflowTaskId to set - */ - public void setWorkflowTaskId(String workflowTaskId) - { - this.workflowTaskId = workflowTaskId; - } - - /** - * @return Returns the version history notes. - */ - public String getVersionNotes() - { - return this.versionNotes; - } - - /** - * @param versionNotes - * The version history notes to set. - */ - public void setVersionNotes(String versionNotes) - { - this.versionNotes = versionNotes; - } - - /** - * @return Returns the copy location. Either the current or other space. - */ - public String getCopyLocation() - { - if (this.getFileName() == null || this.getFileName().length() == 0) - { - return this.copyLocation; - } - else - { - return CCProperties.COPYLOCATION_OTHER; - } - } - - /** - * @param copyLocation - * The copy location. Either the current or other space. - */ - public void setCopyLocation(String copyLocation) - { - this.copyLocation = copyLocation; - } - - /** - * @return Returns WebDav url for online editing. If webdav online editing didn't yet started, returns null - */ - public String getWebdavUrl() - { - return webdavUrl; - } - - /** - * @param webdavUrl The webdav url. Using only for online editing - */ - public void setWebdavUrl(String webdavUrl) - { - this.webdavUrl = webdavUrl; - } - - /** - * @return Returns CIFS path for online editing. If cifs online editing didn't yet started, returns null - */ - public String getCifsPath() - { - return cifsPath; - } - - /** - * @param cifsPath The cifs path. Using only for online editing - */ - public void setCifsPath(String cifsPath) - { - this.cifsPath = cifsPath; - } -} +package org.alfresco.web.bean.coci; + +import java.io.File; +import java.io.Serializable; + +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.coci.CheckOutCheckInService; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.version.VersionService; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +public class CCProperties implements Serializable +{ + + private static final long serialVersionUID = -79530354521757202L; + + /** The VersionOperationsService to be used by the bean */ + transient protected CheckOutCheckInService versionOperationsService; + + /** The VersionQueryService to be used by the bean */ + transient protected VersionService versionQueryService; + + /** The ContentService to be used by the bean */ + transient protected ContentService contentService; + + /** The WorkflowService to be used by the bean */ + transient protected WorkflowService workflowService; + + /** Content of the document returned from in-line editing */ + private String editorOutput; + + /** Content of the document used for HTML in-line editing */ + private String documentContent; + + /** The working copy of the document we are checking out */ + private Node workingDocument; + + /** The current document */ + private Node document; + + /** transient form and upload properties */ + private File file; + private String fileName; + private String webdavUrl; + private String cifsPath; + private boolean keepCheckedOut = false; + private boolean minorChange = true; + private boolean isWorkflowAction = false; + private String workflowTaskId; + private NodeRef selectedSpaceId = null; + + /** constants for copy location selection */ + public static final String COPYLOCATION_CURRENT = "current"; + public static final String COPYLOCATION_OTHER = "other"; + + private String versionNotes = ""; + private String copyLocation = COPYLOCATION_CURRENT; + + /** + * @return Returns the VersionOperationsService. + */ + public CheckOutCheckInService getVersionOperationsService() + { + //check for null in cluster environment + if (versionOperationsService == null) + { + versionOperationsService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCheckOutCheckInService(); + } + return versionOperationsService; + } + + /** + * @param versionOperationsService + * The VersionOperationsService to set. + */ + public void setVersionOperationsService(CheckOutCheckInService versionOperationsService) + { + this.versionOperationsService = versionOperationsService; + } + + /** + * @return Returns the VersionQueryService. + */ + public VersionService getVersionQueryService() + { + if (this.versionQueryService == null) + { + this.versionQueryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getVersionService(); + } + + return this.versionQueryService; + } + + /** + * @param versionQueryService + * The VersionQueryService to set. + */ + public void setVersionQueryService(VersionService versionQueryService) + { + this.versionQueryService = versionQueryService; + } + + /** + * @return Returns the ContentService. + */ + public ContentService getContentService() + { + //check for null in cluster environment + if (contentService == null) + { + contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); + } + return contentService; + } + + /** + * @param contentService + * The ContentService to set. + */ + public void setContentService(ContentService contentService) + { + this.contentService = contentService; + } + + /** + * @param workflowService + * The WorkflowService to set. + */ + public void setWorkflowService(WorkflowService workflowService) + { + this.workflowService = workflowService; + } + + /** + * @return the workflowService + */ + public WorkflowService getWorkflowService() + { + //check for null for cluster environment + if (workflowService == null) + { + workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); + } + return workflowService; + } + + /** + * @return Returns output from the in-line editor page. + */ + public String getEditorOutput() + { + return this.editorOutput; + } + + /** + * @param editorOutput + * The output from the in-line editor page + */ + public void setEditorOutput(String editorOutput) + { + this.editorOutput = editorOutput; + } + + /** + * @return Returns the document content used for HTML in-line editing. + */ + public String getDocumentContent() + { + return this.documentContent; + } + + /** + * @param documentContent + * The document content for HTML in-line editing. + */ + public void setDocumentContent(String documentContent) + { + this.documentContent = documentContent; + } + + /** + * @return Returns the working copy Document. + */ + public Node getWorkingDocument() + { + return this.workingDocument; + } + + /** + * @param workingDocument + * The working copy Document to set. + */ + public void setWorkingDocument(Node workingDocument) + { + this.workingDocument = workingDocument; + } + + /** + * @return The document node being used for the current operation + */ + public Node getDocument() + { + return this.document; + } + + /** + * @param document + * The document node to be used for the current operation + */ + public void setDocument(Node document) + { + this.document = document; + } + + /** + * @return Returns the selected Space Id. + */ + public NodeRef getSelectedSpaceId() + { + return this.selectedSpaceId; + } + + /** + * @param selectedSpaceId + * The selected Space Id to set. + */ + public void setSelectedSpaceId(NodeRef selectedSpaceId) + { + this.selectedSpaceId = selectedSpaceId; + } + + /** + * @return the file + */ + public File getFile() + { + return file; + } + + /** + * @param file the file to set + */ + public void setFile(File file) + { + this.file = file; + } + + /** + * @return the fileName + */ + public String getFileName() + { + return fileName; + } + + /** + * @param fileName the fileName to set + */ + public void setFileName(String fileName) + { + this.fileName = fileName; + } + + /** + * @param keepCheckedOut + * The keepCheckedOut to set. + */ + public void setKeepCheckedOut(boolean keepCheckedOut) + { + this.keepCheckedOut = keepCheckedOut; + } + + /** + * @return Returns the keepCheckedOut. + */ + public boolean getKeepCheckedOut() + { + return this.keepCheckedOut; + } + + /** + * @param minorChange + * The minorChange to set. + */ + public void setMinorChange(boolean minorChange) + { + this.minorChange = minorChange; + } + + /** + * @return Returns the minorChange flag. + */ + public boolean getMinorChange() + { + return this.minorChange; + } + + /** + * @return the isWorkflowAction + */ + public boolean isWorkflowAction() + { + return isWorkflowAction; + } + + /** + * @param isWorkflowAction the isWorkflowAction to set + */ + public void setWorkflowAction(boolean isWorkflowAction) + { + this.isWorkflowAction = isWorkflowAction; + } + + /** + * @return the workflowTaskId + */ + public String getWorkflowTaskId() + { + return workflowTaskId; + } + + /** + * @param workflowTaskId the workflowTaskId to set + */ + public void setWorkflowTaskId(String workflowTaskId) + { + this.workflowTaskId = workflowTaskId; + } + + /** + * @return Returns the version history notes. + */ + public String getVersionNotes() + { + return this.versionNotes; + } + + /** + * @param versionNotes + * The version history notes to set. + */ + public void setVersionNotes(String versionNotes) + { + this.versionNotes = versionNotes; + } + + /** + * @return Returns the copy location. Either the current or other space. + */ + public String getCopyLocation() + { + if (this.getFileName() == null || this.getFileName().length() == 0) + { + return this.copyLocation; + } + else + { + return CCProperties.COPYLOCATION_OTHER; + } + } + + /** + * @param copyLocation + * The copy location. Either the current or other space. + */ + public void setCopyLocation(String copyLocation) + { + this.copyLocation = copyLocation; + } + + /** + * @return Returns WebDav url for online editing. If webdav online editing didn't yet started, returns null + */ + public String getWebdavUrl() + { + return webdavUrl; + } + + /** + * @param webdavUrl The webdav url. Using only for online editing + */ + public void setWebdavUrl(String webdavUrl) + { + this.webdavUrl = webdavUrl; + } + + /** + * @return Returns CIFS path for online editing. If cifs online editing didn't yet started, returns null + */ + public String getCifsPath() + { + return cifsPath; + } + + /** + * @param cifsPath The cifs path. Using only for online editing + */ + public void setCifsPath(String cifsPath) + { + this.cifsPath = cifsPath; + } +} diff --git a/source/java/org/alfresco/web/bean/coci/CCUndoCheckoutFileDialog.java b/source/java/org/alfresco/web/bean/coci/CCUndoCheckoutFileDialog.java index d68d7e489f..d3866b3c71 100644 --- a/source/java/org/alfresco/web/bean/coci/CCUndoCheckoutFileDialog.java +++ b/source/java/org/alfresco/web/bean/coci/CCUndoCheckoutFileDialog.java @@ -1,101 +1,101 @@ -package org.alfresco.web.bean.coci; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -public class CCUndoCheckoutFileDialog extends CheckinCheckoutDialog -{ - private static final long serialVersionUID = -6957120889259486975L; - - public static final String LBL_UNDO_CHECKOUT = "undo_checkout"; - public static final String MSG_UNDO_CHECKOUT_FOR = "undo_checkout_for"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private static Log logger = LogFactory.getLog(CheckinCheckoutDialog.class); - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return undoCheckoutFile(context, outcome); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_UNDO_CHECKOUT_FOR) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), LBL_UNDO_CHECKOUT); - - } - - /** - * Action to undo the checkout of a locked document. This document may - * either by the original copy or the working copy node. Therefore calculate - * which it is, if the working copy is found then we simply cancel checkout - * on that document. If the original copy is found then we need to find the - * appropriate working copy and perform the action on that node. - */ - public String undoCheckoutFile(FacesContext context, String outcome) - { - Node node = property.getDocument(); - if (node != null) - { - try - { - if (node.hasAspect(ContentModel.ASPECT_WORKING_COPY)) - { - this.property.getVersionOperationsService().cancelCheckout(node.getNodeRef()); - } - else if (node.hasAspect(ContentModel.ASPECT_LOCKABLE)) - { - // TODO: find the working copy for this document and cancel - // the checkout on it - // is this possible? as currently only the workingcopy - // aspect has the copyReference - // attribute - this means we cannot find out where the copy - // is to cancel it! - // can we construct an XPath node lookup? - throw new RuntimeException("NOT IMPLEMENTED"); - } - else - { - throw new IllegalStateException("Node supplied for undo checkout has neither Working Copy or Locked aspect!"); - } - - resetState(); - } - catch (Throwable err) - { - Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), MSG_ERROR_CANCELCHECKOUT) + err.getMessage(), err); - ReportedException.throwIfNecessary(err); - } - } - else - { - logger.warn("WARNING: undoCheckout called without a current WorkingDocument!"); - } - - return outcome + ":browse"; - } - -} +package org.alfresco.web.bean.coci; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class CCUndoCheckoutFileDialog extends CheckinCheckoutDialog +{ + private static final long serialVersionUID = -6957120889259486975L; + + public static final String LBL_UNDO_CHECKOUT = "undo_checkout"; + public static final String MSG_UNDO_CHECKOUT_FOR = "undo_checkout_for"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private static Log logger = LogFactory.getLog(CheckinCheckoutDialog.class); + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return undoCheckoutFile(context, outcome); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_UNDO_CHECKOUT_FOR) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), LBL_UNDO_CHECKOUT); + + } + + /** + * Action to undo the checkout of a locked document. This document may + * either by the original copy or the working copy node. Therefore calculate + * which it is, if the working copy is found then we simply cancel checkout + * on that document. If the original copy is found then we need to find the + * appropriate working copy and perform the action on that node. + */ + public String undoCheckoutFile(FacesContext context, String outcome) + { + Node node = property.getDocument(); + if (node != null) + { + try + { + if (node.hasAspect(ContentModel.ASPECT_WORKING_COPY)) + { + this.property.getVersionOperationsService().cancelCheckout(node.getNodeRef()); + } + else if (node.hasAspect(ContentModel.ASPECT_LOCKABLE)) + { + // TODO: find the working copy for this document and cancel + // the checkout on it + // is this possible? as currently only the workingcopy + // aspect has the copyReference + // attribute - this means we cannot find out where the copy + // is to cancel it! + // can we construct an XPath node lookup? + throw new RuntimeException("NOT IMPLEMENTED"); + } + else + { + throw new IllegalStateException("Node supplied for undo checkout has neither Working Copy or Locked aspect!"); + } + + resetState(); + } + catch (Throwable err) + { + Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), MSG_ERROR_CANCELCHECKOUT) + err.getMessage(), err); + ReportedException.throwIfNecessary(err); + } + } + else + { + logger.warn("WARNING: undoCheckout called without a current WorkingDocument!"); + } + + return outcome + ":browse"; + } + +} diff --git a/source/java/org/alfresco/web/bean/coci/CCWorkingCopyMissingDialog.java b/source/java/org/alfresco/web/bean/coci/CCWorkingCopyMissingDialog.java index 5209486adc..3c66897937 100644 --- a/source/java/org/alfresco/web/bean/coci/CCWorkingCopyMissingDialog.java +++ b/source/java/org/alfresco/web/bean/coci/CCWorkingCopyMissingDialog.java @@ -1,46 +1,46 @@ -package org.alfresco.web.bean.coci; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; - -public class CCWorkingCopyMissingDialog extends CheckinCheckoutDialog -{ - private static final long serialVersionUID = 8067485292477557683L; - - public static final String MSG_WORKING_COPY_FOR = "working_copy_for"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - public static final String LBL_CLOSE = "close"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove(AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); - - return getDefaultCancelOutcome(); - } - - @Override - public String cancel() - { - FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove(AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); - - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + ":browse"; - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_WORKING_COPY_FOR) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), LBL_CLOSE); - } -} +package org.alfresco.web.bean.coci; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; + +public class CCWorkingCopyMissingDialog extends CheckinCheckoutDialog +{ + private static final long serialVersionUID = 8067485292477557683L; + + public static final String MSG_WORKING_COPY_FOR = "working_copy_for"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + public static final String LBL_CLOSE = "close"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove(AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); + + return getDefaultCancelOutcome(); + } + + @Override + public String cancel() + { + FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove(AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); + + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + ":browse"; + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_WORKING_COPY_FOR) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + property.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), LBL_CLOSE); + } +} diff --git a/source/java/org/alfresco/web/bean/content/AddContentDialog.java b/source/java/org/alfresco/web/bean/content/AddContentDialog.java index 4516566f71..1b4ea6eaa7 100644 --- a/source/java/org/alfresco/web/bean/content/AddContentDialog.java +++ b/source/java/org/alfresco/web/bean/content/AddContentDialog.java @@ -1,330 +1,330 @@ -package org.alfresco.web.bean.content; - -import java.io.BufferedInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.InputStream; -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.springframework.extensions.config.Config; -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigService; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.content.filestore.FileContentReader; -import org.alfresco.service.cmr.model.FileExistsException; -import org.alfresco.service.cmr.repository.ContentReader; -import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.FileUploadBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; - -/** - * Bean implementation for the "Add Content" dialog - * - * @author gavinc - */ -public class AddContentDialog extends BaseContentWizard -{ - private final static String MSG_OK = "ok"; - private static final long serialVersionUID = 3593557546118692687L; - - protected List inlineEditableMimeTypes; - protected File file; - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - // Try and extract metadata from the file - ContentReader cr = new FileContentReader(this.file); - cr.setMimetype(this.mimeType); - cr.setEncoding(this.encoding); - // create properties for content type - Map contentProps = new HashMap(5, 1.0f); - - if (Repository.extractMetadata(FacesContext.getCurrentInstance(), cr, contentProps)) - { - this.author = (String)(contentProps.get(ContentModel.PROP_AUTHOR)); - this.title = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_TITLE)); - this.description = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_DESCRIPTION)); - } - - // default the title to the file name if not set - if (this.title == null) - { - this.title = this.fileName; - } - - // determine whether inline editing should be enabled by default. - // if the mime type of the added file is in the list of mime types - // configured in "Content Wizards" then enable inline editing - List mimeTypes = getInlineEditableMimeTypes(); - if (mimeTypes.contains(this.mimeType)) - { - this.inlineEdit = true; - } - - saveContent(this.file, null); - - // return default outcome - return outcome; - } - - @Override - public void init(Map parameters) - { - super.init(parameters); - - clearUpload(); - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - clearUpload(); - - // as we were successful, go to the set properties dialog if asked - // to otherwise just return - if (this.showOtherProperties) - { - // check whether the created node is checked out, if a 'check out' - // rule is present in the space the new node will be and an - // attempt to modify the properties will cause an error (ALF-438) - if (getNodeService().hasAspect(this.createdNode, ContentModel.ASPECT_LOCKABLE)) - { - Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), MSG_NODE_LOCKED)); - return outcome; - } - else - { - // we are going to immediately edit the properties so we need - // to setup the BrowseBean context appropriately - this.browseBean.setDocument(new Node(this.createdNode)); - - return "dialog:setContentProperties"; - } - } - else - { - return outcome; - } - } - - @Override - protected String getDefaultFinishOutcome() - { - // as we are using this dialog outside the dialog framework - // just go back to the main page - - return "dialog:close:browse"; - } - - // ------------------------------------------------------------------------------ - // Bean getters and setters - - /** - * @return Returns the message to display when a file has been uploaded - */ - public String getFileUploadSuccessMsg() - { - // NOTE: This is a far from ideal solution but will do until we have - // a pure JSF upload solution working. This method is only called - // after a file is uploaded, so we can calculate the mime type and - // determine whether to enable inline editing in here. - FacesContext fc = FacesContext.getCurrentInstance(); - - // Identify the mimetype as best as we can - this.mimeType = Repository.getMimeTypeForFile(fc, this.fileName, this.file); - - // Identify the encoding as best we can (only really important for text based formats) - this.encoding = "UTF-8"; - InputStream is = null; - try - { - if (this.file != null) - { - is = new BufferedInputStream(new FileInputStream(this.file)); - this.encoding = Repository.guessEncoding(fc, is, this.mimeType); - } - } - catch (Throwable e) - { - // Not terminal - logger.error("Failed to get encoding from file: " + this.fileName, e); - } - finally - { - try { is.close(); } catch (Throwable e) {} // Includes NPE - } - - // Offer inline editing for HTML only - this.inlineEdit = (this.mimeType.equals(MimetypeMap.MIMETYPE_HTML)); - - // get the file upload message - String msg = Application.getMessage(FacesContext.getCurrentInstance(), "file_upload_success"); - return MessageFormat.format(msg, new Object[] {Utils.encode(getFileName())}); - } - - /** - * @return Returns the name of the file - */ - public String getFileName() - { - // try and retrieve the file and filename from the file upload bean - // representing the file we previously uploaded. - FacesContext ctx = FacesContext.getCurrentInstance(); - FileUploadBean fileBean = (FileUploadBean)ctx.getExternalContext().getSessionMap(). - get(FileUploadBean.FILE_UPLOAD_BEAN_NAME); - if (fileBean != null) - { - this.file = fileBean.getFile(); - this.fileName = fileBean.getFileName(); - } - - return this.fileName; - } - - /** - * @param fileName The name of the file - */ - public void setFileName(String fileName) - { - this.fileName = fileName; - - // we also need to keep the file upload bean in sync - FacesContext ctx = FacesContext.getCurrentInstance(); - FileUploadBean fileBean = (FileUploadBean)ctx.getExternalContext().getSessionMap(). - get(FileUploadBean.FILE_UPLOAD_BEAN_NAME); - if (fileBean != null) - { - fileBean.setFileName(this.fileName); - } - } - - // ------------------------------------------------------------------------------ - // Action event handlers - - /** - * Action listener called when the add content dialog is called - */ - public void start(ActionEvent event) - { - // NOTE: this is a temporary solution to allow us to use the new dialog - // framework beans outside of the dialog framework, we need to do - // this because the uploading requires a separate non-JSF form, this - // approach can not be used in the current dialog framework. Until - // we have a pure JSF upload solution we need this initialisation - - init(null); - } - - /** - * Action handler called when the user wishes to remove an uploaded file - */ - public String removeUploadedFile() - { - clearUpload(); - - // also clear the file name - this.fileName = null; - - // refresh the current page - return null; - } - - /** - * Action handler called when the dialog is cancelled - */ - public String cancel() - { - clearUpload(); - return "dialog:close"; - } - - // ------------------------------------------------------------------------------ - // Helper Methods - - /** - * Deletes the uploaded file and removes the FileUploadBean from the session - */ - protected void clearUpload() - { - // delete the temporary file we uploaded earlier - if (this.file != null) - { - this.file.delete(); - } - - this.file = null; - - // remove the file upload bean from the session - FacesContext ctx = FacesContext.getCurrentInstance(); - ctx.getExternalContext().getSessionMap().remove(FileUploadBean.FILE_UPLOAD_BEAN_NAME); - } - - protected List getInlineEditableMimeTypes() - { - if ((this.inlineEditableMimeTypes == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - this.inlineEditableMimeTypes = new ArrayList(8); - - // get the create mime types list from the config - ConfigService svc = Application.getConfigService(FacesContext.getCurrentInstance()); - Config wizardCfg = svc.getConfig("Content Wizards"); - if (wizardCfg != null) - { - ConfigElement typesCfg = wizardCfg.getConfigElement("create-mime-types"); - if (typesCfg != null) - { - for (ConfigElement child : typesCfg.getChildren()) - { - String currentMimeType = child.getAttribute("name"); - this.inlineEditableMimeTypes.add(currentMimeType); - } - } - } - } - - return this.inlineEditableMimeTypes; - } - - @Override - public String getFinishButtonLabel() - { - - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_OK); - } - - @Override - protected String formatErrorMessage(Throwable exception) - { - if (exception instanceof FileExistsException) - { - return MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_EXISTS), - ((FileExistsException)exception).getName()); - } - else - { - return MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), "error_content"), - exception.getMessage()); - } - } - -} +package org.alfresco.web.bean.content; + +import java.io.BufferedInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.InputStream; +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.springframework.extensions.config.Config; +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigService; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.content.filestore.FileContentReader; +import org.alfresco.service.cmr.model.FileExistsException; +import org.alfresco.service.cmr.repository.ContentReader; +import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.FileUploadBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; + +/** + * Bean implementation for the "Add Content" dialog + * + * @author gavinc + */ +public class AddContentDialog extends BaseContentWizard +{ + private final static String MSG_OK = "ok"; + private static final long serialVersionUID = 3593557546118692687L; + + protected List inlineEditableMimeTypes; + protected File file; + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + // Try and extract metadata from the file + ContentReader cr = new FileContentReader(this.file); + cr.setMimetype(this.mimeType); + cr.setEncoding(this.encoding); + // create properties for content type + Map contentProps = new HashMap(5, 1.0f); + + if (Repository.extractMetadata(FacesContext.getCurrentInstance(), cr, contentProps)) + { + this.author = (String)(contentProps.get(ContentModel.PROP_AUTHOR)); + this.title = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_TITLE)); + this.description = DefaultTypeConverter.INSTANCE.convert(String.class, contentProps.get(ContentModel.PROP_DESCRIPTION)); + } + + // default the title to the file name if not set + if (this.title == null) + { + this.title = this.fileName; + } + + // determine whether inline editing should be enabled by default. + // if the mime type of the added file is in the list of mime types + // configured in "Content Wizards" then enable inline editing + List mimeTypes = getInlineEditableMimeTypes(); + if (mimeTypes.contains(this.mimeType)) + { + this.inlineEdit = true; + } + + saveContent(this.file, null); + + // return default outcome + return outcome; + } + + @Override + public void init(Map parameters) + { + super.init(parameters); + + clearUpload(); + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + clearUpload(); + + // as we were successful, go to the set properties dialog if asked + // to otherwise just return + if (this.showOtherProperties) + { + // check whether the created node is checked out, if a 'check out' + // rule is present in the space the new node will be and an + // attempt to modify the properties will cause an error (ALF-438) + if (getNodeService().hasAspect(this.createdNode, ContentModel.ASPECT_LOCKABLE)) + { + Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), MSG_NODE_LOCKED)); + return outcome; + } + else + { + // we are going to immediately edit the properties so we need + // to setup the BrowseBean context appropriately + this.browseBean.setDocument(new Node(this.createdNode)); + + return "dialog:setContentProperties"; + } + } + else + { + return outcome; + } + } + + @Override + protected String getDefaultFinishOutcome() + { + // as we are using this dialog outside the dialog framework + // just go back to the main page + + return "dialog:close:browse"; + } + + // ------------------------------------------------------------------------------ + // Bean getters and setters + + /** + * @return Returns the message to display when a file has been uploaded + */ + public String getFileUploadSuccessMsg() + { + // NOTE: This is a far from ideal solution but will do until we have + // a pure JSF upload solution working. This method is only called + // after a file is uploaded, so we can calculate the mime type and + // determine whether to enable inline editing in here. + FacesContext fc = FacesContext.getCurrentInstance(); + + // Identify the mimetype as best as we can + this.mimeType = Repository.getMimeTypeForFile(fc, this.fileName, this.file); + + // Identify the encoding as best we can (only really important for text based formats) + this.encoding = "UTF-8"; + InputStream is = null; + try + { + if (this.file != null) + { + is = new BufferedInputStream(new FileInputStream(this.file)); + this.encoding = Repository.guessEncoding(fc, is, this.mimeType); + } + } + catch (Throwable e) + { + // Not terminal + logger.error("Failed to get encoding from file: " + this.fileName, e); + } + finally + { + try { is.close(); } catch (Throwable e) {} // Includes NPE + } + + // Offer inline editing for HTML only + this.inlineEdit = (this.mimeType.equals(MimetypeMap.MIMETYPE_HTML)); + + // get the file upload message + String msg = Application.getMessage(FacesContext.getCurrentInstance(), "file_upload_success"); + return MessageFormat.format(msg, new Object[] {Utils.encode(getFileName())}); + } + + /** + * @return Returns the name of the file + */ + public String getFileName() + { + // try and retrieve the file and filename from the file upload bean + // representing the file we previously uploaded. + FacesContext ctx = FacesContext.getCurrentInstance(); + FileUploadBean fileBean = (FileUploadBean)ctx.getExternalContext().getSessionMap(). + get(FileUploadBean.FILE_UPLOAD_BEAN_NAME); + if (fileBean != null) + { + this.file = fileBean.getFile(); + this.fileName = fileBean.getFileName(); + } + + return this.fileName; + } + + /** + * @param fileName The name of the file + */ + public void setFileName(String fileName) + { + this.fileName = fileName; + + // we also need to keep the file upload bean in sync + FacesContext ctx = FacesContext.getCurrentInstance(); + FileUploadBean fileBean = (FileUploadBean)ctx.getExternalContext().getSessionMap(). + get(FileUploadBean.FILE_UPLOAD_BEAN_NAME); + if (fileBean != null) + { + fileBean.setFileName(this.fileName); + } + } + + // ------------------------------------------------------------------------------ + // Action event handlers + + /** + * Action listener called when the add content dialog is called + */ + public void start(ActionEvent event) + { + // NOTE: this is a temporary solution to allow us to use the new dialog + // framework beans outside of the dialog framework, we need to do + // this because the uploading requires a separate non-JSF form, this + // approach can not be used in the current dialog framework. Until + // we have a pure JSF upload solution we need this initialisation + + init(null); + } + + /** + * Action handler called when the user wishes to remove an uploaded file + */ + public String removeUploadedFile() + { + clearUpload(); + + // also clear the file name + this.fileName = null; + + // refresh the current page + return null; + } + + /** + * Action handler called when the dialog is cancelled + */ + public String cancel() + { + clearUpload(); + return "dialog:close"; + } + + // ------------------------------------------------------------------------------ + // Helper Methods + + /** + * Deletes the uploaded file and removes the FileUploadBean from the session + */ + protected void clearUpload() + { + // delete the temporary file we uploaded earlier + if (this.file != null) + { + this.file.delete(); + } + + this.file = null; + + // remove the file upload bean from the session + FacesContext ctx = FacesContext.getCurrentInstance(); + ctx.getExternalContext().getSessionMap().remove(FileUploadBean.FILE_UPLOAD_BEAN_NAME); + } + + protected List getInlineEditableMimeTypes() + { + if ((this.inlineEditableMimeTypes == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + this.inlineEditableMimeTypes = new ArrayList(8); + + // get the create mime types list from the config + ConfigService svc = Application.getConfigService(FacesContext.getCurrentInstance()); + Config wizardCfg = svc.getConfig("Content Wizards"); + if (wizardCfg != null) + { + ConfigElement typesCfg = wizardCfg.getConfigElement("create-mime-types"); + if (typesCfg != null) + { + for (ConfigElement child : typesCfg.getChildren()) + { + String currentMimeType = child.getAttribute("name"); + this.inlineEditableMimeTypes.add(currentMimeType); + } + } + } + } + + return this.inlineEditableMimeTypes; + } + + @Override + public String getFinishButtonLabel() + { + + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_OK); + } + + @Override + protected String formatErrorMessage(Throwable exception) + { + if (exception instanceof FileExistsException) + { + return MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_EXISTS), + ((FileExistsException)exception).getName()); + } + else + { + return MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), "error_content"), + exception.getMessage()); + } + } + +} diff --git a/source/java/org/alfresco/web/bean/content/BaseContentWizard.java b/source/java/org/alfresco/web/bean/content/BaseContentWizard.java index 1020458e06..9bdf45bd9a 100644 --- a/source/java/org/alfresco/web/bean/content/BaseContentWizard.java +++ b/source/java/org/alfresco/web/bean/content/BaseContentWizard.java @@ -1,598 +1,598 @@ -package org.alfresco.web.bean.content; - -import java.io.File; -import java.io.Serializable; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.model.SelectItem; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.dictionary.TypeDefinition; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.MimetypeService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.service.transaction.TransactionService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.wizard.BaseWizardBean; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.repo.component.UICharsetSelector; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.extensions.config.Config; -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigService; - -/** - * Base class for the content related wizards and dialogs - * - * @author gavinc - */ -@SuppressWarnings("serial") -public abstract class BaseContentWizard extends BaseWizardBean -{ - protected String fileName; - protected String author; - protected String title; - protected String description; - protected String mimeType; - protected String encoding; - protected String objectType; - protected boolean inlineEdit; - protected boolean otherPropertiesChoiceVisible = true; - protected boolean showOtherProperties = true; - - // the NodeRef of the node created during finish - protected NodeRef createdNode; - protected List objectTypes; - transient private ContentService contentService; - transient private TransactionService transactionService; - - protected static final String MSG_NODE_LOCKED = "node_locked_dialog_closed"; - - protected static Log logger = LogFactory.getLog(BaseContentWizard.class); - - - // ------------------------------------------------------------------------------ - // Wizard implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.fileName = null; - this.author = null; - this.title = null; - this.description = null; - this.mimeType = null; - this.inlineEdit = false; - this.objectType = null; - - initOtherProperties(); - } - - @Override - public boolean getFinishButtonDisabled() - { - return (this.fileName == null || - this.fileName.length() == 0 || - this.mimeType == null); - } - - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * @return Returns the name of the file - */ - public String getFileName() - { - return this.fileName; - } - - /** - * @param fileName The name of the file - */ - public void setFileName(String fileName) - { - this.fileName = fileName; - } - - /** - * @return Returns the author - */ - public String getAuthor() - { - return this.author; - } - - /** - * @param author Sets the author - */ - public void setAuthor(String author) - { - this.author = author; - } - - /** - * @return Returns the mime type currenty selected - */ - public String getMimeType() - { - return this.mimeType; - } - - /** - * @param mimeType Sets the currently selected mime type - */ - public void setMimeType(String mimeType) - { - this.mimeType = mimeType; - } - - /** - * @return Returns the encoding currently selected - */ - public String getEncoding() - { - if (encoding == null) - { - ConfigService configSvc = Application.getConfigService(FacesContext.getCurrentInstance()); - Config config = configSvc.getConfig("Content Wizards"); - if (config != null) - { - ConfigElement defaultEncCfg = config.getConfigElement("default-encoding"); - if (defaultEncCfg != null) - { - String value = defaultEncCfg.getValue(); - if (value != null) - { - encoding = value.trim(); - } - } - } - if (encoding == null || encoding.length() == 0) - { - // if not configured, set to a sensible default for most character sets - encoding = "UTF-8"; - } - } - return encoding; - } - - /** - * @param encoding the document's encoding - */ - public void setEncoding(String encoding) - { - this.encoding = encoding; - } - - /** - * @return Returns the object type currenty selected - */ - public String getObjectType() - { - return this.objectType; - } - - /** - * @param objectType Sets the currently selected object type - */ - public void setObjectType(String objectType) - { - this.objectType = objectType; - } - - /** - * @return Returns the description - */ - public String getDescription() - { - return this.description; - } - - /** - * @param description Sets the description - */ - public void setDescription(String description) - { - this.description = description; - } - - /** - * @return Returns the title - */ - public String getTitle() - { - return this.title; - } - - /** - * @param title Sets the title - */ - public void setTitle(String title) - { - this.title = title; - } - - /** - * @return Returns the inline edit flag. - */ - public boolean isInlineEdit() - { - return this.inlineEdit; - } - - /** - * @param inlineEdit The inline edit flag to set. - */ - public void setInlineEdit(boolean inlineEdit) - { - this.inlineEdit = inlineEdit; - } - - /** - * @return Determines whether the choice to modify all properties - * is shown - */ - public boolean getOtherPropertiesChoiceVisible() - { - return this.otherPropertiesChoiceVisible; - } - - /** - * @return Determines whether the edit properties dialog should be - * shown when this one ends - */ - public boolean getShowOtherProperties() - { - return this.showOtherProperties; - } - - /** - * @param showOthers Sets whether the edit properties dialog is shown - */ - public void setShowOtherProperties(boolean showOthers) - { - this.showOtherProperties = showOthers; - } - - public List getEncodings() - { - return UICharsetSelector.getCharsetEncodingList(); - } - - /** - * @return Returns a list of object types to allow the user to select from - */ - public List getObjectTypes() - { - return getTransactionService().getRetryingTransactionHelper().doInTransaction(new RetryingTransactionCallback>() - { - @Override - public List execute() throws Throwable - { - return getObjectTypesImpl(); - } - }, true); - } - - private List getObjectTypesImpl() - { - if ((this.objectTypes == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - FacesContext context = FacesContext.getCurrentInstance(); - - // add the well known object type to start with - this.objectTypes = new ArrayList(5); - - ConfigService svc = Application.getConfigService(FacesContext.getCurrentInstance()); - Config wizardCfg = svc.getConfig("Content Wizards"); - if (wizardCfg != null) - { - ConfigElement defaultTypesCfg = wizardCfg.getConfigElement("default-content-type"); - String parentLabel = ""; - if (defaultTypesCfg != null) - { - // Get the default content-type to apply - ConfigElement typeElement = defaultTypesCfg.getChildren().get(0); - QName parentQName = Repository.resolveToQName(typeElement.getAttribute("name")); - TypeDefinition parentType = null; - if (parentQName != null) - { - parentType = this.getDictionaryService().getType(parentQName); - - if (parentType == null) - { - // If no default content type is defined default to content - parentQName = ContentModel.TYPE_CONTENT; - parentType = this.getDictionaryService().getType(ContentModel.TYPE_CONTENT); - this.objectTypes.add(new SelectItem(ContentModel.TYPE_CONTENT.toString(), - Application.getMessage(context, "content"))); - logger.warn("Configured default content type not found in dictionary: " + parentQName); - } - else - { - // try and get the display label from config - parentLabel = Utils.getDisplayLabel(context, typeElement); - - // if there wasn't a client based label try and get it from the dictionary - if (parentLabel == null) - { - parentLabel = parentType.getTitle(this.getDictionaryService()); - } - - // finally, just use the localname - if (parentLabel == null) - { - parentLabel = parentQName.getLocalName(); - } - } - } - - // Get all content types defined - ConfigElement typesCfg = wizardCfg.getConfigElement("content-types"); - if (typesCfg != null) - { - for (ConfigElement child : typesCfg.getChildren()) - { - QName idQName = Repository.resolveToQName(child.getAttribute("name")); - if (idQName != null) - { - TypeDefinition typeDef = this.getDictionaryService().getType(idQName); - - if (typeDef != null) - { - // for each type check if it is a subtype of the default content type - if (this.getDictionaryService().isSubClass(typeDef.getName(), parentType.getName())) - { - // try and get the display label from config - String label = Utils.getDisplayLabel(context, child); - - // if there wasn't a client based label try and get it from the dictionary - if (label == null) - { - label = typeDef.getTitle(this.getDictionaryService()); - } - - // finally, just use the localname - if (label == null) - { - label = idQName.getLocalName(); - } - - this.objectTypes.add(new SelectItem(idQName.toString(), label)); - } - else - { - logger.warn("Failed to add '" + child.getAttribute("name") + - "' to the list of content types - it is not a subtype of " + parentQName); - } - } - } - else - { - logger.warn("Failed to add '" + child.getAttribute("name") + - "' to the list of content types as the type is not recognised"); - } - } - } - - // Case when no type is defined - we add the default content type to the list of available types - if (this.objectTypes.isEmpty()) - { - // add default content type to the list of available types - this.objectTypes.add(new SelectItem(parentQName.toString(), parentLabel)); - } - - // make sure the list is sorted by the label - QuickSort sorter = new QuickSort(this.objectTypes, "label", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - } - else - { - logger.warn("Could not find 'content-types' configuration element"); - } - } - else - { - logger.warn("Could not find 'Content Wizards' configuration section"); - } - - } - - return this.objectTypes; - } - - - // ------------------------------------------------------------------------------ - // Service Injection - - /** - * @param contentService The contentService to set. - */ - public void setContentService(ContentService contentService) - { - this.contentService = contentService; - } - - protected ContentService getContentService() - { - if (contentService == null) - { - contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); - } - return contentService; - } - - protected TransactionService getTransactionService() - { - if (null == transactionService) - { - transactionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getTransactionService(); - } - - return transactionService; - } - - - // ------------------------------------------------------------------------------ - // Helper methods - - /** - * Save the specified content using the currently set wizard attributes - * - * @param fileContent File content to save - * @param strContent String content to save - */ - protected void saveContent(File fileContent, String strContent) throws Exception - { - // get the node ref of the node that will contain the content - NodeRef containerNodeRef; - String nodeId = this.navigator.getCurrentNodeId(); - if (nodeId == null) - { - containerNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); - } - else - { - containerNodeRef = new NodeRef(Repository.getStoreRef(), nodeId); - } - - // apply the inline editable aspect (by adding the property at create time) - Map editProps = new HashMap(6); - if (this.inlineEdit == true) - { - editProps.put(ApplicationModel.PROP_EDITINLINE, this.inlineEdit); - if (logger.isDebugEnabled()) - logger.debug("Added inlineeditable aspect with properties: " + editProps); - } - - // set the name - editProps.put(ContentModel.PROP_NAME, this.fileName); - - // set the author property - editProps.put(ContentModel.PROP_AUTHOR, this.author); - - // apply the titled aspect - title and description - editProps.put(ContentModel.PROP_TITLE, this.title); - editProps.put(ContentModel.PROP_DESCRIPTION, this.description); - if (logger.isDebugEnabled()) - logger.debug("Added titled aspect with properties: " + this.title + ", " + this.description); - - // create the node - NodeRef fileNodeRef = this.getNodeService().createNode( - containerNodeRef, - ContentModel.ASSOC_CONTAINS, - QName.createQNameWithValidLocalName(NamespaceService.CONTENT_MODEL_1_0_URI, this.fileName), - Repository.resolveToQName(this.objectType), - editProps).getChildRef(); - - if (logger.isDebugEnabled()) - logger.debug("Created file node for file: " + this.fileName); - - // get a writer for the content and put the file - ContentWriter writer = getContentService().getWriter(fileNodeRef, ContentModel.PROP_CONTENT, true); - // set the mimetype and encoding - writer.setMimetype(this.mimeType); - writer.setEncoding(getEncoding()); - if (fileContent != null) - { - writer.putContent(fileContent); - } - else - { - writer.putContent(strContent == null ? "" : strContent); - } - - // remember the created node now - this.createdNode = fileNodeRef; - } - - /** - * Returns the display label for the mime type currently chosen - * - * @param mimeType The mime type to get the display label of - * @return The human readable version of the content type - */ - protected String getSummaryMimeType(String mimeType) - { - ServiceRegistry registry = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); - MimetypeService mimetypeService = registry.getMimetypeService(); - - // get the mime type display name - Map mimeTypes = mimetypeService.getDisplaysByMimetype(); - return mimeTypes.get(mimeType); - } - - /** - * Returns the display label for the currently selected object type - * - * @return The objevt type label - */ - protected String getSummaryObjectType() - { - String objType = null; - - for (SelectItem item : this.getObjectTypes()) - { - if (item.getValue().equals(this.objectType)) - { - objType = item.getLabel(); - break; - } - } - - return objType; - } - - /** - * Initialises the other properties flags from config - */ - protected void initOtherProperties() - { - // TODO - review implications of these default values for dynamic/MT client - ConfigService configSvc = Application.getConfigService(FacesContext.getCurrentInstance()); - - if (configSvc != null) - { - Config config = configSvc.getConfig("Content Wizards"); - if (config != null) - { - ConfigElement otherPropsCfg = config.getConfigElement("other-properties"); - if (otherPropsCfg != null) - { - // get the attributes - String userChoiceVisible = otherPropsCfg.getAttribute("user-choice-visible"); - String userChoiceDefault = otherPropsCfg.getAttribute("user-choice-default"); - - // set the defaults - if (userChoiceVisible != null) - { - this.otherPropertiesChoiceVisible = Boolean.parseBoolean(userChoiceVisible); - } - - if (userChoiceDefault != null) - { - this.showOtherProperties = Boolean.parseBoolean(userChoiceDefault); - } - } - } - } - } -} +package org.alfresco.web.bean.content; + +import java.io.File; +import java.io.Serializable; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.model.SelectItem; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.dictionary.TypeDefinition; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.MimetypeService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.service.transaction.TransactionService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.wizard.BaseWizardBean; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.repo.component.UICharsetSelector; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.extensions.config.Config; +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigService; + +/** + * Base class for the content related wizards and dialogs + * + * @author gavinc + */ +@SuppressWarnings("serial") +public abstract class BaseContentWizard extends BaseWizardBean +{ + protected String fileName; + protected String author; + protected String title; + protected String description; + protected String mimeType; + protected String encoding; + protected String objectType; + protected boolean inlineEdit; + protected boolean otherPropertiesChoiceVisible = true; + protected boolean showOtherProperties = true; + + // the NodeRef of the node created during finish + protected NodeRef createdNode; + protected List objectTypes; + transient private ContentService contentService; + transient private TransactionService transactionService; + + protected static final String MSG_NODE_LOCKED = "node_locked_dialog_closed"; + + protected static Log logger = LogFactory.getLog(BaseContentWizard.class); + + + // ------------------------------------------------------------------------------ + // Wizard implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.fileName = null; + this.author = null; + this.title = null; + this.description = null; + this.mimeType = null; + this.inlineEdit = false; + this.objectType = null; + + initOtherProperties(); + } + + @Override + public boolean getFinishButtonDisabled() + { + return (this.fileName == null || + this.fileName.length() == 0 || + this.mimeType == null); + } + + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * @return Returns the name of the file + */ + public String getFileName() + { + return this.fileName; + } + + /** + * @param fileName The name of the file + */ + public void setFileName(String fileName) + { + this.fileName = fileName; + } + + /** + * @return Returns the author + */ + public String getAuthor() + { + return this.author; + } + + /** + * @param author Sets the author + */ + public void setAuthor(String author) + { + this.author = author; + } + + /** + * @return Returns the mime type currenty selected + */ + public String getMimeType() + { + return this.mimeType; + } + + /** + * @param mimeType Sets the currently selected mime type + */ + public void setMimeType(String mimeType) + { + this.mimeType = mimeType; + } + + /** + * @return Returns the encoding currently selected + */ + public String getEncoding() + { + if (encoding == null) + { + ConfigService configSvc = Application.getConfigService(FacesContext.getCurrentInstance()); + Config config = configSvc.getConfig("Content Wizards"); + if (config != null) + { + ConfigElement defaultEncCfg = config.getConfigElement("default-encoding"); + if (defaultEncCfg != null) + { + String value = defaultEncCfg.getValue(); + if (value != null) + { + encoding = value.trim(); + } + } + } + if (encoding == null || encoding.length() == 0) + { + // if not configured, set to a sensible default for most character sets + encoding = "UTF-8"; + } + } + return encoding; + } + + /** + * @param encoding the document's encoding + */ + public void setEncoding(String encoding) + { + this.encoding = encoding; + } + + /** + * @return Returns the object type currenty selected + */ + public String getObjectType() + { + return this.objectType; + } + + /** + * @param objectType Sets the currently selected object type + */ + public void setObjectType(String objectType) + { + this.objectType = objectType; + } + + /** + * @return Returns the description + */ + public String getDescription() + { + return this.description; + } + + /** + * @param description Sets the description + */ + public void setDescription(String description) + { + this.description = description; + } + + /** + * @return Returns the title + */ + public String getTitle() + { + return this.title; + } + + /** + * @param title Sets the title + */ + public void setTitle(String title) + { + this.title = title; + } + + /** + * @return Returns the inline edit flag. + */ + public boolean isInlineEdit() + { + return this.inlineEdit; + } + + /** + * @param inlineEdit The inline edit flag to set. + */ + public void setInlineEdit(boolean inlineEdit) + { + this.inlineEdit = inlineEdit; + } + + /** + * @return Determines whether the choice to modify all properties + * is shown + */ + public boolean getOtherPropertiesChoiceVisible() + { + return this.otherPropertiesChoiceVisible; + } + + /** + * @return Determines whether the edit properties dialog should be + * shown when this one ends + */ + public boolean getShowOtherProperties() + { + return this.showOtherProperties; + } + + /** + * @param showOthers Sets whether the edit properties dialog is shown + */ + public void setShowOtherProperties(boolean showOthers) + { + this.showOtherProperties = showOthers; + } + + public List getEncodings() + { + return UICharsetSelector.getCharsetEncodingList(); + } + + /** + * @return Returns a list of object types to allow the user to select from + */ + public List getObjectTypes() + { + return getTransactionService().getRetryingTransactionHelper().doInTransaction(new RetryingTransactionCallback>() + { + @Override + public List execute() throws Throwable + { + return getObjectTypesImpl(); + } + }, true); + } + + private List getObjectTypesImpl() + { + if ((this.objectTypes == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + FacesContext context = FacesContext.getCurrentInstance(); + + // add the well known object type to start with + this.objectTypes = new ArrayList(5); + + ConfigService svc = Application.getConfigService(FacesContext.getCurrentInstance()); + Config wizardCfg = svc.getConfig("Content Wizards"); + if (wizardCfg != null) + { + ConfigElement defaultTypesCfg = wizardCfg.getConfigElement("default-content-type"); + String parentLabel = ""; + if (defaultTypesCfg != null) + { + // Get the default content-type to apply + ConfigElement typeElement = defaultTypesCfg.getChildren().get(0); + QName parentQName = Repository.resolveToQName(typeElement.getAttribute("name")); + TypeDefinition parentType = null; + if (parentQName != null) + { + parentType = this.getDictionaryService().getType(parentQName); + + if (parentType == null) + { + // If no default content type is defined default to content + parentQName = ContentModel.TYPE_CONTENT; + parentType = this.getDictionaryService().getType(ContentModel.TYPE_CONTENT); + this.objectTypes.add(new SelectItem(ContentModel.TYPE_CONTENT.toString(), + Application.getMessage(context, "content"))); + logger.warn("Configured default content type not found in dictionary: " + parentQName); + } + else + { + // try and get the display label from config + parentLabel = Utils.getDisplayLabel(context, typeElement); + + // if there wasn't a client based label try and get it from the dictionary + if (parentLabel == null) + { + parentLabel = parentType.getTitle(this.getDictionaryService()); + } + + // finally, just use the localname + if (parentLabel == null) + { + parentLabel = parentQName.getLocalName(); + } + } + } + + // Get all content types defined + ConfigElement typesCfg = wizardCfg.getConfigElement("content-types"); + if (typesCfg != null) + { + for (ConfigElement child : typesCfg.getChildren()) + { + QName idQName = Repository.resolveToQName(child.getAttribute("name")); + if (idQName != null) + { + TypeDefinition typeDef = this.getDictionaryService().getType(idQName); + + if (typeDef != null) + { + // for each type check if it is a subtype of the default content type + if (this.getDictionaryService().isSubClass(typeDef.getName(), parentType.getName())) + { + // try and get the display label from config + String label = Utils.getDisplayLabel(context, child); + + // if there wasn't a client based label try and get it from the dictionary + if (label == null) + { + label = typeDef.getTitle(this.getDictionaryService()); + } + + // finally, just use the localname + if (label == null) + { + label = idQName.getLocalName(); + } + + this.objectTypes.add(new SelectItem(idQName.toString(), label)); + } + else + { + logger.warn("Failed to add '" + child.getAttribute("name") + + "' to the list of content types - it is not a subtype of " + parentQName); + } + } + } + else + { + logger.warn("Failed to add '" + child.getAttribute("name") + + "' to the list of content types as the type is not recognised"); + } + } + } + + // Case when no type is defined - we add the default content type to the list of available types + if (this.objectTypes.isEmpty()) + { + // add default content type to the list of available types + this.objectTypes.add(new SelectItem(parentQName.toString(), parentLabel)); + } + + // make sure the list is sorted by the label + QuickSort sorter = new QuickSort(this.objectTypes, "label", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + } + else + { + logger.warn("Could not find 'content-types' configuration element"); + } + } + else + { + logger.warn("Could not find 'Content Wizards' configuration section"); + } + + } + + return this.objectTypes; + } + + + // ------------------------------------------------------------------------------ + // Service Injection + + /** + * @param contentService The contentService to set. + */ + public void setContentService(ContentService contentService) + { + this.contentService = contentService; + } + + protected ContentService getContentService() + { + if (contentService == null) + { + contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); + } + return contentService; + } + + protected TransactionService getTransactionService() + { + if (null == transactionService) + { + transactionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getTransactionService(); + } + + return transactionService; + } + + + // ------------------------------------------------------------------------------ + // Helper methods + + /** + * Save the specified content using the currently set wizard attributes + * + * @param fileContent File content to save + * @param strContent String content to save + */ + protected void saveContent(File fileContent, String strContent) throws Exception + { + // get the node ref of the node that will contain the content + NodeRef containerNodeRef; + String nodeId = this.navigator.getCurrentNodeId(); + if (nodeId == null) + { + containerNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); + } + else + { + containerNodeRef = new NodeRef(Repository.getStoreRef(), nodeId); + } + + // apply the inline editable aspect (by adding the property at create time) + Map editProps = new HashMap(6); + if (this.inlineEdit == true) + { + editProps.put(ApplicationModel.PROP_EDITINLINE, this.inlineEdit); + if (logger.isDebugEnabled()) + logger.debug("Added inlineeditable aspect with properties: " + editProps); + } + + // set the name + editProps.put(ContentModel.PROP_NAME, this.fileName); + + // set the author property + editProps.put(ContentModel.PROP_AUTHOR, this.author); + + // apply the titled aspect - title and description + editProps.put(ContentModel.PROP_TITLE, this.title); + editProps.put(ContentModel.PROP_DESCRIPTION, this.description); + if (logger.isDebugEnabled()) + logger.debug("Added titled aspect with properties: " + this.title + ", " + this.description); + + // create the node + NodeRef fileNodeRef = this.getNodeService().createNode( + containerNodeRef, + ContentModel.ASSOC_CONTAINS, + QName.createQNameWithValidLocalName(NamespaceService.CONTENT_MODEL_1_0_URI, this.fileName), + Repository.resolveToQName(this.objectType), + editProps).getChildRef(); + + if (logger.isDebugEnabled()) + logger.debug("Created file node for file: " + this.fileName); + + // get a writer for the content and put the file + ContentWriter writer = getContentService().getWriter(fileNodeRef, ContentModel.PROP_CONTENT, true); + // set the mimetype and encoding + writer.setMimetype(this.mimeType); + writer.setEncoding(getEncoding()); + if (fileContent != null) + { + writer.putContent(fileContent); + } + else + { + writer.putContent(strContent == null ? "" : strContent); + } + + // remember the created node now + this.createdNode = fileNodeRef; + } + + /** + * Returns the display label for the mime type currently chosen + * + * @param mimeType The mime type to get the display label of + * @return The human readable version of the content type + */ + protected String getSummaryMimeType(String mimeType) + { + ServiceRegistry registry = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); + MimetypeService mimetypeService = registry.getMimetypeService(); + + // get the mime type display name + Map mimeTypes = mimetypeService.getDisplaysByMimetype(); + return mimeTypes.get(mimeType); + } + + /** + * Returns the display label for the currently selected object type + * + * @return The objevt type label + */ + protected String getSummaryObjectType() + { + String objType = null; + + for (SelectItem item : this.getObjectTypes()) + { + if (item.getValue().equals(this.objectType)) + { + objType = item.getLabel(); + break; + } + } + + return objType; + } + + /** + * Initialises the other properties flags from config + */ + protected void initOtherProperties() + { + // TODO - review implications of these default values for dynamic/MT client + ConfigService configSvc = Application.getConfigService(FacesContext.getCurrentInstance()); + + if (configSvc != null) + { + Config config = configSvc.getConfig("Content Wizards"); + if (config != null) + { + ConfigElement otherPropsCfg = config.getConfigElement("other-properties"); + if (otherPropsCfg != null) + { + // get the attributes + String userChoiceVisible = otherPropsCfg.getAttribute("user-choice-visible"); + String userChoiceDefault = otherPropsCfg.getAttribute("user-choice-default"); + + // set the defaults + if (userChoiceVisible != null) + { + this.otherPropertiesChoiceVisible = Boolean.parseBoolean(userChoiceVisible); + } + + if (userChoiceDefault != null) + { + this.showOtherProperties = Boolean.parseBoolean(userChoiceDefault); + } + } + } + } + } +} diff --git a/source/java/org/alfresco/web/bean/content/CreateContentWizard.java b/source/java/org/alfresco/web/bean/content/CreateContentWizard.java index a8a178b0bd..5cf2d1c67c 100644 --- a/source/java/org/alfresco/web/bean/content/CreateContentWizard.java +++ b/source/java/org/alfresco/web/bean/content/CreateContentWizard.java @@ -1,260 +1,260 @@ -package org.alfresco.web.bean.content; - -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; -import java.util.ResourceBundle; - -import javax.faces.context.FacesContext; -import javax.faces.event.ValueChangeEvent; -import javax.faces.model.SelectItem; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.service.cmr.model.FileExistsException; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.extensions.config.Config; -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigService; - -/** - * Bean implementation for the "Create Content Wizard" dialog - * - * @author gavinc - */ -public class CreateContentWizard extends BaseContentWizard -{ - private static final long serialVersionUID = -2740634368271194418L; - - protected String content = null; - protected List createMimeTypes; - - private static Log logger = LogFactory.getLog(CreateContentWizard.class); - - - // ------------------------------------------------------------------------------ - // Wizard implementation - - - @Override - public String finish() - { - String result = super.finish(); - - return result; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - saveContent(null, this.content); - - // return the default outcome - return outcome; - } - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.content = null; - this.inlineEdit = true; - this.mimeType = MimetypeMap.MIMETYPE_HTML; - } - - @Override - public boolean getNextButtonDisabled() - { - // TODO: Allow the next button state to be configured so that - // wizard implementations don't have to worry about - // checking step numbers - - boolean disabled = false; - int step = Application.getWizardManager().getCurrentStep(); - switch(step) - { - case 1: - { - disabled = (this.fileName == null || this.fileName.length() == 0); - break; - } - } - - return disabled; - } - - - @Override - public boolean getFinishButtonDisabled() - { - boolean disabled = false; - int step = Application.getWizardManager().getCurrentStep(); - switch(step) - { - case 1: - { - disabled = (this.fileName == null || this.fileName.length() == 0); - break; - } - } - - return disabled; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - // as we were successful, go to the set properties dialog if asked - // to otherwise just return - if (this.showOtherProperties) - { - // check whether the created node is checked out, if a 'check out' - // rule is present in the space the new node will be and an - // attempt to modify the properties will cause an error (ALF-438) - if (getNodeService().hasAspect(this.createdNode, ContentModel.ASPECT_LOCKABLE)) - { - Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), MSG_NODE_LOCKED)); - return outcome; - } - else - { - // we are going to immediately edit the properties so we need - // to setup the BrowseBean context appropriately - this.browseBean.setDocument(new Node(this.createdNode)); - - return getDefaultFinishOutcome() + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + - "dialog:setContentProperties"; - } - } - else - { - return outcome; - } - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * @return Returns the content from the edited form. - */ - public String getContent() - { - return this.content; - } - - /** - * @param content The content to edit (should be clear initially) - */ - public void setContent(String content) - { - this.content = content; - } - - /** - * @return Returns a list of mime types to allow the user to select from - */ - public List getCreateMimeTypes() - { - if ((this.createMimeTypes == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - FacesContext context = FacesContext.getCurrentInstance(); - - // add the well known object type to start with - this.createMimeTypes = new ArrayList(5); - - // add the configured create mime types to the list - ConfigService svc = Application.getConfigService(context); - Config wizardCfg = svc.getConfig("Content Wizards"); - if (wizardCfg != null) - { - ConfigElement typesCfg = wizardCfg.getConfigElement("create-mime-types"); - if (typesCfg != null) - { - for (ConfigElement child : typesCfg.getChildren()) - { - String currentMimeType = child.getAttribute("name"); - if (currentMimeType != null) - { - String label = getSummaryMimeType(currentMimeType); - this.createMimeTypes.add(new SelectItem(currentMimeType, label)); - } - } - - // make sure the list is sorted by the label - QuickSort sorter = new QuickSort(this.objectTypes, "label", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - } - else - { - logger.warn("Could not find 'create-mime-types' configuration element"); - } - } - else - { - logger.warn("Could not find 'Content Wizards' configuration section"); - } - - } - - return this.createMimeTypes; - } - - /** - * @return Returns the summary data for the wizard. - */ - public String getSummary() - { - ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); - - // TODO: show first few lines of content here? - return buildSummary( - new String[] {bundle.getString("file_name"), - bundle.getString("type"), - bundle.getString("content_type")}, - new String[] {Utils.encode(this.fileName), getSummaryObjectType(), - getSummaryMimeType(this.mimeType)}); - } - - - // ------------------------------------------------------------------------------ - // Action event handlers - - /** - * Create content type value changed by the user - */ - public void createContentChanged(ValueChangeEvent event) - { - // clear the content as HTML is not compatible with the plain text box etc. - this.content = null; - } - - @Override - protected String formatErrorMessage(Throwable exception) - { - if (exception instanceof FileExistsException) - { - return MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_EXISTS), - ((FileExistsException)exception).getName()); - } - else - { - return MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), "error_content"), - exception.getMessage()); - } - } - -} +package org.alfresco.web.bean.content; + +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.ResourceBundle; + +import javax.faces.context.FacesContext; +import javax.faces.event.ValueChangeEvent; +import javax.faces.model.SelectItem; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.service.cmr.model.FileExistsException; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.extensions.config.Config; +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigService; + +/** + * Bean implementation for the "Create Content Wizard" dialog + * + * @author gavinc + */ +public class CreateContentWizard extends BaseContentWizard +{ + private static final long serialVersionUID = -2740634368271194418L; + + protected String content = null; + protected List createMimeTypes; + + private static Log logger = LogFactory.getLog(CreateContentWizard.class); + + + // ------------------------------------------------------------------------------ + // Wizard implementation + + + @Override + public String finish() + { + String result = super.finish(); + + return result; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + saveContent(null, this.content); + + // return the default outcome + return outcome; + } + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.content = null; + this.inlineEdit = true; + this.mimeType = MimetypeMap.MIMETYPE_HTML; + } + + @Override + public boolean getNextButtonDisabled() + { + // TODO: Allow the next button state to be configured so that + // wizard implementations don't have to worry about + // checking step numbers + + boolean disabled = false; + int step = Application.getWizardManager().getCurrentStep(); + switch(step) + { + case 1: + { + disabled = (this.fileName == null || this.fileName.length() == 0); + break; + } + } + + return disabled; + } + + + @Override + public boolean getFinishButtonDisabled() + { + boolean disabled = false; + int step = Application.getWizardManager().getCurrentStep(); + switch(step) + { + case 1: + { + disabled = (this.fileName == null || this.fileName.length() == 0); + break; + } + } + + return disabled; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + // as we were successful, go to the set properties dialog if asked + // to otherwise just return + if (this.showOtherProperties) + { + // check whether the created node is checked out, if a 'check out' + // rule is present in the space the new node will be and an + // attempt to modify the properties will cause an error (ALF-438) + if (getNodeService().hasAspect(this.createdNode, ContentModel.ASPECT_LOCKABLE)) + { + Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), MSG_NODE_LOCKED)); + return outcome; + } + else + { + // we are going to immediately edit the properties so we need + // to setup the BrowseBean context appropriately + this.browseBean.setDocument(new Node(this.createdNode)); + + return getDefaultFinishOutcome() + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + + "dialog:setContentProperties"; + } + } + else + { + return outcome; + } + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * @return Returns the content from the edited form. + */ + public String getContent() + { + return this.content; + } + + /** + * @param content The content to edit (should be clear initially) + */ + public void setContent(String content) + { + this.content = content; + } + + /** + * @return Returns a list of mime types to allow the user to select from + */ + public List getCreateMimeTypes() + { + if ((this.createMimeTypes == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + FacesContext context = FacesContext.getCurrentInstance(); + + // add the well known object type to start with + this.createMimeTypes = new ArrayList(5); + + // add the configured create mime types to the list + ConfigService svc = Application.getConfigService(context); + Config wizardCfg = svc.getConfig("Content Wizards"); + if (wizardCfg != null) + { + ConfigElement typesCfg = wizardCfg.getConfigElement("create-mime-types"); + if (typesCfg != null) + { + for (ConfigElement child : typesCfg.getChildren()) + { + String currentMimeType = child.getAttribute("name"); + if (currentMimeType != null) + { + String label = getSummaryMimeType(currentMimeType); + this.createMimeTypes.add(new SelectItem(currentMimeType, label)); + } + } + + // make sure the list is sorted by the label + QuickSort sorter = new QuickSort(this.objectTypes, "label", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + } + else + { + logger.warn("Could not find 'create-mime-types' configuration element"); + } + } + else + { + logger.warn("Could not find 'Content Wizards' configuration section"); + } + + } + + return this.createMimeTypes; + } + + /** + * @return Returns the summary data for the wizard. + */ + public String getSummary() + { + ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); + + // TODO: show first few lines of content here? + return buildSummary( + new String[] {bundle.getString("file_name"), + bundle.getString("type"), + bundle.getString("content_type")}, + new String[] {Utils.encode(this.fileName), getSummaryObjectType(), + getSummaryMimeType(this.mimeType)}); + } + + + // ------------------------------------------------------------------------------ + // Action event handlers + + /** + * Create content type value changed by the user + */ + public void createContentChanged(ValueChangeEvent event) + { + // clear the content as HTML is not compatible with the plain text box etc. + this.content = null; + } + + @Override + protected String formatErrorMessage(Throwable exception) + { + if (exception instanceof FileExistsException) + { + return MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_EXISTS), + ((FileExistsException)exception).getName()); + } + else + { + return MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), "error_content"), + exception.getMessage()); + } + } + +} diff --git a/source/java/org/alfresco/web/bean/content/DeleteContentDialog.java b/source/java/org/alfresco/web/bean/content/DeleteContentDialog.java index 9d3b3de109..bba16eb61a 100644 --- a/source/java/org/alfresco/web/bean/content/DeleteContentDialog.java +++ b/source/java/org/alfresco/web/bean/content/DeleteContentDialog.java @@ -1,155 +1,155 @@ -package org.alfresco.web.bean.content; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.ml.MultilingualContentService; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation for the "Delete Content" dialog - * - * @author gavinc - */ -public class DeleteContentDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 4199496011879649213L; - - transient private MultilingualContentService multilingualContentService; - - private static final Log logger = LogFactory.getLog(DeleteContentDialog.class); - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - // get the content to delete - Node node = this.browseBean.getDocument(); - if (node != null) - { - if(ContentModel.TYPE_MULTILINGUAL_CONTAINER.equals(node.getType())) - { - if (logger.isDebugEnabled()) - logger.debug("Trying to delete multilingual container: " + node.getId() + " and its translations" ); - - // delete the mlContainer and its translations - getMultilingualContentService().deleteTranslationContainer(node.getNodeRef()); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("Trying to delete content node: " + node.getId()); - - // delete the node - this.getNodeService().deleteNode(node.getNodeRef()); - } - - } - else - { - logger.warn("WARNING: delete called without a current Document!"); - } - - return outcome; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - // clear action context - this.browseBean.setDocument(null); - - // setting the outcome will show the browse view again - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "browse"; - } - - @Override - protected String getErrorMessageId() - { - return "error_delete_file"; - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns the confirmation to display to the user before deleting the content. - * - * @return The formatted message to display - */ - public String getConfirmMessage() - { - String fileConfirmMsg = null; - - Node document = this.browseBean.getDocument(); - - if(document.getType().equals(ContentModel.TYPE_MULTILINGUAL_CONTAINER)) - { - fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - "delete_ml_container_confirm"); - } - else if(document.hasAspect(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) - { - fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - "delete_empty_translation_confirm"); - } - else if(document.hasAspect(ContentModel.ASPECT_MULTILINGUAL_DOCUMENT)) - { - fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - "delete_translation_confirm"); - } - else - { - String strHasMultipleParents = this.parameters.get("hasMultipleParents"); - if (strHasMultipleParents != null && "true".equals(strHasMultipleParents)) - { - fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - "delete_file_multiple_parents_confirm"); - } - else - { - fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - "delete_file_confirm"); - } - } - - return MessageFormat.format(fileConfirmMsg, - new Object[] {document.getName()}); - } - - /** - * @param multilingualContentService the Multilingual Content Service to set - */ - public void setMultilingualContentService(MultilingualContentService multilingualContentService) - { - this.multilingualContentService = multilingualContentService; - } - - protected MultilingualContentService getMultilingualContentService() - { - if (multilingualContentService == null) - { - multilingualContentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getMultilingualContentService(); - } - return multilingualContentService; - } - -} +package org.alfresco.web.bean.content; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.ml.MultilingualContentService; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation for the "Delete Content" dialog + * + * @author gavinc + */ +public class DeleteContentDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 4199496011879649213L; + + transient private MultilingualContentService multilingualContentService; + + private static final Log logger = LogFactory.getLog(DeleteContentDialog.class); + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + // get the content to delete + Node node = this.browseBean.getDocument(); + if (node != null) + { + if(ContentModel.TYPE_MULTILINGUAL_CONTAINER.equals(node.getType())) + { + if (logger.isDebugEnabled()) + logger.debug("Trying to delete multilingual container: " + node.getId() + " and its translations" ); + + // delete the mlContainer and its translations + getMultilingualContentService().deleteTranslationContainer(node.getNodeRef()); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("Trying to delete content node: " + node.getId()); + + // delete the node + this.getNodeService().deleteNode(node.getNodeRef()); + } + + } + else + { + logger.warn("WARNING: delete called without a current Document!"); + } + + return outcome; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + // clear action context + this.browseBean.setDocument(null); + + // setting the outcome will show the browse view again + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "browse"; + } + + @Override + protected String getErrorMessageId() + { + return "error_delete_file"; + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns the confirmation to display to the user before deleting the content. + * + * @return The formatted message to display + */ + public String getConfirmMessage() + { + String fileConfirmMsg = null; + + Node document = this.browseBean.getDocument(); + + if(document.getType().equals(ContentModel.TYPE_MULTILINGUAL_CONTAINER)) + { + fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + "delete_ml_container_confirm"); + } + else if(document.hasAspect(ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) + { + fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + "delete_empty_translation_confirm"); + } + else if(document.hasAspect(ContentModel.ASPECT_MULTILINGUAL_DOCUMENT)) + { + fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + "delete_translation_confirm"); + } + else + { + String strHasMultipleParents = this.parameters.get("hasMultipleParents"); + if (strHasMultipleParents != null && "true".equals(strHasMultipleParents)) + { + fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + "delete_file_multiple_parents_confirm"); + } + else + { + fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + "delete_file_confirm"); + } + } + + return MessageFormat.format(fileConfirmMsg, + new Object[] {document.getName()}); + } + + /** + * @param multilingualContentService the Multilingual Content Service to set + */ + public void setMultilingualContentService(MultilingualContentService multilingualContentService) + { + this.multilingualContentService = multilingualContentService; + } + + protected MultilingualContentService getMultilingualContentService() + { + if (multilingualContentService == null) + { + multilingualContentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getMultilingualContentService(); + } + return multilingualContentService; + } + +} diff --git a/source/java/org/alfresco/web/bean/content/EditContentPropertiesDialog.java b/source/java/org/alfresco/web/bean/content/EditContentPropertiesDialog.java index cef61d0650..2cae261bbe 100644 --- a/source/java/org/alfresco/web/bean/content/EditContentPropertiesDialog.java +++ b/source/java/org/alfresco/web/bean/content/EditContentPropertiesDialog.java @@ -1,306 +1,306 @@ -package org.alfresco.web.bean.content; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.Iterator; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.springframework.extensions.surf.util.I18NUtil; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DataTypeDefinition; -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.service.cmr.model.FileExistsException; -import org.alfresco.service.cmr.repository.AssociationRef; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.ContentData; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; - -/** - * Bean implementation of the "Edit Content Properties" dialog. - * - * @author gavinc - */ -public class EditContentPropertiesDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -5681296528149487178L; - - protected static final String TEMP_PROP_MIMETYPE = "mimetype"; - protected static final String TEMP_PROP_ENCODING = "encoding"; - - protected Node editableNode; - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // setup the editable node - this.editableNode = initEditableNode(); - - if(editableNode != null) - { - - // special case for Mimetype - since this is a sub-property of the ContentData object - // we must extract it so it can be edited in the client, then we check for it later - // and create a new ContentData object to wrap it and it's associated URL - ContentData content = (ContentData)this.editableNode.getProperties().get(ContentModel.PROP_CONTENT); - if (content != null) - { - this.editableNode.getProperties().put(TEMP_PROP_MIMETYPE, content.getMimetype()); - this.editableNode.getProperties().put(TEMP_PROP_ENCODING, content.getEncoding()); - } - } - } - - /** - * Init the editable Node - */ - protected Node initEditableNode() - { - final Node document = this.browseBean.getDocument(); - if (document != null) - { - return new Node(document.getNodeRef()); - } - return null; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - NodeRef nodeRef = this.editableNode.getNodeRef(); - Map editedProps = this.editableNode.getProperties(); - - // get the name and move the node as necessary - String name = (String) editedProps.get(ContentModel.PROP_NAME); - if (name != null) - { - getFileFolderService().rename(nodeRef, name); - } - - // we need to put all the properties from the editable bag back into - // the format expected by the repository - Map repoProps = this.getNodeService().getProperties(nodeRef); - - // Extract and deal with the special mimetype property for ContentData - String mimetype = (String) editedProps.get(TEMP_PROP_MIMETYPE); - if (mimetype != null) - { - // remove temporary prop from list so it isn't saved with the others - editedProps.remove(TEMP_PROP_MIMETYPE); - ContentData contentData = (ContentData)editedProps.get(ContentModel.PROP_CONTENT); - if (contentData != null) - { - contentData = ContentData.setMimetype(contentData, mimetype); - editedProps.put(ContentModel.PROP_CONTENT.toString(), contentData); - } - } - // Extract and deal with the special encoding property for ContentData - String encoding = (String) editedProps.get(TEMP_PROP_ENCODING); - if (encoding != null) - { - // remove temporary prop from list so it isn't saved with the others - editedProps.remove(TEMP_PROP_ENCODING); - ContentData contentData = (ContentData) editedProps.get(ContentModel.PROP_CONTENT); - if (contentData != null) - { - contentData = ContentData.setEncoding(contentData, encoding); - editedProps.put(ContentModel.PROP_CONTENT.toString(), contentData); - } - } - - // add the "author" aspect if required, properties will get set below - if (this.getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_AUTHOR) == false) - { - this.getNodeService().addAspect(nodeRef, ContentModel.ASPECT_AUTHOR, null); - } - - // add the "titled" aspect if required, properties will get set below - if (this.getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_TITLED) == false) - { - getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TITLED, null); - } - - // add the remaining properties - Iterator iterProps = editedProps.keySet().iterator(); - while (iterProps.hasNext()) - { - String propName = iterProps.next(); - QName qname = QName.createQName(propName); - - // make sure the property is represented correctly - Serializable propValue = (Serializable)editedProps.get(propName); - - // check for empty strings when using number types, set to null in this case - if (propValue instanceof String) - { - PropertyDefinition propDef = this.getDictionaryService().getProperty(qname); - if (((String)propValue).length() == 0) - { - if (propDef != null) - { - if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || - propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || - propDef.getDataType().getName().equals(DataTypeDefinition.INT) || - propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) - { - propValue = null; - } - } - } - // handle locale strings to Locale objects - else if (propDef != null && propDef.getDataType().getName().equals(DataTypeDefinition.LOCALE)) - { - propValue = I18NUtil.parseLocale((String)propValue); - } - } - - repoProps.put(qname, propValue); - } - - // send the properties back to the repository - this.getNodeService().setProperties(nodeRef, repoProps); - - // we also need to persist any association changes that may have been made - - // add any associations added in the UI - Map> addedAssocs = this.editableNode.getAddedAssociations(); - for (Map typedAssoc : addedAssocs.values()) - { - for (AssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().createAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); - } - } - - // remove any association removed in the UI - Map> removedAssocs = this.editableNode.getRemovedAssociations(); - for (Map typedAssoc : removedAssocs.values()) - { - for (AssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().removeAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); - } - } - - // add any child associations added in the UI - Map> addedChildAssocs = this.editableNode.getAddedChildAssociations(); - for (Map typedAssoc : addedChildAssocs.values()) - { - for (ChildAssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().addChild(assoc.getParentRef(), assoc.getChildRef(), assoc.getTypeQName(), assoc.getTypeQName()); - } - } - - // remove any child association removed in the UI - Map> removedChildAssocs = this.editableNode.getRemovedChildAssociations(); - for (Map typedAssoc : removedChildAssocs.values()) - { - for (ChildAssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().removeChild(assoc.getParentRef(), assoc.getChildRef()); - } - } - - return outcome; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - // reset the document held by the browse bean as it's just been updated - this.browseBean.getDocument().reset(); - - return outcome; - } - - /** - * Formats the error message to display if an error occurs during finish processing - * - * @param exception The exception - * @return The formatted message - */ - @Override - protected String formatErrorMessage(Throwable exception) - { - if(editableNode != null) - { - - // special case for Mimetype - since this is a sub-property of the ContentData object - // we must extract it so it can be edited in the client, then we check for it later - // and create a new ContentData object to wrap it and it's associated URL - ContentData content = (ContentData)this.editableNode.getProperties().get(ContentModel.PROP_CONTENT); - if (content != null) - { - this.editableNode.getProperties().put(TEMP_PROP_MIMETYPE, content.getMimetype()); - this.editableNode.getProperties().put(TEMP_PROP_ENCODING, content.getEncoding()); - } - } - - if (exception instanceof FileExistsException) - { - return MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_EXISTS), - ((FileExistsException)exception).getName()); - } - else if (exception instanceof InvalidNodeRefException) - { - return MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), - new Object[] {this.browseBean.getDocument().getId()}); - } - else - { - return super.formatErrorMessage(exception); - } - } - - @Override - protected String getErrorOutcome(Throwable exception) - { - if (exception instanceof InvalidNodeRefException) - { - // this failure means the node no longer exists - we cannot show - // the content properties screen again so go back to the main page - return "browse"; - } - else - { - return super.getErrorOutcome(exception); - } - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - - // ------------------------------------------------------------------------------ - // Bean getters and setters - - /** - * Returns the node being edited - * - * @return The node being edited - */ - public Node getEditableNode() - { - return this.editableNode; - } -} +package org.alfresco.web.bean.content; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.Iterator; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.springframework.extensions.surf.util.I18NUtil; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DataTypeDefinition; +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.service.cmr.model.FileExistsException; +import org.alfresco.service.cmr.repository.AssociationRef; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.ContentData; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; + +/** + * Bean implementation of the "Edit Content Properties" dialog. + * + * @author gavinc + */ +public class EditContentPropertiesDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -5681296528149487178L; + + protected static final String TEMP_PROP_MIMETYPE = "mimetype"; + protected static final String TEMP_PROP_ENCODING = "encoding"; + + protected Node editableNode; + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // setup the editable node + this.editableNode = initEditableNode(); + + if(editableNode != null) + { + + // special case for Mimetype - since this is a sub-property of the ContentData object + // we must extract it so it can be edited in the client, then we check for it later + // and create a new ContentData object to wrap it and it's associated URL + ContentData content = (ContentData)this.editableNode.getProperties().get(ContentModel.PROP_CONTENT); + if (content != null) + { + this.editableNode.getProperties().put(TEMP_PROP_MIMETYPE, content.getMimetype()); + this.editableNode.getProperties().put(TEMP_PROP_ENCODING, content.getEncoding()); + } + } + } + + /** + * Init the editable Node + */ + protected Node initEditableNode() + { + final Node document = this.browseBean.getDocument(); + if (document != null) + { + return new Node(document.getNodeRef()); + } + return null; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + NodeRef nodeRef = this.editableNode.getNodeRef(); + Map editedProps = this.editableNode.getProperties(); + + // get the name and move the node as necessary + String name = (String) editedProps.get(ContentModel.PROP_NAME); + if (name != null) + { + getFileFolderService().rename(nodeRef, name); + } + + // we need to put all the properties from the editable bag back into + // the format expected by the repository + Map repoProps = this.getNodeService().getProperties(nodeRef); + + // Extract and deal with the special mimetype property for ContentData + String mimetype = (String) editedProps.get(TEMP_PROP_MIMETYPE); + if (mimetype != null) + { + // remove temporary prop from list so it isn't saved with the others + editedProps.remove(TEMP_PROP_MIMETYPE); + ContentData contentData = (ContentData)editedProps.get(ContentModel.PROP_CONTENT); + if (contentData != null) + { + contentData = ContentData.setMimetype(contentData, mimetype); + editedProps.put(ContentModel.PROP_CONTENT.toString(), contentData); + } + } + // Extract and deal with the special encoding property for ContentData + String encoding = (String) editedProps.get(TEMP_PROP_ENCODING); + if (encoding != null) + { + // remove temporary prop from list so it isn't saved with the others + editedProps.remove(TEMP_PROP_ENCODING); + ContentData contentData = (ContentData) editedProps.get(ContentModel.PROP_CONTENT); + if (contentData != null) + { + contentData = ContentData.setEncoding(contentData, encoding); + editedProps.put(ContentModel.PROP_CONTENT.toString(), contentData); + } + } + + // add the "author" aspect if required, properties will get set below + if (this.getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_AUTHOR) == false) + { + this.getNodeService().addAspect(nodeRef, ContentModel.ASPECT_AUTHOR, null); + } + + // add the "titled" aspect if required, properties will get set below + if (this.getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_TITLED) == false) + { + getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TITLED, null); + } + + // add the remaining properties + Iterator iterProps = editedProps.keySet().iterator(); + while (iterProps.hasNext()) + { + String propName = iterProps.next(); + QName qname = QName.createQName(propName); + + // make sure the property is represented correctly + Serializable propValue = (Serializable)editedProps.get(propName); + + // check for empty strings when using number types, set to null in this case + if (propValue instanceof String) + { + PropertyDefinition propDef = this.getDictionaryService().getProperty(qname); + if (((String)propValue).length() == 0) + { + if (propDef != null) + { + if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || + propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || + propDef.getDataType().getName().equals(DataTypeDefinition.INT) || + propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) + { + propValue = null; + } + } + } + // handle locale strings to Locale objects + else if (propDef != null && propDef.getDataType().getName().equals(DataTypeDefinition.LOCALE)) + { + propValue = I18NUtil.parseLocale((String)propValue); + } + } + + repoProps.put(qname, propValue); + } + + // send the properties back to the repository + this.getNodeService().setProperties(nodeRef, repoProps); + + // we also need to persist any association changes that may have been made + + // add any associations added in the UI + Map> addedAssocs = this.editableNode.getAddedAssociations(); + for (Map typedAssoc : addedAssocs.values()) + { + for (AssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().createAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); + } + } + + // remove any association removed in the UI + Map> removedAssocs = this.editableNode.getRemovedAssociations(); + for (Map typedAssoc : removedAssocs.values()) + { + for (AssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().removeAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); + } + } + + // add any child associations added in the UI + Map> addedChildAssocs = this.editableNode.getAddedChildAssociations(); + for (Map typedAssoc : addedChildAssocs.values()) + { + for (ChildAssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().addChild(assoc.getParentRef(), assoc.getChildRef(), assoc.getTypeQName(), assoc.getTypeQName()); + } + } + + // remove any child association removed in the UI + Map> removedChildAssocs = this.editableNode.getRemovedChildAssociations(); + for (Map typedAssoc : removedChildAssocs.values()) + { + for (ChildAssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().removeChild(assoc.getParentRef(), assoc.getChildRef()); + } + } + + return outcome; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + // reset the document held by the browse bean as it's just been updated + this.browseBean.getDocument().reset(); + + return outcome; + } + + /** + * Formats the error message to display if an error occurs during finish processing + * + * @param exception The exception + * @return The formatted message + */ + @Override + protected String formatErrorMessage(Throwable exception) + { + if(editableNode != null) + { + + // special case for Mimetype - since this is a sub-property of the ContentData object + // we must extract it so it can be edited in the client, then we check for it later + // and create a new ContentData object to wrap it and it's associated URL + ContentData content = (ContentData)this.editableNode.getProperties().get(ContentModel.PROP_CONTENT); + if (content != null) + { + this.editableNode.getProperties().put(TEMP_PROP_MIMETYPE, content.getMimetype()); + this.editableNode.getProperties().put(TEMP_PROP_ENCODING, content.getEncoding()); + } + } + + if (exception instanceof FileExistsException) + { + return MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_EXISTS), + ((FileExistsException)exception).getName()); + } + else if (exception instanceof InvalidNodeRefException) + { + return MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), + new Object[] {this.browseBean.getDocument().getId()}); + } + else + { + return super.formatErrorMessage(exception); + } + } + + @Override + protected String getErrorOutcome(Throwable exception) + { + if (exception instanceof InvalidNodeRefException) + { + // this failure means the node no longer exists - we cannot show + // the content properties screen again so go back to the main page + return "browse"; + } + else + { + return super.getErrorOutcome(exception); + } + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + + // ------------------------------------------------------------------------------ + // Bean getters and setters + + /** + * Returns the node being edited + * + * @return The node being edited + */ + public Node getEditableNode() + { + return this.editableNode; + } +} diff --git a/source/java/org/alfresco/web/bean/content/EditSimpleWorkflowDialog.java b/source/java/org/alfresco/web/bean/content/EditSimpleWorkflowDialog.java index e69351daca..382ba52d19 100644 --- a/source/java/org/alfresco/web/bean/content/EditSimpleWorkflowDialog.java +++ b/source/java/org/alfresco/web/bean/content/EditSimpleWorkflowDialog.java @@ -1,160 +1,160 @@ -package org.alfresco.web.bean.content; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.actions.handlers.SimpleWorkflowHandler; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class EditSimpleWorkflowDialog extends BaseDialogBean -{ - - private static final long serialVersionUID = 7203447561571625990L; - - private static final String MSG_ERROR_UPDATE_SIMPLEWORKFLOW = "error_update_simpleworkflow"; - - protected Map workflowProperties; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - saveWorkflow(); - return outcome; - } - - public boolean getFinishButtonDisabled() - { - return false; - } - - public Node getNode() - { - return this.browseBean.getDocument(); - } - - public Node getDocument() - { - return this.getNode(); - } - - public String saveWorkflow() - { - String outcome = "cancel"; - - try - { - Map updateProps = getNodeService().getProperties(getNode().getNodeRef()); - - // update the simple workflow properties - - // set the approve step name - updateProps.put(ApplicationModel.PROP_APPROVE_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME)); - - // specify whether the approve step will copy or move the content - boolean approveMove = true; - String approveAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_ACTION); - if (approveAction != null && approveAction.equals("copy")) - { - approveMove = false; - } - updateProps.put(ApplicationModel.PROP_APPROVE_MOVE, Boolean.valueOf(approveMove)); - - // create node ref representation of the destination folder - updateProps.put(ApplicationModel.PROP_APPROVE_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_FOLDER)); - - // determine whether there should be a reject step - boolean requireReject = true; - String rejectStepPresent = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT); - if (rejectStepPresent != null && rejectStepPresent.equals("no")) - { - requireReject = false; - } - - if (requireReject) - { - // set the reject step name - updateProps.put(ApplicationModel.PROP_REJECT_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME)); - - // specify whether the reject step will copy or move the content - boolean rejectMove = true; - String rejectAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_ACTION); - if (rejectAction != null && rejectAction.equals("copy")) - { - rejectMove = false; - } - updateProps.put(ApplicationModel.PROP_REJECT_MOVE, Boolean.valueOf(rejectMove)); - - // create node ref representation of the destination folder - updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_FOLDER)); - } - else - { - // set all the reject properties to null to signify there should - // be no reject step - updateProps.put(ApplicationModel.PROP_REJECT_STEP, null); - updateProps.put(ApplicationModel.PROP_REJECT_MOVE, null); - updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, null); - } - - // set the properties on the node - getNodeService().setProperties(getNode().getNodeRef(), updateProps); - getNode().reset(); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), MSG_ERROR_UPDATE_SIMPLEWORKFLOW), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - - return outcome; - } - - public Map getWorkflowProperties() - { - if (this.workflowProperties == null && getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) - { - // get the exisiting properties for the node - Map props = getNode().getProperties(); - - String approveStepName = (String) props.get(ApplicationModel.PROP_APPROVE_STEP.toString()); - String rejectStepName = (String) props.get(ApplicationModel.PROP_REJECT_STEP.toString()); - - Boolean approveMove = (Boolean) props.get(ApplicationModel.PROP_APPROVE_MOVE.toString()); - Boolean rejectMove = (Boolean) props.get(ApplicationModel.PROP_REJECT_MOVE.toString()); - - NodeRef approveFolder = (NodeRef) props.get(ApplicationModel.PROP_APPROVE_FOLDER.toString()); - NodeRef rejectFolder = (NodeRef) props.get(ApplicationModel.PROP_REJECT_FOLDER.toString()); - - // put the workflow properties in a separate map for use by the JSP - this.workflowProperties = new HashMap(7); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME, approveStepName); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_ACTION, approveMove ? "move" : "copy"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_FOLDER, approveFolder); - - if (rejectStepName == null || rejectMove == null || rejectFolder == null) - { - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "no"); - } - else - { - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "yes"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME, rejectStepName); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_ACTION, rejectMove ? "move" : "copy"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_FOLDER, rejectFolder); - } - } - - return this.workflowProperties; - } -} +package org.alfresco.web.bean.content; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.actions.handlers.SimpleWorkflowHandler; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class EditSimpleWorkflowDialog extends BaseDialogBean +{ + + private static final long serialVersionUID = 7203447561571625990L; + + private static final String MSG_ERROR_UPDATE_SIMPLEWORKFLOW = "error_update_simpleworkflow"; + + protected Map workflowProperties; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + saveWorkflow(); + return outcome; + } + + public boolean getFinishButtonDisabled() + { + return false; + } + + public Node getNode() + { + return this.browseBean.getDocument(); + } + + public Node getDocument() + { + return this.getNode(); + } + + public String saveWorkflow() + { + String outcome = "cancel"; + + try + { + Map updateProps = getNodeService().getProperties(getNode().getNodeRef()); + + // update the simple workflow properties + + // set the approve step name + updateProps.put(ApplicationModel.PROP_APPROVE_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME)); + + // specify whether the approve step will copy or move the content + boolean approveMove = true; + String approveAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_ACTION); + if (approveAction != null && approveAction.equals("copy")) + { + approveMove = false; + } + updateProps.put(ApplicationModel.PROP_APPROVE_MOVE, Boolean.valueOf(approveMove)); + + // create node ref representation of the destination folder + updateProps.put(ApplicationModel.PROP_APPROVE_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_FOLDER)); + + // determine whether there should be a reject step + boolean requireReject = true; + String rejectStepPresent = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT); + if (rejectStepPresent != null && rejectStepPresent.equals("no")) + { + requireReject = false; + } + + if (requireReject) + { + // set the reject step name + updateProps.put(ApplicationModel.PROP_REJECT_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME)); + + // specify whether the reject step will copy or move the content + boolean rejectMove = true; + String rejectAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_ACTION); + if (rejectAction != null && rejectAction.equals("copy")) + { + rejectMove = false; + } + updateProps.put(ApplicationModel.PROP_REJECT_MOVE, Boolean.valueOf(rejectMove)); + + // create node ref representation of the destination folder + updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_FOLDER)); + } + else + { + // set all the reject properties to null to signify there should + // be no reject step + updateProps.put(ApplicationModel.PROP_REJECT_STEP, null); + updateProps.put(ApplicationModel.PROP_REJECT_MOVE, null); + updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, null); + } + + // set the properties on the node + getNodeService().setProperties(getNode().getNodeRef(), updateProps); + getNode().reset(); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), MSG_ERROR_UPDATE_SIMPLEWORKFLOW), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + + return outcome; + } + + public Map getWorkflowProperties() + { + if (this.workflowProperties == null && getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) + { + // get the exisiting properties for the node + Map props = getNode().getProperties(); + + String approveStepName = (String) props.get(ApplicationModel.PROP_APPROVE_STEP.toString()); + String rejectStepName = (String) props.get(ApplicationModel.PROP_REJECT_STEP.toString()); + + Boolean approveMove = (Boolean) props.get(ApplicationModel.PROP_APPROVE_MOVE.toString()); + Boolean rejectMove = (Boolean) props.get(ApplicationModel.PROP_REJECT_MOVE.toString()); + + NodeRef approveFolder = (NodeRef) props.get(ApplicationModel.PROP_APPROVE_FOLDER.toString()); + NodeRef rejectFolder = (NodeRef) props.get(ApplicationModel.PROP_REJECT_FOLDER.toString()); + + // put the workflow properties in a separate map for use by the JSP + this.workflowProperties = new HashMap(7); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME, approveStepName); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_ACTION, approveMove ? "move" : "copy"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_FOLDER, approveFolder); + + if (rejectStepName == null || rejectMove == null || rejectFolder == null) + { + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "no"); + } + else + { + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "yes"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME, rejectStepName); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_ACTION, rejectMove ? "move" : "copy"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_FOLDER, rejectFolder); + } + } + + return this.workflowProperties; + } +} diff --git a/source/java/org/alfresco/web/bean/content/InviteContentUsersWizard.java b/source/java/org/alfresco/web/bean/content/InviteContentUsersWizard.java index 67eaa38eb2..a063e6b41f 100644 --- a/source/java/org/alfresco/web/bean/content/InviteContentUsersWizard.java +++ b/source/java/org/alfresco/web/bean/content/InviteContentUsersWizard.java @@ -1,43 +1,43 @@ -package org.alfresco.web.bean.content; - -import java.util.Set; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.wizard.BaseInviteUsersWizard; - -/** - * Concrete implementation providing the ability to invite users to content. - * - * @author gavinc - */ -public class InviteContentUsersWizard extends BaseInviteUsersWizard -{ - private static final long serialVersionUID = 9198783146031469545L; - - @Override - protected Set getPermissionsForType() - { - // Let the permission service do the caching to allow for dynamic model updates, etc. - return this.permissionService.getSettablePermissions(getNode().getType()); - } - - @Override - protected Node getNode() - { - return this.browseBean.getDocument(); - } - - @Override - protected String getEmailTemplateXPath() - { - FacesContext fc = FacesContext.getCurrentInstance(); - String xpath = Application.getRootPath(fc) + "/" + - Application.getGlossaryFolderName(fc) + "/" + - Application.getEmailTemplatesFolderName(fc) + "/" + - Application.getNotifyEmailTemplatesFolderName(fc) + "//*"; - return xpath; - } -} +package org.alfresco.web.bean.content; + +import java.util.Set; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.wizard.BaseInviteUsersWizard; + +/** + * Concrete implementation providing the ability to invite users to content. + * + * @author gavinc + */ +public class InviteContentUsersWizard extends BaseInviteUsersWizard +{ + private static final long serialVersionUID = 9198783146031469545L; + + @Override + protected Set getPermissionsForType() + { + // Let the permission service do the caching to allow for dynamic model updates, etc. + return this.permissionService.getSettablePermissions(getNode().getType()); + } + + @Override + protected Node getNode() + { + return this.browseBean.getDocument(); + } + + @Override + protected String getEmailTemplateXPath() + { + FacesContext fc = FacesContext.getCurrentInstance(); + String xpath = Application.getRootPath(fc) + "/" + + Application.getGlossaryFolderName(fc) + "/" + + Application.getEmailTemplatesFolderName(fc) + "/" + + Application.getNotifyEmailTemplatesFolderName(fc) + "//*"; + return xpath; + } +} diff --git a/source/java/org/alfresco/web/bean/content/SetContentPropertiesDialog.java b/source/java/org/alfresco/web/bean/content/SetContentPropertiesDialog.java index 38cc249848..b441be1b81 100644 --- a/source/java/org/alfresco/web/bean/content/SetContentPropertiesDialog.java +++ b/source/java/org/alfresco/web/bean/content/SetContentPropertiesDialog.java @@ -1,29 +1,29 @@ -package org.alfresco.web.bean.content; - -import org.alfresco.web.app.AlfrescoNavigationHandler; - -/** - * Bean implementation of the "Set Content Properties" dialog. - * - * @author gavinc - */ -public class SetContentPropertiesDialog extends EditContentPropertiesDialog -{ - private static final long serialVersionUID = -7705362669371767349L; - - @Override - protected String getDefaultCancelOutcome() - { - return super.getDefaultCancelOutcome() + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + - "browse"; - } - - @Override - protected String getDefaultFinishOutcome() - { - return super.getDefaultFinishOutcome() + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + - "browse"; - } -} +package org.alfresco.web.bean.content; + +import org.alfresco.web.app.AlfrescoNavigationHandler; + +/** + * Bean implementation of the "Set Content Properties" dialog. + * + * @author gavinc + */ +public class SetContentPropertiesDialog extends EditContentPropertiesDialog +{ + private static final long serialVersionUID = -7705362669371767349L; + + @Override + protected String getDefaultCancelOutcome() + { + return super.getDefaultCancelOutcome() + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + + "browse"; + } + + @Override + protected String getDefaultFinishOutcome() + { + return super.getDefaultFinishOutcome() + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + + "browse"; + } +} diff --git a/source/java/org/alfresco/web/bean/content/ViewContentPropertiesDialog.java b/source/java/org/alfresco/web/bean/content/ViewContentPropertiesDialog.java index ec87834001..d48c36ec22 100644 --- a/source/java/org/alfresco/web/bean/content/ViewContentPropertiesDialog.java +++ b/source/java/org/alfresco/web/bean/content/ViewContentPropertiesDialog.java @@ -1,88 +1,88 @@ -package org.alfresco.web.bean.content; - -import java.text.MessageFormat; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.ContentData; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; - -/** - * Bean implementation of the "View Content Properties" dialog. - * - * @author gavinc - */ -public class ViewContentPropertiesDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -867609607881256449L; - - protected static final String TEMP_PROP_MIMETYPE = "mimetype"; - protected static final String TEMP_PROP_ENCODING = "encoding"; - - protected Node viewingNode; - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - Node document = this.browseBean.getDocument(); - if(document != null) - { - - // setup the editable node - this.viewingNode = new Node(document.getNodeRef()); - - - // special case for Mimetype - since this is a sub-property of the ContentData object - // we must extract it so it can be edited in the client, then we check for it later - // and create a new ContentData object to wrap it and it's associated URL - ContentData content = (ContentData)this.viewingNode.getProperties().get(ContentModel.PROP_CONTENT); - if (content != null) - { - this.viewingNode.getProperties().put(TEMP_PROP_MIMETYPE, content.getMimetype()); - this.viewingNode.getProperties().put(TEMP_PROP_ENCODING, content.getEncoding()); - } - - // add the specially handled 'size' property - this.viewingNode.addPropertyResolver("size", this.browseBean.resolverSize); - } - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - // nothing to do as the finish button is not shown and the dialog is read only - - return outcome; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "close"); - } - - // ------------------------------------------------------------------------------ - // Bean getters and setters - - /** - * Returns the node being viewed - * - * @return The node being viewed - */ - public Node getViewingNode() - { - return this.viewingNode; - } -} +package org.alfresco.web.bean.content; + +import java.text.MessageFormat; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.ContentData; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; + +/** + * Bean implementation of the "View Content Properties" dialog. + * + * @author gavinc + */ +public class ViewContentPropertiesDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -867609607881256449L; + + protected static final String TEMP_PROP_MIMETYPE = "mimetype"; + protected static final String TEMP_PROP_ENCODING = "encoding"; + + protected Node viewingNode; + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + Node document = this.browseBean.getDocument(); + if(document != null) + { + + // setup the editable node + this.viewingNode = new Node(document.getNodeRef()); + + + // special case for Mimetype - since this is a sub-property of the ContentData object + // we must extract it so it can be edited in the client, then we check for it later + // and create a new ContentData object to wrap it and it's associated URL + ContentData content = (ContentData)this.viewingNode.getProperties().get(ContentModel.PROP_CONTENT); + if (content != null) + { + this.viewingNode.getProperties().put(TEMP_PROP_MIMETYPE, content.getMimetype()); + this.viewingNode.getProperties().put(TEMP_PROP_ENCODING, content.getEncoding()); + } + + // add the specially handled 'size' property + this.viewingNode.addPropertyResolver("size", this.browseBean.resolverSize); + } + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + // nothing to do as the finish button is not shown and the dialog is read only + + return outcome; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "close"); + } + + // ------------------------------------------------------------------------------ + // Bean getters and setters + + /** + * Returns the node being viewed + * + * @return The node being viewed + */ + public Node getViewingNode() + { + return this.viewingNode; + } +} diff --git a/source/java/org/alfresco/web/bean/dashboard/DashboardManager.java b/source/java/org/alfresco/web/bean/dashboard/DashboardManager.java index 01ada3984a..2d61403184 100644 --- a/source/java/org/alfresco/web/bean/dashboard/DashboardManager.java +++ b/source/java/org/alfresco/web/bean/dashboard/DashboardManager.java @@ -1,408 +1,408 @@ -package org.alfresco.web.bean.dashboard; - -import java.io.Serializable; -import java.util.Collection; -import java.util.Iterator; -import java.util.List; -import java.util.ListIterator; - -import javax.faces.context.FacesContext; - -import org.springframework.extensions.config.ConfigService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.PreferencesService; -import org.alfresco.web.config.DashboardsConfigElement; -import org.alfresco.web.config.DashboardsConfigElement.DashletDefinition; -import org.alfresco.web.config.DashboardsConfigElement.LayoutDefinition; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean that manages the Dashboard framework. - * - * @author Kevin Roast - */ -public class DashboardManager implements Serializable -{ - private static final long serialVersionUID = 6160628072764689380L; - - public static final String BEAN_NAME = "DashboardManager"; - - private static Log logger = LogFactory.getLog(DashboardManager.class); - - private static final String PREF_DASHBOARD = "dashboard"; - private static final String LAYOUT_DEFAULT = "default"; - private static final String DASHLET_STARTEDDEFAULT = "getting-started"; - private static final String DASHLET_TASKSDEFAULT = "tasks-todo"; - - private static final String JSP_DUMMY = "/jsp/dashboards/dummy.jsp"; - - private PageConfig pageConfig = null; - transient private DashletRenderingList renderingList = null; - transient private DashletTitleList titleList = null; - - /** - * @return The layout JSP page for the current My Alfresco dashboard page - */ - public String getLayoutPage() - { - String layout = null; - Page page = getPageConfig().getCurrentPage(); - if (page != null) - { - layout = page.getLayoutDefinition().JSPPage; - } - return layout; - } - - /** - * Helper to init the dashboard for display - */ - public void initDashboard() - { - this.renderingList = null; - this.titleList = null; - } - - /** - * @return JSF List getter to return which dashlets are available for rendering - */ - public List getDashletAvailable() - { - if (this.renderingList == null) - { - this.renderingList = new DashletRenderingList(getPageConfig()); - } - return this.renderingList; - } - - /** - * @return JSF List getter to return dashlet title strings - */ - public List getDashletTitle() - { - if (this.titleList == null) - { - this.titleList = new DashletTitleList(getPageConfig()); - } - return this.titleList; - } - - /** - * Return the JSP for the specified dashlet index - * - * @param index Zero based index from the left most column working top-bottom then left-right - * - * @return JSP page for the dashlet or a blank dummy page if not found - */ - public String getDashletPage(int index) - { - String page = JSP_DUMMY; - DashletDefinition def = getDashletDefinitionByIndex(getPageConfig(), index); - if (def != null) - { - page = def.JSPPage; - } - return page; - } - - /** - * @return the PageConfig for the current My Alfresco dashboard page - */ - public PageConfig getPageConfig() - { - if (this.pageConfig == null) - { - PageConfig pageConfig; - - DashboardsConfigElement config = getDashboardConfig(); - - // read the config for this user from the Preferences - String xml = (String)PreferencesService.getPreferences().getValue(PREF_DASHBOARD); - if (xml != null && xml.length() != 0) - { - if (logger.isDebugEnabled()) - logger.debug("PageConfig found: " + xml); - - // process the XML config and convert into a PageConfig object - pageConfig = new PageConfig(); - pageConfig.fromXML(config, xml); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("No PageConfig found, creating default instance."); - - // create default config for the first access for a user - pageConfig = new PageConfig(); - LayoutDefinition layout = config.getLayoutDefinition(LAYOUT_DEFAULT); - if (layout != null) - { - Page page = new Page("default", layout); - Column defaultColumn = new Column(); - - // add the default dashlet(s) to the column as specified in the config - if (config.getDefaultDashlets() != null) - { - for (String id : config.getDefaultDashlets()) - { - DashletDefinition dashlet = config.getDashletDefinition(id); - if (dashlet != null) - { - defaultColumn.addDashlet(dashlet); - } - } - } - - // add the column to the page and we are done - page.addColumn(defaultColumn); - pageConfig.addPage(page); - } - } - - this.pageConfig = pageConfig; - } - - return this.pageConfig; - } - - /** - * Persist the supplied PageConfig for the current user - */ - public void savePageConfig(PageConfig config) - { - this.pageConfig = config; - - // reset cached values - initDashboard(); - - // persist the changes - PreferencesService.getPreferences().setValue(PREF_DASHBOARD, this.pageConfig.toXML()); - } - - /** - * @return The externally configured WebClient config element for the Dashboards - */ - public static DashboardsConfigElement getDashboardConfig() - { - ConfigService service = Application.getConfigService(FacesContext.getCurrentInstance()); - DashboardsConfigElement config = (DashboardsConfigElement)service.getConfig("Dashboards").getConfigElement( - DashboardsConfigElement.CONFIG_ELEMENT_ID); - return config; - } - - /** - * Helper to get the DashDefinition as the zero based index, working from the left most column - * top-bottom then working left-right. - * - * @param index Zero based index from the left most column working top-bottom then left-right - * - * @return DashletDefinition if found or null if no dashlet at the specified index - */ - private static DashletDefinition getDashletDefinitionByIndex(PageConfig config, int index) - { - DashletDefinition def = null; - - LayoutDefinition layoutDef = config.getCurrentPage().getLayoutDefinition(); - List columns = config.getCurrentPage().getColumns(); - int columnCount = columns.size(); - int selectedColumn = index / layoutDef.ColumnLength; - if (selectedColumn < columnCount) - { - List dashlets = columns.get(selectedColumn).getDashlets(); - if (index % layoutDef.ColumnLength < dashlets.size()) - { - def = dashlets.get(index % layoutDef.ColumnLength); - } - } - if (logger.isDebugEnabled()) - logger.debug("Searching for dashlet at index: " + index + - " and found " + (def != null ? def.JSPPage : null)); - - return def; - } - - - /** - * Dashlet rendering list. - * - * Returns true from the get() method if the specified dashlet is available for rendering. - */ - private static class DashletRenderingList extends JSFHelperList - { - private static final long serialVersionUID = -8611864902847833088L; - - PageConfig config; - - public DashletRenderingList(PageConfig config) - { - this.config = config; - } - - /** - * @see java.util.List#get(int) - */ - public Object get(int index) - { - return getDashletDefinitionByIndex(config, index) != null; - } - } - - /** - * Dashlet title list. - * - * Returns the title string from the get() method if the specified dashlet is available. - */ - private static class DashletTitleList extends JSFHelperList - { - private static final long serialVersionUID = 3522065600475233262L; - - PageConfig config; - - public DashletTitleList(PageConfig config) - { - this.config = config; - } - - /** - * @see java.util.List#get(int) - */ - public Object get(int index) - { - String result = ""; - - DashletDefinition def = getDashletDefinitionByIndex(config, index); - if (def != null) - { - if (def.LabelId != null) - { - result = Application.getMessage(FacesContext.getCurrentInstance(), def.LabelId); - } - else if (def.Label != null) - { - result = def.Label; - } - } - - return result; - } - } - - /** - * Helper class that implements a dummy List contract for use by JSF List getter methods - */ - private static abstract class JSFHelperList implements List, Serializable - { - // - // Satisfy List interface contract - // - - public void add(int arg0, Object arg1) - { - } - - public boolean add(Object arg0) - { - return false; - } - - public boolean addAll(Collection arg0) - { - return false; - } - - public boolean addAll(int arg0, Collection arg1) - { - return false; - } - - public void clear() - { - } - - public boolean contains(Object arg0) - { - return false; - } - - public boolean containsAll(Collection arg0) - { - return false; - } - - public int indexOf(Object arg0) - { - return 0; - } - - public boolean isEmpty() - { - return false; - } - - public Iterator iterator() - { - return null; - } - - public int lastIndexOf(Object arg0) - { - return 0; - } - - public ListIterator listIterator() - { - return null; - } - - public ListIterator listIterator(int arg0) - { - return null; - } - - public Object remove(int arg0) - { - return null; - } - - public boolean remove(Object arg0) - { - return false; - } - - public boolean removeAll(Collection arg0) - { - return false; - } - - public boolean retainAll(Collection arg0) - { - return false; - } - - public Object set(int arg0, Object arg1) - { - return null; - } - - public int size() - { - return 0; - } - - public List subList(int arg0, int arg1) - { - return null; - } - - public Object[] toArray() - { - return null; - } - - public Object[] toArray(Object[] arg0) - { - return null; - } - } -} +package org.alfresco.web.bean.dashboard; + +import java.io.Serializable; +import java.util.Collection; +import java.util.Iterator; +import java.util.List; +import java.util.ListIterator; + +import javax.faces.context.FacesContext; + +import org.springframework.extensions.config.ConfigService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.PreferencesService; +import org.alfresco.web.config.DashboardsConfigElement; +import org.alfresco.web.config.DashboardsConfigElement.DashletDefinition; +import org.alfresco.web.config.DashboardsConfigElement.LayoutDefinition; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean that manages the Dashboard framework. + * + * @author Kevin Roast + */ +public class DashboardManager implements Serializable +{ + private static final long serialVersionUID = 6160628072764689380L; + + public static final String BEAN_NAME = "DashboardManager"; + + private static Log logger = LogFactory.getLog(DashboardManager.class); + + private static final String PREF_DASHBOARD = "dashboard"; + private static final String LAYOUT_DEFAULT = "default"; + private static final String DASHLET_STARTEDDEFAULT = "getting-started"; + private static final String DASHLET_TASKSDEFAULT = "tasks-todo"; + + private static final String JSP_DUMMY = "/jsp/dashboards/dummy.jsp"; + + private PageConfig pageConfig = null; + transient private DashletRenderingList renderingList = null; + transient private DashletTitleList titleList = null; + + /** + * @return The layout JSP page for the current My Alfresco dashboard page + */ + public String getLayoutPage() + { + String layout = null; + Page page = getPageConfig().getCurrentPage(); + if (page != null) + { + layout = page.getLayoutDefinition().JSPPage; + } + return layout; + } + + /** + * Helper to init the dashboard for display + */ + public void initDashboard() + { + this.renderingList = null; + this.titleList = null; + } + + /** + * @return JSF List getter to return which dashlets are available for rendering + */ + public List getDashletAvailable() + { + if (this.renderingList == null) + { + this.renderingList = new DashletRenderingList(getPageConfig()); + } + return this.renderingList; + } + + /** + * @return JSF List getter to return dashlet title strings + */ + public List getDashletTitle() + { + if (this.titleList == null) + { + this.titleList = new DashletTitleList(getPageConfig()); + } + return this.titleList; + } + + /** + * Return the JSP for the specified dashlet index + * + * @param index Zero based index from the left most column working top-bottom then left-right + * + * @return JSP page for the dashlet or a blank dummy page if not found + */ + public String getDashletPage(int index) + { + String page = JSP_DUMMY; + DashletDefinition def = getDashletDefinitionByIndex(getPageConfig(), index); + if (def != null) + { + page = def.JSPPage; + } + return page; + } + + /** + * @return the PageConfig for the current My Alfresco dashboard page + */ + public PageConfig getPageConfig() + { + if (this.pageConfig == null) + { + PageConfig pageConfig; + + DashboardsConfigElement config = getDashboardConfig(); + + // read the config for this user from the Preferences + String xml = (String)PreferencesService.getPreferences().getValue(PREF_DASHBOARD); + if (xml != null && xml.length() != 0) + { + if (logger.isDebugEnabled()) + logger.debug("PageConfig found: " + xml); + + // process the XML config and convert into a PageConfig object + pageConfig = new PageConfig(); + pageConfig.fromXML(config, xml); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("No PageConfig found, creating default instance."); + + // create default config for the first access for a user + pageConfig = new PageConfig(); + LayoutDefinition layout = config.getLayoutDefinition(LAYOUT_DEFAULT); + if (layout != null) + { + Page page = new Page("default", layout); + Column defaultColumn = new Column(); + + // add the default dashlet(s) to the column as specified in the config + if (config.getDefaultDashlets() != null) + { + for (String id : config.getDefaultDashlets()) + { + DashletDefinition dashlet = config.getDashletDefinition(id); + if (dashlet != null) + { + defaultColumn.addDashlet(dashlet); + } + } + } + + // add the column to the page and we are done + page.addColumn(defaultColumn); + pageConfig.addPage(page); + } + } + + this.pageConfig = pageConfig; + } + + return this.pageConfig; + } + + /** + * Persist the supplied PageConfig for the current user + */ + public void savePageConfig(PageConfig config) + { + this.pageConfig = config; + + // reset cached values + initDashboard(); + + // persist the changes + PreferencesService.getPreferences().setValue(PREF_DASHBOARD, this.pageConfig.toXML()); + } + + /** + * @return The externally configured WebClient config element for the Dashboards + */ + public static DashboardsConfigElement getDashboardConfig() + { + ConfigService service = Application.getConfigService(FacesContext.getCurrentInstance()); + DashboardsConfigElement config = (DashboardsConfigElement)service.getConfig("Dashboards").getConfigElement( + DashboardsConfigElement.CONFIG_ELEMENT_ID); + return config; + } + + /** + * Helper to get the DashDefinition as the zero based index, working from the left most column + * top-bottom then working left-right. + * + * @param index Zero based index from the left most column working top-bottom then left-right + * + * @return DashletDefinition if found or null if no dashlet at the specified index + */ + private static DashletDefinition getDashletDefinitionByIndex(PageConfig config, int index) + { + DashletDefinition def = null; + + LayoutDefinition layoutDef = config.getCurrentPage().getLayoutDefinition(); + List columns = config.getCurrentPage().getColumns(); + int columnCount = columns.size(); + int selectedColumn = index / layoutDef.ColumnLength; + if (selectedColumn < columnCount) + { + List dashlets = columns.get(selectedColumn).getDashlets(); + if (index % layoutDef.ColumnLength < dashlets.size()) + { + def = dashlets.get(index % layoutDef.ColumnLength); + } + } + if (logger.isDebugEnabled()) + logger.debug("Searching for dashlet at index: " + index + + " and found " + (def != null ? def.JSPPage : null)); + + return def; + } + + + /** + * Dashlet rendering list. + * + * Returns true from the get() method if the specified dashlet is available for rendering. + */ + private static class DashletRenderingList extends JSFHelperList + { + private static final long serialVersionUID = -8611864902847833088L; + + PageConfig config; + + public DashletRenderingList(PageConfig config) + { + this.config = config; + } + + /** + * @see java.util.List#get(int) + */ + public Object get(int index) + { + return getDashletDefinitionByIndex(config, index) != null; + } + } + + /** + * Dashlet title list. + * + * Returns the title string from the get() method if the specified dashlet is available. + */ + private static class DashletTitleList extends JSFHelperList + { + private static final long serialVersionUID = 3522065600475233262L; + + PageConfig config; + + public DashletTitleList(PageConfig config) + { + this.config = config; + } + + /** + * @see java.util.List#get(int) + */ + public Object get(int index) + { + String result = ""; + + DashletDefinition def = getDashletDefinitionByIndex(config, index); + if (def != null) + { + if (def.LabelId != null) + { + result = Application.getMessage(FacesContext.getCurrentInstance(), def.LabelId); + } + else if (def.Label != null) + { + result = def.Label; + } + } + + return result; + } + } + + /** + * Helper class that implements a dummy List contract for use by JSF List getter methods + */ + private static abstract class JSFHelperList implements List, Serializable + { + // + // Satisfy List interface contract + // + + public void add(int arg0, Object arg1) + { + } + + public boolean add(Object arg0) + { + return false; + } + + public boolean addAll(Collection arg0) + { + return false; + } + + public boolean addAll(int arg0, Collection arg1) + { + return false; + } + + public void clear() + { + } + + public boolean contains(Object arg0) + { + return false; + } + + public boolean containsAll(Collection arg0) + { + return false; + } + + public int indexOf(Object arg0) + { + return 0; + } + + public boolean isEmpty() + { + return false; + } + + public Iterator iterator() + { + return null; + } + + public int lastIndexOf(Object arg0) + { + return 0; + } + + public ListIterator listIterator() + { + return null; + } + + public ListIterator listIterator(int arg0) + { + return null; + } + + public Object remove(int arg0) + { + return null; + } + + public boolean remove(Object arg0) + { + return false; + } + + public boolean removeAll(Collection arg0) + { + return false; + } + + public boolean retainAll(Collection arg0) + { + return false; + } + + public Object set(int arg0, Object arg1) + { + return null; + } + + public int size() + { + return 0; + } + + public List subList(int arg0, int arg1) + { + return null; + } + + public Object[] toArray() + { + return null; + } + + public Object[] toArray(Object[] arg0) + { + return null; + } + } +} diff --git a/source/java/org/alfresco/web/bean/dashboard/DashboardWizard.java b/source/java/org/alfresco/web/bean/dashboard/DashboardWizard.java index f496dea1ab..51249a17c1 100644 --- a/source/java/org/alfresco/web/bean/dashboard/DashboardWizard.java +++ b/source/java/org/alfresco/web/bean/dashboard/DashboardWizard.java @@ -1,472 +1,472 @@ -package org.alfresco.web.bean.dashboard; - -import java.util.ArrayList; -import java.util.Collection; -import java.util.Iterator; -import java.util.List; -import java.util.Map; - -import javax.faces.component.UISelectMany; -import javax.faces.component.UISelectOne; -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.faces.model.SelectItem; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.wizard.BaseWizardBean; -import org.alfresco.web.config.DashboardsConfigElement; -import org.alfresco.web.config.DashboardsConfigElement.DashletDefinition; -import org.alfresco.web.config.DashboardsConfigElement.LayoutDefinition; -import org.alfresco.web.ui.common.component.UIListItem; -import org.alfresco.web.ui.common.component.description.UIDescription; - -/** - * @author Kevin Roast - */ -public class DashboardWizard extends BaseWizardBean -{ - private static final long serialVersionUID = 2544040677742418309L; - - private static final String COMPONENT_COLUMNDASHLETS = "column-dashlets"; - - private static final String COMPONENT_ALLDASHLETS = "all-dashlets"; - - private static final String MSG_COLUMN = "dashboard_column"; - - /** List of icons items to display as selectable Layout definitions */ - private List layoutIcons = null; - - /** List of descriptions of the layouts */ - private List layoutDescriptions = null; - - /** List of SelectItem objects representing the available dashlets */ - private List dashlets = null; - - /** Currently selected layout */ - private String layout; - - /** Currently selected column to edit */ - private int column; - - /** The PageConfig holding the columns/dashlets during editing */ - private PageConfig editConfig; - - /** The DashboardManager instance */ - private DashboardManager dashboardManager; - - - // ------------------------------------------------------------------------------ - // Bean setters - - /** - * @param dashboardManager The dashboardManager to set. - */ - public void setDashboardManager(DashboardManager dashboardManager) - { - this.dashboardManager = dashboardManager; - } - - - // ------------------------------------------------------------------------------ - // Wizard implementation - - /** - * @see org.alfresco.web.bean.dialog.BaseDialogBean#init(java.util.Map) - */ - public void init(Map parameters) - { - super.init(parameters); - - this.editConfig = new PageConfig(this.dashboardManager.getPageConfig()); - this.layout = this.editConfig.getCurrentPage().getLayoutDefinition().Id; - this.column = 0; - } - - /** - * @see org.alfresco.web.bean.dialog.BaseDialogBean#finishImpl(javax.faces.context.FacesContext, java.lang.String) - */ - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - this.dashboardManager.savePageConfig(this.editConfig); - return outcome; - } - - /** - * @return Returns the summary data for the wizard. - */ - public String getSummary() - { - LayoutDefinition def = DashboardManager.getDashboardConfig().getLayoutDefinition(this.layout); - String label = def.Label; - if (label == null) - { - label = Application.getMessage(FacesContext.getCurrentInstance(), def.LabelId); - } - return buildSummary( - new String[]{Application.getMessage(FacesContext.getCurrentInstance(),"step_layout")}, - new String[]{label}); - } - - - // ------------------------------------------------------------------------------ - // Dashboard Wizard bean getters - - /** - * @return true to allow the Guest user to configure the dashboard, false otherwise - */ - public boolean getAllowGuestConfig() - { - return DashboardManager.getDashboardConfig().getAllowGuestConfig(); - } - - /** - * @return The currently selected layout ID - used by the Dynamic Description component - */ - public String getLayout() - { - return this.layout; - } - - /** - * Set the currently selected layout ID - */ - public void setLayout(String layout) - { - this.layout = layout; - LayoutDefinition def = DashboardManager.getDashboardConfig().getLayoutDefinition(layout); - this.editConfig.getCurrentPage().setLayoutDefinition(def); - if (this.column >= def.Columns) - { - this.column = def.Columns - 1; - } - } - - /** - * @return the number of columns in the selected page layout - */ - public int getColumnCount() - { - return DashboardManager.getDashboardConfig().getLayoutDefinition(getLayout()).Columns; - } - - /** - * @return the number of components per column supported in the selected page layout - */ - public int getColumnMax() - { - return DashboardManager.getDashboardConfig().getLayoutDefinition(getLayout()).ColumnLength; - } - - /** - * @return the array of UI select items representing the columns that can be configured - */ - public SelectItem[] getColumns() - { - FacesContext fc = FacesContext.getCurrentInstance(); - LayoutDefinition layoutDef = DashboardManager.getDashboardConfig().getLayoutDefinition(getLayout()); - SelectItem[] columns = new SelectItem[layoutDef.Columns]; - for (int i=0; i getAllDashlets() - { - if ((this.dashlets == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - FacesContext fc = FacesContext.getCurrentInstance(); - DashboardsConfigElement config = DashboardManager.getDashboardConfig(); - Collection dashletDefs = config.getDashlets(); - List dashlets = new ArrayList(dashletDefs.size()); - for (DashletDefinition dashletDef : dashletDefs) - { - String label = dashletDef.Label; - if (label == null) - { - label = Application.getMessage(fc, dashletDef.LabelId); - } - String description = dashletDef.Description; - if (description == null) - { - description = Application.getMessage(fc, dashletDef.DescriptionId); - } - if (description != null) - { - // append description of the dashlet if set - label = label + " (" + description + ')'; - } - SelectItem item = new SelectItem(dashletDef.Id, label); - dashlets.add(item); - } - this.dashlets = dashlets; - } - return this.dashlets; - } - - /** - * @return the List of SelectItem objects representing the dashlets displayed in the - * currently selected column. - */ - public List getColumnDashlets() - { - FacesContext fc = FacesContext.getCurrentInstance(); - - Column column = this.editConfig.getCurrentPage().getColumns().get(this.column); - // trim the max number of dashlets for this column - LayoutDefinition layoutDef = this.editConfig.getCurrentPage().getLayoutDefinition(); - column.trimDashlets(layoutDef.ColumnLength); - List dashlets = new ArrayList(column.getDashlets().size()); - for (DashletDefinition dashletDef : column.getDashlets()) - { - String label = dashletDef.Label; - if (label == null) - { - label = Application.getMessage(fc, dashletDef.LabelId); - } - dashlets.add(new SelectItem(dashletDef.Id, label)); - } - return dashlets; - } - - /** - * @return the number of dashlets currently displayed in the selected column - */ - public int getColumnDashletCount() - { - Column column = this.editConfig.getCurrentPage().getColumns().get(this.column); - return column.getDashlets().size(); - } - - /** - * @return List of UIDescription objects for the available layouts - */ - public List getLayoutDescriptions() - { - if ((this.layoutDescriptions == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - buildLayoutValueLists(); - } - return this.layoutDescriptions; - } - - /** - * @return the List of UIListItem objects representing the Layout icons - */ - public List getLayoutIcons() - { - if ((this.layoutIcons == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - buildLayoutValueLists(); - } - return this.layoutIcons; - } - - /** - * Build the cached list of values for the layout page. The lists are used by the - * image radio picker and dynamic description components. - */ - private void buildLayoutValueLists() - { - List icons = new ArrayList(4); - List descriptions = new ArrayList(4); - - FacesContext context = FacesContext.getCurrentInstance(); - - DashboardsConfigElement config = DashboardManager.getDashboardConfig(); - Iterator layoutItr = config.getLayouts().iterator(); - while (layoutItr.hasNext()) - { - LayoutDefinition layoutDef = layoutItr.next(); - - // build UIListItem to represent the layout image - String label = layoutDef.Label; - if (label == null) - { - label = Application.getMessage(context, layoutDef.LabelId); - } - String desc = layoutDef.Description; - if (desc == null) - { - desc = Application.getMessage(context, layoutDef.DescriptionId); - } - UIListItem item = new UIListItem(); - item.setLabel(label); - item.setTooltip(desc); - item.setValue(layoutDef.Id); - item.setImage(layoutDef.Image); - icons.add(item); - - // build UIDescription to represent the layout description text - UIDescription description = new UIDescription(); - description.setControlValue(layoutDef.Id); - description.setText(desc); - descriptions.add(description); - } - - this.layoutIcons = icons; - this.layoutDescriptions = descriptions; - } - - /** - * Action event handler called to Add dashlets to the selection for a column - */ - public void addDashlets(ActionEvent event) - { - UISelectMany dashletPicker = (UISelectMany)event.getComponent().findComponent(COMPONENT_ALLDASHLETS); - UISelectOne dashletColumn = (UISelectOne)event.getComponent().findComponent(COMPONENT_COLUMNDASHLETS); - - // get the IDs of the selected Dashlet definitions - Object[] selected = dashletPicker.getSelectedValues(); - - if (selected.length != 0) - { - // get the column to add the dashlets too - DashboardsConfigElement config = DashboardManager.getDashboardConfig(); - LayoutDefinition layoutDef = this.editConfig.getCurrentPage().getLayoutDefinition(); - Column column = this.editConfig.getCurrentPage().getColumns().get(this.column); - - // add each selected dashlet to the column - for (int i=0; i layoutIcons = null; + + /** List of descriptions of the layouts */ + private List layoutDescriptions = null; + + /** List of SelectItem objects representing the available dashlets */ + private List dashlets = null; + + /** Currently selected layout */ + private String layout; + + /** Currently selected column to edit */ + private int column; + + /** The PageConfig holding the columns/dashlets during editing */ + private PageConfig editConfig; + + /** The DashboardManager instance */ + private DashboardManager dashboardManager; + + + // ------------------------------------------------------------------------------ + // Bean setters + + /** + * @param dashboardManager The dashboardManager to set. + */ + public void setDashboardManager(DashboardManager dashboardManager) + { + this.dashboardManager = dashboardManager; + } + + + // ------------------------------------------------------------------------------ + // Wizard implementation + + /** + * @see org.alfresco.web.bean.dialog.BaseDialogBean#init(java.util.Map) + */ + public void init(Map parameters) + { + super.init(parameters); + + this.editConfig = new PageConfig(this.dashboardManager.getPageConfig()); + this.layout = this.editConfig.getCurrentPage().getLayoutDefinition().Id; + this.column = 0; + } + + /** + * @see org.alfresco.web.bean.dialog.BaseDialogBean#finishImpl(javax.faces.context.FacesContext, java.lang.String) + */ + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + this.dashboardManager.savePageConfig(this.editConfig); + return outcome; + } + + /** + * @return Returns the summary data for the wizard. + */ + public String getSummary() + { + LayoutDefinition def = DashboardManager.getDashboardConfig().getLayoutDefinition(this.layout); + String label = def.Label; + if (label == null) + { + label = Application.getMessage(FacesContext.getCurrentInstance(), def.LabelId); + } + return buildSummary( + new String[]{Application.getMessage(FacesContext.getCurrentInstance(),"step_layout")}, + new String[]{label}); + } + + + // ------------------------------------------------------------------------------ + // Dashboard Wizard bean getters + + /** + * @return true to allow the Guest user to configure the dashboard, false otherwise + */ + public boolean getAllowGuestConfig() + { + return DashboardManager.getDashboardConfig().getAllowGuestConfig(); + } + + /** + * @return The currently selected layout ID - used by the Dynamic Description component + */ + public String getLayout() + { + return this.layout; + } + + /** + * Set the currently selected layout ID + */ + public void setLayout(String layout) + { + this.layout = layout; + LayoutDefinition def = DashboardManager.getDashboardConfig().getLayoutDefinition(layout); + this.editConfig.getCurrentPage().setLayoutDefinition(def); + if (this.column >= def.Columns) + { + this.column = def.Columns - 1; + } + } + + /** + * @return the number of columns in the selected page layout + */ + public int getColumnCount() + { + return DashboardManager.getDashboardConfig().getLayoutDefinition(getLayout()).Columns; + } + + /** + * @return the number of components per column supported in the selected page layout + */ + public int getColumnMax() + { + return DashboardManager.getDashboardConfig().getLayoutDefinition(getLayout()).ColumnLength; + } + + /** + * @return the array of UI select items representing the columns that can be configured + */ + public SelectItem[] getColumns() + { + FacesContext fc = FacesContext.getCurrentInstance(); + LayoutDefinition layoutDef = DashboardManager.getDashboardConfig().getLayoutDefinition(getLayout()); + SelectItem[] columns = new SelectItem[layoutDef.Columns]; + for (int i=0; i getAllDashlets() + { + if ((this.dashlets == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + FacesContext fc = FacesContext.getCurrentInstance(); + DashboardsConfigElement config = DashboardManager.getDashboardConfig(); + Collection dashletDefs = config.getDashlets(); + List dashlets = new ArrayList(dashletDefs.size()); + for (DashletDefinition dashletDef : dashletDefs) + { + String label = dashletDef.Label; + if (label == null) + { + label = Application.getMessage(fc, dashletDef.LabelId); + } + String description = dashletDef.Description; + if (description == null) + { + description = Application.getMessage(fc, dashletDef.DescriptionId); + } + if (description != null) + { + // append description of the dashlet if set + label = label + " (" + description + ')'; + } + SelectItem item = new SelectItem(dashletDef.Id, label); + dashlets.add(item); + } + this.dashlets = dashlets; + } + return this.dashlets; + } + + /** + * @return the List of SelectItem objects representing the dashlets displayed in the + * currently selected column. + */ + public List getColumnDashlets() + { + FacesContext fc = FacesContext.getCurrentInstance(); + + Column column = this.editConfig.getCurrentPage().getColumns().get(this.column); + // trim the max number of dashlets for this column + LayoutDefinition layoutDef = this.editConfig.getCurrentPage().getLayoutDefinition(); + column.trimDashlets(layoutDef.ColumnLength); + List dashlets = new ArrayList(column.getDashlets().size()); + for (DashletDefinition dashletDef : column.getDashlets()) + { + String label = dashletDef.Label; + if (label == null) + { + label = Application.getMessage(fc, dashletDef.LabelId); + } + dashlets.add(new SelectItem(dashletDef.Id, label)); + } + return dashlets; + } + + /** + * @return the number of dashlets currently displayed in the selected column + */ + public int getColumnDashletCount() + { + Column column = this.editConfig.getCurrentPage().getColumns().get(this.column); + return column.getDashlets().size(); + } + + /** + * @return List of UIDescription objects for the available layouts + */ + public List getLayoutDescriptions() + { + if ((this.layoutDescriptions == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + buildLayoutValueLists(); + } + return this.layoutDescriptions; + } + + /** + * @return the List of UIListItem objects representing the Layout icons + */ + public List getLayoutIcons() + { + if ((this.layoutIcons == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + buildLayoutValueLists(); + } + return this.layoutIcons; + } + + /** + * Build the cached list of values for the layout page. The lists are used by the + * image radio picker and dynamic description components. + */ + private void buildLayoutValueLists() + { + List icons = new ArrayList(4); + List descriptions = new ArrayList(4); + + FacesContext context = FacesContext.getCurrentInstance(); + + DashboardsConfigElement config = DashboardManager.getDashboardConfig(); + Iterator layoutItr = config.getLayouts().iterator(); + while (layoutItr.hasNext()) + { + LayoutDefinition layoutDef = layoutItr.next(); + + // build UIListItem to represent the layout image + String label = layoutDef.Label; + if (label == null) + { + label = Application.getMessage(context, layoutDef.LabelId); + } + String desc = layoutDef.Description; + if (desc == null) + { + desc = Application.getMessage(context, layoutDef.DescriptionId); + } + UIListItem item = new UIListItem(); + item.setLabel(label); + item.setTooltip(desc); + item.setValue(layoutDef.Id); + item.setImage(layoutDef.Image); + icons.add(item); + + // build UIDescription to represent the layout description text + UIDescription description = new UIDescription(); + description.setControlValue(layoutDef.Id); + description.setText(desc); + descriptions.add(description); + } + + this.layoutIcons = icons; + this.layoutDescriptions = descriptions; + } + + /** + * Action event handler called to Add dashlets to the selection for a column + */ + public void addDashlets(ActionEvent event) + { + UISelectMany dashletPicker = (UISelectMany)event.getComponent().findComponent(COMPONENT_ALLDASHLETS); + UISelectOne dashletColumn = (UISelectOne)event.getComponent().findComponent(COMPONENT_COLUMNDASHLETS); + + // get the IDs of the selected Dashlet definitions + Object[] selected = dashletPicker.getSelectedValues(); + + if (selected.length != 0) + { + // get the column to add the dashlets too + DashboardsConfigElement config = DashboardManager.getDashboardConfig(); + LayoutDefinition layoutDef = this.editConfig.getCurrentPage().getLayoutDefinition(); + Column column = this.editConfig.getCurrentPage().getColumns().get(this.column); + + // add each selected dashlet to the column + for (int i=0; i pages = new ArrayList(4); - private Page currentPage = null; - - - /** - * Default constructor - */ - public PageConfig() - { - } - - /** - * Copy constructor - * - * @param copy PageConfig to copy - */ - public PageConfig(PageConfig copy) - { - this.pages = new ArrayList(copy.pages.size()); - for (Page page : copy.pages) - { - // invoke the copy constructor on each Page - // which in turn calls the copy constructor of child classes - this.pages.add(new Page(page)); - } - } - - /** - * @return The current page in the config - */ - public Page getCurrentPage() - { - if (this.currentPage == null) - { - if (this.pages.size() != 0) - { - this.currentPage = pages.get(0); - } - } - return this.currentPage; - } - - /** - * Set the current Page for the cnfig - * - * @param pageId ID of the page to set as current - */ - public void setCurrentPage(String pageId) - { - for (Page page : pages) - { - if (page.getId().equals(pageId)) - { - this.currentPage = page; - break; - } - } - } - - /** - * Add a new Page to the list - * - * @param page Page to add - */ - public void addPage(Page page) - { - pages.add(page); - } - - /** - * Get a Page with the specified page Id - * - * @param pageId Of the page to return - * - * @return Page or null if not found - */ - public Page getPage(String pageId) - { - Page foundPage = null; - for (Page page : pages) - { - if (page.getId().equals(pageId)) - { - foundPage = page; - break; - } - } - return foundPage; - } - - /** - * Convert this config to an XML definition which can be serialized. - * Example: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * @return XML for this config - */ - public String toXML() - { - try - { - Document doc = DocumentHelper.createDocument(); - - Element root = doc.addElement(ELEMENT_DASHBOARD); - for (Page page : pages) - { - Element pageElement = root.addElement(ELEMENT_PAGE); - pageElement.addAttribute(ATTR_ID, page.getId()); - pageElement.addAttribute(ATTR_LAYOUTID, page.getLayoutDefinition().Id); - for (Column column : page.getColumns()) - { - Element columnElement = pageElement.addElement(ELEMENT_COLUMN); - for (DashletDefinition dashletDef : column.getDashlets()) - { - columnElement.addElement(ELEMENT_DASHLET).addAttribute(ATTR_REFID, dashletDef.Id); - } - } - } - - StringWriter out = new StringWriter(512); - XMLWriter writer = new XMLWriter(OutputFormat.createPrettyPrint()); - writer.setWriter(out); - writer.write(doc); - - return out.toString(); - } - catch (Throwable err) - { - throw new AlfrescoRuntimeException("Unable to serialize Dashboard PageConfig to XML: " + err.getMessage(), err); - } - } - - @Override - public String toString() - { - return toXML(); - } - - /** - * Deserialise this PageConfig instance from the specified XML stream. - * - * @param xml - */ - public void fromXML(DashboardsConfigElement config, String xml) - { - try - { - SAXReader reader = new SAXReader(); - Document document = reader.read(new StringReader(xml)); - Element rootElement = document.getRootElement(); - - // walk the pages found in xml - Iterator itrPages = rootElement.elementIterator(ELEMENT_PAGE); - while (itrPages.hasNext()) - { - Element pageElement = (Element)itrPages.next(); - String layoutId = pageElement.attributeValue(ATTR_LAYOUTID); - LayoutDefinition layoutDef = config.getLayoutDefinition(layoutId); - if (layoutDef != null) - { - // found the layout now build the page and read the columns - Page page = new Page(pageElement.attributeValue(ATTR_ID), layoutDef); - Iterator itrColumns = pageElement.elementIterator(ELEMENT_COLUMN); - while (itrColumns.hasNext()) - { - Column column = new Column(); - - // read and resolve the dashlet definitions for this column - Element columnElement = (Element)itrColumns.next(); - Iterator itrDashlets = columnElement.elementIterator(ELEMENT_DASHLET); - while (itrDashlets.hasNext()) - { - String dashletId = ((Element)itrDashlets.next()).attributeValue(ATTR_REFID); - DashletDefinition dashletDef = config.getDashletDefinition(dashletId); - if (dashletDef != null) - { - column.addDashlet(dashletDef); - } - else if (logger.isWarnEnabled()) - { - logger.warn("Failed to resolve Dashboard Dashlet Definition ID: " + dashletId); - } - } - - // add the column of dashlets to the page - page.addColumn(column); - } - - // add the page to this config instance - this.addPage(page); - } - else if (logger.isWarnEnabled()) - { - logger.warn("Failed to resolve Dashboard Layout Definition ID: " + layoutId); - } - } - } - catch (DocumentException docErr) - { - // if we cannot parse, then we simply revert to default - } - } -} - -/** - * Simple class to represent a Page in a Dashboard. - * Each Page has a Layout associated with it, and a number of Column definitions. - */ -final class Page implements Serializable -{ - private static final long serialVersionUID = 8023042580316126423L; - - private String id; - private LayoutDefinition layoutDef; - private List columns = new ArrayList(4); - - /** - * Constructor - * - * @param id - * @param layout - */ - public Page(String id, LayoutDefinition layout) - { - if (id == null || id.length() == 0) - { - throw new IllegalArgumentException("ID for a Dashboard Page is mandatory."); - } - if (layout == null) - { - throw new IllegalArgumentException("Layout for a Dashboard Page is mandatory."); - } - this.id = id; - this.layoutDef = layout; - } - - /** - * Copy Constructor - * - * @param copy Page to build a copy from - */ - public Page(Page copy) - { - this.id = copy.id; - this.layoutDef = copy.layoutDef; - for (Column column : copy.columns) - { - Column cloneColumn = new Column(column); - addColumn(cloneColumn); - } - } - - public String getId() - { - return this.id; - } - - public LayoutDefinition getLayoutDefinition() - { - return this.layoutDef; - } - - public void setLayoutDefinition(LayoutDefinition layout) - { - if (layout == null) - { - throw new IllegalArgumentException("Layout for a Dashboard Page is mandatory."); - } - - // correct column collection based on new layout definition - while (this.columns.size() < layout.Columns) - { - addColumn(new Column()); - } - if (this.columns.size() > layout.Columns) - { - this.columns = this.columns.subList(0, layout.Columns); - } - - this.layoutDef = layout; - } - - public void addColumn(Column column) - { - this.columns.add(column); - } - - public List getColumns() - { - return this.columns; - } -} - -/** - * Simple class representing a single Column in a dashboard Page. - * Each column contains a list of Dashlet definitions. - */ -final class Column implements Serializable -{ - private static final long serialVersionUID = 6462844390234508010L; - - private List dashlets = new ArrayList(4); - - /** - * Default constructor - */ - public Column() - { - } - - /** - * Copy constructor - * - * @param copy Column to copy - */ - public Column(Column copy) - { - this.dashlets = new ArrayList(copy.dashlets.size()); - this.dashlets.addAll(copy.dashlets); - } - - public void addDashlet(DashletDefinition dashlet) - { - dashlets.add(dashlet); - } - - public List getDashlets() - { - return this.dashlets; - } - - public void trimDashlets(int max) - { - if (max >= 0) - { - int maxTrim = Math.min(this.dashlets.size(), max); - this.dashlets = this.dashlets.subList(0, maxTrim); - } - } -} +package org.alfresco.web.bean.dashboard; + +import java.io.Serializable; +import java.io.StringReader; +import java.io.StringWriter; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.config.DashboardsConfigElement; +import org.alfresco.web.config.DashboardsConfigElement.DashletDefinition; +import org.alfresco.web.config.DashboardsConfigElement.LayoutDefinition; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.dom4j.Document; +import org.dom4j.DocumentException; +import org.dom4j.DocumentHelper; +import org.dom4j.Element; +import org.dom4j.io.OutputFormat; +import org.dom4j.io.SAXReader; +import org.dom4j.io.XMLWriter; + +/** + * Describes the config for the Pages in a user Dashboard. + * Multiple Pages are supported. + * + * @author Kevin Roast + */ +public final class PageConfig implements Serializable +{ + private static final long serialVersionUID = 5464324390924278215L; + + private static Log logger = LogFactory.getLog(DashboardManager.class); + + private static final String ELEMENT_DASHBOARD = "dashboard"; + private static final String ELEMENT_PAGE = "page"; + private static final String ELEMENT_COLUMN = "column"; + private static final String ELEMENT_DASHLET = "dashlet"; + private static final String ATTR_ID = "id"; + private static final String ATTR_LAYOUTID = "layout-id"; + private static final String ATTR_REFID = "idref"; + + private List pages = new ArrayList(4); + private Page currentPage = null; + + + /** + * Default constructor + */ + public PageConfig() + { + } + + /** + * Copy constructor + * + * @param copy PageConfig to copy + */ + public PageConfig(PageConfig copy) + { + this.pages = new ArrayList(copy.pages.size()); + for (Page page : copy.pages) + { + // invoke the copy constructor on each Page + // which in turn calls the copy constructor of child classes + this.pages.add(new Page(page)); + } + } + + /** + * @return The current page in the config + */ + public Page getCurrentPage() + { + if (this.currentPage == null) + { + if (this.pages.size() != 0) + { + this.currentPage = pages.get(0); + } + } + return this.currentPage; + } + + /** + * Set the current Page for the cnfig + * + * @param pageId ID of the page to set as current + */ + public void setCurrentPage(String pageId) + { + for (Page page : pages) + { + if (page.getId().equals(pageId)) + { + this.currentPage = page; + break; + } + } + } + + /** + * Add a new Page to the list + * + * @param page Page to add + */ + public void addPage(Page page) + { + pages.add(page); + } + + /** + * Get a Page with the specified page Id + * + * @param pageId Of the page to return + * + * @return Page or null if not found + */ + public Page getPage(String pageId) + { + Page foundPage = null; + for (Page page : pages) + { + if (page.getId().equals(pageId)) + { + foundPage = page; + break; + } + } + return foundPage; + } + + /** + * Convert this config to an XML definition which can be serialized. + * Example: + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * @return XML for this config + */ + public String toXML() + { + try + { + Document doc = DocumentHelper.createDocument(); + + Element root = doc.addElement(ELEMENT_DASHBOARD); + for (Page page : pages) + { + Element pageElement = root.addElement(ELEMENT_PAGE); + pageElement.addAttribute(ATTR_ID, page.getId()); + pageElement.addAttribute(ATTR_LAYOUTID, page.getLayoutDefinition().Id); + for (Column column : page.getColumns()) + { + Element columnElement = pageElement.addElement(ELEMENT_COLUMN); + for (DashletDefinition dashletDef : column.getDashlets()) + { + columnElement.addElement(ELEMENT_DASHLET).addAttribute(ATTR_REFID, dashletDef.Id); + } + } + } + + StringWriter out = new StringWriter(512); + XMLWriter writer = new XMLWriter(OutputFormat.createPrettyPrint()); + writer.setWriter(out); + writer.write(doc); + + return out.toString(); + } + catch (Throwable err) + { + throw new AlfrescoRuntimeException("Unable to serialize Dashboard PageConfig to XML: " + err.getMessage(), err); + } + } + + @Override + public String toString() + { + return toXML(); + } + + /** + * Deserialise this PageConfig instance from the specified XML stream. + * + * @param xml + */ + public void fromXML(DashboardsConfigElement config, String xml) + { + try + { + SAXReader reader = new SAXReader(); + Document document = reader.read(new StringReader(xml)); + Element rootElement = document.getRootElement(); + + // walk the pages found in xml + Iterator itrPages = rootElement.elementIterator(ELEMENT_PAGE); + while (itrPages.hasNext()) + { + Element pageElement = (Element)itrPages.next(); + String layoutId = pageElement.attributeValue(ATTR_LAYOUTID); + LayoutDefinition layoutDef = config.getLayoutDefinition(layoutId); + if (layoutDef != null) + { + // found the layout now build the page and read the columns + Page page = new Page(pageElement.attributeValue(ATTR_ID), layoutDef); + Iterator itrColumns = pageElement.elementIterator(ELEMENT_COLUMN); + while (itrColumns.hasNext()) + { + Column column = new Column(); + + // read and resolve the dashlet definitions for this column + Element columnElement = (Element)itrColumns.next(); + Iterator itrDashlets = columnElement.elementIterator(ELEMENT_DASHLET); + while (itrDashlets.hasNext()) + { + String dashletId = ((Element)itrDashlets.next()).attributeValue(ATTR_REFID); + DashletDefinition dashletDef = config.getDashletDefinition(dashletId); + if (dashletDef != null) + { + column.addDashlet(dashletDef); + } + else if (logger.isWarnEnabled()) + { + logger.warn("Failed to resolve Dashboard Dashlet Definition ID: " + dashletId); + } + } + + // add the column of dashlets to the page + page.addColumn(column); + } + + // add the page to this config instance + this.addPage(page); + } + else if (logger.isWarnEnabled()) + { + logger.warn("Failed to resolve Dashboard Layout Definition ID: " + layoutId); + } + } + } + catch (DocumentException docErr) + { + // if we cannot parse, then we simply revert to default + } + } +} + +/** + * Simple class to represent a Page in a Dashboard. + * Each Page has a Layout associated with it, and a number of Column definitions. + */ +final class Page implements Serializable +{ + private static final long serialVersionUID = 8023042580316126423L; + + private String id; + private LayoutDefinition layoutDef; + private List columns = new ArrayList(4); + + /** + * Constructor + * + * @param id + * @param layout + */ + public Page(String id, LayoutDefinition layout) + { + if (id == null || id.length() == 0) + { + throw new IllegalArgumentException("ID for a Dashboard Page is mandatory."); + } + if (layout == null) + { + throw new IllegalArgumentException("Layout for a Dashboard Page is mandatory."); + } + this.id = id; + this.layoutDef = layout; + } + + /** + * Copy Constructor + * + * @param copy Page to build a copy from + */ + public Page(Page copy) + { + this.id = copy.id; + this.layoutDef = copy.layoutDef; + for (Column column : copy.columns) + { + Column cloneColumn = new Column(column); + addColumn(cloneColumn); + } + } + + public String getId() + { + return this.id; + } + + public LayoutDefinition getLayoutDefinition() + { + return this.layoutDef; + } + + public void setLayoutDefinition(LayoutDefinition layout) + { + if (layout == null) + { + throw new IllegalArgumentException("Layout for a Dashboard Page is mandatory."); + } + + // correct column collection based on new layout definition + while (this.columns.size() < layout.Columns) + { + addColumn(new Column()); + } + if (this.columns.size() > layout.Columns) + { + this.columns = this.columns.subList(0, layout.Columns); + } + + this.layoutDef = layout; + } + + public void addColumn(Column column) + { + this.columns.add(column); + } + + public List getColumns() + { + return this.columns; + } +} + +/** + * Simple class representing a single Column in a dashboard Page. + * Each column contains a list of Dashlet definitions. + */ +final class Column implements Serializable +{ + private static final long serialVersionUID = 6462844390234508010L; + + private List dashlets = new ArrayList(4); + + /** + * Default constructor + */ + public Column() + { + } + + /** + * Copy constructor + * + * @param copy Column to copy + */ + public Column(Column copy) + { + this.dashlets = new ArrayList(copy.dashlets.size()); + this.dashlets.addAll(copy.dashlets); + } + + public void addDashlet(DashletDefinition dashlet) + { + dashlets.add(dashlet); + } + + public List getDashlets() + { + return this.dashlets; + } + + public void trimDashlets(int max) + { + if (max >= 0) + { + int maxTrim = Math.min(this.dashlets.size(), max); + this.dashlets = this.dashlets.subList(0, maxTrim); + } + } +} diff --git a/source/java/org/alfresco/web/bean/dialog/BaseDialogBean.java b/source/java/org/alfresco/web/bean/dialog/BaseDialogBean.java index c3d64328ba..c8251113b5 100644 --- a/source/java/org/alfresco/web/bean/dialog/BaseDialogBean.java +++ b/source/java/org/alfresco/web/bean/dialog/BaseDialogBean.java @@ -1,432 +1,432 @@ -package org.alfresco.web.bean.dialog; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.Collections; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.coci.CheckOutCheckInService; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.model.FileFolderService; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.rule.RuleService; -import org.alfresco.service.cmr.search.SearchService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.transaction.TransactionService; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.bean.BrowseBean; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -/** - * Base class for all dialog beans providing common functionality - * - * @author gavinc - */ -@SuppressWarnings("serial") -public abstract class BaseDialogBean implements IDialogBean, Serializable -{ - protected Map parameters; - protected boolean isFinished = false; - - // services common to most dialogs - protected BrowseBean browseBean; - protected NavigationBean navigator; - - transient private TransactionService transactionService; - transient private NodeService nodeService; - transient private CheckOutCheckInService checkOutCheckInService; - transient private FileFolderService fileFolderService; - transient private SearchService searchService; - transient private DictionaryService dictionaryService; - transient private NamespaceService namespaceService; - transient private RuleService ruleService; - - public void init(Map parameters) - { - // tell any beans to update themselves so the UI gets refreshed - UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); - - // store the parameters, create empty map if necessary - this.parameters = parameters; - - if (this.parameters == null) - { - this.parameters = Collections.emptyMap(); - } - - // reset the isFinished flag - this.isFinished = false; - } - - public void restored() - { - // do nothing by default, subclasses can override if necessary - } - - public String cancel() - { - // remove container variable - FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove( - AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); - - return getDefaultCancelOutcome(); - } - - public String finish() - { - final FacesContext context = FacesContext.getCurrentInstance(); - final String defaultOutcome = getDefaultFinishOutcome(); - String outcome = null; - - // check the isFinished flag to stop the finish button - // being pressed multiple times - if (this.isFinished == false) - { - this.isFinished = true; - - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public String execute() throws Throwable - { - // call the actual implementation - return finishImpl(context, defaultOutcome); - } - }; - try - { - // Execute - outcome = txnHelper.doInTransaction(callback, false, true); - - // allow any subclasses to perform post commit processing - // i.e. resetting state or setting status messages - outcome = doPostCommitProcessing(context, outcome); - - // remove container variable - context.getExternalContext().getSessionMap().remove( - AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); - } - catch (Throwable e) - { - // reset the flag so we can re-attempt the operation - isFinished = false; - outcome = getErrorOutcome(e); - if (e instanceof ReportedException == false) - { - Utils.addErrorMessage(formatErrorMessage(e), e); - } - ReportedException.throwIfNecessary(e); - } - } - else - { - Utils.addErrorMessage(Application.getMessage(context, "error_wizard_completed_already")); - } - - return outcome; - } - - public boolean isFinished() - { - return isFinished; - } - - public List getAdditionalButtons() - { - // none by default, subclasses can override if necessary - - return null; - } - - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "cancel"); - } - - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); - } - - public boolean getFinishButtonDisabled() - { - return true; - } - - public String getContainerTitle() - { - // nothing by default, subclasses can override if necessary - - return null; - } - - public String getContainerSubTitle() - { - // nothing by default, subclasses can override if necessary - - return null; - } - - public String getContainerDescription() - { - // nothing by default, subclasses can override if necessary - - return null; - } - - public Object getActionsContext() - { - // return the current node as the context for actions be default - // dialog implementations can override this method to return the - // appropriate object for their use case - - if (this.navigator == null) - { - throw new AlfrescoRuntimeException("To use actions in the dialog the 'navigator' " + - "property must be injected with an instance of NavigationBean!"); - } - - return this.navigator.getCurrentNode(); - } - - public String getActionsConfigId() - { - // nothing by default, subclasses can override if necessary - - return null; - } - - public String getMoreActionsConfigId() - { - // nothing by default, subclasses can override if necessary - - return null; - } - - /** - * @param browseBean The BrowseBean to set. - */ - public void setBrowseBean(BrowseBean browseBean) - { - this.browseBean = browseBean; - } - - /** - * @param navigator The NavigationBean to set. - */ - public void setNavigator(NavigationBean navigator) - { - this.navigator = navigator; - } - - protected TransactionService getTransactionService() - { - if (this.transactionService == null) - { - this.transactionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getTransactionService(); - } - return this.transactionService; - } - - /** - * @param nodeService The nodeService to set. - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - protected NodeService getNodeService() - { - if (this.nodeService == null) - { - this.nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return this.nodeService; - } - - protected CheckOutCheckInService getCheckOutCheckInService() - { - if (this.checkOutCheckInService == null) - { - this.checkOutCheckInService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCheckOutCheckInService(); - } - return this.checkOutCheckInService; - } - - /** - * Get the rule service - * @return RuleService rule service - */ - protected RuleService getRuleService() - { - if (ruleService == null) - { - ruleService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getRuleService(); - } - return ruleService; - } - - /** - * @param fileFolderService used to manipulate folder/folder model nodes - */ - public void setFileFolderService(FileFolderService fileFolderService) - { - this.fileFolderService = fileFolderService; - } - - protected FileFolderService getFileFolderService() - { - if (this.fileFolderService == null) - { - this.fileFolderService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getFileFolderService(); - } - return this.fileFolderService; - } - - /** - * @param searchService the service used to find nodes - */ - public void setSearchService(SearchService searchService) - { - this.searchService = searchService; - } - - protected SearchService getSearchService() - { - if (this.searchService == null) - { - this.searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); - } - return this.searchService; - } - - /** - * Sets the dictionary service - * - * @param dictionaryService the dictionary service - */ - public void setDictionaryService(DictionaryService dictionaryService) - { - this.dictionaryService = dictionaryService; - } - - protected DictionaryService getDictionaryService() - { - if (this.dictionaryService == null) - { - this.dictionaryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getDictionaryService(); - } - return this.dictionaryService; - } - - /** - * @param namespaceService The NamespaceService - */ - public void setNamespaceService(NamespaceService namespaceService) - { - this.namespaceService = namespaceService; - } - - protected NamespaceService getNamespaceService() - { - if (this.namespaceService == null) - { - this.namespaceService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNamespaceService(); - } - return this.namespaceService; - } - - /** - * Returns the default cancel outcome - * - * @return Default close outcome, dialog:close by default - */ - protected String getDefaultCancelOutcome() - { - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; - } - - /** - * Returns the default finish outcome - * - * @return Default finish outcome, dialog:close by default - */ - protected String getDefaultFinishOutcome() - { - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; - } - - /** - * Performs the actual processing for the wizard. - * NOTE: This method is called within the context of a transaction - * so no transaction handling is required - * - * @param context FacesContext - * @param outcome The default outcome - * @return The outcome - */ - protected abstract String finishImpl(FacesContext context, String outcome) - throws Throwable; - - /** - * Performs any post commit processing subclasses may want to provide - * - * @param context FacesContext - * @param outcome The default outcome - * @return The outcome - */ - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - // do nothing by default, subclasses can override if necessary - - return outcome; - } - - /** - * The default message id to use in error messages - * - * @return The error message lookup id - */ - protected String getErrorMessageId() - { - return Repository.ERROR_GENERIC; - } - - /** - * The outcome to return if the given exception occurs - * - * @param exception The exception that got thrown - * @return The error outcome, null by default - */ - protected String getErrorOutcome(Throwable exception) - { - return null; - } - - /** - * Returns a formatted exception string for the given exception - * - * @param exception The exception that got thrown - * @return The formatted message - */ - protected String formatErrorMessage(Throwable exception) - { - return MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), getErrorMessageId()), - exception.getMessage()); - } - -} +package org.alfresco.web.bean.dialog; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.coci.CheckOutCheckInService; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.model.FileFolderService; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.rule.RuleService; +import org.alfresco.service.cmr.search.SearchService; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.transaction.TransactionService; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.bean.BrowseBean; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +/** + * Base class for all dialog beans providing common functionality + * + * @author gavinc + */ +@SuppressWarnings("serial") +public abstract class BaseDialogBean implements IDialogBean, Serializable +{ + protected Map parameters; + protected boolean isFinished = false; + + // services common to most dialogs + protected BrowseBean browseBean; + protected NavigationBean navigator; + + transient private TransactionService transactionService; + transient private NodeService nodeService; + transient private CheckOutCheckInService checkOutCheckInService; + transient private FileFolderService fileFolderService; + transient private SearchService searchService; + transient private DictionaryService dictionaryService; + transient private NamespaceService namespaceService; + transient private RuleService ruleService; + + public void init(Map parameters) + { + // tell any beans to update themselves so the UI gets refreshed + UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); + + // store the parameters, create empty map if necessary + this.parameters = parameters; + + if (this.parameters == null) + { + this.parameters = Collections.emptyMap(); + } + + // reset the isFinished flag + this.isFinished = false; + } + + public void restored() + { + // do nothing by default, subclasses can override if necessary + } + + public String cancel() + { + // remove container variable + FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove( + AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); + + return getDefaultCancelOutcome(); + } + + public String finish() + { + final FacesContext context = FacesContext.getCurrentInstance(); + final String defaultOutcome = getDefaultFinishOutcome(); + String outcome = null; + + // check the isFinished flag to stop the finish button + // being pressed multiple times + if (this.isFinished == false) + { + this.isFinished = true; + + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public String execute() throws Throwable + { + // call the actual implementation + return finishImpl(context, defaultOutcome); + } + }; + try + { + // Execute + outcome = txnHelper.doInTransaction(callback, false, true); + + // allow any subclasses to perform post commit processing + // i.e. resetting state or setting status messages + outcome = doPostCommitProcessing(context, outcome); + + // remove container variable + context.getExternalContext().getSessionMap().remove( + AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); + } + catch (Throwable e) + { + // reset the flag so we can re-attempt the operation + isFinished = false; + outcome = getErrorOutcome(e); + if (e instanceof ReportedException == false) + { + Utils.addErrorMessage(formatErrorMessage(e), e); + } + ReportedException.throwIfNecessary(e); + } + } + else + { + Utils.addErrorMessage(Application.getMessage(context, "error_wizard_completed_already")); + } + + return outcome; + } + + public boolean isFinished() + { + return isFinished; + } + + public List getAdditionalButtons() + { + // none by default, subclasses can override if necessary + + return null; + } + + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "cancel"); + } + + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); + } + + public boolean getFinishButtonDisabled() + { + return true; + } + + public String getContainerTitle() + { + // nothing by default, subclasses can override if necessary + + return null; + } + + public String getContainerSubTitle() + { + // nothing by default, subclasses can override if necessary + + return null; + } + + public String getContainerDescription() + { + // nothing by default, subclasses can override if necessary + + return null; + } + + public Object getActionsContext() + { + // return the current node as the context for actions be default + // dialog implementations can override this method to return the + // appropriate object for their use case + + if (this.navigator == null) + { + throw new AlfrescoRuntimeException("To use actions in the dialog the 'navigator' " + + "property must be injected with an instance of NavigationBean!"); + } + + return this.navigator.getCurrentNode(); + } + + public String getActionsConfigId() + { + // nothing by default, subclasses can override if necessary + + return null; + } + + public String getMoreActionsConfigId() + { + // nothing by default, subclasses can override if necessary + + return null; + } + + /** + * @param browseBean The BrowseBean to set. + */ + public void setBrowseBean(BrowseBean browseBean) + { + this.browseBean = browseBean; + } + + /** + * @param navigator The NavigationBean to set. + */ + public void setNavigator(NavigationBean navigator) + { + this.navigator = navigator; + } + + protected TransactionService getTransactionService() + { + if (this.transactionService == null) + { + this.transactionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getTransactionService(); + } + return this.transactionService; + } + + /** + * @param nodeService The nodeService to set. + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + protected NodeService getNodeService() + { + if (this.nodeService == null) + { + this.nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return this.nodeService; + } + + protected CheckOutCheckInService getCheckOutCheckInService() + { + if (this.checkOutCheckInService == null) + { + this.checkOutCheckInService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getCheckOutCheckInService(); + } + return this.checkOutCheckInService; + } + + /** + * Get the rule service + * @return RuleService rule service + */ + protected RuleService getRuleService() + { + if (ruleService == null) + { + ruleService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getRuleService(); + } + return ruleService; + } + + /** + * @param fileFolderService used to manipulate folder/folder model nodes + */ + public void setFileFolderService(FileFolderService fileFolderService) + { + this.fileFolderService = fileFolderService; + } + + protected FileFolderService getFileFolderService() + { + if (this.fileFolderService == null) + { + this.fileFolderService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getFileFolderService(); + } + return this.fileFolderService; + } + + /** + * @param searchService the service used to find nodes + */ + public void setSearchService(SearchService searchService) + { + this.searchService = searchService; + } + + protected SearchService getSearchService() + { + if (this.searchService == null) + { + this.searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); + } + return this.searchService; + } + + /** + * Sets the dictionary service + * + * @param dictionaryService the dictionary service + */ + public void setDictionaryService(DictionaryService dictionaryService) + { + this.dictionaryService = dictionaryService; + } + + protected DictionaryService getDictionaryService() + { + if (this.dictionaryService == null) + { + this.dictionaryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getDictionaryService(); + } + return this.dictionaryService; + } + + /** + * @param namespaceService The NamespaceService + */ + public void setNamespaceService(NamespaceService namespaceService) + { + this.namespaceService = namespaceService; + } + + protected NamespaceService getNamespaceService() + { + if (this.namespaceService == null) + { + this.namespaceService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNamespaceService(); + } + return this.namespaceService; + } + + /** + * Returns the default cancel outcome + * + * @return Default close outcome, dialog:close by default + */ + protected String getDefaultCancelOutcome() + { + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; + } + + /** + * Returns the default finish outcome + * + * @return Default finish outcome, dialog:close by default + */ + protected String getDefaultFinishOutcome() + { + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; + } + + /** + * Performs the actual processing for the wizard. + * NOTE: This method is called within the context of a transaction + * so no transaction handling is required + * + * @param context FacesContext + * @param outcome The default outcome + * @return The outcome + */ + protected abstract String finishImpl(FacesContext context, String outcome) + throws Throwable; + + /** + * Performs any post commit processing subclasses may want to provide + * + * @param context FacesContext + * @param outcome The default outcome + * @return The outcome + */ + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + // do nothing by default, subclasses can override if necessary + + return outcome; + } + + /** + * The default message id to use in error messages + * + * @return The error message lookup id + */ + protected String getErrorMessageId() + { + return Repository.ERROR_GENERIC; + } + + /** + * The outcome to return if the given exception occurs + * + * @param exception The exception that got thrown + * @return The error outcome, null by default + */ + protected String getErrorOutcome(Throwable exception) + { + return null; + } + + /** + * Returns a formatted exception string for the given exception + * + * @param exception The exception that got thrown + * @return The formatted message + */ + protected String formatErrorMessage(Throwable exception) + { + return MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), getErrorMessageId()), + exception.getMessage()); + } + +} diff --git a/source/java/org/alfresco/web/bean/dialog/ChangeViewSupport.java b/source/java/org/alfresco/web/bean/dialog/ChangeViewSupport.java index 93755ceb43..f84e174cef 100644 --- a/source/java/org/alfresco/web/bean/dialog/ChangeViewSupport.java +++ b/source/java/org/alfresco/web/bean/dialog/ChangeViewSupport.java @@ -1,22 +1,22 @@ -package org.alfresco.web.bean.dialog; - -import java.util.List; -import javax.faces.event.ActionEvent; -import org.alfresco.web.ui.common.component.UIListItem; - -/** - * Interface definition for dialog beans that wish to use the view - * drop down to change the layout of the dialog. - * - * @author gavinc - */ -public interface ChangeViewSupport -{ - public List getViewItems(); - - public String getViewMode(); - - public void setViewMode(String viewMode); - - public void viewModeChanged(ActionEvent event); -} +package org.alfresco.web.bean.dialog; + +import java.util.List; +import javax.faces.event.ActionEvent; +import org.alfresco.web.ui.common.component.UIListItem; + +/** + * Interface definition for dialog beans that wish to use the view + * drop down to change the layout of the dialog. + * + * @author gavinc + */ +public interface ChangeViewSupport +{ + public List getViewItems(); + + public String getViewMode(); + + public void setViewMode(String viewMode); + + public void viewModeChanged(ActionEvent event); +} diff --git a/source/java/org/alfresco/web/bean/dialog/DialogManager.java b/source/java/org/alfresco/web/bean/dialog/DialogManager.java index 93ae029e47..5869bd14ec 100644 --- a/source/java/org/alfresco/web/bean/dialog/DialogManager.java +++ b/source/java/org/alfresco/web/bean/dialog/DialogManager.java @@ -1,522 +1,522 @@ -package org.alfresco.web.bean.dialog; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; -import org.alfresco.web.config.DialogsConfigElement.DialogConfig; -import org.alfresco.web.ui.common.component.UIActionLink; - -/** - * Bean that manages the dialog framework - * - * @author gavinc - */ -public final class DialogManager implements Serializable -{ - private static final long serialVersionUID = -8690844273074627353L; - - public final static String BEAN_NAME = "DialogManager"; - - private DialogState currentDialogState; - private Map paramsToApply; - - /** - * Sets the parameters the next dialog will initialise with - * - * @param params The parameters - */ - public void setupParameters(Map params) - { - this.paramsToApply = params; - } - - /** - * Action handler used to setup parameters for the dialog being launched - * - * @param event The event containing the parameters - */ - public void setupParameters(ActionEvent event) - { - // check the component the event come from was an action link - UIComponent component = event.getComponent(); - if (component instanceof UIActionLink) - { - // store the parameters - this.paramsToApply = ((UIActionLink)component).getParameterMap(); - - // make sure "null" parameters are actually null, this can occur - // when null parameters are sent to the client and posted back - for (String name : this.paramsToApply.keySet()) - { - String value = this.paramsToApply.get(name); - if (value != null && value.equalsIgnoreCase("null")) - { - this.paramsToApply.put(name, null); - } - } - } - } - - /** - * Sets the current dialog - * - * @param config The configuration for the dialog to set - */ - public void setCurrentDialog(DialogConfig config) - { - // make sure the managed bean is present - String beanName = config.getManagedBean(); - - Object bean = FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), beanName); - - if (bean == null) - { - throw new AlfrescoRuntimeException("Failed to start dialog as managed bean '" + beanName + - "' has not been defined"); - } - - // make sure the bean implements the IDialogBean interface - IDialogBean dialog = null; - if (bean instanceof IDialogBean) - { - dialog = (IDialogBean)bean; - } - else - { - throw new AlfrescoRuntimeException("Failed to start dialog as managed bean '" + beanName + - "' does not implement the required IDialogBean interface"); - } - - // create the DialogState object - this.currentDialogState = new DialogState(config, dialog); - - // initialise the managed bean - dialog.init(this.paramsToApply); - - // reset the current parameters so subsequent dialogs don't get them - this.paramsToApply = null; - } - - /** - * Returns the state of the currently active dialog - * - * @return Current dialog's state - */ - public DialogState getState() - { - return this.currentDialogState; - } - - /** - * Restores the dialog represented by the given DialogState object. - * NOTE: The dialog's restored() method is also called during this - * method. - * - * @param state The DialogState for the dialog to restore - */ - public void restoreState(DialogState state) - { - this.currentDialogState = state; - - // retrieve the dialog and call it's restored() method - this.currentDialogState.getDialog().restored(); - } - - /** - * Returns the config for the current dialog - * - * @return The current dialog config - */ - public DialogConfig getCurrentDialog() - { - return this.currentDialogState.getConfig(); - } - - /** - * Returns the current dialog bean being managed - * - * @return The current managed bean - */ - public IDialogBean getBean() - { - return this.currentDialogState.getDialog(); - } - - /** - * Returns the icon to use for the current dialog - * - * @return The icon - */ - public String getIcon() - { - return this.currentDialogState.getConfig().getIcon(); - } - - /** - * Returns the error message to use in error conditions - * - * @return The error message - */ - public String getErrorMessage() - { - return Application.getMessage(FacesContext.getCurrentInstance(), - this.currentDialogState.getConfig().getErrorMessageId()); - } - - /** - * Returns the resolved title to use for the dialog - * - * @return The title - */ - public String getTitle() - { - // try and get the title directly from the dialog - String title = this.currentDialogState.getDialog().getContainerTitle(); - - if (title == null) - { - // try and get the title via a message bundle key - title = this.currentDialogState.getConfig().getTitleId(); - - if (title != null) - { - title = Application.getMessage(FacesContext.getCurrentInstance(), title); - } - else - { - // try and get the title from the configuration - title = this.currentDialogState.getConfig().getTitle(); - } - } - - return title; - } - - /** - * Returns the resolved subtitle to use for the dialog - * - * @return The subtitle - */ - public String getSubTitle() - { - // try and get the subtitle directly from the dialog - String subTitle = this.currentDialogState.getDialog().getContainerSubTitle(); - - if (subTitle == null) - { - // try and get the title via a message bundle key - subTitle = this.currentDialogState.getConfig().getSubTitleId(); - - if (subTitle != null) - { - subTitle = Application.getMessage(FacesContext.getCurrentInstance(), subTitle); - } - else - { - // try and get the title from the configuration - subTitle = this.currentDialogState.getConfig().getSubTitle(); - } - } - - return subTitle; - } - - /** - * Returns the resolved description to use for the dialog - * - * @return The description - */ - public String getDescription() - { - // try and get the description directly from the dialog - String desc = this.currentDialogState.getDialog().getContainerDescription(); - - if (desc == null) - { - // try and get the description via a message bundle key - desc = this.currentDialogState.getConfig().getDescriptionId(); - - if (desc != null) - { - desc = Application.getMessage(FacesContext.getCurrentInstance(), desc); - } - else - { - // try and get the description from the configuration - desc = this.currentDialogState.getConfig().getDescription(); - } - } - - return desc; - } - - /** - * Returns the page the dialog will use - * - * @return The page - */ - public String getPage() - { - return this.currentDialogState.getConfig().getPage(); - } - - /** - * Returns the id of a configured action group representing the actions to - * display for the dialog - * - * @return The action group id - */ - public String getActionsId() - { - // first see if the dialog itself has supplied an actions id - String configId = this.currentDialogState.getDialog().getActionsConfigId(); - - if (configId == null) - { - // see if an actions id was specified in the dialog config - configId = this.currentDialogState.getConfig().getActionsConfigId(); - } - - return configId; - } - - /** - * Returns the id of a configured action group representing the - * 'more actions' to display for the dialog - * - * @return The action group id - */ - public String getMoreActionsId() - { - // first see if the dialog itself has supplied a more actions id - String configId = this.currentDialogState.getDialog().getMoreActionsConfigId(); - - if (configId == null) - { - // see if an actions id was specified in the dialog config - configId = this.currentDialogState.getConfig().getMoreActionsConfigId(); - } - - return configId; - } - - /** - * Returns the object to use as the context for the main and more - * actions that may be configured by the dialog - * - * @return Object to use as the context for actions, the current - * node by default - */ - public Object getActionsContext() - { - return this.currentDialogState.getDialog().getActionsContext(); - } - - /** - * Returns the label to use for the main actions when a menu is being used - * - * @return The actions menu label - */ - public String getActionsMenuLabel() - { - // try and get the label via a message bundle key - String label = this.currentDialogState.getConfig().getActionsMenuLabelId(); - - if (label != null) - { - label = Application.getMessage(FacesContext.getCurrentInstance(), label); - } - else - { - // try and get the description from the configuration - label = this.currentDialogState.getConfig().getActionsMenuLabel(); - } - - // if the label is still null use the default of 'Create' - if (label == null) - { - label = Application.getMessage(FacesContext.getCurrentInstance(), "create_options"); - } - - return label; - } - - /** - * Returns the label to use for the more actions menu - * - * @return The more actions menu label - */ - public String getMoreActionsMenuLabel() - { - // try and get the label via a message bundle key - String label = this.currentDialogState.getConfig().getMoreActionsMenuLabelId(); - - if (label != null) - { - label = Application.getMessage(FacesContext.getCurrentInstance(), label); - } - else - { - // try and get the description from the configuration - label = this.currentDialogState.getConfig().getMoreActionsMenuLabel(); - } - - // if the label is still null use the default of 'More Actions' - if (label == null) - { - label = Application.getMessage(FacesContext.getCurrentInstance(), "more_actions"); - } - - return label; - } - - /** - * Determines whether the main actions should be rendered as a - * menu - * - * @return true to render the main set of actions as a menu, false - * to render them as a horizontal list - */ - public boolean getActionsAsMenu() - { - return this.currentDialogState.getConfig().getActionsAsMenu(); - } - - /** - * Determines whether the current dialog's OK button is visible - * - * @return true if the OK button is visible, false if it's not - */ - public boolean isOKButtonVisible() - { - return this.currentDialogState.getConfig().isOKButtonVisible(); - } - - /** - * Determines whether the current dialog should display the next - * and previous buttons in the header area - * - * @return true if navigation support is enabled - */ - public boolean isNavigationVisible() - { - return (getBean() instanceof NavigationSupport); - } - - /** - * Determines whether the current dialog should display the list - * of views in the header area - * - * @return true if change view support is enabled - */ - public boolean isViewListVisible() - { - return (getBean() instanceof ChangeViewSupport); - } - - /** - * Determines whether the current dialog should display the list - * of filters in the header area - * - * @return true if filter support is enabled - */ - public boolean isFilterListVisible() - { - return (getBean() instanceof FilterViewSupport); - } - - /** - * Returns a list of additional buttons to display in the dialog - * - * @return List of button configurations - */ - public List getAdditionalButtons() - { - List buttons = null; - - // get a list of buttons to display from the configuration - List cfgButtons = this.currentDialogState.getConfig().getButtons(); - - // get a list of buttons added dynamically by the dialog - List dynButtons = this.currentDialogState.getDialog().getAdditionalButtons(); - - if (cfgButtons != null && dynButtons != null) - { - // combine the two lists - buttons = new ArrayList( - cfgButtons.size() + dynButtons.size()); - buttons.addAll(cfgButtons); - buttons.addAll(dynButtons); - } - else if (cfgButtons != null && dynButtons == null) - { - buttons = cfgButtons; - } - else if (cfgButtons == null && dynButtons != null) - { - buttons = dynButtons; - } - - return buttons; - } - - /** - * Returns the label to use for the cancel button - * - * @return The cancel button label - */ - public String getCancelButtonLabel() - { - return this.currentDialogState.getDialog().getCancelButtonLabel(); - } - - /** - * Returns the label to use for the finish button - * - * @return The finish button label - */ - public String getFinishButtonLabel() - { - return this.currentDialogState.getDialog().getFinishButtonLabel(); - } - - /** - * Determines whether the finish button on the dialog should be disabled - * - * @return true if the button should be disabled - */ - public boolean getFinishButtonDisabled() - { - return this.currentDialogState.getDialog().getFinishButtonDisabled(); - } - - /** - * Method handler called when the finish button of the dialog is pressed - * - * @return The outcome - */ - public String finish() - { - return this.currentDialogState.getDialog().finish(); - } - - /** - * Method handler called when the cancel button of the dialog is pressed - * - * @return The outcome - */ - public String cancel() - { - return this.currentDialogState.getDialog().cancel(); - } -} +package org.alfresco.web.bean.dialog; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; +import org.alfresco.web.config.DialogsConfigElement.DialogConfig; +import org.alfresco.web.ui.common.component.UIActionLink; + +/** + * Bean that manages the dialog framework + * + * @author gavinc + */ +public final class DialogManager implements Serializable +{ + private static final long serialVersionUID = -8690844273074627353L; + + public final static String BEAN_NAME = "DialogManager"; + + private DialogState currentDialogState; + private Map paramsToApply; + + /** + * Sets the parameters the next dialog will initialise with + * + * @param params The parameters + */ + public void setupParameters(Map params) + { + this.paramsToApply = params; + } + + /** + * Action handler used to setup parameters for the dialog being launched + * + * @param event The event containing the parameters + */ + public void setupParameters(ActionEvent event) + { + // check the component the event come from was an action link + UIComponent component = event.getComponent(); + if (component instanceof UIActionLink) + { + // store the parameters + this.paramsToApply = ((UIActionLink)component).getParameterMap(); + + // make sure "null" parameters are actually null, this can occur + // when null parameters are sent to the client and posted back + for (String name : this.paramsToApply.keySet()) + { + String value = this.paramsToApply.get(name); + if (value != null && value.equalsIgnoreCase("null")) + { + this.paramsToApply.put(name, null); + } + } + } + } + + /** + * Sets the current dialog + * + * @param config The configuration for the dialog to set + */ + public void setCurrentDialog(DialogConfig config) + { + // make sure the managed bean is present + String beanName = config.getManagedBean(); + + Object bean = FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), beanName); + + if (bean == null) + { + throw new AlfrescoRuntimeException("Failed to start dialog as managed bean '" + beanName + + "' has not been defined"); + } + + // make sure the bean implements the IDialogBean interface + IDialogBean dialog = null; + if (bean instanceof IDialogBean) + { + dialog = (IDialogBean)bean; + } + else + { + throw new AlfrescoRuntimeException("Failed to start dialog as managed bean '" + beanName + + "' does not implement the required IDialogBean interface"); + } + + // create the DialogState object + this.currentDialogState = new DialogState(config, dialog); + + // initialise the managed bean + dialog.init(this.paramsToApply); + + // reset the current parameters so subsequent dialogs don't get them + this.paramsToApply = null; + } + + /** + * Returns the state of the currently active dialog + * + * @return Current dialog's state + */ + public DialogState getState() + { + return this.currentDialogState; + } + + /** + * Restores the dialog represented by the given DialogState object. + * NOTE: The dialog's restored() method is also called during this + * method. + * + * @param state The DialogState for the dialog to restore + */ + public void restoreState(DialogState state) + { + this.currentDialogState = state; + + // retrieve the dialog and call it's restored() method + this.currentDialogState.getDialog().restored(); + } + + /** + * Returns the config for the current dialog + * + * @return The current dialog config + */ + public DialogConfig getCurrentDialog() + { + return this.currentDialogState.getConfig(); + } + + /** + * Returns the current dialog bean being managed + * + * @return The current managed bean + */ + public IDialogBean getBean() + { + return this.currentDialogState.getDialog(); + } + + /** + * Returns the icon to use for the current dialog + * + * @return The icon + */ + public String getIcon() + { + return this.currentDialogState.getConfig().getIcon(); + } + + /** + * Returns the error message to use in error conditions + * + * @return The error message + */ + public String getErrorMessage() + { + return Application.getMessage(FacesContext.getCurrentInstance(), + this.currentDialogState.getConfig().getErrorMessageId()); + } + + /** + * Returns the resolved title to use for the dialog + * + * @return The title + */ + public String getTitle() + { + // try and get the title directly from the dialog + String title = this.currentDialogState.getDialog().getContainerTitle(); + + if (title == null) + { + // try and get the title via a message bundle key + title = this.currentDialogState.getConfig().getTitleId(); + + if (title != null) + { + title = Application.getMessage(FacesContext.getCurrentInstance(), title); + } + else + { + // try and get the title from the configuration + title = this.currentDialogState.getConfig().getTitle(); + } + } + + return title; + } + + /** + * Returns the resolved subtitle to use for the dialog + * + * @return The subtitle + */ + public String getSubTitle() + { + // try and get the subtitle directly from the dialog + String subTitle = this.currentDialogState.getDialog().getContainerSubTitle(); + + if (subTitle == null) + { + // try and get the title via a message bundle key + subTitle = this.currentDialogState.getConfig().getSubTitleId(); + + if (subTitle != null) + { + subTitle = Application.getMessage(FacesContext.getCurrentInstance(), subTitle); + } + else + { + // try and get the title from the configuration + subTitle = this.currentDialogState.getConfig().getSubTitle(); + } + } + + return subTitle; + } + + /** + * Returns the resolved description to use for the dialog + * + * @return The description + */ + public String getDescription() + { + // try and get the description directly from the dialog + String desc = this.currentDialogState.getDialog().getContainerDescription(); + + if (desc == null) + { + // try and get the description via a message bundle key + desc = this.currentDialogState.getConfig().getDescriptionId(); + + if (desc != null) + { + desc = Application.getMessage(FacesContext.getCurrentInstance(), desc); + } + else + { + // try and get the description from the configuration + desc = this.currentDialogState.getConfig().getDescription(); + } + } + + return desc; + } + + /** + * Returns the page the dialog will use + * + * @return The page + */ + public String getPage() + { + return this.currentDialogState.getConfig().getPage(); + } + + /** + * Returns the id of a configured action group representing the actions to + * display for the dialog + * + * @return The action group id + */ + public String getActionsId() + { + // first see if the dialog itself has supplied an actions id + String configId = this.currentDialogState.getDialog().getActionsConfigId(); + + if (configId == null) + { + // see if an actions id was specified in the dialog config + configId = this.currentDialogState.getConfig().getActionsConfigId(); + } + + return configId; + } + + /** + * Returns the id of a configured action group representing the + * 'more actions' to display for the dialog + * + * @return The action group id + */ + public String getMoreActionsId() + { + // first see if the dialog itself has supplied a more actions id + String configId = this.currentDialogState.getDialog().getMoreActionsConfigId(); + + if (configId == null) + { + // see if an actions id was specified in the dialog config + configId = this.currentDialogState.getConfig().getMoreActionsConfigId(); + } + + return configId; + } + + /** + * Returns the object to use as the context for the main and more + * actions that may be configured by the dialog + * + * @return Object to use as the context for actions, the current + * node by default + */ + public Object getActionsContext() + { + return this.currentDialogState.getDialog().getActionsContext(); + } + + /** + * Returns the label to use for the main actions when a menu is being used + * + * @return The actions menu label + */ + public String getActionsMenuLabel() + { + // try and get the label via a message bundle key + String label = this.currentDialogState.getConfig().getActionsMenuLabelId(); + + if (label != null) + { + label = Application.getMessage(FacesContext.getCurrentInstance(), label); + } + else + { + // try and get the description from the configuration + label = this.currentDialogState.getConfig().getActionsMenuLabel(); + } + + // if the label is still null use the default of 'Create' + if (label == null) + { + label = Application.getMessage(FacesContext.getCurrentInstance(), "create_options"); + } + + return label; + } + + /** + * Returns the label to use for the more actions menu + * + * @return The more actions menu label + */ + public String getMoreActionsMenuLabel() + { + // try and get the label via a message bundle key + String label = this.currentDialogState.getConfig().getMoreActionsMenuLabelId(); + + if (label != null) + { + label = Application.getMessage(FacesContext.getCurrentInstance(), label); + } + else + { + // try and get the description from the configuration + label = this.currentDialogState.getConfig().getMoreActionsMenuLabel(); + } + + // if the label is still null use the default of 'More Actions' + if (label == null) + { + label = Application.getMessage(FacesContext.getCurrentInstance(), "more_actions"); + } + + return label; + } + + /** + * Determines whether the main actions should be rendered as a + * menu + * + * @return true to render the main set of actions as a menu, false + * to render them as a horizontal list + */ + public boolean getActionsAsMenu() + { + return this.currentDialogState.getConfig().getActionsAsMenu(); + } + + /** + * Determines whether the current dialog's OK button is visible + * + * @return true if the OK button is visible, false if it's not + */ + public boolean isOKButtonVisible() + { + return this.currentDialogState.getConfig().isOKButtonVisible(); + } + + /** + * Determines whether the current dialog should display the next + * and previous buttons in the header area + * + * @return true if navigation support is enabled + */ + public boolean isNavigationVisible() + { + return (getBean() instanceof NavigationSupport); + } + + /** + * Determines whether the current dialog should display the list + * of views in the header area + * + * @return true if change view support is enabled + */ + public boolean isViewListVisible() + { + return (getBean() instanceof ChangeViewSupport); + } + + /** + * Determines whether the current dialog should display the list + * of filters in the header area + * + * @return true if filter support is enabled + */ + public boolean isFilterListVisible() + { + return (getBean() instanceof FilterViewSupport); + } + + /** + * Returns a list of additional buttons to display in the dialog + * + * @return List of button configurations + */ + public List getAdditionalButtons() + { + List buttons = null; + + // get a list of buttons to display from the configuration + List cfgButtons = this.currentDialogState.getConfig().getButtons(); + + // get a list of buttons added dynamically by the dialog + List dynButtons = this.currentDialogState.getDialog().getAdditionalButtons(); + + if (cfgButtons != null && dynButtons != null) + { + // combine the two lists + buttons = new ArrayList( + cfgButtons.size() + dynButtons.size()); + buttons.addAll(cfgButtons); + buttons.addAll(dynButtons); + } + else if (cfgButtons != null && dynButtons == null) + { + buttons = cfgButtons; + } + else if (cfgButtons == null && dynButtons != null) + { + buttons = dynButtons; + } + + return buttons; + } + + /** + * Returns the label to use for the cancel button + * + * @return The cancel button label + */ + public String getCancelButtonLabel() + { + return this.currentDialogState.getDialog().getCancelButtonLabel(); + } + + /** + * Returns the label to use for the finish button + * + * @return The finish button label + */ + public String getFinishButtonLabel() + { + return this.currentDialogState.getDialog().getFinishButtonLabel(); + } + + /** + * Determines whether the finish button on the dialog should be disabled + * + * @return true if the button should be disabled + */ + public boolean getFinishButtonDisabled() + { + return this.currentDialogState.getDialog().getFinishButtonDisabled(); + } + + /** + * Method handler called when the finish button of the dialog is pressed + * + * @return The outcome + */ + public String finish() + { + return this.currentDialogState.getDialog().finish(); + } + + /** + * Method handler called when the cancel button of the dialog is pressed + * + * @return The outcome + */ + public String cancel() + { + return this.currentDialogState.getDialog().cancel(); + } +} diff --git a/source/java/org/alfresco/web/bean/dialog/DialogState.java b/source/java/org/alfresco/web/bean/dialog/DialogState.java index 7ece93c451..fe202afbba 100644 --- a/source/java/org/alfresco/web/bean/dialog/DialogState.java +++ b/source/java/org/alfresco/web/bean/dialog/DialogState.java @@ -1,57 +1,57 @@ -package org.alfresco.web.bean.dialog; - -import java.io.Serializable; - -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.config.DialogsConfigElement.DialogConfig; - -/** - * Object responsible for holding the current state of an active dialog. - * - * @author gavinc - */ -public final class DialogState implements Serializable -{ - private static final long serialVersionUID = -5007635589636930602L; - - private DialogConfig config; - private IDialogBean dialog; - - /** - * Default constructor - * - * @param config The configuration for the dialog - * @param dialog The dialog bean instance - */ - public DialogState(DialogConfig config, IDialogBean dialog) - { - this.config = config; - this.dialog = dialog; - } - - /** - * Returns the configuration for the dialog - * - * @return The dialog configuration - */ - public DialogConfig getConfig() - { - return config; - } - - /** - * Returns the bean representing the dialog instance - * - * @return The dialog bean instance - */ - public IDialogBean getDialog() - { - return dialog; - } - - @Override - public String toString() - { - return AlfrescoNavigationHandler.DIALOG_PREFIX + this.config.getName(); - } -} +package org.alfresco.web.bean.dialog; + +import java.io.Serializable; + +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.config.DialogsConfigElement.DialogConfig; + +/** + * Object responsible for holding the current state of an active dialog. + * + * @author gavinc + */ +public final class DialogState implements Serializable +{ + private static final long serialVersionUID = -5007635589636930602L; + + private DialogConfig config; + private IDialogBean dialog; + + /** + * Default constructor + * + * @param config The configuration for the dialog + * @param dialog The dialog bean instance + */ + public DialogState(DialogConfig config, IDialogBean dialog) + { + this.config = config; + this.dialog = dialog; + } + + /** + * Returns the configuration for the dialog + * + * @return The dialog configuration + */ + public DialogConfig getConfig() + { + return config; + } + + /** + * Returns the bean representing the dialog instance + * + * @return The dialog bean instance + */ + public IDialogBean getDialog() + { + return dialog; + } + + @Override + public String toString() + { + return AlfrescoNavigationHandler.DIALOG_PREFIX + this.config.getName(); + } +} diff --git a/source/java/org/alfresco/web/bean/dialog/FilterViewSupport.java b/source/java/org/alfresco/web/bean/dialog/FilterViewSupport.java index 296943cc2c..da3cda9aa2 100644 --- a/source/java/org/alfresco/web/bean/dialog/FilterViewSupport.java +++ b/source/java/org/alfresco/web/bean/dialog/FilterViewSupport.java @@ -1,22 +1,22 @@ -package org.alfresco.web.bean.dialog; - -import java.util.List; -import javax.faces.event.ActionEvent; -import org.alfresco.web.ui.common.component.UIListItem; - -/** - * Interface definition for dialog beans that wish to use the filter - * drop down to change the contents of the dialog. - * - * @author gavinc - */ -public interface FilterViewSupport -{ - public List getFilterItems(); - - public String getFilterMode(); - - public void setFilterMode(String filterMode); - - public void filterModeChanged(ActionEvent event); -} +package org.alfresco.web.bean.dialog; + +import java.util.List; +import javax.faces.event.ActionEvent; +import org.alfresco.web.ui.common.component.UIListItem; + +/** + * Interface definition for dialog beans that wish to use the filter + * drop down to change the contents of the dialog. + * + * @author gavinc + */ +public interface FilterViewSupport +{ + public List getFilterItems(); + + public String getFilterMode(); + + public void setFilterMode(String filterMode); + + public void filterModeChanged(ActionEvent event); +} diff --git a/source/java/org/alfresco/web/bean/dialog/IDialogBean.java b/source/java/org/alfresco/web/bean/dialog/IDialogBean.java index 8068d9c931..d12cdb06f6 100644 --- a/source/java/org/alfresco/web/bean/dialog/IDialogBean.java +++ b/source/java/org/alfresco/web/bean/dialog/IDialogBean.java @@ -1,125 +1,125 @@ -package org.alfresco.web.bean.dialog; - -import java.io.Serializable; -import java.util.List; -import java.util.Map; - -import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; - -/** - * Interface that defines the contract for a dialog backing bean - * - * @author gavinc - */ -public interface IDialogBean extends Serializable -{ - /** - * Initialises the dialog bean - * - * @param parameters Map of parameters for the dialog - */ - public void init(Map parameters); - - /** - * Called when the dialog is restored after a nested dialog is closed - */ - public void restored(); - - /** - * Method handler called when the cancel button of the dialog is pressed - * - * @return The outcome to return - */ - public String cancel(); - - /** - * Method handler called when the finish button of the dialog is pressed - * - * @return The outcome to return - */ - public String finish(); - - /** - * Returns a list of additional buttons to display in the dialog. - * - * @return List of button configurations, null if there are no buttons - */ - public List getAdditionalButtons(); - - /** - * Returns the label to use for the cancel button - * - * @return The cancel button label - */ - public String getCancelButtonLabel(); - - /** - * Returns the label to use for the finish button - * - * @return The finish button label - */ - public String getFinishButtonLabel(); - - /** - * Determines whether the finish button on the dialog should be disabled - * - * @return true if the button should be disabled - */ - public boolean getFinishButtonDisabled(); - - /** - * Returns the title to be used for the dialog - *

If this returns null the DialogManager will - * lookup the title via the dialog configuration

- * - * @return The title or null if the title is to be acquired via configuration - */ - public String getContainerTitle(); - - /** - * Returns the subtitle to be used for the dialog - *

If this returns null the DialogManager will - * lookup the subtitle via the dialog configuration

- * - * @return The subtitle or null if the subtitle is to be acquired via configuration - */ - public String getContainerSubTitle(); - - /** - * Returns the description to be used for the dialog - *

If this returns null the DialogManager will - * lookup the description via the dialog configuration

- * - * @return The title or null if the title is to be acquired via configuration - */ - public String getContainerDescription(); - - /** - * Returns the object to use as the context for the main and more - * actions that may be configured by the dialog - * - * @return Object to use as the context for actions - */ - public Object getActionsContext(); - - /** - * Returns the id of an action group to use for the main actions - * - * @return Id of an action group - */ - public String getActionsConfigId(); - - /** - * Returns the id of an action group to use for the more actions - * - * @return Id of an action group - */ - public String getMoreActionsConfigId(); - - /** - * Determines whether the has finished - * - * @return true if the wizard has finished - */ - public boolean isFinished(); -} +package org.alfresco.web.bean.dialog; + +import java.io.Serializable; +import java.util.List; +import java.util.Map; + +import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; + +/** + * Interface that defines the contract for a dialog backing bean + * + * @author gavinc + */ +public interface IDialogBean extends Serializable +{ + /** + * Initialises the dialog bean + * + * @param parameters Map of parameters for the dialog + */ + public void init(Map parameters); + + /** + * Called when the dialog is restored after a nested dialog is closed + */ + public void restored(); + + /** + * Method handler called when the cancel button of the dialog is pressed + * + * @return The outcome to return + */ + public String cancel(); + + /** + * Method handler called when the finish button of the dialog is pressed + * + * @return The outcome to return + */ + public String finish(); + + /** + * Returns a list of additional buttons to display in the dialog. + * + * @return List of button configurations, null if there are no buttons + */ + public List getAdditionalButtons(); + + /** + * Returns the label to use for the cancel button + * + * @return The cancel button label + */ + public String getCancelButtonLabel(); + + /** + * Returns the label to use for the finish button + * + * @return The finish button label + */ + public String getFinishButtonLabel(); + + /** + * Determines whether the finish button on the dialog should be disabled + * + * @return true if the button should be disabled + */ + public boolean getFinishButtonDisabled(); + + /** + * Returns the title to be used for the dialog + *

If this returns null the DialogManager will + * lookup the title via the dialog configuration

+ * + * @return The title or null if the title is to be acquired via configuration + */ + public String getContainerTitle(); + + /** + * Returns the subtitle to be used for the dialog + *

If this returns null the DialogManager will + * lookup the subtitle via the dialog configuration

+ * + * @return The subtitle or null if the subtitle is to be acquired via configuration + */ + public String getContainerSubTitle(); + + /** + * Returns the description to be used for the dialog + *

If this returns null the DialogManager will + * lookup the description via the dialog configuration

+ * + * @return The title or null if the title is to be acquired via configuration + */ + public String getContainerDescription(); + + /** + * Returns the object to use as the context for the main and more + * actions that may be configured by the dialog + * + * @return Object to use as the context for actions + */ + public Object getActionsContext(); + + /** + * Returns the id of an action group to use for the main actions + * + * @return Id of an action group + */ + public String getActionsConfigId(); + + /** + * Returns the id of an action group to use for the more actions + * + * @return Id of an action group + */ + public String getMoreActionsConfigId(); + + /** + * Determines whether the has finished + * + * @return true if the wizard has finished + */ + public boolean isFinished(); +} diff --git a/source/java/org/alfresco/web/bean/dialog/NavigationSupport.java b/source/java/org/alfresco/web/bean/dialog/NavigationSupport.java index 49a48b2e58..51e8ebd1b4 100644 --- a/source/java/org/alfresco/web/bean/dialog/NavigationSupport.java +++ b/source/java/org/alfresco/web/bean/dialog/NavigationSupport.java @@ -1,20 +1,20 @@ -package org.alfresco.web.bean.dialog; - -import javax.faces.event.ActionEvent; - -/** - * Interface definition for dialog beans that wish to use the next - * previous buttons for quick navigation. - * - * @author gavinc - */ -public interface NavigationSupport -{ - public String getCurrentItemId(); - - public void nextItem(ActionEvent event); - - public void previousItem(ActionEvent event); - - public String getOutcome(); -} +package org.alfresco.web.bean.dialog; + +import javax.faces.event.ActionEvent; + +/** + * Interface definition for dialog beans that wish to use the next + * previous buttons for quick navigation. + * + * @author gavinc + */ +public interface NavigationSupport +{ + public String getCurrentItemId(); + + public void nextItem(ActionEvent event); + + public void previousItem(ActionEvent event); + + public String getOutcome(); +} diff --git a/source/java/org/alfresco/web/bean/forums/CreateDiscussionDialog.java b/source/java/org/alfresco/web/bean/forums/CreateDiscussionDialog.java index 555f33ce46..87bebfae39 100644 --- a/source/java/org/alfresco/web/bean/forums/CreateDiscussionDialog.java +++ b/source/java/org/alfresco/web/bean/forums/CreateDiscussionDialog.java @@ -1,192 +1,192 @@ -package org.alfresco.web.bean.forums; - -import java.text.MessageFormat; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.AbortProcessingException; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.model.ForumModel; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.RegexQNamePattern; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation for the "Create Discusssion Dialog". - * - * @author gavinc - */ -public class CreateDiscussionDialog extends CreateTopicDialog -{ - private static final long serialVersionUID = 3500493916528264014L; - - protected NodeRef discussingNodeRef; - - private static final Log logger = LogFactory.getLog(CreateDiscussionDialog.class); - - // ------------------------------------------------------------------------------ - // Wizard implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // get the id of the node we are creating the discussion for - String id = parameters.get("id"); - if (id == null || id.length() == 0) - { - throw new AlfrescoRuntimeException("createDiscussion called without an id"); - } - - // create the topic to hold the discussions - createTopic(id); - } - - @Override - public String cancel() - { - // if the user cancels the creation of a discussion all the setup that was done - // when the dialog started needs to be undone i.e. removing the created forum - // and the discussable aspect - deleteTopic(); - - // as we are cancelling the creation of a discussion we know we need to go back - // to the browse screen, this also makes sure we don't end up in the forum that - // just got deleted! - FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove( - AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); - return getDefaultCancelOutcome(); - } - - // ------------------------------------------------------------------------------ - // Helper methods - - /** - * Creates a topic for the node with the given id - * - * @param id The id of the node to discuss - */ - protected void createTopic(final String id) - { - RetryingTransactionCallback createTopicCallback = new RetryingTransactionCallback() - { - public NodeRef execute() throws Throwable - { - NodeRef forumNodeRef = null; - discussingNodeRef = new NodeRef(Repository.getStoreRef(), id); - - if (getNodeService().hasAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE)) - { - throw new AlfrescoRuntimeException("createDiscussion called for an object that already has a discussion!"); - } - - // Add the discussable aspect - getNodeService().addAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE, null); - // The discussion aspect create the necessary child - List destChildren = getNodeService().getChildAssocs( - discussingNodeRef, - ForumModel.ASSOC_DISCUSSION, - RegexQNamePattern.MATCH_ALL); - // Take the first one - if (destChildren.size() == 0) - { - // Drop the aspect and recreate it. This should not happen, but just in case ... - getNodeService().removeAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE); - getNodeService().addAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE, null); - // The discussion aspect create the necessary child - destChildren = getNodeService().getChildAssocs( - discussingNodeRef, - ForumModel.ASSOC_DISCUSSION, - RegexQNamePattern.MATCH_ALL); - } - if (destChildren.size() == 0) - { - throw new AlfrescoRuntimeException("The discussable aspect behaviour is not creating a topic"); - } - else - { - // We just take the first one - ChildAssociationRef discussionAssoc = destChildren.get(0); - forumNodeRef = discussionAssoc.getChildRef(); - } - - if (logger.isDebugEnabled()) - logger.debug("created forum for content: " + discussingNodeRef.toString()); - - return forumNodeRef; - } - }; - - FacesContext context = FacesContext.getCurrentInstance(); - NodeRef forumNodeRef = null; - try - { - forumNodeRef = getTransactionService().getRetryingTransactionHelper().doInTransaction( - createTopicCallback, false); - } - catch (InvalidNodeRefException refErr) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {id}) ); - throw new AbortProcessingException("Invalid node reference"); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - context, Repository.ERROR_GENERIC), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - // finally setup the context for the forum we just created - if (forumNodeRef != null) - { - this.browseBean.clickSpace(forumNodeRef); - } - } - - /** - * Deletes the setup performed during the initialisation of the dialog. - */ - protected void deleteTopic() - { - RetryingTransactionCallback deleteTopicCallback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // remove this node from the breadcrumb if required - Node forumNode = navigator.getCurrentNode(); - browseBean.removeSpaceFromBreadcrumb(forumNode); - - // remove the discussable aspect from the node we were going to discuss! - // AWC-1519: removing the aspect that defines the child association now does the - // cascade delete so we no longer have to delete the child explicitly - getNodeService().removeAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE); - // Done - return null; - } - }; - FacesContext context = FacesContext.getCurrentInstance(); - try - { - getTransactionService().getRetryingTransactionHelper().doInTransaction(deleteTopicCallback, false); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - context, Repository.ERROR_GENERIC), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } -} +package org.alfresco.web.bean.forums; + +import java.text.MessageFormat; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.AbortProcessingException; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.model.ForumModel; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.RegexQNamePattern; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation for the "Create Discusssion Dialog". + * + * @author gavinc + */ +public class CreateDiscussionDialog extends CreateTopicDialog +{ + private static final long serialVersionUID = 3500493916528264014L; + + protected NodeRef discussingNodeRef; + + private static final Log logger = LogFactory.getLog(CreateDiscussionDialog.class); + + // ------------------------------------------------------------------------------ + // Wizard implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // get the id of the node we are creating the discussion for + String id = parameters.get("id"); + if (id == null || id.length() == 0) + { + throw new AlfrescoRuntimeException("createDiscussion called without an id"); + } + + // create the topic to hold the discussions + createTopic(id); + } + + @Override + public String cancel() + { + // if the user cancels the creation of a discussion all the setup that was done + // when the dialog started needs to be undone i.e. removing the created forum + // and the discussable aspect + deleteTopic(); + + // as we are cancelling the creation of a discussion we know we need to go back + // to the browse screen, this also makes sure we don't end up in the forum that + // just got deleted! + FacesContext.getCurrentInstance().getExternalContext().getSessionMap().remove( + AlfrescoNavigationHandler.EXTERNAL_CONTAINER_SESSION); + return getDefaultCancelOutcome(); + } + + // ------------------------------------------------------------------------------ + // Helper methods + + /** + * Creates a topic for the node with the given id + * + * @param id The id of the node to discuss + */ + protected void createTopic(final String id) + { + RetryingTransactionCallback createTopicCallback = new RetryingTransactionCallback() + { + public NodeRef execute() throws Throwable + { + NodeRef forumNodeRef = null; + discussingNodeRef = new NodeRef(Repository.getStoreRef(), id); + + if (getNodeService().hasAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE)) + { + throw new AlfrescoRuntimeException("createDiscussion called for an object that already has a discussion!"); + } + + // Add the discussable aspect + getNodeService().addAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE, null); + // The discussion aspect create the necessary child + List destChildren = getNodeService().getChildAssocs( + discussingNodeRef, + ForumModel.ASSOC_DISCUSSION, + RegexQNamePattern.MATCH_ALL); + // Take the first one + if (destChildren.size() == 0) + { + // Drop the aspect and recreate it. This should not happen, but just in case ... + getNodeService().removeAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE); + getNodeService().addAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE, null); + // The discussion aspect create the necessary child + destChildren = getNodeService().getChildAssocs( + discussingNodeRef, + ForumModel.ASSOC_DISCUSSION, + RegexQNamePattern.MATCH_ALL); + } + if (destChildren.size() == 0) + { + throw new AlfrescoRuntimeException("The discussable aspect behaviour is not creating a topic"); + } + else + { + // We just take the first one + ChildAssociationRef discussionAssoc = destChildren.get(0); + forumNodeRef = discussionAssoc.getChildRef(); + } + + if (logger.isDebugEnabled()) + logger.debug("created forum for content: " + discussingNodeRef.toString()); + + return forumNodeRef; + } + }; + + FacesContext context = FacesContext.getCurrentInstance(); + NodeRef forumNodeRef = null; + try + { + forumNodeRef = getTransactionService().getRetryingTransactionHelper().doInTransaction( + createTopicCallback, false); + } + catch (InvalidNodeRefException refErr) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {id}) ); + throw new AbortProcessingException("Invalid node reference"); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + context, Repository.ERROR_GENERIC), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + // finally setup the context for the forum we just created + if (forumNodeRef != null) + { + this.browseBean.clickSpace(forumNodeRef); + } + } + + /** + * Deletes the setup performed during the initialisation of the dialog. + */ + protected void deleteTopic() + { + RetryingTransactionCallback deleteTopicCallback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // remove this node from the breadcrumb if required + Node forumNode = navigator.getCurrentNode(); + browseBean.removeSpaceFromBreadcrumb(forumNode); + + // remove the discussable aspect from the node we were going to discuss! + // AWC-1519: removing the aspect that defines the child association now does the + // cascade delete so we no longer have to delete the child explicitly + getNodeService().removeAspect(discussingNodeRef, ForumModel.ASPECT_DISCUSSABLE); + // Done + return null; + } + }; + FacesContext context = FacesContext.getCurrentInstance(); + try + { + getTransactionService().getRetryingTransactionHelper().doInTransaction(deleteTopicCallback, false); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + context, Repository.ERROR_GENERIC), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } +} diff --git a/source/java/org/alfresco/web/bean/forums/CreateForumDialog.java b/source/java/org/alfresco/web/bean/forums/CreateForumDialog.java index 002d119087..4e9f961ee4 100644 --- a/source/java/org/alfresco/web/bean/forums/CreateForumDialog.java +++ b/source/java/org/alfresco/web/bean/forums/CreateForumDialog.java @@ -1,36 +1,36 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.spaces.CreateSpaceDialog; - -/** - * Bean used to implement the "Create Forum Dialog". - * - * @author gavinc - */ -public class CreateForumDialog extends CreateSpaceDialog -{ - // ------------------------------------------------------------------------------ - // Wizard implementation - - private static final long serialVersionUID = 277281993463789379L; - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.spaceType = ForumModel.TYPE_FORUM.toString(); - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "create_forum"); - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.spaces.CreateSpaceDialog; + +/** + * Bean used to implement the "Create Forum Dialog". + * + * @author gavinc + */ +public class CreateForumDialog extends CreateSpaceDialog +{ + // ------------------------------------------------------------------------------ + // Wizard implementation + + private static final long serialVersionUID = 277281993463789379L; + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.spaceType = ForumModel.TYPE_FORUM.toString(); + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "create_forum"); + } +} diff --git a/source/java/org/alfresco/web/bean/forums/CreateForumsDialog.java b/source/java/org/alfresco/web/bean/forums/CreateForumsDialog.java index f5dc521e59..e3a07c8ca1 100644 --- a/source/java/org/alfresco/web/bean/forums/CreateForumsDialog.java +++ b/source/java/org/alfresco/web/bean/forums/CreateForumsDialog.java @@ -1,36 +1,36 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.spaces.CreateSpaceDialog; - -/** - * Bean used to implement the "Create Forums Dialog". - * - * @author gavinc - */ -public class CreateForumsDialog extends CreateSpaceDialog -{ - // ------------------------------------------------------------------------------ - // Wizard implementation - - private static final long serialVersionUID = 4371868975654509241L; - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.spaceType = ForumModel.TYPE_FORUMS.toString(); - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "create_forums"); - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.spaces.CreateSpaceDialog; + +/** + * Bean used to implement the "Create Forums Dialog". + * + * @author gavinc + */ +public class CreateForumsDialog extends CreateSpaceDialog +{ + // ------------------------------------------------------------------------------ + // Wizard implementation + + private static final long serialVersionUID = 4371868975654509241L; + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.spaceType = ForumModel.TYPE_FORUMS.toString(); + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "create_forums"); + } +} diff --git a/source/java/org/alfresco/web/bean/forums/CreatePostDialog.java b/source/java/org/alfresco/web/bean/forums/CreatePostDialog.java index 46f117bd9a..a4eef65598 100644 --- a/source/java/org/alfresco/web/bean/forums/CreatePostDialog.java +++ b/source/java/org/alfresco/web/bean/forums/CreatePostDialog.java @@ -1,65 +1,65 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.content.CreateContentWizard; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; - -/** - * Bean implementation of the "New Post Dialog". - * - * @author gavinc - */ -public class CreatePostDialog extends CreateContentWizard -{ - // ------------------------------------------------------------------------------ - // Wizard implementation - - private static final long serialVersionUID = -2859329677883776068L; - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // set up for creating a post - this.objectType = ForumModel.TYPE_POST.toString(); - - // make sure we don't show the edit properties dialog after creation - this.showOtherProperties = false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // create appropriate values for filename and content type - this.fileName = ForumsBean.createPostFileName(); - this.mimeType = Repository.getMimeTypeForFileName( - FacesContext.getCurrentInstance(), this.fileName); - - // remove link breaks and replace with
- this.content = Utils.replaceLineBreaks(this.content, false); - - // set UTF-8 encoding for the post (all original posts are UTF-8 also) - this.encoding = "UTF-8"; - - return super.finishImpl(context, outcome); - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "post"); - } - - @Override - public boolean getFinishButtonDisabled() - { - return true; - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.content.CreateContentWizard; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; + +/** + * Bean implementation of the "New Post Dialog". + * + * @author gavinc + */ +public class CreatePostDialog extends CreateContentWizard +{ + // ------------------------------------------------------------------------------ + // Wizard implementation + + private static final long serialVersionUID = -2859329677883776068L; + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // set up for creating a post + this.objectType = ForumModel.TYPE_POST.toString(); + + // make sure we don't show the edit properties dialog after creation + this.showOtherProperties = false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // create appropriate values for filename and content type + this.fileName = ForumsBean.createPostFileName(); + this.mimeType = Repository.getMimeTypeForFileName( + FacesContext.getCurrentInstance(), this.fileName); + + // remove link breaks and replace with
+ this.content = Utils.replaceLineBreaks(this.content, false); + + // set UTF-8 encoding for the post (all original posts are UTF-8 also) + this.encoding = "UTF-8"; + + return super.finishImpl(context, outcome); + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "post"); + } + + @Override + public boolean getFinishButtonDisabled() + { + return true; + } +} diff --git a/source/java/org/alfresco/web/bean/forums/CreateReplyDialog.java b/source/java/org/alfresco/web/bean/forums/CreateReplyDialog.java index 50f5c244cc..0d9395e3ef 100644 --- a/source/java/org/alfresco/web/bean/forums/CreateReplyDialog.java +++ b/source/java/org/alfresco/web/bean/forums/CreateReplyDialog.java @@ -1,65 +1,65 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation of the "Create Reply Dialog". - * - * @author gavinc - */ -public class CreateReplyDialog extends CreatePostDialog -{ - private static final long serialVersionUID = 8036934269090933533L; - - protected String replyContent = null; - - private static final Log logger = LogFactory.getLog(CreateReplyDialog.class); - - // ------------------------------------------------------------------------------ - // Wizard implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.replyContent = null; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // remove link breaks and replace with
- this.content = Utils.replaceLineBreaks(this.content, false); - - super.finishImpl(context, outcome); - - // setup the referencing aspect with the references association - // between the new post and the one being replied to - this.getNodeService().addAspect(this.createdNode, ContentModel.ASPECT_REFERENCING, null); - this.getNodeService().createAssociation(this.createdNode, this.browseBean.getDocument().getNodeRef(), - ContentModel.ASSOC_REFERENCES); - - if (logger.isDebugEnabled()) - { - logger.debug("created new node: " + this.createdNode); - logger.debug("existing node: " + this.browseBean.getDocument().getNodeRef()); - } - - return outcome; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "reply"); - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation of the "Create Reply Dialog". + * + * @author gavinc + */ +public class CreateReplyDialog extends CreatePostDialog +{ + private static final long serialVersionUID = 8036934269090933533L; + + protected String replyContent = null; + + private static final Log logger = LogFactory.getLog(CreateReplyDialog.class); + + // ------------------------------------------------------------------------------ + // Wizard implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.replyContent = null; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // remove link breaks and replace with
+ this.content = Utils.replaceLineBreaks(this.content, false); + + super.finishImpl(context, outcome); + + // setup the referencing aspect with the references association + // between the new post and the one being replied to + this.getNodeService().addAspect(this.createdNode, ContentModel.ASPECT_REFERENCING, null); + this.getNodeService().createAssociation(this.createdNode, this.browseBean.getDocument().getNodeRef(), + ContentModel.ASSOC_REFERENCES); + + if (logger.isDebugEnabled()) + { + logger.debug("created new node: " + this.createdNode); + logger.debug("existing node: " + this.browseBean.getDocument().getNodeRef()); + } + + return outcome; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "reply"); + } +} diff --git a/source/java/org/alfresco/web/bean/forums/CreateTopicDialog.java b/source/java/org/alfresco/web/bean/forums/CreateTopicDialog.java index 01b17ff920..c4b2beb781 100644 --- a/source/java/org/alfresco/web/bean/forums/CreateTopicDialog.java +++ b/source/java/org/alfresco/web/bean/forums/CreateTopicDialog.java @@ -1,156 +1,156 @@ -package org.alfresco.web.bean.forums; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.model.FileInfo; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.spaces.CreateSpaceDialog; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation of the "Create Topic Dialog". - * - * @author gavinc - */ -public class CreateTopicDialog extends CreateSpaceDialog -{ - private static final long serialVersionUID = -8672220556613430308L; - - protected String message; - transient private ContentService contentService; - - private static final Log logger = LogFactory.getLog(CreateTopicDialog.class); - - // ------------------------------------------------------------------------------ - // Wizard implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.spaceType = ForumModel.TYPE_TOPIC.toString(); - this.message = null; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - super.finishImpl(context, outcome); - - // do topic specific processing - - // get the node ref of the node that will contain the content - NodeRef containerNodeRef = this.createdNode; - - // create a unique file name for the message content - String fileName = ForumsBean.createPostFileName(); - - FileInfo fileInfo = this.getFileFolderService().create(containerNodeRef, - fileName, ForumModel.TYPE_POST); - NodeRef postNodeRef = fileInfo.getNodeRef(); - - if (logger.isDebugEnabled()) - logger.debug("Created post node with filename: " + fileName); - - // apply the titled aspect - title and description - Map titledProps = new HashMap(3, 1.0f); - titledProps.put(ContentModel.PROP_TITLE, fileName); - this.getNodeService().addAspect(postNodeRef, ContentModel.ASPECT_TITLED, titledProps); - - if (logger.isDebugEnabled()) - logger.debug("Added titled aspect with properties: " + titledProps); - - Map editProps = new HashMap(1, 1.0f); - editProps.put(ApplicationModel.PROP_EDITINLINE, true); - this.getNodeService().addAspect(postNodeRef, ApplicationModel.ASPECT_INLINEEDITABLE, editProps); - - if (logger.isDebugEnabled()) - logger.debug("Added inlineeditable aspect with properties: " + editProps); - - // get a writer for the content and put the file - ContentWriter writer = getContentService().getWriter(postNodeRef, ContentModel.PROP_CONTENT, true); - // set the mimetype and encoding - writer.setMimetype(Repository.getMimeTypeForFileName(context, fileName)); - writer.setEncoding("UTF-8"); - writer.putContent(Utils.replaceLineBreaks(this.message, false)); - - return outcome; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - // if the creation was successful we need to simulate a user - // selecting the topic, the dispatching will take us to the - // correct view. - this.browseBean.clickSpace(this.createdNode); - - return outcome + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "showTopic"; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "create_topic"); - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns the message entered by the user for the first post - * - * @return The message for the first post - */ - public String getMessage() - { - return this.message; - } - - /** - * Sets the message - * - * @param message The message - */ - public void setMessage(String message) - { - this.message = message; - } - - // ------------------------------------------------------------------------------ - // Service Injection - - /** - * @param contentService The contentService to set. - */ - public void setContentService(ContentService contentService) - { - this.contentService = contentService; - } - - protected ContentService getContentService() - { - if (contentService == null) - { - contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); - } - return contentService; - } - -} +package org.alfresco.web.bean.forums; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.model.FileInfo; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.spaces.CreateSpaceDialog; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation of the "Create Topic Dialog". + * + * @author gavinc + */ +public class CreateTopicDialog extends CreateSpaceDialog +{ + private static final long serialVersionUID = -8672220556613430308L; + + protected String message; + transient private ContentService contentService; + + private static final Log logger = LogFactory.getLog(CreateTopicDialog.class); + + // ------------------------------------------------------------------------------ + // Wizard implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.spaceType = ForumModel.TYPE_TOPIC.toString(); + this.message = null; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + super.finishImpl(context, outcome); + + // do topic specific processing + + // get the node ref of the node that will contain the content + NodeRef containerNodeRef = this.createdNode; + + // create a unique file name for the message content + String fileName = ForumsBean.createPostFileName(); + + FileInfo fileInfo = this.getFileFolderService().create(containerNodeRef, + fileName, ForumModel.TYPE_POST); + NodeRef postNodeRef = fileInfo.getNodeRef(); + + if (logger.isDebugEnabled()) + logger.debug("Created post node with filename: " + fileName); + + // apply the titled aspect - title and description + Map titledProps = new HashMap(3, 1.0f); + titledProps.put(ContentModel.PROP_TITLE, fileName); + this.getNodeService().addAspect(postNodeRef, ContentModel.ASPECT_TITLED, titledProps); + + if (logger.isDebugEnabled()) + logger.debug("Added titled aspect with properties: " + titledProps); + + Map editProps = new HashMap(1, 1.0f); + editProps.put(ApplicationModel.PROP_EDITINLINE, true); + this.getNodeService().addAspect(postNodeRef, ApplicationModel.ASPECT_INLINEEDITABLE, editProps); + + if (logger.isDebugEnabled()) + logger.debug("Added inlineeditable aspect with properties: " + editProps); + + // get a writer for the content and put the file + ContentWriter writer = getContentService().getWriter(postNodeRef, ContentModel.PROP_CONTENT, true); + // set the mimetype and encoding + writer.setMimetype(Repository.getMimeTypeForFileName(context, fileName)); + writer.setEncoding("UTF-8"); + writer.putContent(Utils.replaceLineBreaks(this.message, false)); + + return outcome; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + // if the creation was successful we need to simulate a user + // selecting the topic, the dispatching will take us to the + // correct view. + this.browseBean.clickSpace(this.createdNode); + + return outcome + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "showTopic"; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "create_topic"); + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns the message entered by the user for the first post + * + * @return The message for the first post + */ + public String getMessage() + { + return this.message; + } + + /** + * Sets the message + * + * @param message The message + */ + public void setMessage(String message) + { + this.message = message; + } + + // ------------------------------------------------------------------------------ + // Service Injection + + /** + * @param contentService The contentService to set. + */ + public void setContentService(ContentService contentService) + { + this.contentService = contentService; + } + + protected ContentService getContentService() + { + if (contentService == null) + { + contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); + } + return contentService; + } + +} diff --git a/source/java/org/alfresco/web/bean/forums/DeleteForumDialog.java b/source/java/org/alfresco/web/bean/forums/DeleteForumDialog.java index 31a8179365..08fccba79f 100644 --- a/source/java/org/alfresco/web/bean/forums/DeleteForumDialog.java +++ b/source/java/org/alfresco/web/bean/forums/DeleteForumDialog.java @@ -1,106 +1,106 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.spaces.DeleteSpaceDialog; - -/** - * Bean implementation for the "Delete Forum" dialog - * - * @author gavinc - */ -public class DeleteForumDialog extends DeleteSpaceDialog -{ - private static final long serialVersionUID = -4246549059188399460L; - - protected boolean reDisplayForums; - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // reset the reDisplayForums flag - this.reDisplayForums = false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // find out what the parent type of the node being deleted - Node node = this.browseBean.getActionSpace(); - NodeRef parent = null; - ChildAssociationRef assoc = this.getNodeService().getPrimaryParent(node.getNodeRef()); - if (assoc != null) - { - // get the parent node - parent = assoc.getParentRef(); - - // if the parent type is a forum space then we need the dialog to go - // back to the forums view otherwise it will use the default of 'browse', - // this happens when a forum being used to discuss a node is deleted. - QName parentType = this.getNodeService().getType(parent); - if (parentType.equals(ForumModel.TYPE_FORUMS)) - { - this.reDisplayForums = true; - } - } - - // delete the forum itself - outcome = super.finishImpl(context, outcome); - - // remove the discussable aspect if appropriate - if (assoc != null && parent != null) - { - // get the association type - QName type = assoc.getTypeQName(); - if (type.equals(ForumModel.ASSOC_DISCUSSION)) - { - // if the association type is the 'discussion' association we - // need to remove the discussable aspect from the parent node - this.getNodeService().removeAspect(parent, ForumModel.ASPECT_DISCUSSABLE); - } - } - - return outcome; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - outcome = super.doPostCommitProcessing(context, outcome); - - if (this.reDisplayForums) - { - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "forumDeleted"; - } - else - { - return outcome; - } - } - - /** - * Returns the message bundle id of the confirmation message to display to - * the user before deleting the forum. - * - * @return The message bundle id - */ - @Override - protected String getConfirmMessageId() - { - return "delete_forum_confirm"; - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.spaces.DeleteSpaceDialog; + +/** + * Bean implementation for the "Delete Forum" dialog + * + * @author gavinc + */ +public class DeleteForumDialog extends DeleteSpaceDialog +{ + private static final long serialVersionUID = -4246549059188399460L; + + protected boolean reDisplayForums; + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // reset the reDisplayForums flag + this.reDisplayForums = false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // find out what the parent type of the node being deleted + Node node = this.browseBean.getActionSpace(); + NodeRef parent = null; + ChildAssociationRef assoc = this.getNodeService().getPrimaryParent(node.getNodeRef()); + if (assoc != null) + { + // get the parent node + parent = assoc.getParentRef(); + + // if the parent type is a forum space then we need the dialog to go + // back to the forums view otherwise it will use the default of 'browse', + // this happens when a forum being used to discuss a node is deleted. + QName parentType = this.getNodeService().getType(parent); + if (parentType.equals(ForumModel.TYPE_FORUMS)) + { + this.reDisplayForums = true; + } + } + + // delete the forum itself + outcome = super.finishImpl(context, outcome); + + // remove the discussable aspect if appropriate + if (assoc != null && parent != null) + { + // get the association type + QName type = assoc.getTypeQName(); + if (type.equals(ForumModel.ASSOC_DISCUSSION)) + { + // if the association type is the 'discussion' association we + // need to remove the discussable aspect from the parent node + this.getNodeService().removeAspect(parent, ForumModel.ASPECT_DISCUSSABLE); + } + } + + return outcome; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + outcome = super.doPostCommitProcessing(context, outcome); + + if (this.reDisplayForums) + { + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "forumDeleted"; + } + else + { + return outcome; + } + } + + /** + * Returns the message bundle id of the confirmation message to display to + * the user before deleting the forum. + * + * @return The message bundle id + */ + @Override + protected String getConfirmMessageId() + { + return "delete_forum_confirm"; + } +} diff --git a/source/java/org/alfresco/web/bean/forums/DeleteForumsDialog.java b/source/java/org/alfresco/web/bean/forums/DeleteForumsDialog.java index e9e7f7f09a..c0024e5c5f 100644 --- a/source/java/org/alfresco/web/bean/forums/DeleteForumsDialog.java +++ b/source/java/org/alfresco/web/bean/forums/DeleteForumsDialog.java @@ -1,72 +1,72 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.spaces.DeleteSpaceDialog; - -/** - * Bean implementation for the "Delete Forum Space" dialog - * - * @author gavinc - */ -public class DeleteForumsDialog extends DeleteSpaceDialog -{ - private static final long serialVersionUID = -1673691210425371041L; - - protected boolean reDisplayForums; - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // reset the reDisplayForums flag - this.reDisplayForums = false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // find out what the parent type of the node being deleted - Node node = this.browseBean.getActionSpace(); - ChildAssociationRef assoc = this.getNodeService().getPrimaryParent(node.getNodeRef()); - if (assoc != null) - { - NodeRef parent = assoc.getParentRef(); - QName parentType = this.getNodeService().getType(parent); - if (parentType.equals(ForumModel.TYPE_FORUMS)) - { - this.reDisplayForums = true; - } - } - - return super.finishImpl(context, outcome); - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - outcome = super.doPostCommitProcessing(context, outcome); - - if (this.reDisplayForums) - { - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "forumsDeleted"; - } - else - { - return outcome; - } - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.spaces.DeleteSpaceDialog; + +/** + * Bean implementation for the "Delete Forum Space" dialog + * + * @author gavinc + */ +public class DeleteForumsDialog extends DeleteSpaceDialog +{ + private static final long serialVersionUID = -1673691210425371041L; + + protected boolean reDisplayForums; + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // reset the reDisplayForums flag + this.reDisplayForums = false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // find out what the parent type of the node being deleted + Node node = this.browseBean.getActionSpace(); + ChildAssociationRef assoc = this.getNodeService().getPrimaryParent(node.getNodeRef()); + if (assoc != null) + { + NodeRef parent = assoc.getParentRef(); + QName parentType = this.getNodeService().getType(parent); + if (parentType.equals(ForumModel.TYPE_FORUMS)) + { + this.reDisplayForums = true; + } + } + + return super.finishImpl(context, outcome); + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + outcome = super.doPostCommitProcessing(context, outcome); + + if (this.reDisplayForums) + { + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "forumsDeleted"; + } + else + { + return outcome; + } + } +} diff --git a/source/java/org/alfresco/web/bean/forums/DeletePostDialog.java b/source/java/org/alfresco/web/bean/forums/DeletePostDialog.java index 9577a11b96..589aa97afb 100644 --- a/source/java/org/alfresco/web/bean/forums/DeletePostDialog.java +++ b/source/java/org/alfresco/web/bean/forums/DeletePostDialog.java @@ -1,46 +1,46 @@ -package org.alfresco.web.bean.forums; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.content.DeleteContentDialog; - -/** - * Bean implementation for the "Delete Post" dialog. - * - * @author gavinc - */ -public class DeletePostDialog extends DeleteContentDialog -{ - // ------------------------------------------------------------------------------ - // Dialog implementation - - private static final long serialVersionUID = 6804626884508461423L; - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - super.doPostCommitProcessing(context, outcome); - - return this.getDefaultFinishOutcome(); - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns the confirmation to display to the user before deleting the content. - * - * @return The formatted message to display - */ - public String getConfirmMessage() - { - String postConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - "delete_post_confirm"); - - return MessageFormat.format(postConfirmMsg, - new Object[] {this.browseBean.getDocument().getProperties().get("creator")}); - } -} +package org.alfresco.web.bean.forums; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.content.DeleteContentDialog; + +/** + * Bean implementation for the "Delete Post" dialog. + * + * @author gavinc + */ +public class DeletePostDialog extends DeleteContentDialog +{ + // ------------------------------------------------------------------------------ + // Dialog implementation + + private static final long serialVersionUID = 6804626884508461423L; + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + super.doPostCommitProcessing(context, outcome); + + return this.getDefaultFinishOutcome(); + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns the confirmation to display to the user before deleting the content. + * + * @return The formatted message to display + */ + public String getConfirmMessage() + { + String postConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + "delete_post_confirm"); + + return MessageFormat.format(postConfirmMsg, + new Object[] {this.browseBean.getDocument().getProperties().get("creator")}); + } +} diff --git a/source/java/org/alfresco/web/bean/forums/DeleteTopicDialog.java b/source/java/org/alfresco/web/bean/forums/DeleteTopicDialog.java index 010f8b524c..d638aa8670 100644 --- a/source/java/org/alfresco/web/bean/forums/DeleteTopicDialog.java +++ b/source/java/org/alfresco/web/bean/forums/DeleteTopicDialog.java @@ -1,84 +1,84 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.spaces.DeleteSpaceDialog; - -/** - * Bean implementation for the "Delete Topic" dialog - * - * @author gavinc - */ -public class DeleteTopicDialog extends DeleteSpaceDialog -{ - private static final long serialVersionUID = 548182341698381545L; - - protected boolean reDisplayTopics; - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // reset the reDisplayTopics flag - this.reDisplayTopics = false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // find out what the parent type of the node being deleted - Node node = this.browseBean.getActionSpace(); - ChildAssociationRef assoc = this.getNodeService().getPrimaryParent(node.getNodeRef()); - if (assoc != null) - { - NodeRef parent = assoc.getParentRef(); - QName parentType = this.getNodeService().getType(parent); - if (parentType.equals(ForumModel.TYPE_FORUM)) - { - this.reDisplayTopics = true; - } - } - - return super.finishImpl(context, outcome); - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - outcome = super.doPostCommitProcessing(context, outcome); - - if (this.reDisplayTopics) - { - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "topicDeleted"; - } - else - { - return outcome; - } - } - - /** - * Returns the message bundle id of the confirmation message to display to - * the user before deleting the topic. - * - * @return The message bundle id - */ - @Override - protected String getConfirmMessageId() - { - return "delete_topic_confirm"; - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.spaces.DeleteSpaceDialog; + +/** + * Bean implementation for the "Delete Topic" dialog + * + * @author gavinc + */ +public class DeleteTopicDialog extends DeleteSpaceDialog +{ + private static final long serialVersionUID = 548182341698381545L; + + protected boolean reDisplayTopics; + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // reset the reDisplayTopics flag + this.reDisplayTopics = false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // find out what the parent type of the node being deleted + Node node = this.browseBean.getActionSpace(); + ChildAssociationRef assoc = this.getNodeService().getPrimaryParent(node.getNodeRef()); + if (assoc != null) + { + NodeRef parent = assoc.getParentRef(); + QName parentType = this.getNodeService().getType(parent); + if (parentType.equals(ForumModel.TYPE_FORUM)) + { + this.reDisplayTopics = true; + } + } + + return super.finishImpl(context, outcome); + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + outcome = super.doPostCommitProcessing(context, outcome); + + if (this.reDisplayTopics) + { + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "topicDeleted"; + } + else + { + return outcome; + } + } + + /** + * Returns the message bundle id of the confirmation message to display to + * the user before deleting the topic. + * + * @return The message bundle id + */ + @Override + protected String getConfirmMessageId() + { + return "delete_topic_confirm"; + } +} diff --git a/source/java/org/alfresco/web/bean/forums/EditPostDialog.java b/source/java/org/alfresco/web/bean/forums/EditPostDialog.java index 8ec2ac1968..e432f3659b 100644 --- a/source/java/org/alfresco/web/bean/forums/EditPostDialog.java +++ b/source/java/org/alfresco/web/bean/forums/EditPostDialog.java @@ -1,87 +1,87 @@ -package org.alfresco.web.bean.forums; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.ContentReader; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.Utils; -import org.springframework.util.StringUtils; - -/** - * Bean implementation for the "Edit Post Dialog". - * - * @author gavinc - */ -public class EditPostDialog extends CreatePostDialog -{ - // ------------------------------------------------------------------------------ - // Wizard implementation - - private static final long serialVersionUID = 7925794441178897699L; - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // we need to remove the
tags and replace with carriage returns - // and then setup the content member variable - Node currentDocument = this.browseBean.getDocument(); - ContentReader reader = this.getContentService().getReader(currentDocument.getNodeRef(), - ContentModel.PROP_CONTENT); - - if (reader != null) - { - String htmlContent = reader.getContentString(); - if (htmlContent != null) - { - // ETHREEOH-1216: replace both forms of 'br' as older posts have the
version - // which doesn't work in all browsers supported by Alfresco Explorer - htmlContent = StringUtils.replace(htmlContent, "
", "\r\n"); - this.content = StringUtils.replace(htmlContent, "
", "\r\n"); - } - } - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // remove link breaks and replace with
- this.content = Utils.replaceLineBreaks(this.content, false); - - // update the content - NodeRef postNode = this.browseBean.getDocument().getNodeRef(); - - // check that the name of this post does not contain the : - // character (used in previous versions), if it does rename - // the post. - String name = (String)this.getNodeService().getProperty( - postNode, ContentModel.PROP_NAME); - if (name.indexOf(":") != -1) - { - String newName = name.replace(':', '-'); - this.getFileFolderService().rename(postNode, newName); - } - - ContentWriter writer = this.getContentService().getWriter(postNode, - ContentModel.PROP_CONTENT, true); - if (writer != null) - { - writer.putContent(this.content); - } - - return outcome; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); - } -} +package org.alfresco.web.bean.forums; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.ContentReader; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.Utils; +import org.springframework.util.StringUtils; + +/** + * Bean implementation for the "Edit Post Dialog". + * + * @author gavinc + */ +public class EditPostDialog extends CreatePostDialog +{ + // ------------------------------------------------------------------------------ + // Wizard implementation + + private static final long serialVersionUID = 7925794441178897699L; + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // we need to remove the
tags and replace with carriage returns + // and then setup the content member variable + Node currentDocument = this.browseBean.getDocument(); + ContentReader reader = this.getContentService().getReader(currentDocument.getNodeRef(), + ContentModel.PROP_CONTENT); + + if (reader != null) + { + String htmlContent = reader.getContentString(); + if (htmlContent != null) + { + // ETHREEOH-1216: replace both forms of 'br' as older posts have the
version + // which doesn't work in all browsers supported by Alfresco Explorer + htmlContent = StringUtils.replace(htmlContent, "
", "\r\n"); + this.content = StringUtils.replace(htmlContent, "
", "\r\n"); + } + } + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // remove link breaks and replace with
+ this.content = Utils.replaceLineBreaks(this.content, false); + + // update the content + NodeRef postNode = this.browseBean.getDocument().getNodeRef(); + + // check that the name of this post does not contain the : + // character (used in previous versions), if it does rename + // the post. + String name = (String)this.getNodeService().getProperty( + postNode, ContentModel.PROP_NAME); + if (name.indexOf(":") != -1) + { + String newName = name.replace(':', '-'); + this.getFileFolderService().rename(postNode, newName); + } + + ContentWriter writer = this.getContentService().getWriter(postNode, + ContentModel.PROP_CONTENT, true); + if (writer != null) + { + writer.putContent(this.content); + } + + return outcome; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); + } +} diff --git a/source/java/org/alfresco/web/bean/forums/ForumsBean.java b/source/java/org/alfresco/web/bean/forums/ForumsBean.java index 7c26079395..a3206f9aa3 100644 --- a/source/java/org/alfresco/web/bean/forums/ForumsBean.java +++ b/source/java/org/alfresco/web/bean/forums/ForumsBean.java @@ -1,1326 +1,1326 @@ -package org.alfresco.web.bean.forums; - -import java.io.IOException; -import java.io.StringWriter; -import java.io.Writer; -import java.text.MessageFormat; -import java.text.SimpleDateFormat; -import java.util.ArrayList; -import java.util.Collections; -import java.util.Date; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.UUID; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.event.ActionEvent; -import javax.transaction.UserTransaction; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.model.ContentModel; -import org.alfresco.model.ForumModel; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.dictionary.TypeDefinition; -import org.alfresco.service.cmr.repository.AssociationRef; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.ContentReader; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.search.QueryParameterDefinition; -import org.alfresco.service.cmr.search.SearchService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.service.namespace.RegexQNamePattern; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.IContextListener; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.bean.BrowseBean; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.repository.MapNode; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.NodePropertyResolver; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.config.ViewsConfigElement; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.alfresco.web.ui.common.component.UIModeList; -import org.alfresco.web.ui.common.component.data.UIColumn; -import org.alfresco.web.ui.common.component.data.UIRichList; -import org.alfresco.web.ui.common.renderer.data.IRichListRenderer; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean providing properties and behaviour for the forums screens. - * - * @author gavinc - */ -public class ForumsBean implements IContextListener -{ - private static final long serialVersionUID = 7066410060288061436L; - - private static Log logger = LogFactory.getLog(ForumsBean.class); - private static final String PAGE_NAME_FORUMS = "forums"; - private static final String PAGE_NAME_FORUM = "forum"; - private static final String PAGE_NAME_TOPIC = "topic"; - - /** The NodeService to be used by the bean */ - transient private NodeService nodeService; - - /** The ContentService to be used by the bean */ - transient private ContentService contentService; - - /** The DictionaryService bean reference */ - transient private DictionaryService dictionaryService; - - /** The SearchService bean reference. */ - transient private SearchService searchService; - - /** The NamespaceService bean reference. */ - transient private NamespaceService namespaceService; - - /** The browse bean */ - protected BrowseBean browseBean; - - /** The NavigationBean bean reference */ - protected NavigationBean navigator; - - /** Views configuration object */ - protected ViewsConfigElement viewsConfig = null; - - /** Component references */ - protected UIRichList forumsRichList; - protected UIRichList forumRichList; - protected UIRichList topicRichList; - - /** Node lists */ - private List forums; - private List topics; - private List posts; - - /** The current forums view mode - set to a well known IRichListRenderer identifier */ - private String forumsViewMode; - - /** The current forums view page size */ - private int forumsPageSize; - - /** The current forum view mode - set to a well known IRichListRenderer identifier */ - private String forumViewMode; - - /** The current forum view page size */ - private int forumPageSize; - - /** The current topic view mode - set to a well known IRichListRenderer identifier */ - private String topicViewMode; - - /** The current topic view page size */ - private int topicPageSize; - - - // ------------------------------------------------------------------------------ - // Construction - - /** - * Default Constructor - */ - public ForumsBean() - { - UIContextService.getInstance(FacesContext.getCurrentInstance()).registerBean(this); - - initFromClientConfig(); - } - - - // ------------------------------------------------------------------------------ - // Bean property getters and setters - - /** - * @param nodeService The NodeService to set. - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - protected NodeService getNodeService() - { - if (nodeService == null) - { - nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return nodeService; - } - - /** - * Sets the content service to use - * - * @param contentService The ContentService - */ - public void setContentService(ContentService contentService) - { - this.contentService = contentService; - } - - protected ContentService getContentService() - { - if (contentService == null) - { - contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); - } - return contentService; - } - - /** - * @param dictionaryService The DictionaryService to set. - */ - public void setDictionaryService(DictionaryService dictionaryService) - { - this.dictionaryService = dictionaryService; - } - - protected DictionaryService getDictionaryService() - { - if (dictionaryService == null) - { - dictionaryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getDictionaryService(); - } - return dictionaryService; - } - - /** - * @param searchService The SearchService to set. - */ - public void setSearchService(SearchService searchService) - { - this.searchService = searchService; - } - - protected SearchService getSearchService() - { - if (searchService == null) - { - searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); - } - return searchService; - } - - /** - * @param namespaceService The NamespaceService to set. - */ - public void setNamespaceService(NamespaceService namespaceService) - { - this.namespaceService = namespaceService; - } - - protected NamespaceService getNamespaceService() - { - if (namespaceService == null) - { - namespaceService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNamespaceService(); - } - return namespaceService; - } - - /** - * Sets the BrowseBean instance to use to retrieve the current document - * - * @param browseBean BrowseBean instance - */ - public void setBrowseBean(BrowseBean browseBean) - { - this.browseBean = browseBean; - } - - /** - * @param navigator The NavigationBean to set. - */ - public void setNavigator(NavigationBean navigator) - { - this.navigator = navigator; - } - - /** - * @param forumsRichList The forumsRichList to set. - */ - public void setForumsRichList(UIRichList forumsRichList) - { - this.forumsRichList = forumsRichList; - if (this.forumsRichList != null) - { - // set the initial sort column and direction - this.forumsRichList.setInitialSortColumn( - this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUMS)); - this.forumsRichList.setInitialSortDescending( - this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUMS)); - - // ETWOONE-183 & ETWOONE-339. For URL addressability of forums spaces - this.forumsRichList.setRefreshOnBind(true); - } - } - - /** - * @return Returns the forumsRichList. - */ - public UIRichList getForumsRichList() - { - return this.forumsRichList; - } - - /** - * @return Returns the forums View mode. See UIRichList - */ - public String getForumsViewMode() - { - return this.forumsViewMode; - } - - /** - * @param forumsViewMode The forums View mode to set. See UIRichList. - */ - public void setForumsViewMode(String forumsViewMode) - { - this.forumsViewMode = forumsViewMode; - } - - /** - * @return Returns the forumsPageSize. - */ - public int getForumsPageSize() - { - return this.forumsPageSize; - } - - /** - * @param forumsPageSize The forumsPageSize to set. - */ - public void setForumsPageSize(int forumsPageSize) - { - this.forumsPageSize = forumsPageSize; - } - - /** - * @param topicRichList The topicRichList to set. - */ - public void setTopicRichList(UIRichList topicRichList) - { - this.topicRichList = topicRichList; - - if (this.topicRichList != null) - { - // set the initial sort column and direction - this.topicRichList.setInitialSortColumn( - this.viewsConfig.getDefaultSortColumn(PAGE_NAME_TOPIC)); - this.topicRichList.setInitialSortDescending( - this.viewsConfig.hasDescendingSort(PAGE_NAME_TOPIC)); - - // ETWOONE-183. For URL addressability of topics: - this.topicRichList.setRefreshOnBind(true); - } - } - - /** - * @return Returns the topicRichList. - */ - public UIRichList getTopicRichList() - { - return this.topicRichList; - } - - /** - * @return Returns the topics View mode. See UIRichList - */ - public String getTopicViewMode() - { - return this.topicViewMode; - } - - /** - * @param topicViewMode The topic View mode to set. See UIRichList. - */ - public void setTopicViewMode(String topicViewMode) - { - this.topicViewMode = topicViewMode; - } - - /** - * @return Returns the topicsPageSize. - */ - public int getTopicPageSize() - { - return this.topicPageSize; - } - - /** - * @param topicPageSize The topicPageSize to set. - */ - public void setTopicPageSize(int topicPageSize) - { - this.topicPageSize = topicPageSize; - } - - /** - * @param forumRichList The forumRichList to set. - */ - public void setForumRichList(UIRichList forumRichList) - { - this.forumRichList = forumRichList; - - if (this.forumRichList != null) - { - // set the initial sort column and direction - this.forumRichList.setInitialSortColumn( - this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUM)); - this.forumRichList.setInitialSortDescending( - this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUM)); - - // ETWOONE-183 & ETWOONE-339. For URL addressability of forum spaces - this.forumRichList.setRefreshOnBind(true); - } - } - - /** - * @return Returns the forumRichList. - */ - public UIRichList getForumRichList() - { - return this.forumRichList; - } - - /** - * @return Returns the forum View mode. See UIRichList - */ - public String getForumViewMode() - { - return this.forumViewMode; - } - - /** - * @param forumViewMode The forum View mode to set. See UIRichList. - */ - public void setForumViewMode(String forumViewMode) - { - this.forumViewMode = forumViewMode; - } - - /** - * @return Returns the forumPageSize. - */ - public int getForumPageSize() - { - return this.forumPageSize; - } - - /** - * @param forumPageSize The forumPageSize to set. - */ - public void setForumPageSize(int forumPageSize) - { - this.forumPageSize = forumPageSize; - } - - public List getForums() - { - if (this.forums == null) - { - getNodes(); - } - - return this.forums; - } - - public List getTopics() - { - if (this.topics == null) - { - getNodes(); - } - - return this.topics; - } - - public List getPosts() - { - if (this.posts == null) - { - getNodes(); - } - - return this.posts; - } - - private void getNodes() - { - long startTime = 0; - if (logger.isDebugEnabled()) - startTime = System.currentTimeMillis(); - - UserTransaction tx = null; - try - { - FacesContext context = FacesContext.getCurrentInstance(); - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - // get the current space from NavigationBean - String parentNodeId = this.navigator.getCurrentNodeId(); - - NodeRef parentRef; - if (parentNodeId == null) - { - // no specific parent node specified - use the root node - parentRef = this.getNodeService().getRootNode(Repository.getStoreRef()); - } - else - { - // build a NodeRef for the specified Id and our store - parentRef = new NodeRef(Repository.getStoreRef(), parentNodeId); - } - - List childRefs = this.getNodeService().getChildAssocs(parentRef, - ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL); - this.forums = new ArrayList(childRefs.size()); - this.topics = new ArrayList(childRefs.size()); - this.posts = new ArrayList(childRefs.size()); - - for (ChildAssociationRef ref: childRefs) - { - // create our Node representation from the NodeRef - NodeRef nodeRef = ref.getChildRef(); - - if (this.getNodeService().exists(nodeRef)) - { - // find it's type so we can see if it's a node we are interested in - QName type = this.getNodeService().getType(nodeRef); - - // make sure the type is defined in the data dictionary - TypeDefinition typeDef = this.getDictionaryService().getType(type); - - if (typeDef != null) - { - // extract forums, forum, topic and post types - - if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_SYSTEM_FOLDER) == false) - { - if (this.getDictionaryService().isSubClass(type, ForumModel.TYPE_FORUMS) || - this.getDictionaryService().isSubClass(type, ForumModel.TYPE_FORUM)) - { - // create our Node representation - MapNode node = new MapNode(nodeRef, this.getNodeService(), true); - node.addPropertyResolver("icon", this.browseBean.resolverSpaceIcon); - node.addPropertyResolver("smallIcon", this.browseBean.resolverSmallIcon); - - this.forums.add(node); - } - if (this.getDictionaryService().isSubClass(type, ForumModel.TYPE_TOPIC)) - { - // create our Node representation - MapNode node = new MapNode(nodeRef, this.getNodeService(), true); - node.addPropertyResolver("icon", this.browseBean.resolverSpaceIcon); - node.addPropertyResolver("smallIcon", this.browseBean.resolverSmallIcon); - node.addPropertyResolver("replies", this.resolverReplies); - - this.topics.add(node); - } - else if (this.getDictionaryService().isSubClass(type, ForumModel.TYPE_POST)) - { - // create our Node representation - MapNode node = new MapNode(nodeRef, this.getNodeService(), true); - - this.browseBean.setupCommonBindingProperties(node); - node.addPropertyResolver("smallIcon", this.browseBean.resolverSmallIcon); - node.addPropertyResolver("message", this.resolverContent); - node.addPropertyResolver("replyTo", this.resolverReplyTo); - - this.posts.add(node); - } - } - } - else - { - if (logger.isWarnEnabled()) - logger.warn("Found invalid object in database: id = " + nodeRef + ", type = " + type); - } - } - } - - // commit the transaction - tx.commit(); - } - catch (InvalidNodeRefException refErr) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {refErr.getNodeRef()}) ); - this.forums = Collections.emptyList(); - this.topics = Collections.emptyList(); - this.posts = Collections.emptyList(); - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); - this.forums = Collections.emptyList(); - this.topics = Collections.emptyList(); - this.posts = Collections.emptyList(); - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - - if (logger.isDebugEnabled()) - { - long endTime = System.currentTimeMillis(); - logger.debug("Time to query and build forums nodes: " + (endTime - startTime) + "ms"); - } - } - - /** - * Returns the HTML to represent a bubble rendition of the text of the the - * forum article being replied to. - * - * @return The HTML for the bubble - */ - public String getReplyBubbleHTML() - { - try - { - // if the forum being replied to was a new post show the orange bubble - // with the user on the left otherwise show the yellow bubble with the - // user on the right. - StringWriter writer = new StringWriter(); - - FacesContext context = FacesContext.getCurrentInstance(); - Node replyToNode = this.browseBean.getDocument(); - boolean isReplyPost = this.getNodeService().hasAspect(replyToNode.getNodeRef(), - ContentModel.ASPECT_REFERENCING); - String contextPath = context.getExternalContext().getRequestContextPath(); - String colour = isReplyPost ? "yellow" : "orange"; - String bgColour = isReplyPost ? "#FFF5A3" : "#FCC75E"; - - // build the HTML to represent the user that posted the article being replied to - StringBuilder replyPosterHTML = new StringBuilder(""); - replyPosterHTML.append("
"); - replyPosterHTML.append((String)replyToNode.getProperties().get("creator")); - replyPosterHTML.append(""); - - // start the table - writer.write(""); - - if (isReplyPost) - { - renderReplyContentHTML(context, replyToNode, writer, contextPath, colour, bgColour); - writer.write(replyPosterHTML.toString()); - } - else - { - writer.write(replyPosterHTML.toString()); - renderReplyContentHTML(context, replyToNode, writer, contextPath, colour, bgColour); - } - - // finish the table - writer.write("
"); - - return writer.toString(); - } - catch (IOException ioe) - { - throw new AlfrescoRuntimeException("Failed to render reply bubble HTML", ioe); - } - } - - // ------------------------------------------------------------------------------ - // IContextListener implementation - - /** - * @see org.alfresco.web.app.context.IContextListener#contextUpdated() - */ - public void contextUpdated() - { - if (logger.isDebugEnabled()) - logger.debug("Invalidating forums components..."); - - // clear the value for the list components - will cause re-bind to it's data and refresh - if (this.forumsRichList != null) - { - this.forumsRichList.setValue(null); - if (this.forumsRichList.getInitialSortColumn() == null) - { - // set the initial sort column and direction - this.forumsRichList.setInitialSortColumn( - this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUMS)); - this.forumsRichList.setInitialSortDescending( - this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUMS)); - } - } - - if (this.forumRichList != null) - { - this.forumRichList.setValue(null); - if (this.forumRichList.getInitialSortColumn() == null) - { - // set the initial sort column and direction - this.forumRichList.setInitialSortColumn( - this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUM)); - this.forumRichList.setInitialSortDescending( - this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUM)); - } - } - - if (this.topicRichList != null) - { - this.topicRichList.setValue(null); - if (this.topicRichList.getInitialSortColumn() == null) - { - // set the initial sort column and direction - this.topicRichList.setInitialSortColumn( - this.viewsConfig.getDefaultSortColumn(PAGE_NAME_TOPIC)); - this.topicRichList.setInitialSortDescending( - this.viewsConfig.hasDescendingSort(PAGE_NAME_TOPIC)); - } - } - - // reset the lists - this.forums = null; - this.topics = null; - this.posts = null; - } - - /** - * @see org.alfresco.web.app.context.IContextListener#areaChanged() - */ - public void areaChanged() - { - // nothing to do - } - - /** - * @see org.alfresco.web.app.context.IContextListener#spaceChanged() - */ - public void spaceChanged() - { - // nothing to do - } - - // ------------------------------------------------------------------------------ - // Navigation action event handlers - - /** - * Change the current forums view mode based on user selection - * - * @param event ActionEvent - */ - public void forumsViewModeChanged(ActionEvent event) - { - UIModeList viewList = (UIModeList)event.getComponent(); - - // get the view mode ID - String viewMode = viewList.getValue().toString(); - - // push the view mode into the lists - setForumsViewMode(viewMode); - - // get the default for the forum page - this.forumsPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUMS, - this.forumsViewMode); - - if (logger.isDebugEnabled()) - logger.debug("Set default forums page size to: " + this.forumsPageSize); - } - - /** - * Change the current forum view mode based on user selection - * - * @param event ActionEvent - */ - public void forumViewModeChanged(ActionEvent event) - { - UIModeList viewList = (UIModeList)event.getComponent(); - - // get the view mode ID - String viewMode = viewList.getValue().toString(); - - // push the view mode into the lists - setForumViewMode(viewMode); - - // get the default for the forum page - this.forumPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUM, - this.forumViewMode); - - if (logger.isDebugEnabled()) - logger.debug("Set default forum page size to: " + this.forumPageSize); - } - - /** - * Change the current topic view mode based on user selection - * - * @param event ActionEvent - */ - public void topicViewModeChanged(ActionEvent event) - { - UIModeList viewList = (UIModeList)event.getComponent(); - - // get the view mode ID - String viewMode = viewList.getValue().toString(); - - // push the view mode into the lists - setTopicViewMode(viewMode); - - // change the default page size if necessary - this.topicPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_TOPIC, - this.topicViewMode); - - if (logger.isDebugEnabled()) - logger.debug("Set default topic page size to: " + this.topicPageSize); - } - - /** - * Event handler called when a user wants to view or participate - * in a discussion on an object - * - * @param event ActionEvent - */ - public void discuss(ActionEvent event) - { - UIActionLink link = (UIActionLink)event.getComponent(); - Map params = link.getParameterMap(); - String id = params.get("id"); - if (id == null || id.length() == 0) - { - throw new AlfrescoRuntimeException("discuss called without an id"); - } - - FacesContext context = FacesContext.getCurrentInstance(); - - NodeRef nodeRef = new NodeRef(Repository.getStoreRef(), id); - - if (this.getNodeService().hasAspect(nodeRef, ForumModel.ASPECT_DISCUSSABLE) == false) - { - throw new AlfrescoRuntimeException("discuss called for an object that does not have a discussion!"); - } - - // as the node has the discussable aspect there must be a discussions child assoc - List children = this.getNodeService().getChildAssocs(nodeRef, - ForumModel.ASSOC_DISCUSSION, RegexQNamePattern.MATCH_ALL); - - // there should only be one child, retrieve it if there is - if (children.size() == 1) - { - // show the forum for the discussion - NodeRef forumNodeRef = children.get(0).getChildRef(); - this.browseBean.clickSpace(forumNodeRef); - context.getApplication().getNavigationHandler().handleNavigation(context, null, "showForum"); - } - else - { - // this should never happen as the action evaluator should stop the action - // from displaying, just in case print a warning to the console - logger.warn("Node has the discussable aspect but does not have 1 child, it has " + - children.size() + " children!"); - } - } - - // ------------------------------------------------------------------------------ - // Property Resolvers - - public NodePropertyResolver resolverReplies = new NodePropertyResolver() { - private static final long serialVersionUID = -4800772273246202885L; - - public Object get(Node node) - { - // query for the number of posts within the given node - String repliesXPath = "./*[(subtypeOf('" + ForumModel.TYPE_POST + "'))]"; - List replies = getSearchService().selectNodes( - node.getNodeRef(), - repliesXPath, - new QueryParameterDefinition[] {}, - getNamespaceService(), - false); - - // reduce the count by 1 as one of the posts will be the initial post - int noReplies = replies.size() - 1; - - if (noReplies < 0) - { - noReplies = 0; - } - - return new Integer(noReplies); - } - }; - - public NodePropertyResolver resolverContent = new NodePropertyResolver() { - private static final long serialVersionUID = -2575377410105460440L; - - public Object get(Node node) - { - String content = null; - - // get the content property from the node and retrieve the - // full content as a string (obviously should only be used - // for small amounts of content) - ContentReader reader = getContentService().getReader(node.getNodeRef(), - ContentModel.PROP_CONTENT); - - if (reader != null) - { - content = Utils.stripUnsafeHTMLTags(reader.getContentString()); - } - - return content; - } - }; - - public NodePropertyResolver resolverReplyTo = new NodePropertyResolver() { - private static final long serialVersionUID = 2614901755220899360L; - - public Object get(Node node) - { - // determine if this node is a reply to another post, if so find - // the creator of the original poster - String replyTo = null; - - List assocs = getNodeService().getTargetAssocs(node.getNodeRef(), - ContentModel.ASSOC_REFERENCES); - - // there should only be one association, if there is more than one - // just get the first one - if (assocs.size() > 0) - { - AssociationRef assoc = assocs.get(0); - NodeRef target = assoc.getTargetRef(); - Node targetNode = new Node(target); - replyTo = (String)targetNode.getProperties().get("creator"); - } - - return replyTo; - } - }; - - /** - * Creates a file name for the message being posted - * - * @return The file name for the post - */ - public static String createPostFileName() - { - StringBuilder name = new StringBuilder("posted-"); - - // add a timestamp - SimpleDateFormat dateFormat = new SimpleDateFormat("dd-MM-yyyy-HH-mm-ss"); - name.append(dateFormat.format(new Date())); - - // add Universal Unique Identifier - // fix bugs ETWOONE-196 and ETWOONE-203 - name.append("-" + UUID.randomUUID()); - - // add the HTML file extension - name.append(".html"); - - return name.toString(); - } - - - // ------------------------------------------------------------------------------ - // Helpers - - /** - * Initialise default values from client configuration - */ - private void initFromClientConfig() - { - // TODO - review implications of these default values for dynamic/MT client - this.viewsConfig = (ViewsConfigElement)Application.getConfigService( - FacesContext.getCurrentInstance()).getConfig("Views"). - getConfigElement(ViewsConfigElement.CONFIG_ELEMENT_ID); - - // get the defaults for the forums page - this.forumsViewMode = this.viewsConfig.getDefaultView(PAGE_NAME_FORUMS); - this.forumsPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUMS, - this.forumsViewMode); - - // get the default for the forum page - this.forumViewMode = this.viewsConfig.getDefaultView(PAGE_NAME_FORUM); - this.forumPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUM, - this.forumViewMode); - - // get the default for the topic page - this.topicViewMode = this.viewsConfig.getDefaultView(PAGE_NAME_TOPIC); - this.topicPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_TOPIC, - this.topicViewMode); - - if (logger.isDebugEnabled()) - { - logger.debug("Set default forums view mode to: " + this.forumsViewMode); - logger.debug("Set default forums page size to: " + this.forumsPageSize); - logger.debug("Set default forum view mode to: " + this.forumViewMode); - logger.debug("Set default forum page size to: " + this.forumPageSize); - logger.debug("Set default topic view mode to: " + this.topicViewMode); - logger.debug("Set default topic page size to: " + this.topicPageSize); - } - } - - protected void renderReplyContentHTML(FacesContext context, - Node replyToNode, StringWriter writer, - String contextPath, String colour, String bgColour) - throws IOException - { - // get the content of the article being replied to - String replyContent = ""; - ContentReader reader = this.getContentService().getReader(replyToNode.getNodeRef(), - ContentModel.PROP_CONTENT); - if (reader != null) - { - replyContent = Utils.stripUnsafeHTMLTags(reader.getContentString()); - } - - // get the date of the article being replied to - String postedDate = Utils.getDateTimeFormat(context). - format(replyToNode.getProperties().get("created")); - - // generate the HTML - writer.write(""); - TopicBubbleViewRenderer.renderBubbleTop(writer, contextPath, colour, bgColour); - writer.write(""); - writer.write(Application.getMessage(context, "posted")); - writer.write(": "); - writer.write(postedDate); - TopicBubbleViewRenderer.renderBubbleMiddle(writer, contextPath, colour); - writer.write(replyContent); - TopicBubbleViewRenderer.renderBubbleBottom(writer, contextPath, colour); - writer.write(""); - } - - /** - * Class to implement a bubble view for the RichList component used in the topics screen - * - * @author gavinc - */ - public static class TopicBubbleViewRenderer implements IRichListRenderer - { - private static final long serialVersionUID = -6641033880549363822L; - - public static final String VIEWMODEID = "bubble"; - - public String getViewModeID() - { - return VIEWMODEID; - } - - public void renderListBefore(FacesContext context, UIRichList richList, UIColumn[] columns) - throws IOException - { - // nothing to do - } - - public void renderListRow(FacesContext context, UIRichList richList, UIColumn[] columns, Object row) - throws IOException - { - ResponseWriter out = context.getResponseWriter(); - - // find primary column (which must exist) and the actions column (which doesn't - // have to exist) - UIColumn primaryColumn = null; - UIColumn actionsColumn = null; - for (int i = 0; i < columns.length; i++) - { - if (columns[i].isRendered()) - { - if (columns[i].getPrimary()) - { - primaryColumn = columns[i]; - } - else if (columns[i].getActions()) - { - actionsColumn = columns[i]; - } - } - } - - if (primaryColumn == null) - { - if (logger.isWarnEnabled()) - logger.warn("No primary column found for RichList definition: " + richList.getId()); - } - - out.write(""); - - Node node = (Node)row; - if (node.getProperties().get("replyTo") == null) - { - renderNewPostBubble(context, out, node, primaryColumn, actionsColumn, columns); - } - else - { - renderReplyToBubble(context, out, node, primaryColumn, actionsColumn, columns); - } - - out.write(""); - - // add a little padding - out.write("
"); - } - - public void renderListAfter(FacesContext context, UIRichList richList, UIColumn[] columns) - throws IOException - { - ResponseWriter out = context.getResponseWriter(); - - out.write(""); - for (Iterator i = richList.getChildren().iterator(); i.hasNext(); /**/) - { - // output all remaining child components that are not UIColumn - UIComponent child = (UIComponent)i.next(); - if (child instanceof UIColumn == false) - { - Utils.encodeRecursive(context, child); - } - } - out.write(""); - } - - /** - * Renders the top part of the bubble i.e. before the header - * - * @param out The writer to output to - * @param contextPath Context path of the application - * @param colour The colour of the bubble - * @param titleBgColour Background colour of the header area - */ - public static void renderBubbleTop(Writer out, String contextPath, - String colour, String titleBgColour) throws IOException - { - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write(""); - out.write("
"); - } - - /** - * Renders the middle part of the bubble i.e. after the header and before the body - * - * @param out The writer to output to - * @param contextPath Context path of the application - * @param colour The colour of the bubble - */ - public static void renderBubbleMiddle(Writer out, String contextPath, String colour) - throws IOException - { - out.write("
"); - } - - /** - * Renders the bottom part of the bubble i.e. after the body - * - * @param out The writer to output to - * @param contextPath Context path of the application - * @param colour The colour of the bubble - */ - public static void renderBubbleBottom(Writer out, String contextPath, String colour) - throws IOException - { - out.write("
"); - } - - /** - * Renders the new post speech bubble - * - * @param context Faces context - * @param out The response writer - * @param node The Node for the row being rendered - * @param primaryColumn The primary column containing the message content - * @param actionsColumn The actions column containing all the actions - * @param columns All configured columns - */ - private void renderNewPostBubble(FacesContext context, ResponseWriter out, Node node, - UIColumn primaryColumn, UIColumn actionsColumn, UIColumn[] columns) throws IOException - { - String contextPath = context.getExternalContext().getRequestContextPath(); - String colour = "orange"; - - out.write(""); - out.write("

"); - out.write((String)node.getProperties().get("creator")); - out.write("		"); - - renderBubbleTop(out, contextPath, colour, "#FCC75E"); - renderHeaderContents(context, out, primaryColumn, actionsColumn, columns); - renderBubbleMiddle(out, contextPath, colour); - renderBodyContents(context, primaryColumn); - renderBubbleBottom(out, contextPath, colour); - - out.write("
"); - } - - /** - * Renders the reply to post speech bubble - * - * @param context Faces context - * @param out The response writer - * @param node The Node for the row being rendered - * @param primaryColumn The primary column containing the message content - * @param actionsColumn The actions column containing all the actions - * @param columns All configured columns - */ - private void renderReplyToBubble(FacesContext context, ResponseWriter out, Node node, - UIColumn primaryColumn, UIColumn actionsColumn, UIColumn[] columns) throws IOException - { - String contextPath = context.getExternalContext().getRequestContextPath(); - String colour = "yellow"; - - out.write(""); - out.write("
"); - - renderBubbleTop(out, contextPath, colour, "#FFF5A3"); - renderHeaderContents(context, out, primaryColumn, actionsColumn, columns); - renderBubbleMiddle(out, contextPath, colour); - renderBodyContents(context, primaryColumn); - renderBubbleBottom(out, contextPath, colour); - - out.write("
"); - out.write((String)node.getProperties().get("creator")); - out.write("
"); - } - - private void renderHeaderContents(FacesContext context, ResponseWriter out, - UIColumn primaryColumn, UIColumn actionsColumn, UIColumn[] columns) throws IOException - { - // render the header area with the configured columns - out.write(""); - - for (int i = 0; i < columns.length; i++) - { - UIColumn column = columns[i]; - - if (column.isRendered() == true && - column.getPrimary() == false && - column.getActions() == false) - { - // render the column header as the label - UIComponent header = column.getFacet("header"); - if (header != null) - { - out.write(""); - } - - // render the contents of the column - if (column.getChildCount() != 0) - { - out.write(""); - } - } - } - - // render the actions column - out.write("
"); - Utils.encodeRecursive(context, header); - out.write(""); - Utils.encodeRecursive(context, column); - out.write(""); - if (actionsColumn != null && actionsColumn.getChildCount() != 0) - { - Utils.encodeRecursive(context, actionsColumn); - } - out.write("
"); - } - - /** - * Renders the body contents for the bubble using the given primary coumn - * - * @param context Faces context - * @param primaryColumn The primary column holding the message text - */ - private void renderBodyContents(FacesContext context, UIColumn primaryColumn) - throws IOException - { - // render the primary column - if (primaryColumn != null && primaryColumn.getChildCount() != 0) - { - Utils.encodeRecursive(context, primaryColumn); - } - } - } -} +package org.alfresco.web.bean.forums; + +import java.io.IOException; +import java.io.StringWriter; +import java.io.Writer; +import java.text.MessageFormat; +import java.text.SimpleDateFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Date; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.UUID; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.event.ActionEvent; +import javax.transaction.UserTransaction; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.model.ContentModel; +import org.alfresco.model.ForumModel; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.dictionary.TypeDefinition; +import org.alfresco.service.cmr.repository.AssociationRef; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.ContentReader; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.search.QueryParameterDefinition; +import org.alfresco.service.cmr.search.SearchService; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.service.namespace.RegexQNamePattern; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.IContextListener; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.bean.BrowseBean; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.repository.MapNode; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.NodePropertyResolver; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.config.ViewsConfigElement; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.alfresco.web.ui.common.component.UIModeList; +import org.alfresco.web.ui.common.component.data.UIColumn; +import org.alfresco.web.ui.common.component.data.UIRichList; +import org.alfresco.web.ui.common.renderer.data.IRichListRenderer; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean providing properties and behaviour for the forums screens. + * + * @author gavinc + */ +public class ForumsBean implements IContextListener +{ + private static final long serialVersionUID = 7066410060288061436L; + + private static Log logger = LogFactory.getLog(ForumsBean.class); + private static final String PAGE_NAME_FORUMS = "forums"; + private static final String PAGE_NAME_FORUM = "forum"; + private static final String PAGE_NAME_TOPIC = "topic"; + + /** The NodeService to be used by the bean */ + transient private NodeService nodeService; + + /** The ContentService to be used by the bean */ + transient private ContentService contentService; + + /** The DictionaryService bean reference */ + transient private DictionaryService dictionaryService; + + /** The SearchService bean reference. */ + transient private SearchService searchService; + + /** The NamespaceService bean reference. */ + transient private NamespaceService namespaceService; + + /** The browse bean */ + protected BrowseBean browseBean; + + /** The NavigationBean bean reference */ + protected NavigationBean navigator; + + /** Views configuration object */ + protected ViewsConfigElement viewsConfig = null; + + /** Component references */ + protected UIRichList forumsRichList; + protected UIRichList forumRichList; + protected UIRichList topicRichList; + + /** Node lists */ + private List forums; + private List topics; + private List posts; + + /** The current forums view mode - set to a well known IRichListRenderer identifier */ + private String forumsViewMode; + + /** The current forums view page size */ + private int forumsPageSize; + + /** The current forum view mode - set to a well known IRichListRenderer identifier */ + private String forumViewMode; + + /** The current forum view page size */ + private int forumPageSize; + + /** The current topic view mode - set to a well known IRichListRenderer identifier */ + private String topicViewMode; + + /** The current topic view page size */ + private int topicPageSize; + + + // ------------------------------------------------------------------------------ + // Construction + + /** + * Default Constructor + */ + public ForumsBean() + { + UIContextService.getInstance(FacesContext.getCurrentInstance()).registerBean(this); + + initFromClientConfig(); + } + + + // ------------------------------------------------------------------------------ + // Bean property getters and setters + + /** + * @param nodeService The NodeService to set. + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + protected NodeService getNodeService() + { + if (nodeService == null) + { + nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return nodeService; + } + + /** + * Sets the content service to use + * + * @param contentService The ContentService + */ + public void setContentService(ContentService contentService) + { + this.contentService = contentService; + } + + protected ContentService getContentService() + { + if (contentService == null) + { + contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); + } + return contentService; + } + + /** + * @param dictionaryService The DictionaryService to set. + */ + public void setDictionaryService(DictionaryService dictionaryService) + { + this.dictionaryService = dictionaryService; + } + + protected DictionaryService getDictionaryService() + { + if (dictionaryService == null) + { + dictionaryService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getDictionaryService(); + } + return dictionaryService; + } + + /** + * @param searchService The SearchService to set. + */ + public void setSearchService(SearchService searchService) + { + this.searchService = searchService; + } + + protected SearchService getSearchService() + { + if (searchService == null) + { + searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); + } + return searchService; + } + + /** + * @param namespaceService The NamespaceService to set. + */ + public void setNamespaceService(NamespaceService namespaceService) + { + this.namespaceService = namespaceService; + } + + protected NamespaceService getNamespaceService() + { + if (namespaceService == null) + { + namespaceService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNamespaceService(); + } + return namespaceService; + } + + /** + * Sets the BrowseBean instance to use to retrieve the current document + * + * @param browseBean BrowseBean instance + */ + public void setBrowseBean(BrowseBean browseBean) + { + this.browseBean = browseBean; + } + + /** + * @param navigator The NavigationBean to set. + */ + public void setNavigator(NavigationBean navigator) + { + this.navigator = navigator; + } + + /** + * @param forumsRichList The forumsRichList to set. + */ + public void setForumsRichList(UIRichList forumsRichList) + { + this.forumsRichList = forumsRichList; + if (this.forumsRichList != null) + { + // set the initial sort column and direction + this.forumsRichList.setInitialSortColumn( + this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUMS)); + this.forumsRichList.setInitialSortDescending( + this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUMS)); + + // ETWOONE-183 & ETWOONE-339. For URL addressability of forums spaces + this.forumsRichList.setRefreshOnBind(true); + } + } + + /** + * @return Returns the forumsRichList. + */ + public UIRichList getForumsRichList() + { + return this.forumsRichList; + } + + /** + * @return Returns the forums View mode. See UIRichList + */ + public String getForumsViewMode() + { + return this.forumsViewMode; + } + + /** + * @param forumsViewMode The forums View mode to set. See UIRichList. + */ + public void setForumsViewMode(String forumsViewMode) + { + this.forumsViewMode = forumsViewMode; + } + + /** + * @return Returns the forumsPageSize. + */ + public int getForumsPageSize() + { + return this.forumsPageSize; + } + + /** + * @param forumsPageSize The forumsPageSize to set. + */ + public void setForumsPageSize(int forumsPageSize) + { + this.forumsPageSize = forumsPageSize; + } + + /** + * @param topicRichList The topicRichList to set. + */ + public void setTopicRichList(UIRichList topicRichList) + { + this.topicRichList = topicRichList; + + if (this.topicRichList != null) + { + // set the initial sort column and direction + this.topicRichList.setInitialSortColumn( + this.viewsConfig.getDefaultSortColumn(PAGE_NAME_TOPIC)); + this.topicRichList.setInitialSortDescending( + this.viewsConfig.hasDescendingSort(PAGE_NAME_TOPIC)); + + // ETWOONE-183. For URL addressability of topics: + this.topicRichList.setRefreshOnBind(true); + } + } + + /** + * @return Returns the topicRichList. + */ + public UIRichList getTopicRichList() + { + return this.topicRichList; + } + + /** + * @return Returns the topics View mode. See UIRichList + */ + public String getTopicViewMode() + { + return this.topicViewMode; + } + + /** + * @param topicViewMode The topic View mode to set. See UIRichList. + */ + public void setTopicViewMode(String topicViewMode) + { + this.topicViewMode = topicViewMode; + } + + /** + * @return Returns the topicsPageSize. + */ + public int getTopicPageSize() + { + return this.topicPageSize; + } + + /** + * @param topicPageSize The topicPageSize to set. + */ + public void setTopicPageSize(int topicPageSize) + { + this.topicPageSize = topicPageSize; + } + + /** + * @param forumRichList The forumRichList to set. + */ + public void setForumRichList(UIRichList forumRichList) + { + this.forumRichList = forumRichList; + + if (this.forumRichList != null) + { + // set the initial sort column and direction + this.forumRichList.setInitialSortColumn( + this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUM)); + this.forumRichList.setInitialSortDescending( + this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUM)); + + // ETWOONE-183 & ETWOONE-339. For URL addressability of forum spaces + this.forumRichList.setRefreshOnBind(true); + } + } + + /** + * @return Returns the forumRichList. + */ + public UIRichList getForumRichList() + { + return this.forumRichList; + } + + /** + * @return Returns the forum View mode. See UIRichList + */ + public String getForumViewMode() + { + return this.forumViewMode; + } + + /** + * @param forumViewMode The forum View mode to set. See UIRichList. + */ + public void setForumViewMode(String forumViewMode) + { + this.forumViewMode = forumViewMode; + } + + /** + * @return Returns the forumPageSize. + */ + public int getForumPageSize() + { + return this.forumPageSize; + } + + /** + * @param forumPageSize The forumPageSize to set. + */ + public void setForumPageSize(int forumPageSize) + { + this.forumPageSize = forumPageSize; + } + + public List getForums() + { + if (this.forums == null) + { + getNodes(); + } + + return this.forums; + } + + public List getTopics() + { + if (this.topics == null) + { + getNodes(); + } + + return this.topics; + } + + public List getPosts() + { + if (this.posts == null) + { + getNodes(); + } + + return this.posts; + } + + private void getNodes() + { + long startTime = 0; + if (logger.isDebugEnabled()) + startTime = System.currentTimeMillis(); + + UserTransaction tx = null; + try + { + FacesContext context = FacesContext.getCurrentInstance(); + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + // get the current space from NavigationBean + String parentNodeId = this.navigator.getCurrentNodeId(); + + NodeRef parentRef; + if (parentNodeId == null) + { + // no specific parent node specified - use the root node + parentRef = this.getNodeService().getRootNode(Repository.getStoreRef()); + } + else + { + // build a NodeRef for the specified Id and our store + parentRef = new NodeRef(Repository.getStoreRef(), parentNodeId); + } + + List childRefs = this.getNodeService().getChildAssocs(parentRef, + ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL); + this.forums = new ArrayList(childRefs.size()); + this.topics = new ArrayList(childRefs.size()); + this.posts = new ArrayList(childRefs.size()); + + for (ChildAssociationRef ref: childRefs) + { + // create our Node representation from the NodeRef + NodeRef nodeRef = ref.getChildRef(); + + if (this.getNodeService().exists(nodeRef)) + { + // find it's type so we can see if it's a node we are interested in + QName type = this.getNodeService().getType(nodeRef); + + // make sure the type is defined in the data dictionary + TypeDefinition typeDef = this.getDictionaryService().getType(type); + + if (typeDef != null) + { + // extract forums, forum, topic and post types + + if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_SYSTEM_FOLDER) == false) + { + if (this.getDictionaryService().isSubClass(type, ForumModel.TYPE_FORUMS) || + this.getDictionaryService().isSubClass(type, ForumModel.TYPE_FORUM)) + { + // create our Node representation + MapNode node = new MapNode(nodeRef, this.getNodeService(), true); + node.addPropertyResolver("icon", this.browseBean.resolverSpaceIcon); + node.addPropertyResolver("smallIcon", this.browseBean.resolverSmallIcon); + + this.forums.add(node); + } + if (this.getDictionaryService().isSubClass(type, ForumModel.TYPE_TOPIC)) + { + // create our Node representation + MapNode node = new MapNode(nodeRef, this.getNodeService(), true); + node.addPropertyResolver("icon", this.browseBean.resolverSpaceIcon); + node.addPropertyResolver("smallIcon", this.browseBean.resolverSmallIcon); + node.addPropertyResolver("replies", this.resolverReplies); + + this.topics.add(node); + } + else if (this.getDictionaryService().isSubClass(type, ForumModel.TYPE_POST)) + { + // create our Node representation + MapNode node = new MapNode(nodeRef, this.getNodeService(), true); + + this.browseBean.setupCommonBindingProperties(node); + node.addPropertyResolver("smallIcon", this.browseBean.resolverSmallIcon); + node.addPropertyResolver("message", this.resolverContent); + node.addPropertyResolver("replyTo", this.resolverReplyTo); + + this.posts.add(node); + } + } + } + else + { + if (logger.isWarnEnabled()) + logger.warn("Found invalid object in database: id = " + nodeRef + ", type = " + type); + } + } + } + + // commit the transaction + tx.commit(); + } + catch (InvalidNodeRefException refErr) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {refErr.getNodeRef()}) ); + this.forums = Collections.emptyList(); + this.topics = Collections.emptyList(); + this.posts = Collections.emptyList(); + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); + this.forums = Collections.emptyList(); + this.topics = Collections.emptyList(); + this.posts = Collections.emptyList(); + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + + if (logger.isDebugEnabled()) + { + long endTime = System.currentTimeMillis(); + logger.debug("Time to query and build forums nodes: " + (endTime - startTime) + "ms"); + } + } + + /** + * Returns the HTML to represent a bubble rendition of the text of the the + * forum article being replied to. + * + * @return The HTML for the bubble + */ + public String getReplyBubbleHTML() + { + try + { + // if the forum being replied to was a new post show the orange bubble + // with the user on the left otherwise show the yellow bubble with the + // user on the right. + StringWriter writer = new StringWriter(); + + FacesContext context = FacesContext.getCurrentInstance(); + Node replyToNode = this.browseBean.getDocument(); + boolean isReplyPost = this.getNodeService().hasAspect(replyToNode.getNodeRef(), + ContentModel.ASPECT_REFERENCING); + String contextPath = context.getExternalContext().getRequestContextPath(); + String colour = isReplyPost ? "yellow" : "orange"; + String bgColour = isReplyPost ? "#FFF5A3" : "#FCC75E"; + + // build the HTML to represent the user that posted the article being replied to + StringBuilder replyPosterHTML = new StringBuilder(""); + replyPosterHTML.append("
"); + replyPosterHTML.append((String)replyToNode.getProperties().get("creator")); + replyPosterHTML.append(""); + + // start the table + writer.write(""); + + if (isReplyPost) + { + renderReplyContentHTML(context, replyToNode, writer, contextPath, colour, bgColour); + writer.write(replyPosterHTML.toString()); + } + else + { + writer.write(replyPosterHTML.toString()); + renderReplyContentHTML(context, replyToNode, writer, contextPath, colour, bgColour); + } + + // finish the table + writer.write("
"); + + return writer.toString(); + } + catch (IOException ioe) + { + throw new AlfrescoRuntimeException("Failed to render reply bubble HTML", ioe); + } + } + + // ------------------------------------------------------------------------------ + // IContextListener implementation + + /** + * @see org.alfresco.web.app.context.IContextListener#contextUpdated() + */ + public void contextUpdated() + { + if (logger.isDebugEnabled()) + logger.debug("Invalidating forums components..."); + + // clear the value for the list components - will cause re-bind to it's data and refresh + if (this.forumsRichList != null) + { + this.forumsRichList.setValue(null); + if (this.forumsRichList.getInitialSortColumn() == null) + { + // set the initial sort column and direction + this.forumsRichList.setInitialSortColumn( + this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUMS)); + this.forumsRichList.setInitialSortDescending( + this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUMS)); + } + } + + if (this.forumRichList != null) + { + this.forumRichList.setValue(null); + if (this.forumRichList.getInitialSortColumn() == null) + { + // set the initial sort column and direction + this.forumRichList.setInitialSortColumn( + this.viewsConfig.getDefaultSortColumn(PAGE_NAME_FORUM)); + this.forumRichList.setInitialSortDescending( + this.viewsConfig.hasDescendingSort(PAGE_NAME_FORUM)); + } + } + + if (this.topicRichList != null) + { + this.topicRichList.setValue(null); + if (this.topicRichList.getInitialSortColumn() == null) + { + // set the initial sort column and direction + this.topicRichList.setInitialSortColumn( + this.viewsConfig.getDefaultSortColumn(PAGE_NAME_TOPIC)); + this.topicRichList.setInitialSortDescending( + this.viewsConfig.hasDescendingSort(PAGE_NAME_TOPIC)); + } + } + + // reset the lists + this.forums = null; + this.topics = null; + this.posts = null; + } + + /** + * @see org.alfresco.web.app.context.IContextListener#areaChanged() + */ + public void areaChanged() + { + // nothing to do + } + + /** + * @see org.alfresco.web.app.context.IContextListener#spaceChanged() + */ + public void spaceChanged() + { + // nothing to do + } + + // ------------------------------------------------------------------------------ + // Navigation action event handlers + + /** + * Change the current forums view mode based on user selection + * + * @param event ActionEvent + */ + public void forumsViewModeChanged(ActionEvent event) + { + UIModeList viewList = (UIModeList)event.getComponent(); + + // get the view mode ID + String viewMode = viewList.getValue().toString(); + + // push the view mode into the lists + setForumsViewMode(viewMode); + + // get the default for the forum page + this.forumsPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUMS, + this.forumsViewMode); + + if (logger.isDebugEnabled()) + logger.debug("Set default forums page size to: " + this.forumsPageSize); + } + + /** + * Change the current forum view mode based on user selection + * + * @param event ActionEvent + */ + public void forumViewModeChanged(ActionEvent event) + { + UIModeList viewList = (UIModeList)event.getComponent(); + + // get the view mode ID + String viewMode = viewList.getValue().toString(); + + // push the view mode into the lists + setForumViewMode(viewMode); + + // get the default for the forum page + this.forumPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUM, + this.forumViewMode); + + if (logger.isDebugEnabled()) + logger.debug("Set default forum page size to: " + this.forumPageSize); + } + + /** + * Change the current topic view mode based on user selection + * + * @param event ActionEvent + */ + public void topicViewModeChanged(ActionEvent event) + { + UIModeList viewList = (UIModeList)event.getComponent(); + + // get the view mode ID + String viewMode = viewList.getValue().toString(); + + // push the view mode into the lists + setTopicViewMode(viewMode); + + // change the default page size if necessary + this.topicPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_TOPIC, + this.topicViewMode); + + if (logger.isDebugEnabled()) + logger.debug("Set default topic page size to: " + this.topicPageSize); + } + + /** + * Event handler called when a user wants to view or participate + * in a discussion on an object + * + * @param event ActionEvent + */ + public void discuss(ActionEvent event) + { + UIActionLink link = (UIActionLink)event.getComponent(); + Map params = link.getParameterMap(); + String id = params.get("id"); + if (id == null || id.length() == 0) + { + throw new AlfrescoRuntimeException("discuss called without an id"); + } + + FacesContext context = FacesContext.getCurrentInstance(); + + NodeRef nodeRef = new NodeRef(Repository.getStoreRef(), id); + + if (this.getNodeService().hasAspect(nodeRef, ForumModel.ASPECT_DISCUSSABLE) == false) + { + throw new AlfrescoRuntimeException("discuss called for an object that does not have a discussion!"); + } + + // as the node has the discussable aspect there must be a discussions child assoc + List children = this.getNodeService().getChildAssocs(nodeRef, + ForumModel.ASSOC_DISCUSSION, RegexQNamePattern.MATCH_ALL); + + // there should only be one child, retrieve it if there is + if (children.size() == 1) + { + // show the forum for the discussion + NodeRef forumNodeRef = children.get(0).getChildRef(); + this.browseBean.clickSpace(forumNodeRef); + context.getApplication().getNavigationHandler().handleNavigation(context, null, "showForum"); + } + else + { + // this should never happen as the action evaluator should stop the action + // from displaying, just in case print a warning to the console + logger.warn("Node has the discussable aspect but does not have 1 child, it has " + + children.size() + " children!"); + } + } + + // ------------------------------------------------------------------------------ + // Property Resolvers + + public NodePropertyResolver resolverReplies = new NodePropertyResolver() { + private static final long serialVersionUID = -4800772273246202885L; + + public Object get(Node node) + { + // query for the number of posts within the given node + String repliesXPath = "./*[(subtypeOf('" + ForumModel.TYPE_POST + "'))]"; + List replies = getSearchService().selectNodes( + node.getNodeRef(), + repliesXPath, + new QueryParameterDefinition[] {}, + getNamespaceService(), + false); + + // reduce the count by 1 as one of the posts will be the initial post + int noReplies = replies.size() - 1; + + if (noReplies < 0) + { + noReplies = 0; + } + + return new Integer(noReplies); + } + }; + + public NodePropertyResolver resolverContent = new NodePropertyResolver() { + private static final long serialVersionUID = -2575377410105460440L; + + public Object get(Node node) + { + String content = null; + + // get the content property from the node and retrieve the + // full content as a string (obviously should only be used + // for small amounts of content) + ContentReader reader = getContentService().getReader(node.getNodeRef(), + ContentModel.PROP_CONTENT); + + if (reader != null) + { + content = Utils.stripUnsafeHTMLTags(reader.getContentString()); + } + + return content; + } + }; + + public NodePropertyResolver resolverReplyTo = new NodePropertyResolver() { + private static final long serialVersionUID = 2614901755220899360L; + + public Object get(Node node) + { + // determine if this node is a reply to another post, if so find + // the creator of the original poster + String replyTo = null; + + List assocs = getNodeService().getTargetAssocs(node.getNodeRef(), + ContentModel.ASSOC_REFERENCES); + + // there should only be one association, if there is more than one + // just get the first one + if (assocs.size() > 0) + { + AssociationRef assoc = assocs.get(0); + NodeRef target = assoc.getTargetRef(); + Node targetNode = new Node(target); + replyTo = (String)targetNode.getProperties().get("creator"); + } + + return replyTo; + } + }; + + /** + * Creates a file name for the message being posted + * + * @return The file name for the post + */ + public static String createPostFileName() + { + StringBuilder name = new StringBuilder("posted-"); + + // add a timestamp + SimpleDateFormat dateFormat = new SimpleDateFormat("dd-MM-yyyy-HH-mm-ss"); + name.append(dateFormat.format(new Date())); + + // add Universal Unique Identifier + // fix bugs ETWOONE-196 and ETWOONE-203 + name.append("-" + UUID.randomUUID()); + + // add the HTML file extension + name.append(".html"); + + return name.toString(); + } + + + // ------------------------------------------------------------------------------ + // Helpers + + /** + * Initialise default values from client configuration + */ + private void initFromClientConfig() + { + // TODO - review implications of these default values for dynamic/MT client + this.viewsConfig = (ViewsConfigElement)Application.getConfigService( + FacesContext.getCurrentInstance()).getConfig("Views"). + getConfigElement(ViewsConfigElement.CONFIG_ELEMENT_ID); + + // get the defaults for the forums page + this.forumsViewMode = this.viewsConfig.getDefaultView(PAGE_NAME_FORUMS); + this.forumsPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUMS, + this.forumsViewMode); + + // get the default for the forum page + this.forumViewMode = this.viewsConfig.getDefaultView(PAGE_NAME_FORUM); + this.forumPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_FORUM, + this.forumViewMode); + + // get the default for the topic page + this.topicViewMode = this.viewsConfig.getDefaultView(PAGE_NAME_TOPIC); + this.topicPageSize = this.viewsConfig.getDefaultPageSize(PAGE_NAME_TOPIC, + this.topicViewMode); + + if (logger.isDebugEnabled()) + { + logger.debug("Set default forums view mode to: " + this.forumsViewMode); + logger.debug("Set default forums page size to: " + this.forumsPageSize); + logger.debug("Set default forum view mode to: " + this.forumViewMode); + logger.debug("Set default forum page size to: " + this.forumPageSize); + logger.debug("Set default topic view mode to: " + this.topicViewMode); + logger.debug("Set default topic page size to: " + this.topicPageSize); + } + } + + protected void renderReplyContentHTML(FacesContext context, + Node replyToNode, StringWriter writer, + String contextPath, String colour, String bgColour) + throws IOException + { + // get the content of the article being replied to + String replyContent = ""; + ContentReader reader = this.getContentService().getReader(replyToNode.getNodeRef(), + ContentModel.PROP_CONTENT); + if (reader != null) + { + replyContent = Utils.stripUnsafeHTMLTags(reader.getContentString()); + } + + // get the date of the article being replied to + String postedDate = Utils.getDateTimeFormat(context). + format(replyToNode.getProperties().get("created")); + + // generate the HTML + writer.write(""); + TopicBubbleViewRenderer.renderBubbleTop(writer, contextPath, colour, bgColour); + writer.write(""); + writer.write(Application.getMessage(context, "posted")); + writer.write(": "); + writer.write(postedDate); + TopicBubbleViewRenderer.renderBubbleMiddle(writer, contextPath, colour); + writer.write(replyContent); + TopicBubbleViewRenderer.renderBubbleBottom(writer, contextPath, colour); + writer.write(""); + } + + /** + * Class to implement a bubble view for the RichList component used in the topics screen + * + * @author gavinc + */ + public static class TopicBubbleViewRenderer implements IRichListRenderer + { + private static final long serialVersionUID = -6641033880549363822L; + + public static final String VIEWMODEID = "bubble"; + + public String getViewModeID() + { + return VIEWMODEID; + } + + public void renderListBefore(FacesContext context, UIRichList richList, UIColumn[] columns) + throws IOException + { + // nothing to do + } + + public void renderListRow(FacesContext context, UIRichList richList, UIColumn[] columns, Object row) + throws IOException + { + ResponseWriter out = context.getResponseWriter(); + + // find primary column (which must exist) and the actions column (which doesn't + // have to exist) + UIColumn primaryColumn = null; + UIColumn actionsColumn = null; + for (int i = 0; i < columns.length; i++) + { + if (columns[i].isRendered()) + { + if (columns[i].getPrimary()) + { + primaryColumn = columns[i]; + } + else if (columns[i].getActions()) + { + actionsColumn = columns[i]; + } + } + } + + if (primaryColumn == null) + { + if (logger.isWarnEnabled()) + logger.warn("No primary column found for RichList definition: " + richList.getId()); + } + + out.write(""); + + Node node = (Node)row; + if (node.getProperties().get("replyTo") == null) + { + renderNewPostBubble(context, out, node, primaryColumn, actionsColumn, columns); + } + else + { + renderReplyToBubble(context, out, node, primaryColumn, actionsColumn, columns); + } + + out.write(""); + + // add a little padding + out.write("
"); + } + + public void renderListAfter(FacesContext context, UIRichList richList, UIColumn[] columns) + throws IOException + { + ResponseWriter out = context.getResponseWriter(); + + out.write(""); + for (Iterator i = richList.getChildren().iterator(); i.hasNext(); /**/) + { + // output all remaining child components that are not UIColumn + UIComponent child = (UIComponent)i.next(); + if (child instanceof UIColumn == false) + { + Utils.encodeRecursive(context, child); + } + } + out.write(""); + } + + /** + * Renders the top part of the bubble i.e. before the header + * + * @param out The writer to output to + * @param contextPath Context path of the application + * @param colour The colour of the bubble + * @param titleBgColour Background colour of the header area + */ + public static void renderBubbleTop(Writer out, String contextPath, + String colour, String titleBgColour) throws IOException + { + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write(""); + out.write("
"); + } + + /** + * Renders the middle part of the bubble i.e. after the header and before the body + * + * @param out The writer to output to + * @param contextPath Context path of the application + * @param colour The colour of the bubble + */ + public static void renderBubbleMiddle(Writer out, String contextPath, String colour) + throws IOException + { + out.write("
"); + } + + /** + * Renders the bottom part of the bubble i.e. after the body + * + * @param out The writer to output to + * @param contextPath Context path of the application + * @param colour The colour of the bubble + */ + public static void renderBubbleBottom(Writer out, String contextPath, String colour) + throws IOException + { + out.write("
"); + } + + /** + * Renders the new post speech bubble + * + * @param context Faces context + * @param out The response writer + * @param node The Node for the row being rendered + * @param primaryColumn The primary column containing the message content + * @param actionsColumn The actions column containing all the actions + * @param columns All configured columns + */ + private void renderNewPostBubble(FacesContext context, ResponseWriter out, Node node, + UIColumn primaryColumn, UIColumn actionsColumn, UIColumn[] columns) throws IOException + { + String contextPath = context.getExternalContext().getRequestContextPath(); + String colour = "orange"; + + out.write(""); + out.write("

"); + out.write((String)node.getProperties().get("creator")); + out.write("		"); + + renderBubbleTop(out, contextPath, colour, "#FCC75E"); + renderHeaderContents(context, out, primaryColumn, actionsColumn, columns); + renderBubbleMiddle(out, contextPath, colour); + renderBodyContents(context, primaryColumn); + renderBubbleBottom(out, contextPath, colour); + + out.write("
"); + } + + /** + * Renders the reply to post speech bubble + * + * @param context Faces context + * @param out The response writer + * @param node The Node for the row being rendered + * @param primaryColumn The primary column containing the message content + * @param actionsColumn The actions column containing all the actions + * @param columns All configured columns + */ + private void renderReplyToBubble(FacesContext context, ResponseWriter out, Node node, + UIColumn primaryColumn, UIColumn actionsColumn, UIColumn[] columns) throws IOException + { + String contextPath = context.getExternalContext().getRequestContextPath(); + String colour = "yellow"; + + out.write(""); + out.write("
"); + + renderBubbleTop(out, contextPath, colour, "#FFF5A3"); + renderHeaderContents(context, out, primaryColumn, actionsColumn, columns); + renderBubbleMiddle(out, contextPath, colour); + renderBodyContents(context, primaryColumn); + renderBubbleBottom(out, contextPath, colour); + + out.write("
"); + out.write((String)node.getProperties().get("creator")); + out.write("
"); + } + + private void renderHeaderContents(FacesContext context, ResponseWriter out, + UIColumn primaryColumn, UIColumn actionsColumn, UIColumn[] columns) throws IOException + { + // render the header area with the configured columns + out.write(""); + + for (int i = 0; i < columns.length; i++) + { + UIColumn column = columns[i]; + + if (column.isRendered() == true && + column.getPrimary() == false && + column.getActions() == false) + { + // render the column header as the label + UIComponent header = column.getFacet("header"); + if (header != null) + { + out.write(""); + } + + // render the contents of the column + if (column.getChildCount() != 0) + { + out.write(""); + } + } + } + + // render the actions column + out.write("
"); + Utils.encodeRecursive(context, header); + out.write(""); + Utils.encodeRecursive(context, column); + out.write(""); + if (actionsColumn != null && actionsColumn.getChildCount() != 0) + { + Utils.encodeRecursive(context, actionsColumn); + } + out.write("
"); + } + + /** + * Renders the body contents for the bubble using the given primary coumn + * + * @param context Faces context + * @param primaryColumn The primary column holding the message text + */ + private void renderBodyContents(FacesContext context, UIColumn primaryColumn) + throws IOException + { + // render the primary column + if (primaryColumn != null && primaryColumn.getChildCount() != 0) + { + Utils.encodeRecursive(context, primaryColumn); + } + } + } +} diff --git a/source/java/org/alfresco/web/bean/generator/AjaxTagPickerGenerator.java b/source/java/org/alfresco/web/bean/generator/AjaxTagPickerGenerator.java index 2a7a48a31a..1fdd1ab7de 100644 --- a/source/java/org/alfresco/web/bean/generator/AjaxTagPickerGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/AjaxTagPickerGenerator.java @@ -1,83 +1,83 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a category selector component. - * - * @author Mike Hatfield - */ -public class AjaxTagPickerGenerator extends BaseComponentGenerator -{ - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(RepoConstants.ALFRESCO_FACES_AJAX_TAG_PICKER); - FacesHelper.setupComponentId(context, component, id); - - return component; - } - - @Override - @SuppressWarnings("unchecked") - protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - // the category selector component is used whatever mode the property sheet is in - return generate(context, item.getName()); - } - - @Override - protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) - { - if (component instanceof UIMultiValueEditor) - { - // Override the setup of the mandatory validation - // so we can send the _current_value id suffix. - // We also enable real time so the page load - // check disables the ok button if necessary, as the user - // adds or removes items from the multi value list the - // page will be refreshed and therefore re-check the status. - - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_current_value"); - } - else - { - // Override the setup of the mandatory validation - // so we can send the _selected id suffix. - // We also enable real time so the page load check disabled - // the ok button if necessary, as the control is used the - // page will be refreshed and therefore re-check the status. - - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_selected"); - } - } - - @Override - protected ControlType getControlType() - { - return ControlType.SELECTOR; - } - - @Override - protected UIComponent setupMultiValuePropertyIfNecessary( - FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem property, PropertyDefinition propertyDef, - UIComponent component) - { - return component; - } - -} - +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a category selector component. + * + * @author Mike Hatfield + */ +public class AjaxTagPickerGenerator extends BaseComponentGenerator +{ + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(RepoConstants.ALFRESCO_FACES_AJAX_TAG_PICKER); + FacesHelper.setupComponentId(context, component, id); + + return component; + } + + @Override + @SuppressWarnings("unchecked") + protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + // the category selector component is used whatever mode the property sheet is in + return generate(context, item.getName()); + } + + @Override + protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) + { + if (component instanceof UIMultiValueEditor) + { + // Override the setup of the mandatory validation + // so we can send the _current_value id suffix. + // We also enable real time so the page load + // check disables the ok button if necessary, as the user + // adds or removes items from the multi value list the + // page will be refreshed and therefore re-check the status. + + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_current_value"); + } + else + { + // Override the setup of the mandatory validation + // so we can send the _selected id suffix. + // We also enable real time so the page load check disabled + // the ok button if necessary, as the control is used the + // page will be refreshed and therefore re-check the status. + + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_selected"); + } + } + + @Override + protected ControlType getControlType() + { + return ControlType.SELECTOR; + } + + @Override + protected UIComponent setupMultiValuePropertyIfNecessary( + FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem property, PropertyDefinition propertyDef, + UIComponent component) + { + return component; + } + +} + diff --git a/source/java/org/alfresco/web/bean/generator/AssociationGenerator.java b/source/java/org/alfresco/web/bean/generator/AssociationGenerator.java index 7a6e1d5e80..285253e413 100644 --- a/source/java/org/alfresco/web/bean/generator/AssociationGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/AssociationGenerator.java @@ -1,64 +1,64 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a component to manage associations. - * - * @author gavinc - */ -public class AssociationGenerator extends BaseComponentGenerator -{ - protected String optionsSize = null; - - public String getAvailableOptionsSize() - { - return this.optionsSize; - } - - public void setAvailableOptionsSize(String optionsSize) - { - this.optionsSize = optionsSize; - } - - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(RepoConstants.ALFRESCO_FACES_ASSOC_EDITOR); - FacesHelper.setupComponentId(context, component, id); - - // set the size of the list (if provided) - if (this.optionsSize != null) - { - component.getAttributes().put("availableOptionsSize", this.optionsSize); - } - - return component; - } - - @Override - protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) - { - // Override the setup of the mandatory validation - // so we can send the _current_value id suffix. - // We also enable real time so the page load - // check disables the ok button if necessary, as the user - // adds or removes items from the multi value list the - // page will be refreshed and therefore re-check the status. - // Only so this however id the component is not read-only - - if (item.isReadOnly() == false) - { - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_current_value"); - } - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a component to manage associations. + * + * @author gavinc + */ +public class AssociationGenerator extends BaseComponentGenerator +{ + protected String optionsSize = null; + + public String getAvailableOptionsSize() + { + return this.optionsSize; + } + + public void setAvailableOptionsSize(String optionsSize) + { + this.optionsSize = optionsSize; + } + + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(RepoConstants.ALFRESCO_FACES_ASSOC_EDITOR); + FacesHelper.setupComponentId(context, component, id); + + // set the size of the list (if provided) + if (this.optionsSize != null) + { + component.getAttributes().put("availableOptionsSize", this.optionsSize); + } + + return component; + } + + @Override + protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) + { + // Override the setup of the mandatory validation + // so we can send the _current_value id suffix. + // We also enable real time so the page load + // check disables the ok button if necessary, as the user + // adds or removes items from the multi value list the + // page will be refreshed and therefore re-check the status. + // Only so this however id the component is not read-only + + if (item.isReadOnly() == false) + { + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_current_value"); + } + } +} diff --git a/source/java/org/alfresco/web/bean/generator/BaseComponentGenerator.java b/source/java/org/alfresco/web/bean/generator/BaseComponentGenerator.java index 11ee7b8d6b..9fb5995ea6 100644 --- a/source/java/org/alfresco/web/bean/generator/BaseComponentGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/BaseComponentGenerator.java @@ -1,755 +1,755 @@ -package org.alfresco.web.bean.generator; - -import java.io.UnsupportedEncodingException; -import java.net.URLEncoder; -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.List; - -import javax.faces.FacesException; -import javax.faces.component.UIComponent; -import javax.faces.component.UIGraphic; -import javax.faces.component.UIOutput; -import javax.faces.context.FacesContext; -import javax.faces.convert.Converter; -import javax.faces.el.ValueBinding; - -import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint; -import org.alfresco.repo.dictionary.constraint.NumericRangeConstraint; -import org.alfresco.repo.dictionary.constraint.RegexConstraint; -import org.alfresco.repo.dictionary.constraint.StringLengthConstraint; -import org.alfresco.service.cmr.dictionary.AssociationDefinition; -import org.alfresco.service.cmr.dictionary.Constraint; -import org.alfresco.service.cmr.dictionary.ConstraintDefinition; -import org.alfresco.service.cmr.dictionary.DataTypeDefinition; -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.repository.DataDictionary; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; -import org.alfresco.web.ui.repo.component.property.BaseAssociationEditor; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIProperty; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; -import org.alfresco.web.ui.repo.component.property.UISeparator; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet.ClientValidation; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.util.StringUtils; -import org.springframework.web.jsf.FacesContextUtils; - -public abstract class BaseComponentGenerator implements IComponentGenerator -{ - private static Log logger = LogFactory.getLog(BaseComponentGenerator.class); - - protected enum ControlType { FIELD, SELECTOR; } - - protected DataDictionary dataDictionary; - - @SuppressWarnings("unchecked") - public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - UIComponent component = null; - - if (item instanceof UIProperty) - { - // get the property definition - PropertyDefinition propertyDef = getPropertyDefinition(context, - propertySheet.getNode(), item.getName()); - - // create the component and add it to the property sheet - component = createComponent(context, propertySheet, item); - - // setup the component for multi value editing if necessary - component = setupMultiValuePropertyIfNecessary(context, propertySheet, - item, propertyDef, component); - - // setup common aspects of the property i.e. value binding - setupProperty(context, propertySheet, item, propertyDef, component); - - // add the component now, it needs to be added before the validations - // are setup as we need access to the component id, which in turn needs - // to have a parent to get the correct id - item.getChildren().add(component); - - // setup the component for mandatory validation if necessary - setupMandatoryPropertyIfNecessary(context, propertySheet, item, - propertyDef, component); - - // setup any constraints the property has - setupConstraints(context, propertySheet, item, propertyDef, component); - - // setup any converter the property needs - setupConverter(context, propertySheet, item, propertyDef, component); - } - else if (item instanceof UISeparator) - { - // just create the component and add it - component = createComponent(context, propertySheet, item); - item.getChildren().add(component); - } - else - { - // get the association definition - AssociationDefinition assocationDef = this.getAssociationDefinition(context, - propertySheet.getNode(), item.getName()); - - // create the component and add it to the property sheet - component = createComponent(context, propertySheet, item); - - // setup common aspects of the association i.e. value binding - setupAssociation(context, propertySheet, item, assocationDef, component); - - // add the component now, it needs to be added before the validations - // are setup as we need access to the component id, which needs have a - // parent to get the correct id - item.getChildren().add(component); - - // setup the component for mandatory validation if necessary - setupMandatoryAssociationIfNecessary(context, propertySheet, item, - assocationDef, component); - - // setup any converter the association needs - setupConverter(context, propertySheet, item, assocationDef, component); - } - - return component; - } - - - /** - * Creates the component for the given proerty sheet item. - * - * @param context FacesContext - * @param propertySheet The property sheet being generated - * @param item The property or association being generated - * @return The newly created component - */ - @SuppressWarnings("unchecked") - protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - UIComponent component = null; - - if (item instanceof UIProperty) - { - if (propertySheet.inEditMode()) - { - // use the standard component in edit mode - component = generate(context, item.getName()); - } - else - { - // create an output text component in view mode - component = createOutputTextComponent(context, item.getName()); - } - } - else - { - // create the standard association component - component = generate(context, item.getName()); - } - - return component; - } - - /** - * Creates the converter with the given id and adds it to the component. - * - * @param context FacesContext - * @param converterId The name of the converter to create - * @param component The component to add the converter to - */ - protected void createAndSetConverter(FacesContext context, String converterId, - UIComponent component) - { - if (converterId != null && component instanceof UIOutput) - { - try - { - Converter conv = context.getApplication().createConverter(converterId); - ((UIOutput)component).setConverter(conv); - } - catch (NullPointerException npe) - { - // workaround a NPE bug in MyFaces - logger.warn("Converter " + converterId + " could not be applied"); - } - catch (FacesException fe) - { - logger.warn("Converter " + converterId + " could not be applied"); - } - } - } - - /** - * Creates an output text component. - * - * @param context FacesContext - * @param id Optional id to set - * @return The new component - */ - protected UIOutput createOutputTextComponent(FacesContext context, String id) - { - UIOutput component = (UIOutput)context.getApplication().createComponent( - ComponentConstants.JAVAX_FACES_OUTPUT); - - component.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); - FacesHelper.setupComponentId(context, component, id); - - return component; - } - - /** - * Sets up the property component i.e. setting the value binding - * - * @param context FacesContext - * @param propertySheet The property sheet - * @param item The parent component - * @param propertyDef The property definition - * @param component The component representing the property - */ - @SuppressWarnings("unchecked") - protected void setupProperty(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item, PropertyDefinition propertyDef, UIComponent component) - { - // create and set the value binding - ValueBinding vb = null; - - if (propertyDef != null) - { - vb = context.getApplication().createValueBinding( - "#{" + propertySheet.getVar() + ".properties[\"" + - propertyDef.getName().toString() + "\"]}"); - } - else - { - vb = context.getApplication().createValueBinding( - "#{" + propertySheet.getVar() + ".properties[\"" + - item.getName() + "\"]}"); - } - - component.setValueBinding("value", vb); - - // disable the component if it is read only or protected - // or if the property sheet is in view mode - if (propertySheet.inEditMode() == false || item.isReadOnly() || - (propertyDef != null && propertyDef.isProtected())) - { - component.getAttributes().put("disabled", Boolean.TRUE); - } - } - - /** - * Sets up the association component i.e. setting the value binding - * - * @param context FacesContext - * @param propertySheet The property sheet - * @param item The parent component - * @param associationDef The association definition - * @param component The component representing the association - */ - @SuppressWarnings("unchecked") - protected void setupAssociation(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item, AssociationDefinition associationDef, UIComponent component) - { - // create and set the value binding - ValueBinding vb = context.getApplication().createValueBinding( - "#{" + propertySheet.getVar() + "}"); - component.setValueBinding("value", vb); - - // set the association name and set to disabled if appropriate - ((BaseAssociationEditor)component).setAssociationName( - associationDef.getName().toString()); - - // disable the component if it is read only or protected - // or if the property sheet is in view mode - if (propertySheet.inEditMode() == false || item.isReadOnly() || - (associationDef != null && associationDef.isProtected())) - { - component.getAttributes().put("disabled", Boolean.TRUE); - } - } - - /** - * Creates a wrapper component around the given component to enable the user - * to edit multiple values. - * - * @param context FacesContext - * @param propertySheet The property sheet being generated - * @param property The property being generated - * @param propertyDef The data dictionary definition for the property - * @param component The component representing the property - * @return A wrapped component if the property is multi-valued or the - * original component if it is not multi-valued - */ - @SuppressWarnings("unchecked") - protected UIComponent setupMultiValuePropertyIfNecessary(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - UIComponent multiValueComponent = component; - - if (propertySheet.inEditMode() && property.isReadOnly() == false && - propertyDef != null && propertyDef.isProtected() == false && - propertyDef.isMultiValued()) - { - // if the property is multi-valued create a multi value editor wrapper component - String id = "multi_" + property.getName(); - multiValueComponent = context.getApplication().createComponent( - RepoConstants.ALFRESCO_FACES_MULTIVALUE_EDITOR); - FacesHelper.setupComponentId(context, multiValueComponent, id); - - // set the renderer depending on whether the item is a 'field' or a 'selector' - if (getControlType() == ControlType.FIELD) - { - multiValueComponent.setRendererType(RepoConstants.ALFRESCO_FACES_FIELD_RENDERER); - - // set flag to indicate the wrapped field is multilingual, if necessary - if (propertyDef.getDataType().getName().equals(DataTypeDefinition.MLTEXT)) - { - multiValueComponent.getAttributes().put("mltext", Boolean.TRUE); - } - } - else - { - multiValueComponent.setRendererType(RepoConstants.ALFRESCO_FACES_SELECTOR_RENDERER); - - // set the value binding for the wrapped component and the lastItemAdded attribute of - // the multi select component, needs to point somewhere that can hold any object, it - // will store the item last added by the user. - String expr = "#{MultiValueEditorBean.lastItemsAdded['" + - property.getName() + "']}"; - ValueBinding vb = context.getApplication().createValueBinding(expr); - multiValueComponent.setValueBinding("lastItemAdded", vb); - component.setValueBinding("value", vb); - } - - // add the original component as a child of the wrapper - multiValueComponent.getChildren().add(component); - } - - return multiValueComponent; - } - - /** - * Sets up a mandatory validation rule for the given property. - * - * @param context FacesContext - * @param propertySheet The property sheet being generated - * @param property The property being generated - * @param propertyDef The data dictionary definition of the property - * @param component The component representing the property - */ - @SuppressWarnings("unchecked") - protected void setupMandatoryPropertyIfNecessary(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - // only setup validations if the property sheet is in edit mode, - // validation is enabled and the property is declared as mandatory - if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && - propertyDef != null && propertyDef.isMandatory()) - { - setupMandatoryValidation(context, propertySheet, property, component, false, null); - setupMandatoryMarker(context, property); - } - } - - /** - * Sets up a mandatory validation rule for the given association. - * - * @param context FacesContext - * @param propertySheet The property sheet being generated - * @param association The association being generated - * @param associationDef The data dictionary definition of the association - * @param component The component representing the association - */ - protected void setupMandatoryAssociationIfNecessary(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem association, - AssociationDefinition associationDef, UIComponent component) - { - // only setup validations if the property sheet is in edit mode, - // validation is enabled and the association is declared as mandatory - if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && - associationDef != null && associationDef.isTargetMandatory()) - { - setupMandatoryValidation(context, propertySheet, association, component, false, null); - setupMandatoryMarker(context, association); - } - } - - /** - * Sets up a client mandatory validation rule with the property - * sheet for the given item. - * - * @param context FacesContext - * @param propertySheet The property sheet to add the validation rule to - * @param item The item being generated - * @param component The component representing the item - * @param realTimeChecking true to make the client validate as the user types - * @param idSuffix An optional suffix to add to the client id - */ - protected void setupMandatoryValidation(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem item, - UIComponent component, boolean realTimeChecking, - String idSuffix) - { - List params = new ArrayList(3); - - // add the value parameter - StringBuilder value = new StringBuilder("document.getElementById('"); - value.append(component.getClientId(context)); - if (idSuffix != null) - { - value.append(idSuffix); - } - value.append("')"); - params.add(value.toString()); - - // add the validation failed message to show (use the value of the - // label component of the given item) - String msg = Application.getMessage(context, "validation_mandatory"); - addStringConstraintParam(params, - MessageFormat.format(msg, new Object[] {item.getResolvedDisplayLabel()})); - - // add the validation case to the property sheet - propertySheet.addClientValidation(new ClientValidation("validateMandatory", - params, realTimeChecking)); - } - - /** - * Sets up the marker to show that the item is mandatory. - * - * @param context FacesContext - * @param item The item being generated - */ - @SuppressWarnings("unchecked") - protected void setupMandatoryMarker(FacesContext context, PropertySheetItem item) - { - // create the required field graphic - UIGraphic image = (UIGraphic)context.getApplication(). - createComponent(UIGraphic.COMPONENT_TYPE); - image.setUrl("/images/icons/required_field.gif"); - image.getAttributes().put("style", "padding-right: 4px;"); - - // add marker as child to the property sheet item - item.getChildren().add(image); - } - - /** - * Sets up client validation rules for any constraints the property has. - * - * @param context FacesContext - * propertySheet The property sheet being generated - * @param property The property being generated - * @param propertyDef The data dictionary definition of the property - * @param component The component representing the property - */ - protected void setupConstraints(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - // only setup constraints if the property sheet is in edit mode, - // validation is enabled - if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && - propertyDef != null) - { - List constraints = propertyDef.getConstraints(); - for (ConstraintDefinition constraintDef : constraints) - { - Constraint constraint = constraintDef.getConstraint(); - - if (constraint instanceof RegexConstraint) - { - setupRegexConstraint(context, propertySheet, property, component, - (RegexConstraint)constraint, false); - } - else if (constraint instanceof StringLengthConstraint) - { - setupStringLengthConstraint(context, propertySheet, property, component, - (StringLengthConstraint)constraint, false); - } - else if (constraint instanceof NumericRangeConstraint) - { - setupNumericRangeConstraint(context, propertySheet, property, component, - (NumericRangeConstraint)constraint, false); - } - else if (constraint instanceof ListOfValuesConstraint) - { - // NOTE: This is dealt with at the component creation stage - // as a different component is usually required. - } - } - } - } - - /** - * Sets up a default validation rule for the regular expression constraint - * - * @param context FacesContext - * @param propertySheet The property sheet to add the validation rule to - * @param property The property being generated - * @param component The component representing the property - * @param constraint The constraint to setup - * @param realTimeChecking true to make the client validate as the user types - */ - protected void setupRegexConstraint(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - UIComponent component, RegexConstraint constraint, - boolean realTimeChecking) - { - String expression = constraint.getExpression(); - boolean requiresMatch = constraint.getRequiresMatch(); - - List params = new ArrayList(3); - - // add the value parameter - String value = "document.getElementById('" + - component.getClientId(context) + - (component instanceof UIMultiValueEditor ? "_current_value" : "") + - "')"; - params.add(value); - - // add the regular expression parameter - try - { - // encode the expression so it can be unescaped by JavaScript - addStringConstraintParam(params, URLEncoder.encode(expression, "UTF-8")); - } - catch (UnsupportedEncodingException e) - { - // just add the expression as is - addStringConstraintParam(params, expression); - } - - // add the requiresMatch parameter - params.add(Boolean.toString(requiresMatch)); - - // add the validation failed messages - String matchMsg = Application.getMessage(context, "validation_regex"); - addStringConstraintParam(params, - MessageFormat.format(matchMsg, new Object[] {property.getResolvedDisplayLabel()})); - - String noMatchMsg = Application.getMessage(context, "validation_regex_not_match"); - addStringConstraintParam(params, - MessageFormat.format(noMatchMsg, new Object[] {property.getResolvedDisplayLabel()})); - - // add the validation case to the property sheet - propertySheet.addClientValidation(new ClientValidation((component instanceof UIMultiValueEditor ? "validateMultivalueRegex" : "validateRegex"), - params, realTimeChecking)); - } - - /** - * Sets up a default validation rule for the string length constraint - * - * @param context FacesContext - * @param propertySheet The property sheet to add the validation rule to - * @param property The property being generated - * @param component The component representing the property - * @param constraint The constraint to setup - * @param realTimeChecking true to make the client validate as the user types - */ - protected void setupStringLengthConstraint(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - UIComponent component, StringLengthConstraint constraint, - boolean realTimeChecking) - { - int min = constraint.getMinLength(); - int max = constraint.getMaxLength(); - - List params = new ArrayList(3); - - // add the value parameter - String value = "document.getElementById('" + - component.getClientId(context) + "')"; - params.add(value); - - // add the min parameter - params.add(Integer.toString(min)); - - // add the max parameter - params.add(Integer.toString(max)); - - // add the validation failed message to show - String msg = Application.getMessage(context, "validation_string_length"); - addStringConstraintParam(params, - MessageFormat.format(msg, new Object[] {property.getResolvedDisplayLabel(), min, max})); - - // add the validation case to the property sheet - propertySheet.addClientValidation(new ClientValidation("validateStringLength", - params, realTimeChecking)); - } - - /** - * Sets up a default validation rule for the numeric range constraint - * - * @param context FacesContext - * @param propertySheet The property sheet to add the validation rule to - * @param property The property being generated - * @param component The component representing the property - * @param constraint The constraint to setup - * @param realTimeChecking true to make the client validate as the user types - */ - protected void setupNumericRangeConstraint(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - UIComponent component, NumericRangeConstraint constraint, - boolean realTimeChecking) - { - double min = constraint.getMinValue(); - double max = constraint.getMaxValue(); - - List params = new ArrayList(3); - - // add the value parameter - String value = "document.getElementById('" + - component.getClientId(context) + "')"; - params.add(value); - - // add the min parameter - params.add(Double.toString(min)); - - // add the max parameter - params.add(Double.toString(max)); - - // add the validation failed message to show - String msg = Application.getMessage(context, "validation_numeric_range"); - addStringConstraintParam(params, - MessageFormat.format(msg, new Object[] {property.getResolvedDisplayLabel(), min, max})); - - // add the validation case to the property sheet - propertySheet.addClientValidation(new ClientValidation("validateNumberRange", - params, false)); - } - - /** - * Sets up the appropriate converter for the given property - * - * @param context FacesContext - * @param propertySheet The property sheet being generated - * @param property The property being generated - * @param propertyDef The data dictionary definition of the property - * @param component The component representing the property - */ - protected void setupConverter(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - if (property.getConverter() != null) - { - // create and add the custom converter - createAndSetConverter(context, property.getConverter(), component); - } - else if (propertySheet.inEditMode() == false && - propertyDef != null && propertyDef.isMultiValued()) - { - // if there isn't a custom converter and the property is - // multi-valued add the multi value converter as a default - createAndSetConverter(context, RepoConstants.ALFRESCO_FACES_MULTIVALUE_CONVERTER, - component); - } - } - - /** - * Sets up the appropriate converter for the given association - * - * @param context FacesContext - * @param propertySheet The property sheet being generated - * @param association The association being generated - * @param associationDef The data dictionary definition of the property - * @param component The component representing the association - */ - protected void setupConverter(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem association, - AssociationDefinition associationDef, UIComponent component) - { - if (association.getConverter() != null) - { - // create and add the custom converter - createAndSetConverter(context, association.getConverter(), component); - } - } - - /** - * Returns the type of the control being generated - * - * @return The type of the control either a FIELD or a SELECTOR - */ - protected ControlType getControlType() - { - return ControlType.FIELD; - } - - /** - * Retrieve the PropertyDefinition for the given property name on the given node - * - * @param node The node to get the property definition from - * @param propertyName The name of the property - * @return PropertyDefinition for the node or null if a definition can not be found - */ - protected PropertyDefinition getPropertyDefinition(FacesContext context, - Node node, String propertyName) - { - return getDataDictionary(context).getPropertyDefinition(node, propertyName); - } - - /** - * Retrieve the AssociationDefinition for the given property name on the given node - * - * @param node The node to get the association definition from - * @param associationName The name of the property - * @return AssociationDefinition for the node or null if a definition can not be found - */ - protected AssociationDefinition getAssociationDefinition(FacesContext context, - Node node, String associationName) - { - return getDataDictionary(context).getAssociationDefinition(node, associationName); - } - - /** - * Adds the given string parameter to the list of parameters to be used for - * validating constraints on the client. - * This method adds the quotes around the given parameter and also escapes - * any ocurrences of the double quote character. - * - * @param params The list of parameters for the constraint - * @param param The string parameter to add - */ - protected void addStringConstraintParam(List params, String param) - { - params.add("\"" + StringUtils.replace(param, "\"", "\\\"") + "\""); - } - - private DataDictionary getDataDictionary(FacesContext context) - { - if (this.dataDictionary == null) - { - this.dataDictionary = (DataDictionary)FacesContextUtils.getRequiredWebApplicationContext( - context).getBean(Application.BEAN_DATA_DICTIONARY); - } - - return this.dataDictionary; - } - - public boolean isEnabledInEditMode (FacesContext context, UIComponent control, PropertyDefinition propDef) - { - // get type info for the property - DataTypeDefinition dataTypeDef = propDef.getDataType(); - QName typeName = dataTypeDef.getName(); - if (typeName.equals(DataTypeDefinition.NODE_REF) || typeName.equals(DataTypeDefinition.PATH) || - typeName.equals(DataTypeDefinition.CONTENT) || typeName.equals(DataTypeDefinition.QNAME) || - typeName.equals(DataTypeDefinition.CHILD_ASSOC_REF) || typeName.equals(DataTypeDefinition.ASSOC_REF)) - { - return false; - } - else - { - return true; - } - } -} +package org.alfresco.web.bean.generator; + +import java.io.UnsupportedEncodingException; +import java.net.URLEncoder; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.List; + +import javax.faces.FacesException; +import javax.faces.component.UIComponent; +import javax.faces.component.UIGraphic; +import javax.faces.component.UIOutput; +import javax.faces.context.FacesContext; +import javax.faces.convert.Converter; +import javax.faces.el.ValueBinding; + +import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint; +import org.alfresco.repo.dictionary.constraint.NumericRangeConstraint; +import org.alfresco.repo.dictionary.constraint.RegexConstraint; +import org.alfresco.repo.dictionary.constraint.StringLengthConstraint; +import org.alfresco.service.cmr.dictionary.AssociationDefinition; +import org.alfresco.service.cmr.dictionary.Constraint; +import org.alfresco.service.cmr.dictionary.ConstraintDefinition; +import org.alfresco.service.cmr.dictionary.DataTypeDefinition; +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.repository.DataDictionary; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; +import org.alfresco.web.ui.repo.component.property.BaseAssociationEditor; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIProperty; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; +import org.alfresco.web.ui.repo.component.property.UISeparator; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet.ClientValidation; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.util.StringUtils; +import org.springframework.web.jsf.FacesContextUtils; + +public abstract class BaseComponentGenerator implements IComponentGenerator +{ + private static Log logger = LogFactory.getLog(BaseComponentGenerator.class); + + protected enum ControlType { FIELD, SELECTOR; } + + protected DataDictionary dataDictionary; + + @SuppressWarnings("unchecked") + public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + UIComponent component = null; + + if (item instanceof UIProperty) + { + // get the property definition + PropertyDefinition propertyDef = getPropertyDefinition(context, + propertySheet.getNode(), item.getName()); + + // create the component and add it to the property sheet + component = createComponent(context, propertySheet, item); + + // setup the component for multi value editing if necessary + component = setupMultiValuePropertyIfNecessary(context, propertySheet, + item, propertyDef, component); + + // setup common aspects of the property i.e. value binding + setupProperty(context, propertySheet, item, propertyDef, component); + + // add the component now, it needs to be added before the validations + // are setup as we need access to the component id, which in turn needs + // to have a parent to get the correct id + item.getChildren().add(component); + + // setup the component for mandatory validation if necessary + setupMandatoryPropertyIfNecessary(context, propertySheet, item, + propertyDef, component); + + // setup any constraints the property has + setupConstraints(context, propertySheet, item, propertyDef, component); + + // setup any converter the property needs + setupConverter(context, propertySheet, item, propertyDef, component); + } + else if (item instanceof UISeparator) + { + // just create the component and add it + component = createComponent(context, propertySheet, item); + item.getChildren().add(component); + } + else + { + // get the association definition + AssociationDefinition assocationDef = this.getAssociationDefinition(context, + propertySheet.getNode(), item.getName()); + + // create the component and add it to the property sheet + component = createComponent(context, propertySheet, item); + + // setup common aspects of the association i.e. value binding + setupAssociation(context, propertySheet, item, assocationDef, component); + + // add the component now, it needs to be added before the validations + // are setup as we need access to the component id, which needs have a + // parent to get the correct id + item.getChildren().add(component); + + // setup the component for mandatory validation if necessary + setupMandatoryAssociationIfNecessary(context, propertySheet, item, + assocationDef, component); + + // setup any converter the association needs + setupConverter(context, propertySheet, item, assocationDef, component); + } + + return component; + } + + + /** + * Creates the component for the given proerty sheet item. + * + * @param context FacesContext + * @param propertySheet The property sheet being generated + * @param item The property or association being generated + * @return The newly created component + */ + @SuppressWarnings("unchecked") + protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + UIComponent component = null; + + if (item instanceof UIProperty) + { + if (propertySheet.inEditMode()) + { + // use the standard component in edit mode + component = generate(context, item.getName()); + } + else + { + // create an output text component in view mode + component = createOutputTextComponent(context, item.getName()); + } + } + else + { + // create the standard association component + component = generate(context, item.getName()); + } + + return component; + } + + /** + * Creates the converter with the given id and adds it to the component. + * + * @param context FacesContext + * @param converterId The name of the converter to create + * @param component The component to add the converter to + */ + protected void createAndSetConverter(FacesContext context, String converterId, + UIComponent component) + { + if (converterId != null && component instanceof UIOutput) + { + try + { + Converter conv = context.getApplication().createConverter(converterId); + ((UIOutput)component).setConverter(conv); + } + catch (NullPointerException npe) + { + // workaround a NPE bug in MyFaces + logger.warn("Converter " + converterId + " could not be applied"); + } + catch (FacesException fe) + { + logger.warn("Converter " + converterId + " could not be applied"); + } + } + } + + /** + * Creates an output text component. + * + * @param context FacesContext + * @param id Optional id to set + * @return The new component + */ + protected UIOutput createOutputTextComponent(FacesContext context, String id) + { + UIOutput component = (UIOutput)context.getApplication().createComponent( + ComponentConstants.JAVAX_FACES_OUTPUT); + + component.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); + FacesHelper.setupComponentId(context, component, id); + + return component; + } + + /** + * Sets up the property component i.e. setting the value binding + * + * @param context FacesContext + * @param propertySheet The property sheet + * @param item The parent component + * @param propertyDef The property definition + * @param component The component representing the property + */ + @SuppressWarnings("unchecked") + protected void setupProperty(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item, PropertyDefinition propertyDef, UIComponent component) + { + // create and set the value binding + ValueBinding vb = null; + + if (propertyDef != null) + { + vb = context.getApplication().createValueBinding( + "#{" + propertySheet.getVar() + ".properties[\"" + + propertyDef.getName().toString() + "\"]}"); + } + else + { + vb = context.getApplication().createValueBinding( + "#{" + propertySheet.getVar() + ".properties[\"" + + item.getName() + "\"]}"); + } + + component.setValueBinding("value", vb); + + // disable the component if it is read only or protected + // or if the property sheet is in view mode + if (propertySheet.inEditMode() == false || item.isReadOnly() || + (propertyDef != null && propertyDef.isProtected())) + { + component.getAttributes().put("disabled", Boolean.TRUE); + } + } + + /** + * Sets up the association component i.e. setting the value binding + * + * @param context FacesContext + * @param propertySheet The property sheet + * @param item The parent component + * @param associationDef The association definition + * @param component The component representing the association + */ + @SuppressWarnings("unchecked") + protected void setupAssociation(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item, AssociationDefinition associationDef, UIComponent component) + { + // create and set the value binding + ValueBinding vb = context.getApplication().createValueBinding( + "#{" + propertySheet.getVar() + "}"); + component.setValueBinding("value", vb); + + // set the association name and set to disabled if appropriate + ((BaseAssociationEditor)component).setAssociationName( + associationDef.getName().toString()); + + // disable the component if it is read only or protected + // or if the property sheet is in view mode + if (propertySheet.inEditMode() == false || item.isReadOnly() || + (associationDef != null && associationDef.isProtected())) + { + component.getAttributes().put("disabled", Boolean.TRUE); + } + } + + /** + * Creates a wrapper component around the given component to enable the user + * to edit multiple values. + * + * @param context FacesContext + * @param propertySheet The property sheet being generated + * @param property The property being generated + * @param propertyDef The data dictionary definition for the property + * @param component The component representing the property + * @return A wrapped component if the property is multi-valued or the + * original component if it is not multi-valued + */ + @SuppressWarnings("unchecked") + protected UIComponent setupMultiValuePropertyIfNecessary(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + UIComponent multiValueComponent = component; + + if (propertySheet.inEditMode() && property.isReadOnly() == false && + propertyDef != null && propertyDef.isProtected() == false && + propertyDef.isMultiValued()) + { + // if the property is multi-valued create a multi value editor wrapper component + String id = "multi_" + property.getName(); + multiValueComponent = context.getApplication().createComponent( + RepoConstants.ALFRESCO_FACES_MULTIVALUE_EDITOR); + FacesHelper.setupComponentId(context, multiValueComponent, id); + + // set the renderer depending on whether the item is a 'field' or a 'selector' + if (getControlType() == ControlType.FIELD) + { + multiValueComponent.setRendererType(RepoConstants.ALFRESCO_FACES_FIELD_RENDERER); + + // set flag to indicate the wrapped field is multilingual, if necessary + if (propertyDef.getDataType().getName().equals(DataTypeDefinition.MLTEXT)) + { + multiValueComponent.getAttributes().put("mltext", Boolean.TRUE); + } + } + else + { + multiValueComponent.setRendererType(RepoConstants.ALFRESCO_FACES_SELECTOR_RENDERER); + + // set the value binding for the wrapped component and the lastItemAdded attribute of + // the multi select component, needs to point somewhere that can hold any object, it + // will store the item last added by the user. + String expr = "#{MultiValueEditorBean.lastItemsAdded['" + + property.getName() + "']}"; + ValueBinding vb = context.getApplication().createValueBinding(expr); + multiValueComponent.setValueBinding("lastItemAdded", vb); + component.setValueBinding("value", vb); + } + + // add the original component as a child of the wrapper + multiValueComponent.getChildren().add(component); + } + + return multiValueComponent; + } + + /** + * Sets up a mandatory validation rule for the given property. + * + * @param context FacesContext + * @param propertySheet The property sheet being generated + * @param property The property being generated + * @param propertyDef The data dictionary definition of the property + * @param component The component representing the property + */ + @SuppressWarnings("unchecked") + protected void setupMandatoryPropertyIfNecessary(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + // only setup validations if the property sheet is in edit mode, + // validation is enabled and the property is declared as mandatory + if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && + propertyDef != null && propertyDef.isMandatory()) + { + setupMandatoryValidation(context, propertySheet, property, component, false, null); + setupMandatoryMarker(context, property); + } + } + + /** + * Sets up a mandatory validation rule for the given association. + * + * @param context FacesContext + * @param propertySheet The property sheet being generated + * @param association The association being generated + * @param associationDef The data dictionary definition of the association + * @param component The component representing the association + */ + protected void setupMandatoryAssociationIfNecessary(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem association, + AssociationDefinition associationDef, UIComponent component) + { + // only setup validations if the property sheet is in edit mode, + // validation is enabled and the association is declared as mandatory + if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && + associationDef != null && associationDef.isTargetMandatory()) + { + setupMandatoryValidation(context, propertySheet, association, component, false, null); + setupMandatoryMarker(context, association); + } + } + + /** + * Sets up a client mandatory validation rule with the property + * sheet for the given item. + * + * @param context FacesContext + * @param propertySheet The property sheet to add the validation rule to + * @param item The item being generated + * @param component The component representing the item + * @param realTimeChecking true to make the client validate as the user types + * @param idSuffix An optional suffix to add to the client id + */ + protected void setupMandatoryValidation(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem item, + UIComponent component, boolean realTimeChecking, + String idSuffix) + { + List params = new ArrayList(3); + + // add the value parameter + StringBuilder value = new StringBuilder("document.getElementById('"); + value.append(component.getClientId(context)); + if (idSuffix != null) + { + value.append(idSuffix); + } + value.append("')"); + params.add(value.toString()); + + // add the validation failed message to show (use the value of the + // label component of the given item) + String msg = Application.getMessage(context, "validation_mandatory"); + addStringConstraintParam(params, + MessageFormat.format(msg, new Object[] {item.getResolvedDisplayLabel()})); + + // add the validation case to the property sheet + propertySheet.addClientValidation(new ClientValidation("validateMandatory", + params, realTimeChecking)); + } + + /** + * Sets up the marker to show that the item is mandatory. + * + * @param context FacesContext + * @param item The item being generated + */ + @SuppressWarnings("unchecked") + protected void setupMandatoryMarker(FacesContext context, PropertySheetItem item) + { + // create the required field graphic + UIGraphic image = (UIGraphic)context.getApplication(). + createComponent(UIGraphic.COMPONENT_TYPE); + image.setUrl("/images/icons/required_field.gif"); + image.getAttributes().put("style", "padding-right: 4px;"); + + // add marker as child to the property sheet item + item.getChildren().add(image); + } + + /** + * Sets up client validation rules for any constraints the property has. + * + * @param context FacesContext + * propertySheet The property sheet being generated + * @param property The property being generated + * @param propertyDef The data dictionary definition of the property + * @param component The component representing the property + */ + protected void setupConstraints(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + // only setup constraints if the property sheet is in edit mode, + // validation is enabled + if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && + propertyDef != null) + { + List constraints = propertyDef.getConstraints(); + for (ConstraintDefinition constraintDef : constraints) + { + Constraint constraint = constraintDef.getConstraint(); + + if (constraint instanceof RegexConstraint) + { + setupRegexConstraint(context, propertySheet, property, component, + (RegexConstraint)constraint, false); + } + else if (constraint instanceof StringLengthConstraint) + { + setupStringLengthConstraint(context, propertySheet, property, component, + (StringLengthConstraint)constraint, false); + } + else if (constraint instanceof NumericRangeConstraint) + { + setupNumericRangeConstraint(context, propertySheet, property, component, + (NumericRangeConstraint)constraint, false); + } + else if (constraint instanceof ListOfValuesConstraint) + { + // NOTE: This is dealt with at the component creation stage + // as a different component is usually required. + } + } + } + } + + /** + * Sets up a default validation rule for the regular expression constraint + * + * @param context FacesContext + * @param propertySheet The property sheet to add the validation rule to + * @param property The property being generated + * @param component The component representing the property + * @param constraint The constraint to setup + * @param realTimeChecking true to make the client validate as the user types + */ + protected void setupRegexConstraint(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + UIComponent component, RegexConstraint constraint, + boolean realTimeChecking) + { + String expression = constraint.getExpression(); + boolean requiresMatch = constraint.getRequiresMatch(); + + List params = new ArrayList(3); + + // add the value parameter + String value = "document.getElementById('" + + component.getClientId(context) + + (component instanceof UIMultiValueEditor ? "_current_value" : "") + + "')"; + params.add(value); + + // add the regular expression parameter + try + { + // encode the expression so it can be unescaped by JavaScript + addStringConstraintParam(params, URLEncoder.encode(expression, "UTF-8")); + } + catch (UnsupportedEncodingException e) + { + // just add the expression as is + addStringConstraintParam(params, expression); + } + + // add the requiresMatch parameter + params.add(Boolean.toString(requiresMatch)); + + // add the validation failed messages + String matchMsg = Application.getMessage(context, "validation_regex"); + addStringConstraintParam(params, + MessageFormat.format(matchMsg, new Object[] {property.getResolvedDisplayLabel()})); + + String noMatchMsg = Application.getMessage(context, "validation_regex_not_match"); + addStringConstraintParam(params, + MessageFormat.format(noMatchMsg, new Object[] {property.getResolvedDisplayLabel()})); + + // add the validation case to the property sheet + propertySheet.addClientValidation(new ClientValidation((component instanceof UIMultiValueEditor ? "validateMultivalueRegex" : "validateRegex"), + params, realTimeChecking)); + } + + /** + * Sets up a default validation rule for the string length constraint + * + * @param context FacesContext + * @param propertySheet The property sheet to add the validation rule to + * @param property The property being generated + * @param component The component representing the property + * @param constraint The constraint to setup + * @param realTimeChecking true to make the client validate as the user types + */ + protected void setupStringLengthConstraint(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + UIComponent component, StringLengthConstraint constraint, + boolean realTimeChecking) + { + int min = constraint.getMinLength(); + int max = constraint.getMaxLength(); + + List params = new ArrayList(3); + + // add the value parameter + String value = "document.getElementById('" + + component.getClientId(context) + "')"; + params.add(value); + + // add the min parameter + params.add(Integer.toString(min)); + + // add the max parameter + params.add(Integer.toString(max)); + + // add the validation failed message to show + String msg = Application.getMessage(context, "validation_string_length"); + addStringConstraintParam(params, + MessageFormat.format(msg, new Object[] {property.getResolvedDisplayLabel(), min, max})); + + // add the validation case to the property sheet + propertySheet.addClientValidation(new ClientValidation("validateStringLength", + params, realTimeChecking)); + } + + /** + * Sets up a default validation rule for the numeric range constraint + * + * @param context FacesContext + * @param propertySheet The property sheet to add the validation rule to + * @param property The property being generated + * @param component The component representing the property + * @param constraint The constraint to setup + * @param realTimeChecking true to make the client validate as the user types + */ + protected void setupNumericRangeConstraint(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + UIComponent component, NumericRangeConstraint constraint, + boolean realTimeChecking) + { + double min = constraint.getMinValue(); + double max = constraint.getMaxValue(); + + List params = new ArrayList(3); + + // add the value parameter + String value = "document.getElementById('" + + component.getClientId(context) + "')"; + params.add(value); + + // add the min parameter + params.add(Double.toString(min)); + + // add the max parameter + params.add(Double.toString(max)); + + // add the validation failed message to show + String msg = Application.getMessage(context, "validation_numeric_range"); + addStringConstraintParam(params, + MessageFormat.format(msg, new Object[] {property.getResolvedDisplayLabel(), min, max})); + + // add the validation case to the property sheet + propertySheet.addClientValidation(new ClientValidation("validateNumberRange", + params, false)); + } + + /** + * Sets up the appropriate converter for the given property + * + * @param context FacesContext + * @param propertySheet The property sheet being generated + * @param property The property being generated + * @param propertyDef The data dictionary definition of the property + * @param component The component representing the property + */ + protected void setupConverter(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + if (property.getConverter() != null) + { + // create and add the custom converter + createAndSetConverter(context, property.getConverter(), component); + } + else if (propertySheet.inEditMode() == false && + propertyDef != null && propertyDef.isMultiValued()) + { + // if there isn't a custom converter and the property is + // multi-valued add the multi value converter as a default + createAndSetConverter(context, RepoConstants.ALFRESCO_FACES_MULTIVALUE_CONVERTER, + component); + } + } + + /** + * Sets up the appropriate converter for the given association + * + * @param context FacesContext + * @param propertySheet The property sheet being generated + * @param association The association being generated + * @param associationDef The data dictionary definition of the property + * @param component The component representing the association + */ + protected void setupConverter(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem association, + AssociationDefinition associationDef, UIComponent component) + { + if (association.getConverter() != null) + { + // create and add the custom converter + createAndSetConverter(context, association.getConverter(), component); + } + } + + /** + * Returns the type of the control being generated + * + * @return The type of the control either a FIELD or a SELECTOR + */ + protected ControlType getControlType() + { + return ControlType.FIELD; + } + + /** + * Retrieve the PropertyDefinition for the given property name on the given node + * + * @param node The node to get the property definition from + * @param propertyName The name of the property + * @return PropertyDefinition for the node or null if a definition can not be found + */ + protected PropertyDefinition getPropertyDefinition(FacesContext context, + Node node, String propertyName) + { + return getDataDictionary(context).getPropertyDefinition(node, propertyName); + } + + /** + * Retrieve the AssociationDefinition for the given property name on the given node + * + * @param node The node to get the association definition from + * @param associationName The name of the property + * @return AssociationDefinition for the node or null if a definition can not be found + */ + protected AssociationDefinition getAssociationDefinition(FacesContext context, + Node node, String associationName) + { + return getDataDictionary(context).getAssociationDefinition(node, associationName); + } + + /** + * Adds the given string parameter to the list of parameters to be used for + * validating constraints on the client. + * This method adds the quotes around the given parameter and also escapes + * any ocurrences of the double quote character. + * + * @param params The list of parameters for the constraint + * @param param The string parameter to add + */ + protected void addStringConstraintParam(List params, String param) + { + params.add("\"" + StringUtils.replace(param, "\"", "\\\"") + "\""); + } + + private DataDictionary getDataDictionary(FacesContext context) + { + if (this.dataDictionary == null) + { + this.dataDictionary = (DataDictionary)FacesContextUtils.getRequiredWebApplicationContext( + context).getBean(Application.BEAN_DATA_DICTIONARY); + } + + return this.dataDictionary; + } + + public boolean isEnabledInEditMode (FacesContext context, UIComponent control, PropertyDefinition propDef) + { + // get type info for the property + DataTypeDefinition dataTypeDef = propDef.getDataType(); + QName typeName = dataTypeDef.getName(); + if (typeName.equals(DataTypeDefinition.NODE_REF) || typeName.equals(DataTypeDefinition.PATH) || + typeName.equals(DataTypeDefinition.CONTENT) || typeName.equals(DataTypeDefinition.QNAME) || + typeName.equals(DataTypeDefinition.CHILD_ASSOC_REF) || typeName.equals(DataTypeDefinition.ASSOC_REF)) + { + return false; + } + else + { + return true; + } + } +} diff --git a/source/java/org/alfresco/web/bean/generator/CategorySelectorGenerator.java b/source/java/org/alfresco/web/bean/generator/CategorySelectorGenerator.java index 00a8f9fb4f..b06cf59b77 100644 --- a/source/java/org/alfresco/web/bean/generator/CategorySelectorGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/CategorySelectorGenerator.java @@ -1,71 +1,71 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a category selector component. - * - * @author gavinc - */ -public class CategorySelectorGenerator extends BaseComponentGenerator -{ - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(RepoConstants.ALFRESCO_FACES_CATEGORY_SELECTOR); - FacesHelper.setupComponentId(context, component, id); - - return component; - } - - @Override - @SuppressWarnings("unchecked") - protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - // the category selector component is used whatever mode the property sheet is in - return generate(context, item.getName()); - } - - @Override - protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) - { - if (component instanceof UIMultiValueEditor) - { - // Override the setup of the mandatory validation - // so we can send the _current_value id suffix. - // We also enable real time so the page load - // check disables the ok button if necessary, as the user - // adds or removes items from the multi value list the - // page will be refreshed and therefore re-check the status. - - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_current_value"); - } - else - { - // Override the setup of the mandatory validation - // so we can send the _selected id suffix. - // We also enable real time so the page load check disabled - // the ok button if necessary, as the control is used the - // page will be refreshed and therefore re-check the status. - - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_selected"); - } - } - - @Override - protected ControlType getControlType() - { - return ControlType.SELECTOR; - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a category selector component. + * + * @author gavinc + */ +public class CategorySelectorGenerator extends BaseComponentGenerator +{ + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(RepoConstants.ALFRESCO_FACES_CATEGORY_SELECTOR); + FacesHelper.setupComponentId(context, component, id); + + return component; + } + + @Override + @SuppressWarnings("unchecked") + protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + // the category selector component is used whatever mode the property sheet is in + return generate(context, item.getName()); + } + + @Override + protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) + { + if (component instanceof UIMultiValueEditor) + { + // Override the setup of the mandatory validation + // so we can send the _current_value id suffix. + // We also enable real time so the page load + // check disables the ok button if necessary, as the user + // adds or removes items from the multi value list the + // page will be refreshed and therefore re-check the status. + + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_current_value"); + } + else + { + // Override the setup of the mandatory validation + // so we can send the _selected id suffix. + // We also enable real time so the page load check disabled + // the ok button if necessary, as the control is used the + // page will be refreshed and therefore re-check the status. + + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_selected"); + } + } + + @Override + protected ControlType getControlType() + { + return ControlType.SELECTOR; + } +} diff --git a/source/java/org/alfresco/web/bean/generator/CheckboxGenerator.java b/source/java/org/alfresco/web/bean/generator/CheckboxGenerator.java index 32299f803e..8ef919547e 100644 --- a/source/java/org/alfresco/web/bean/generator/CheckboxGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/CheckboxGenerator.java @@ -1,60 +1,60 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.common.converter.BooleanLabelConverter; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a checkbox component. - * - * @author gavinc - */ -public class CheckboxGenerator extends BaseComponentGenerator -{ - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(ComponentConstants.JAVAX_FACES_SELECT_BOOLEAN); - component.setRendererType(ComponentConstants.JAVAX_FACES_CHECKBOX); - FacesHelper.setupComponentId(context, component, id); - - return component; - } - - @Override - protected void setupConverter(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - if (property.getConverter() != null) - { - // create and add the custom converter - createAndSetConverter(context, property.getConverter(), component); - } - else - { - if (propertySheet.inEditMode() == false) - { - // if there isn't a custom converter add the boolean - // converter as a default - createAndSetConverter(context, BooleanLabelConverter.CONVERTER_ID, - component); - } - } - } - - @Override - protected void setupMandatoryValidation(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem item, - UIComponent component, boolean realTimeChecking, String idSuffix) - { - // a checkbox will always have one value or another so there - // is no need to create a mandatory validation rule - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.common.converter.BooleanLabelConverter; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a checkbox component. + * + * @author gavinc + */ +public class CheckboxGenerator extends BaseComponentGenerator +{ + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(ComponentConstants.JAVAX_FACES_SELECT_BOOLEAN); + component.setRendererType(ComponentConstants.JAVAX_FACES_CHECKBOX); + FacesHelper.setupComponentId(context, component, id); + + return component; + } + + @Override + protected void setupConverter(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + if (property.getConverter() != null) + { + // create and add the custom converter + createAndSetConverter(context, property.getConverter(), component); + } + else + { + if (propertySheet.inEditMode() == false) + { + // if there isn't a custom converter add the boolean + // converter as a default + createAndSetConverter(context, BooleanLabelConverter.CONVERTER_ID, + component); + } + } + } + + @Override + protected void setupMandatoryValidation(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem item, + UIComponent component, boolean realTimeChecking, String idSuffix) + { + // a checkbox will always have one value or another so there + // is no need to create a mandatory validation rule + } +} diff --git a/source/java/org/alfresco/web/bean/generator/ChildAssociationGenerator.java b/source/java/org/alfresco/web/bean/generator/ChildAssociationGenerator.java index a85cba9604..7c1408b73f 100644 --- a/source/java/org/alfresco/web/bean/generator/ChildAssociationGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/ChildAssociationGenerator.java @@ -1,64 +1,64 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a component to manage child associations. - * - * @author gavinc - */ -public class ChildAssociationGenerator extends BaseComponentGenerator -{ - protected String optionsSize = null; - - public String getAvailableOptionsSize() - { - return this.optionsSize; - } - - public void setAvailableOptionsSize(String optionsSize) - { - this.optionsSize = optionsSize; - } - - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(RepoConstants.ALFRESCO_FACES_CHILD_ASSOC_EDITOR); - FacesHelper.setupComponentId(context, component, id); - - // set the size of the list (if provided) - if (this.optionsSize != null) - { - component.getAttributes().put("availableOptionsSize", this.optionsSize); - } - - return component; - } - - @Override - protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) - { - // Override the setup of the mandatory validation - // so we can send the _current_value id suffix. - // We also enable real time so the page load - // check disables the ok button if necessary, as the user - // adds or removes items from the multi value list the - // page will be refreshed and therefore re-check the status. - // But only do this if the component is not read-only - - if (item.isReadOnly() == false) - { - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_current_value"); - } - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a component to manage child associations. + * + * @author gavinc + */ +public class ChildAssociationGenerator extends BaseComponentGenerator +{ + protected String optionsSize = null; + + public String getAvailableOptionsSize() + { + return this.optionsSize; + } + + public void setAvailableOptionsSize(String optionsSize) + { + this.optionsSize = optionsSize; + } + + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(RepoConstants.ALFRESCO_FACES_CHILD_ASSOC_EDITOR); + FacesHelper.setupComponentId(context, component, id); + + // set the size of the list (if provided) + if (this.optionsSize != null) + { + component.getAttributes().put("availableOptionsSize", this.optionsSize); + } + + return component; + } + + @Override + protected void setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) + { + // Override the setup of the mandatory validation + // so we can send the _current_value id suffix. + // We also enable real time so the page load + // check disables the ok button if necessary, as the user + // adds or removes items from the multi value list the + // page will be refreshed and therefore re-check the status. + // But only do this if the component is not read-only + + if (item.isReadOnly() == false) + { + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_current_value"); + } + } +} diff --git a/source/java/org/alfresco/web/bean/generator/DatePickerGenerator.java b/source/java/org/alfresco/web/bean/generator/DatePickerGenerator.java index 8bab731dcc..eb0f66fa65 100644 --- a/source/java/org/alfresco/web/bean/generator/DatePickerGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/DatePickerGenerator.java @@ -1,185 +1,185 @@ -package org.alfresco.web.bean.generator; - -import java.util.Calendar; - -import javax.faces.component.UIComponent; -import javax.faces.component.UIOutput; -import javax.faces.context.FacesContext; -import javax.faces.convert.Converter; - -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.common.converter.XMLDateConverter; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a date picker component. - * - * @author gavinc - */ -public class DatePickerGenerator extends BaseComponentGenerator -{ - private boolean initialiseIfNull = false; - private int yearCount = 30; - private int startYear = Calendar.getInstance().get(Calendar.YEAR) + 2; - private String noneLabel = null; - - private static final String MSG_DATE = "date_pattern"; - - /** - * @return Returns the year to start counting back from - */ - public int getStartYear() - { - return startYear; - } - - /** - * @param startYear Sets the year to start counting back from - */ - public void setStartYear(int startYear) - { - this.startYear = startYear; - } - - /** - * @return Returns the number of years to show - */ - public int getYearCount() - { - return yearCount; - } - - /** - * @param yearCount Sets the number of years to show - */ - public void setYearCount(int yearCount) - { - this.yearCount = yearCount; - } - - /** - * @return Determines whether the control should initially show - * today's date if the model value is null - */ - public boolean isInitialiseIfNull() - { - return initialiseIfNull; - } - - /** - * @param initialiseIfNull Determines whether the control should - * initially show today's date if the model value is null. - * This will also hide the None button thus disallowing - * the user to set the date back to null. - */ - public void setInitialiseIfNull(boolean initialiseIfNull) - { - this.initialiseIfNull = initialiseIfNull; - } - - /** - * Returns the label to use when there is no date set. - * - * @return The 'None' label to use - */ - public String getNoneLabel() - { - return this.noneLabel; - } - - /** - * Sets the label to use when there is no date set. - * Setting this to null will use the default label. - * - * @param noneLabel The 'None' label - */ - public void setNoneLabel(String noneLabel) - { - this.noneLabel = noneLabel; - } - - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(ComponentConstants.JAVAX_FACES_INPUT); - component.setRendererType(RepoConstants.ALFRESCO_FACES_DATE_PICKER_RENDERER); - FacesHelper.setupComponentId(context, component, id); - component.getAttributes().put("startYear", this.startYear); - component.getAttributes().put("yearCount", this.yearCount); - component.getAttributes().put("initialiseIfNull", new Boolean(this.initialiseIfNull)); - component.getAttributes().put("style", "margin-right: 7px;"); - if (this.noneLabel != null) - { - component.getAttributes().put("noneLabel", this.noneLabel); - } - - return component; - } - - @Override - protected void setupConverter(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - if (property.getConverter() != null) - { - // create and add the custom converter - createAndSetConverter(context, property.getConverter(), component); - } - else - { - // use the default converter for the date component - // we can cast this as we know it is an UIOutput type - ((UIOutput)component).setConverter(getDefaultConverter(context)); - } - } - - @Override - protected void setupMandatoryValidation(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem item, - UIComponent component, boolean realTimeChecking, String idSuffix) - { - if (component instanceof UIMultiValueEditor) - { - // Override the setup of the mandatory validation - // so we can send the _current_value id suffix. - // We also enable real time so the page load - // check disables the ok button if necessary, as the user - // adds or removes items from the multi value list the - // page will be refreshed and therefore re-check the status. - - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_current_value"); - } - else - { - // setup the client validation rule with real time validation enabled - // so that the initial page load checks the state of the date - super.setupMandatoryValidation(context, propertySheet, item, - component, true, idSuffix); - } - - } - - /** - * Retrieves the default converter for the date component - * - * @param context FacesContext - * @return XMLDateConverter - */ - protected Converter getDefaultConverter(FacesContext context) - { - XMLDateConverter converter = (XMLDateConverter)context.getApplication(). - createConverter(RepoConstants.ALFRESCO_FACES_XMLDATE_CONVERTER); - converter.setType("date"); - converter.setPattern(Application.getMessage(context, MSG_DATE)); - return converter; - } -} +package org.alfresco.web.bean.generator; + +import java.util.Calendar; + +import javax.faces.component.UIComponent; +import javax.faces.component.UIOutput; +import javax.faces.context.FacesContext; +import javax.faces.convert.Converter; + +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.common.converter.XMLDateConverter; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a date picker component. + * + * @author gavinc + */ +public class DatePickerGenerator extends BaseComponentGenerator +{ + private boolean initialiseIfNull = false; + private int yearCount = 30; + private int startYear = Calendar.getInstance().get(Calendar.YEAR) + 2; + private String noneLabel = null; + + private static final String MSG_DATE = "date_pattern"; + + /** + * @return Returns the year to start counting back from + */ + public int getStartYear() + { + return startYear; + } + + /** + * @param startYear Sets the year to start counting back from + */ + public void setStartYear(int startYear) + { + this.startYear = startYear; + } + + /** + * @return Returns the number of years to show + */ + public int getYearCount() + { + return yearCount; + } + + /** + * @param yearCount Sets the number of years to show + */ + public void setYearCount(int yearCount) + { + this.yearCount = yearCount; + } + + /** + * @return Determines whether the control should initially show + * today's date if the model value is null + */ + public boolean isInitialiseIfNull() + { + return initialiseIfNull; + } + + /** + * @param initialiseIfNull Determines whether the control should + * initially show today's date if the model value is null. + * This will also hide the None button thus disallowing + * the user to set the date back to null. + */ + public void setInitialiseIfNull(boolean initialiseIfNull) + { + this.initialiseIfNull = initialiseIfNull; + } + + /** + * Returns the label to use when there is no date set. + * + * @return The 'None' label to use + */ + public String getNoneLabel() + { + return this.noneLabel; + } + + /** + * Sets the label to use when there is no date set. + * Setting this to null will use the default label. + * + * @param noneLabel The 'None' label + */ + public void setNoneLabel(String noneLabel) + { + this.noneLabel = noneLabel; + } + + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(ComponentConstants.JAVAX_FACES_INPUT); + component.setRendererType(RepoConstants.ALFRESCO_FACES_DATE_PICKER_RENDERER); + FacesHelper.setupComponentId(context, component, id); + component.getAttributes().put("startYear", this.startYear); + component.getAttributes().put("yearCount", this.yearCount); + component.getAttributes().put("initialiseIfNull", new Boolean(this.initialiseIfNull)); + component.getAttributes().put("style", "margin-right: 7px;"); + if (this.noneLabel != null) + { + component.getAttributes().put("noneLabel", this.noneLabel); + } + + return component; + } + + @Override + protected void setupConverter(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + if (property.getConverter() != null) + { + // create and add the custom converter + createAndSetConverter(context, property.getConverter(), component); + } + else + { + // use the default converter for the date component + // we can cast this as we know it is an UIOutput type + ((UIOutput)component).setConverter(getDefaultConverter(context)); + } + } + + @Override + protected void setupMandatoryValidation(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem item, + UIComponent component, boolean realTimeChecking, String idSuffix) + { + if (component instanceof UIMultiValueEditor) + { + // Override the setup of the mandatory validation + // so we can send the _current_value id suffix. + // We also enable real time so the page load + // check disables the ok button if necessary, as the user + // adds or removes items from the multi value list the + // page will be refreshed and therefore re-check the status. + + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_current_value"); + } + else + { + // setup the client validation rule with real time validation enabled + // so that the initial page load checks the state of the date + super.setupMandatoryValidation(context, propertySheet, item, + component, true, idSuffix); + } + + } + + /** + * Retrieves the default converter for the date component + * + * @param context FacesContext + * @return XMLDateConverter + */ + protected Converter getDefaultConverter(FacesContext context) + { + XMLDateConverter converter = (XMLDateConverter)context.getApplication(). + createConverter(RepoConstants.ALFRESCO_FACES_XMLDATE_CONVERTER); + converter.setType("date"); + converter.setPattern(Application.getMessage(context, MSG_DATE)); + return converter; + } +} diff --git a/source/java/org/alfresco/web/bean/generator/DateTimePickerGenerator.java b/source/java/org/alfresco/web/bean/generator/DateTimePickerGenerator.java index 6d9b4eb016..70b163e3cf 100644 --- a/source/java/org/alfresco/web/bean/generator/DateTimePickerGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/DateTimePickerGenerator.java @@ -1,45 +1,45 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.convert.Converter; - -import org.alfresco.web.app.Application; -import org.alfresco.web.ui.common.converter.XMLDateConverter; -import org.alfresco.web.ui.repo.RepoConstants; - -/** - * Generates a date time picker component. - * - * @author gavinc - */ -public class DateTimePickerGenerator extends DatePickerGenerator -{ - private static final String MSG_DATE_TIME = "date_time_pattern"; - - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = super.generate(context, id); - - // add the attribute to show the time - component.getAttributes().put("showTime", Boolean.TRUE); - - return component; - } - - /** - * Retrieves the default converter for the date time component - * - * @param context FacesContext - * @return XMLDateConverter - */ - protected Converter getDefaultConverter(FacesContext context) - { - XMLDateConverter converter = (XMLDateConverter)context.getApplication(). - createConverter(RepoConstants.ALFRESCO_FACES_XMLDATE_CONVERTER); - converter.setType("both"); - converter.setPattern(Application.getMessage(context, MSG_DATE_TIME)); - return converter; - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.convert.Converter; + +import org.alfresco.web.app.Application; +import org.alfresco.web.ui.common.converter.XMLDateConverter; +import org.alfresco.web.ui.repo.RepoConstants; + +/** + * Generates a date time picker component. + * + * @author gavinc + */ +public class DateTimePickerGenerator extends DatePickerGenerator +{ + private static final String MSG_DATE_TIME = "date_time_pattern"; + + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = super.generate(context, id); + + // add the attribute to show the time + component.getAttributes().put("showTime", Boolean.TRUE); + + return component; + } + + /** + * Retrieves the default converter for the date time component + * + * @param context FacesContext + * @return XMLDateConverter + */ + protected Converter getDefaultConverter(FacesContext context) + { + XMLDateConverter converter = (XMLDateConverter)context.getApplication(). + createConverter(RepoConstants.ALFRESCO_FACES_XMLDATE_CONVERTER); + converter.setType("both"); + converter.setPattern(Application.getMessage(context, MSG_DATE_TIME)); + return converter; + } +} diff --git a/source/java/org/alfresco/web/bean/generator/HtmlSeparatorGenerator.java b/source/java/org/alfresco/web/bean/generator/HtmlSeparatorGenerator.java index 8fe3079b3d..92edb52ba9 100644 --- a/source/java/org/alfresco/web/bean/generator/HtmlSeparatorGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/HtmlSeparatorGenerator.java @@ -1,79 +1,79 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a component to represent a separator. - *

The HTML to be used for the separator is configured via the - * setHtml method. - * - * @author gavinc - */ -public class HtmlSeparatorGenerator extends BaseComponentGenerator -{ - protected String html = ""; - - /** - * Returns the HTML configured to be used for this separator - * - * @return The HTML to display - */ - public String getHtml() - { - return html; - } - - /** - * Sets the HTML to display for the separator - * - * @param html The HTML - */ - public void setHtml(String html) - { - this.html = html; - } - - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = this.createOutputTextComponent(context, id); - component.getAttributes().put("escape", Boolean.FALSE); - - return component; - } - - @Override - @SuppressWarnings("unchecked") - protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - UIComponent component = this.generate(context, item.getName()); - - // set the HTML to use - component.getAttributes().put("value", getResolvedHtml(component, item)); - - return component; - } - - /** - * Returns the resolved HTML to use for the separator. - *

In the default case we just return the HTML set - * via setHtml however subclasses may choose to generate - * the resulting HTML using a combination of the HTML set - * via setHtml and the given PropertySheetItem. - * - * @param component The JSF component representing the separator - * @param item The separator item - * @return The resolved HTML - */ - protected String getResolvedHtml(UIComponent component, PropertySheetItem item) - { - // In the default case we just return the HTML set via setHtml - - return this.html; - } +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a component to represent a separator. + *

The HTML to be used for the separator is configured via the + * setHtml method. + * + * @author gavinc + */ +public class HtmlSeparatorGenerator extends BaseComponentGenerator +{ + protected String html = ""; + + /** + * Returns the HTML configured to be used for this separator + * + * @return The HTML to display + */ + public String getHtml() + { + return html; + } + + /** + * Sets the HTML to display for the separator + * + * @param html The HTML + */ + public void setHtml(String html) + { + this.html = html; + } + + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = this.createOutputTextComponent(context, id); + component.getAttributes().put("escape", Boolean.FALSE); + + return component; + } + + @Override + @SuppressWarnings("unchecked") + protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + UIComponent component = this.generate(context, item.getName()); + + // set the HTML to use + component.getAttributes().put("value", getResolvedHtml(component, item)); + + return component; + } + + /** + * Returns the resolved HTML to use for the separator. + *

In the default case we just return the HTML set + * via setHtml however subclasses may choose to generate + * the resulting HTML using a combination of the HTML set + * via setHtml and the given PropertySheetItem. + * + * @param component The JSF component representing the separator + * @param item The separator item + * @return The resolved HTML + */ + protected String getResolvedHtml(UIComponent component, PropertySheetItem item) + { + // In the default case we just return the HTML set via setHtml + + return this.html; + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/bean/generator/IComponentGenerator.java b/source/java/org/alfresco/web/bean/generator/IComponentGenerator.java index 33e740ba96..7a4266c939 100644 --- a/source/java/org/alfresco/web/bean/generator/IComponentGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/IComponentGenerator.java @@ -1,50 +1,50 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Interface definition for objects that dynamically generate components. - * - * @author gavinc - */ -public interface IComponentGenerator -{ - /** - * Dynamically generates a component in a default state - * - * @param context FacesContext - * @param id Optional id for the newly created component, if null - * is passed a unique id is generated - * @return The component instance - */ - UIComponent generate(FacesContext context, String id); - - /** - * Dynamically generates a component for the given property sheet item. - * The generated component is also setup appropriately for it's model - * definition and added to the given property sheet. - * - * @param context FacesContext - * @param propertySheet The property sheet component - * @param item The wrappper component representing the item to generate, - * either a property, association or child association - * @return The component instance - */ - UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item); - - /** - * Determines whether the component will be enabled when rendered. - * - * @param context FacesContext - * @param control The control being rendered - * @param propDef The definition of the property - * @return true if the component should be enabled - */ - boolean isEnabledInEditMode (FacesContext context, UIComponent control, PropertyDefinition propDef); -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Interface definition for objects that dynamically generate components. + * + * @author gavinc + */ +public interface IComponentGenerator +{ + /** + * Dynamically generates a component in a default state + * + * @param context FacesContext + * @param id Optional id for the newly created component, if null + * is passed a unique id is generated + * @return The component instance + */ + UIComponent generate(FacesContext context, String id); + + /** + * Dynamically generates a component for the given property sheet item. + * The generated component is also setup appropriately for it's model + * definition and added to the given property sheet. + * + * @param context FacesContext + * @param propertySheet The property sheet component + * @param item The wrappper component representing the item to generate, + * either a property, association or child association + * @return The component instance + */ + UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item); + + /** + * Determines whether the component will be enabled when rendered. + * + * @param context FacesContext + * @param control The control being rendered + * @param propDef The definition of the property + * @return true if the component should be enabled + */ + boolean isEnabledInEditMode (FacesContext context, UIComponent control, PropertyDefinition propDef); +} diff --git a/source/java/org/alfresco/web/bean/generator/LabelGenerator.java b/source/java/org/alfresco/web/bean/generator/LabelGenerator.java index 6cb4b7a716..a8ad2f24ed 100644 --- a/source/java/org/alfresco/web/bean/generator/LabelGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/LabelGenerator.java @@ -1,35 +1,35 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a text field component to represent a label. - * - * @author gavinc - */ -public class LabelGenerator extends BaseComponentGenerator -{ - public UIComponent generate(FacesContext context, String id) - { - return createOutputTextComponent(context, id); - } - - @Override - @SuppressWarnings("unchecked") - public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - UIComponent component = generate(context, "label_" + item.getName()); - - // add the component to the property sheet item - item.getChildren().add(component); - - // TODO: setup the 'for' attribute to associate with it the control - - return component; - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a text field component to represent a label. + * + * @author gavinc + */ +public class LabelGenerator extends BaseComponentGenerator +{ + public UIComponent generate(FacesContext context, String id) + { + return createOutputTextComponent(context, id); + } + + @Override + @SuppressWarnings("unchecked") + public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + UIComponent component = generate(context, "label_" + item.getName()); + + // add the component to the property sheet item + item.getChildren().add(component); + + // TODO: setup the 'for' attribute to associate with it the control + + return component; + } +} diff --git a/source/java/org/alfresco/web/bean/generator/LinkGenerator.java b/source/java/org/alfresco/web/bean/generator/LinkGenerator.java index a5b7ba95ce..7e56d108a4 100644 --- a/source/java/org/alfresco/web/bean/generator/LinkGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/LinkGenerator.java @@ -1,75 +1,75 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.component.UIOutput; -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Link Generator. - * - * Generates a link tag which opend the URL into a new browsers window. - * - * @author Roy Wetherall - */ -public class LinkGenerator extends BaseComponentGenerator -{ - private boolean inEditMode = false; - - /** - * @see org.alfresco.web.bean.generator.IComponentGenerator#generate(javax.faces.context.FacesContext, java.lang.String) - */ - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = null; - if (this.inEditMode == false) - { - component = context.getApplication().createComponent(UIOutput.COMPONENT_TYPE); - component.setRendererType("javax.faces.Link"); - component.getAttributes().put("target", "new"); - } - else - { - component = context.getApplication().createComponent(ComponentConstants.JAVAX_FACES_INPUT); - component.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); - } - - FacesHelper.setupComponentId(context, component, id); - return component; - } - - /** - * @see org.alfresco.web.bean.generator.BaseComponentGenerator#createComponent(javax.faces.context.FacesContext, org.alfresco.web.ui.repo.component.property.UIPropertySheet, org.alfresco.web.ui.repo.component.property.PropertySheetItem) - */ - @Override - protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem item) - { - this.inEditMode = propertySheet.inEditMode(); - return this.generate(context, item.getName()); - } - - /** - * @see org.alfresco.web.bean.generator.BaseComponentGenerator#setupProperty(javax.faces.context.FacesContext, org.alfresco.web.ui.repo.component.property.UIPropertySheet, org.alfresco.web.ui.repo.component.property.PropertySheetItem, org.alfresco.service.cmr.dictionary.PropertyDefinition, javax.faces.component.UIComponent) - */ - @SuppressWarnings("unchecked") - @Override - protected void setupProperty(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item, PropertyDefinition propertyDef, UIComponent component) - { - super.setupProperty(context, propertySheet, item, propertyDef, component); - - if (component.getRendererType().equals("javax.faces.Link") == true) - { - // Add child text component - UIOutput output = createOutputTextComponent(context, "linklabel_" + component.getId()); - output.setValueBinding("value", component.getValueBinding("value")); - component.getChildren().add(output); - } - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.component.UIOutput; +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Link Generator. + * + * Generates a link tag which opend the URL into a new browsers window. + * + * @author Roy Wetherall + */ +public class LinkGenerator extends BaseComponentGenerator +{ + private boolean inEditMode = false; + + /** + * @see org.alfresco.web.bean.generator.IComponentGenerator#generate(javax.faces.context.FacesContext, java.lang.String) + */ + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = null; + if (this.inEditMode == false) + { + component = context.getApplication().createComponent(UIOutput.COMPONENT_TYPE); + component.setRendererType("javax.faces.Link"); + component.getAttributes().put("target", "new"); + } + else + { + component = context.getApplication().createComponent(ComponentConstants.JAVAX_FACES_INPUT); + component.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); + } + + FacesHelper.setupComponentId(context, component, id); + return component; + } + + /** + * @see org.alfresco.web.bean.generator.BaseComponentGenerator#createComponent(javax.faces.context.FacesContext, org.alfresco.web.ui.repo.component.property.UIPropertySheet, org.alfresco.web.ui.repo.component.property.PropertySheetItem) + */ + @Override + protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem item) + { + this.inEditMode = propertySheet.inEditMode(); + return this.generate(context, item.getName()); + } + + /** + * @see org.alfresco.web.bean.generator.BaseComponentGenerator#setupProperty(javax.faces.context.FacesContext, org.alfresco.web.ui.repo.component.property.UIPropertySheet, org.alfresco.web.ui.repo.component.property.PropertySheetItem, org.alfresco.service.cmr.dictionary.PropertyDefinition, javax.faces.component.UIComponent) + */ + @SuppressWarnings("unchecked") + @Override + protected void setupProperty(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item, PropertyDefinition propertyDef, UIComponent component) + { + super.setupProperty(context, propertySheet, item, propertyDef, component); + + if (component.getRendererType().equals("javax.faces.Link") == true) + { + // Add child text component + UIOutput output = createOutputTextComponent(context, "linklabel_" + component.getId()); + output.setValueBinding("value", component.getValueBinding("value")); + component.getChildren().add(output); + } + } +} diff --git a/source/java/org/alfresco/web/bean/generator/MimeTypeSelectorGenerator.java b/source/java/org/alfresco/web/bean/generator/MimeTypeSelectorGenerator.java index fea5476f8b..af1440dd35 100644 --- a/source/java/org/alfresco/web/bean/generator/MimeTypeSelectorGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/MimeTypeSelectorGenerator.java @@ -1,59 +1,59 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.repo.component.UIMimeTypeSelector; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; -import org.alfresco.web.ui.repo.converter.MimeTypeConverter; - -/** - * Generates a MIME type selector component. - * - * @author gavinc - */ -public class MimeTypeSelectorGenerator extends BaseComponentGenerator -{ - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(UIMimeTypeSelector.COMPONENT_TYPE); - FacesHelper.setupComponentId(context, component, id); - - return component; - } - - @Override - protected void setupConverter(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - if (propertySheet.inEditMode() == false) - { - if (property.getConverter() != null) - { - // create and add the custom converter - createAndSetConverter(context, property.getConverter(), component); - } - else - { - // if there isn't a custom converter add the mime type - // converter as a default - createAndSetConverter(context, MimeTypeConverter.CONVERTER_ID, - component); - } - } - } - - @Override - protected void setupMandatoryValidation(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem item, - UIComponent component, boolean realTimeChecking, String idSuffix) - { - // a mime type selector will always have one value or another - // so there is no need to create a mandatory validation rule. - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.repo.component.UIMimeTypeSelector; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; +import org.alfresco.web.ui.repo.converter.MimeTypeConverter; + +/** + * Generates a MIME type selector component. + * + * @author gavinc + */ +public class MimeTypeSelectorGenerator extends BaseComponentGenerator +{ + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(UIMimeTypeSelector.COMPONENT_TYPE); + FacesHelper.setupComponentId(context, component, id); + + return component; + } + + @Override + protected void setupConverter(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + if (propertySheet.inEditMode() == false) + { + if (property.getConverter() != null) + { + // create and add the custom converter + createAndSetConverter(context, property.getConverter(), component); + } + else + { + // if there isn't a custom converter add the mime type + // converter as a default + createAndSetConverter(context, MimeTypeConverter.CONVERTER_ID, + component); + } + } + } + + @Override + protected void setupMandatoryValidation(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem item, + UIComponent component, boolean realTimeChecking, String idSuffix) + { + // a mime type selector will always have one value or another + // so there is no need to create a mandatory validation rule. + } +} diff --git a/source/java/org/alfresco/web/bean/generator/MultilingualTextAreaGenerator.java b/source/java/org/alfresco/web/bean/generator/MultilingualTextAreaGenerator.java index 1fbb2c78de..5a4188c7b1 100644 --- a/source/java/org/alfresco/web/bean/generator/MultilingualTextAreaGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/MultilingualTextAreaGenerator.java @@ -1,37 +1,37 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.component.UIInput; -import javax.faces.component.UIOutput; -import javax.faces.component.UISelectOne; -import javax.faces.context.FacesContext; - -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a multilingual text area component. - * - * @author gavinc - */ -public class MultilingualTextAreaGenerator extends TextAreaGenerator -{ - @Override - public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - UIComponent component = super.generateAndAdd(context, propertySheet, item); - - if ((component instanceof UIInput) && (component instanceof UISelectOne) == false) - { - component.setRendererType(RepoConstants.ALFRESCO_FACES_MLTEXTAREA_RENDERER); - } - else if ((component instanceof UIOutput)) - { - component.setRendererType(RepoConstants.ALFRESCO_FACES_MLTEXT_RENDERER); - } - - return component; - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.component.UIInput; +import javax.faces.component.UIOutput; +import javax.faces.component.UISelectOne; +import javax.faces.context.FacesContext; + +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a multilingual text area component. + * + * @author gavinc + */ +public class MultilingualTextAreaGenerator extends TextAreaGenerator +{ + @Override + public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + UIComponent component = super.generateAndAdd(context, propertySheet, item); + + if ((component instanceof UIInput) && (component instanceof UISelectOne) == false) + { + component.setRendererType(RepoConstants.ALFRESCO_FACES_MLTEXTAREA_RENDERER); + } + else if ((component instanceof UIOutput)) + { + component.setRendererType(RepoConstants.ALFRESCO_FACES_MLTEXT_RENDERER); + } + + return component; + } +} diff --git a/source/java/org/alfresco/web/bean/generator/MultilingualTextFieldGenerator.java b/source/java/org/alfresco/web/bean/generator/MultilingualTextFieldGenerator.java index 14a6b57880..0efffc9f13 100644 --- a/source/java/org/alfresco/web/bean/generator/MultilingualTextFieldGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/MultilingualTextFieldGenerator.java @@ -1,33 +1,33 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.component.UISelectOne; -import javax.faces.context.FacesContext; - -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates a multilingual text field component. - * - * @author gavinc - */ -public class MultilingualTextFieldGenerator extends TextFieldGenerator -{ - @Override - public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - UIComponent component = super.generateAndAdd(context, propertySheet, item); - - if ((component instanceof UISelectOne) == false && - (component instanceof UIMultiValueEditor) == false) - { - component.setRendererType(RepoConstants.ALFRESCO_FACES_MLTEXT_RENDERER); - } - - return component; - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.component.UISelectOne; +import javax.faces.context.FacesContext; + +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates a multilingual text field component. + * + * @author gavinc + */ +public class MultilingualTextFieldGenerator extends TextFieldGenerator +{ + @Override + public UIComponent generateAndAdd(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + UIComponent component = super.generateAndAdd(context, propertySheet, item); + + if ((component instanceof UISelectOne) == false && + (component instanceof UIMultiValueEditor) == false) + { + component.setRendererType(RepoConstants.ALFRESCO_FACES_MLTEXT_RENDERER); + } + + return component; + } +} diff --git a/source/java/org/alfresco/web/bean/generator/SpaceIconPickerGenerator.java b/source/java/org/alfresco/web/bean/generator/SpaceIconPickerGenerator.java index e61f3a4f28..04ad45b8f4 100644 --- a/source/java/org/alfresco/web/bean/generator/SpaceIconPickerGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/SpaceIconPickerGenerator.java @@ -1,81 +1,81 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.el.ValueBinding; - -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.common.component.UIListItems; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; - -/** - * Generates the image picker component with rounded corners for selecting - * an icon for a space. - * - * @author gavinc - */ -public class SpaceIconPickerGenerator extends BaseComponentGenerator -{ - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - // create the outer component - UIComponent component = context.getApplication(). - createComponent(RepoConstants.ALFRESCO_FACES_IMAGE_PICKER); - - // setup the outer component - component.setRendererType(RepoConstants.ALFRESCO_FACES_RADIO_PANEL_RENDERER); - FacesHelper.setupComponentId(context, component, id); - component.getAttributes().put("columns", new Integer(6)); - component.getAttributes().put("spacing", new Integer(4)); - component.getAttributes().put("panelBorder", "blue"); - component.getAttributes().put("panelBgcolor", "#D3E6FE"); - - return component; - } - - @Override - @SuppressWarnings("unchecked") - protected void setupProperty(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem item, - PropertyDefinition propertyDef, UIComponent component) - { - // do the standard setup - super.setupProperty(context, propertySheet, item, propertyDef, component); - - // if the property sheet is in edit mode we also need to setup the - // list of icons the user can select from - if (propertySheet.inEditMode()) - { - // create the list items child component - UIListItems items = (UIListItems)context.getApplication(). - createComponent(RepoConstants.ALFRESCO_FACES_LIST_ITEMS); - - // setup the value binding for the list of icons, this needs - // to be sensitive to the bean used for the property sheet - // we therefore need to get the value binding expression and - // extract the bean name and then add '.icons' to the end, - // this means any page that uses this component must supply - // a getIcons method that returns a List of UIListItem's - ValueBinding binding = propertySheet.getValueBinding("value"); - String expression = binding.getExpressionString(); - String beanName = expression.substring(2, expression.indexOf(".")+1); - if (beanName.equals("DialogManager.") || beanName.equals("WizardManager.")) - { - // deal with the special dialog and wizard manager beans by - // adding .bean - beanName = beanName + "bean."; - } - String newExpression = "#{" + beanName + "icons}"; - - ValueBinding vb = context.getApplication().createValueBinding(newExpression); - items.setValueBinding("value", vb); - - // add the list items component to the image picker component - component.getChildren().add(items); - } - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.el.ValueBinding; + +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.common.component.UIListItems; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; + +/** + * Generates the image picker component with rounded corners for selecting + * an icon for a space. + * + * @author gavinc + */ +public class SpaceIconPickerGenerator extends BaseComponentGenerator +{ + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + // create the outer component + UIComponent component = context.getApplication(). + createComponent(RepoConstants.ALFRESCO_FACES_IMAGE_PICKER); + + // setup the outer component + component.setRendererType(RepoConstants.ALFRESCO_FACES_RADIO_PANEL_RENDERER); + FacesHelper.setupComponentId(context, component, id); + component.getAttributes().put("columns", new Integer(6)); + component.getAttributes().put("spacing", new Integer(4)); + component.getAttributes().put("panelBorder", "blue"); + component.getAttributes().put("panelBgcolor", "#D3E6FE"); + + return component; + } + + @Override + @SuppressWarnings("unchecked") + protected void setupProperty(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem item, + PropertyDefinition propertyDef, UIComponent component) + { + // do the standard setup + super.setupProperty(context, propertySheet, item, propertyDef, component); + + // if the property sheet is in edit mode we also need to setup the + // list of icons the user can select from + if (propertySheet.inEditMode()) + { + // create the list items child component + UIListItems items = (UIListItems)context.getApplication(). + createComponent(RepoConstants.ALFRESCO_FACES_LIST_ITEMS); + + // setup the value binding for the list of icons, this needs + // to be sensitive to the bean used for the property sheet + // we therefore need to get the value binding expression and + // extract the bean name and then add '.icons' to the end, + // this means any page that uses this component must supply + // a getIcons method that returns a List of UIListItem's + ValueBinding binding = propertySheet.getValueBinding("value"); + String expression = binding.getExpressionString(); + String beanName = expression.substring(2, expression.indexOf(".")+1); + if (beanName.equals("DialogManager.") || beanName.equals("WizardManager.")) + { + // deal with the special dialog and wizard manager beans by + // adding .bean + beanName = beanName + "bean."; + } + String newExpression = "#{" + beanName + "icons}"; + + ValueBinding vb = context.getApplication().createValueBinding(newExpression); + items.setValueBinding("value", vb); + + // add the list items component to the image picker component + component.getChildren().add(items); + } + } +} diff --git a/source/java/org/alfresco/web/bean/generator/StoreSelectorGenerator.java b/source/java/org/alfresco/web/bean/generator/StoreSelectorGenerator.java index 749775be77..d9fa43a9bf 100644 --- a/source/java/org/alfresco/web/bean/generator/StoreSelectorGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/StoreSelectorGenerator.java @@ -1,23 +1,23 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.repo.component.UIStoreSelector; - -/** - * Generates a content store selector component. - */ -public class StoreSelectorGenerator extends BaseComponentGenerator -{ - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(UIStoreSelector.COMPONENT_TYPE); - FacesHelper.setupComponentId(context, component, id); - - return component; - } - -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.repo.component.UIStoreSelector; + +/** + * Generates a content store selector component. + */ +public class StoreSelectorGenerator extends BaseComponentGenerator +{ + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(UIStoreSelector.COMPONENT_TYPE); + FacesHelper.setupComponentId(context, component, id); + + return component; + } + +} diff --git a/source/java/org/alfresco/web/bean/generator/TextAreaGenerator.java b/source/java/org/alfresco/web/bean/generator/TextAreaGenerator.java index eebdecd190..0c8b623fe4 100644 --- a/source/java/org/alfresco/web/bean/generator/TextAreaGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/TextAreaGenerator.java @@ -1,72 +1,72 @@ -package org.alfresco.web.bean.generator; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.common.ComponentConstants; - -/** - * Generates a text field component. - * - * @author gavinc - */ -public class TextAreaGenerator extends TextFieldGenerator -{ - private int rows = 3; - private int columns = 32; - - /** - * @return Returns the number of columns - */ - public int getColumns() - { - return columns; - } - - /** - * @param columns Sets the number of columns - */ - public void setColumns(int columns) - { - this.columns = columns; - } - - /** - * @return Returns the number of rows - */ - public int getRows() - { - return rows; - } - - /** - * @param rows Sets the number of rows - */ - public void setRows(int rows) - { - this.rows = rows; - } - - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(ComponentConstants.JAVAX_FACES_INPUT); - component.setRendererType(ComponentConstants.JAVAX_FACES_TEXTAREA); - FacesHelper.setupComponentId(context, component, id); - - component.getAttributes().put("rows", this.rows); - component.getAttributes().put("cols", this.columns); - - // MNT-10171 Exception thrown if Share metadata is longer than 1024 characters - if (ContentModel.PROP_DESCRIPTION.getLocalName().equals(id)) - { - // add 'onfocus' event for adding 'maxlength' attribute - component.getAttributes().put("onfocus", "addMaxLengthForDescriptionTextArea(this)"); - } - - return component; - } -} +package org.alfresco.web.bean.generator; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.common.ComponentConstants; + +/** + * Generates a text field component. + * + * @author gavinc + */ +public class TextAreaGenerator extends TextFieldGenerator +{ + private int rows = 3; + private int columns = 32; + + /** + * @return Returns the number of columns + */ + public int getColumns() + { + return columns; + } + + /** + * @param columns Sets the number of columns + */ + public void setColumns(int columns) + { + this.columns = columns; + } + + /** + * @return Returns the number of rows + */ + public int getRows() + { + return rows; + } + + /** + * @param rows Sets the number of rows + */ + public void setRows(int rows) + { + this.rows = rows; + } + + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(ComponentConstants.JAVAX_FACES_INPUT); + component.setRendererType(ComponentConstants.JAVAX_FACES_TEXTAREA); + FacesHelper.setupComponentId(context, component, id); + + component.getAttributes().put("rows", this.rows); + component.getAttributes().put("cols", this.columns); + + // MNT-10171 Exception thrown if Share metadata is longer than 1024 characters + if (ContentModel.PROP_DESCRIPTION.getLocalName().equals(id)) + { + // add 'onfocus' event for adding 'maxlength' attribute + component.getAttributes().put("onfocus", "addMaxLengthForDescriptionTextArea(this)"); + } + + return component; + } +} diff --git a/source/java/org/alfresco/web/bean/generator/TextFieldGenerator.java b/source/java/org/alfresco/web/bean/generator/TextFieldGenerator.java index 55996f44b0..62eec21f41 100644 --- a/source/java/org/alfresco/web/bean/generator/TextFieldGenerator.java +++ b/source/java/org/alfresco/web/bean/generator/TextFieldGenerator.java @@ -1,334 +1,334 @@ -package org.alfresco.web.bean.generator; - -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.List; - -import javax.faces.component.UIComponent; -import javax.faces.component.UIOutput; -import javax.faces.component.UISelectItems; -import javax.faces.component.UISelectOne; -import javax.faces.context.FacesContext; -import javax.faces.convert.Converter; -import javax.faces.convert.FloatConverter; -import javax.faces.convert.IntegerConverter; -import javax.faces.convert.LongConverter; -import javax.faces.model.SelectItem; - -import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint; -import org.alfresco.service.cmr.dictionary.Constraint; -import org.alfresco.service.cmr.dictionary.ConstraintDefinition; -import org.alfresco.service.cmr.dictionary.DataTypeDefinition; -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; -import org.alfresco.web.ui.repo.component.property.PropertySheetItem; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet; -import org.alfresco.web.ui.repo.component.property.UIPropertySheet.ClientValidation; - -/** - * Generates a text field component. - * - * @author gavinc - */ -public class TextFieldGenerator extends BaseComponentGenerator -{ - private int size = 35; - private int maxLength = 1024; - - /** - * @return Returns the default size for a text field - */ - public int getSize() - { - return size; - } - - /** - * @param size Sets the size of a text field - */ - public void setSize(int size) - { - this.size = size; - } - - /** - * @return Returns the max length for the text field - */ - public int getMaxLength() - { - return maxLength; - } - - /** - * @param maxLength Sets the max length of the text field - */ - public void setMaxLength(int maxLength) - { - this.maxLength = maxLength; - } - - @SuppressWarnings("unchecked") - public UIComponent generate(FacesContext context, String id) - { - UIComponent component = context.getApplication(). - createComponent(ComponentConstants.JAVAX_FACES_INPUT); - component.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); - FacesHelper.setupComponentId(context, component, id); - - component.getAttributes().put("size", this.size); - component.getAttributes().put("maxlength", this.maxLength); - - return component; - } - - @Override - @SuppressWarnings("unchecked") - protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, - PropertySheetItem item) - { - UIComponent component = null; - - if (propertySheet.inEditMode()) - { - // if the field has the list of values constraint - // and it is editable a SelectOne component is - // required otherwise create the standard edit component - ListOfValuesConstraint constraint = getListOfValuesConstraint( - context, propertySheet, item); - - PropertyDefinition propDef = this.getPropertyDefinition(context, - propertySheet.getNode(), item.getName()); - - if (constraint != null && item.isReadOnly() == false && - propDef != null && propDef.isProtected() == false) - { - component = context.getApplication().createComponent( - UISelectOne.COMPONENT_TYPE); - FacesHelper.setupComponentId(context, component, item.getName()); - - // create the list of choices - UISelectItems itemsComponent = (UISelectItems)context.getApplication(). - createComponent("javax.faces.SelectItems"); - - List values = constraint.getAllowedValues(); - List items = new ArrayList(values.size()); - for (String value : values) - { - Object obj = null; - - // we need to setup the list with objects of the correct type - if (propDef.getDataType().getName().equals(DataTypeDefinition.INT)) - { - obj = Integer.valueOf(value); - } - else if (propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) - { - obj = Long.valueOf(value); - } - else if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE)) - { - obj = Double.valueOf(value); - } - else if (propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT)) - { - obj = Float.valueOf(value); - } - else - { - obj = value; - } - - // retrieve the display label - String label = constraint.getDisplayLabel(value, dataDictionary.getDictionaryService()); - if (label == null) - { - label = value; - } - - items.add(new SelectItem(obj, label)); - } - - itemsComponent.setValue(items); - - // add the items as a child component - component.getChildren().add(itemsComponent); - } - else - { - // use the standard component in edit mode - component = generate(context, item.getName()); - } - } - else - { - // create an output text component in view mode - component = createOutputTextComponent(context, item.getName()); - } - - return component; - } - - @Override - @SuppressWarnings("unchecked") - protected void setupMandatoryValidation(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem item, - UIComponent component, boolean realTimeChecking, - String idSuffix) - { - if (component instanceof UIMultiValueEditor) - { - // Override the setup of the mandatory validation - // so we can send the _current_value id suffix. - // We also enable real time so the page load - // check disables the ok button if necessary, as the user - // adds or removes items from the multi value list the - // page will be refreshed and therefore re-check the status. - - super.setupMandatoryValidation(context, propertySheet, item, - component, true, "_current_value"); - } - else if (component instanceof UISelectOne) - { - // when there is a list of values constraint there - // will always be a value so validation is not required. - } - else - { - // setup the client validation rule with real time validation enabled - super.setupMandatoryValidation(context, propertySheet, item, - component, true, idSuffix); - - // add event handler to kick off real time checks - component.getAttributes().put("onkeyup", "processButtonState();"); - } - } - - @Override - @SuppressWarnings("unchecked") - protected void setupConstraints(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - // do the default processing first - super.setupConstraints(context, propertySheet, property, - propertyDef, component); - - // if the property type is a number based type and the property - // sheet is in edit mode and validation is turned, on add the - // validateIsNumber validation function - if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && - propertyDef != null) - { - // check the type of the property is a number - if (propertyDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || - propertyDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || - propertyDef.getDataType().getName().equals(DataTypeDefinition.INT) || - propertyDef.getDataType().getName().equals(DataTypeDefinition.LONG)) - { - List params = new ArrayList(3); - - // add the value parameter - String value = "document.getElementById('" + - component.getClientId(context) + "')"; - params.add(value); - - // add the validation failed message to show - String msg = Application.getMessage(context, "validation_is_number"); - addStringConstraintParam(params, - MessageFormat.format(msg, new Object[] {property.getResolvedDisplayLabel()})); - - // add the validation case to the property sheet - propertySheet.addClientValidation(new ClientValidation("validateIsNumber", - params, false)); - } - } - } - - /** - * Retrieves the list of values constraint for the item, if it has one - * - * @param context FacesContext - * @param propertySheet The property sheet being generated - * @param item The item being generated - * @return The constraint if the item has one, null otherwise - */ - protected ListOfValuesConstraint getListOfValuesConstraint(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem item) - { - ListOfValuesConstraint lovConstraint = null; - - // get the property definition for the item - PropertyDefinition propertyDef = getPropertyDefinition(context, - propertySheet.getNode(), item.getName()); - - if (propertyDef != null) - { - // go through the constaints and see if it has the - // list of values constraint - List constraints = propertyDef.getConstraints(); - for (ConstraintDefinition constraintDef : constraints) - { - Constraint constraint = constraintDef.getConstraint(); - - if (constraint instanceof ListOfValuesConstraint) - { - lovConstraint = (ListOfValuesConstraint)constraint; - break; - } - } - } - - return lovConstraint; - } - - protected void setupConverter(FacesContext context, - UIPropertySheet propertySheet, PropertySheetItem property, - PropertyDefinition propertyDef, UIComponent component) - { - // do default processing - super.setupConverter(context, propertySheet, property, propertyDef, component); - - // if there isn't a converter and the property has a list of values constraint - // on a number property we need to add the appropriate one. - if (propertySheet.inEditMode() && propertyDef != null && - component instanceof UIOutput) - { - Converter converter = ((UIOutput)component).getConverter(); - if (converter == null) - { - ListOfValuesConstraint constraint = getListOfValuesConstraint(context, - propertySheet, property); - if (constraint != null) - { - String converterId = null; - - if (propertyDef.getDataType().getName().equals(DataTypeDefinition.INT)) - { - converterId = IntegerConverter.CONVERTER_ID; - } - else if (propertyDef.getDataType().getName().equals(DataTypeDefinition.LONG)) - { - converterId = LongConverter.CONVERTER_ID; - } - else if (propertyDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE)) - { - // NOTE: the constant for the double converter is wrong in MyFaces!! - converterId = "javax.faces.Double"; - } - else if (propertyDef.getDataType().getName().equals(DataTypeDefinition.FLOAT)) - { - converterId = FloatConverter.CONVERTER_ID; - } - - if (converterId != null) - { - createAndSetConverter(context, converterId, component); - } - } - } - } - } -} +package org.alfresco.web.bean.generator; + +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.List; + +import javax.faces.component.UIComponent; +import javax.faces.component.UIOutput; +import javax.faces.component.UISelectItems; +import javax.faces.component.UISelectOne; +import javax.faces.context.FacesContext; +import javax.faces.convert.Converter; +import javax.faces.convert.FloatConverter; +import javax.faces.convert.IntegerConverter; +import javax.faces.convert.LongConverter; +import javax.faces.model.SelectItem; + +import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint; +import org.alfresco.service.cmr.dictionary.Constraint; +import org.alfresco.service.cmr.dictionary.ConstraintDefinition; +import org.alfresco.service.cmr.dictionary.DataTypeDefinition; +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; +import org.alfresco.web.ui.repo.component.property.PropertySheetItem; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet; +import org.alfresco.web.ui.repo.component.property.UIPropertySheet.ClientValidation; + +/** + * Generates a text field component. + * + * @author gavinc + */ +public class TextFieldGenerator extends BaseComponentGenerator +{ + private int size = 35; + private int maxLength = 1024; + + /** + * @return Returns the default size for a text field + */ + public int getSize() + { + return size; + } + + /** + * @param size Sets the size of a text field + */ + public void setSize(int size) + { + this.size = size; + } + + /** + * @return Returns the max length for the text field + */ + public int getMaxLength() + { + return maxLength; + } + + /** + * @param maxLength Sets the max length of the text field + */ + public void setMaxLength(int maxLength) + { + this.maxLength = maxLength; + } + + @SuppressWarnings("unchecked") + public UIComponent generate(FacesContext context, String id) + { + UIComponent component = context.getApplication(). + createComponent(ComponentConstants.JAVAX_FACES_INPUT); + component.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); + FacesHelper.setupComponentId(context, component, id); + + component.getAttributes().put("size", this.size); + component.getAttributes().put("maxlength", this.maxLength); + + return component; + } + + @Override + @SuppressWarnings("unchecked") + protected UIComponent createComponent(FacesContext context, UIPropertySheet propertySheet, + PropertySheetItem item) + { + UIComponent component = null; + + if (propertySheet.inEditMode()) + { + // if the field has the list of values constraint + // and it is editable a SelectOne component is + // required otherwise create the standard edit component + ListOfValuesConstraint constraint = getListOfValuesConstraint( + context, propertySheet, item); + + PropertyDefinition propDef = this.getPropertyDefinition(context, + propertySheet.getNode(), item.getName()); + + if (constraint != null && item.isReadOnly() == false && + propDef != null && propDef.isProtected() == false) + { + component = context.getApplication().createComponent( + UISelectOne.COMPONENT_TYPE); + FacesHelper.setupComponentId(context, component, item.getName()); + + // create the list of choices + UISelectItems itemsComponent = (UISelectItems)context.getApplication(). + createComponent("javax.faces.SelectItems"); + + List values = constraint.getAllowedValues(); + List items = new ArrayList(values.size()); + for (String value : values) + { + Object obj = null; + + // we need to setup the list with objects of the correct type + if (propDef.getDataType().getName().equals(DataTypeDefinition.INT)) + { + obj = Integer.valueOf(value); + } + else if (propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) + { + obj = Long.valueOf(value); + } + else if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE)) + { + obj = Double.valueOf(value); + } + else if (propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT)) + { + obj = Float.valueOf(value); + } + else + { + obj = value; + } + + // retrieve the display label + String label = constraint.getDisplayLabel(value, dataDictionary.getDictionaryService()); + if (label == null) + { + label = value; + } + + items.add(new SelectItem(obj, label)); + } + + itemsComponent.setValue(items); + + // add the items as a child component + component.getChildren().add(itemsComponent); + } + else + { + // use the standard component in edit mode + component = generate(context, item.getName()); + } + } + else + { + // create an output text component in view mode + component = createOutputTextComponent(context, item.getName()); + } + + return component; + } + + @Override + @SuppressWarnings("unchecked") + protected void setupMandatoryValidation(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem item, + UIComponent component, boolean realTimeChecking, + String idSuffix) + { + if (component instanceof UIMultiValueEditor) + { + // Override the setup of the mandatory validation + // so we can send the _current_value id suffix. + // We also enable real time so the page load + // check disables the ok button if necessary, as the user + // adds or removes items from the multi value list the + // page will be refreshed and therefore re-check the status. + + super.setupMandatoryValidation(context, propertySheet, item, + component, true, "_current_value"); + } + else if (component instanceof UISelectOne) + { + // when there is a list of values constraint there + // will always be a value so validation is not required. + } + else + { + // setup the client validation rule with real time validation enabled + super.setupMandatoryValidation(context, propertySheet, item, + component, true, idSuffix); + + // add event handler to kick off real time checks + component.getAttributes().put("onkeyup", "processButtonState();"); + } + } + + @Override + @SuppressWarnings("unchecked") + protected void setupConstraints(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + // do the default processing first + super.setupConstraints(context, propertySheet, property, + propertyDef, component); + + // if the property type is a number based type and the property + // sheet is in edit mode and validation is turned, on add the + // validateIsNumber validation function + if (propertySheet.inEditMode() && propertySheet.isValidationEnabled() && + propertyDef != null) + { + // check the type of the property is a number + if (propertyDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || + propertyDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || + propertyDef.getDataType().getName().equals(DataTypeDefinition.INT) || + propertyDef.getDataType().getName().equals(DataTypeDefinition.LONG)) + { + List params = new ArrayList(3); + + // add the value parameter + String value = "document.getElementById('" + + component.getClientId(context) + "')"; + params.add(value); + + // add the validation failed message to show + String msg = Application.getMessage(context, "validation_is_number"); + addStringConstraintParam(params, + MessageFormat.format(msg, new Object[] {property.getResolvedDisplayLabel()})); + + // add the validation case to the property sheet + propertySheet.addClientValidation(new ClientValidation("validateIsNumber", + params, false)); + } + } + } + + /** + * Retrieves the list of values constraint for the item, if it has one + * + * @param context FacesContext + * @param propertySheet The property sheet being generated + * @param item The item being generated + * @return The constraint if the item has one, null otherwise + */ + protected ListOfValuesConstraint getListOfValuesConstraint(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem item) + { + ListOfValuesConstraint lovConstraint = null; + + // get the property definition for the item + PropertyDefinition propertyDef = getPropertyDefinition(context, + propertySheet.getNode(), item.getName()); + + if (propertyDef != null) + { + // go through the constaints and see if it has the + // list of values constraint + List constraints = propertyDef.getConstraints(); + for (ConstraintDefinition constraintDef : constraints) + { + Constraint constraint = constraintDef.getConstraint(); + + if (constraint instanceof ListOfValuesConstraint) + { + lovConstraint = (ListOfValuesConstraint)constraint; + break; + } + } + } + + return lovConstraint; + } + + protected void setupConverter(FacesContext context, + UIPropertySheet propertySheet, PropertySheetItem property, + PropertyDefinition propertyDef, UIComponent component) + { + // do default processing + super.setupConverter(context, propertySheet, property, propertyDef, component); + + // if there isn't a converter and the property has a list of values constraint + // on a number property we need to add the appropriate one. + if (propertySheet.inEditMode() && propertyDef != null && + component instanceof UIOutput) + { + Converter converter = ((UIOutput)component).getConverter(); + if (converter == null) + { + ListOfValuesConstraint constraint = getListOfValuesConstraint(context, + propertySheet, property); + if (constraint != null) + { + String converterId = null; + + if (propertyDef.getDataType().getName().equals(DataTypeDefinition.INT)) + { + converterId = IntegerConverter.CONVERTER_ID; + } + else if (propertyDef.getDataType().getName().equals(DataTypeDefinition.LONG)) + { + converterId = LongConverter.CONVERTER_ID; + } + else if (propertyDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE)) + { + // NOTE: the constant for the double converter is wrong in MyFaces!! + converterId = "javax.faces.Double"; + } + else if (propertyDef.getDataType().getName().equals(DataTypeDefinition.FLOAT)) + { + converterId = FloatConverter.CONVERTER_ID; + } + + if (converterId != null) + { + createAndSetConverter(context, converterId, component); + } + } + } + } + } +} diff --git a/source/java/org/alfresco/web/bean/ml/MultilingualManageDialog.java b/source/java/org/alfresco/web/bean/ml/MultilingualManageDialog.java index 60ab890653..149a670202 100644 --- a/source/java/org/alfresco/web/bean/ml/MultilingualManageDialog.java +++ b/source/java/org/alfresco/web/bean/ml/MultilingualManageDialog.java @@ -1,524 +1,524 @@ -package org.alfresco.web.bean.ml; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.ml.ContentFilterLanguagesService; -import org.alfresco.service.cmr.ml.EditionService; -import org.alfresco.service.cmr.ml.MultilingualContentService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.version.Version; -import org.alfresco.service.cmr.version.VersionHistory; -import org.alfresco.service.cmr.version.VersionService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.DownloadContentServlet; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.MapNode; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.UIPanel.ExpandedEvent; - -public class MultilingualManageDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 4168804472130450812L; - - private final String MSG_MANAGE_DETAILS_FOR="manage_multilingual_details_for"; - private static final String MSG_CURRENT = "current"; - private static final String ML_VERSION_PANEL_ID = "ml-versions-panel"; - private static final String MSG_CLOSE = "close"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - protected Map panels = new HashMap(4, 1.0f); - - transient private MultilingualContentService multilingualContentService; - transient private ContentFilterLanguagesService contentFilterLanguagesService; - transient private EditionService editionService; - transient private VersionService versionService; - - private Node translationDocument; - - /** For the client side iteration on the edition hitories list, it represents the index of the list */ - private int currentEditionCursorPosition; - - /** List of client light weight edition histories */ - private List editionHistory = null; - - /** - * Returns the document this bean is currently representing - * - * @return The document Node - */ - public Node getDocument() - { - return this.getNode(); - } - - /** - * Returns the Node this bean is currently representing - * - * @return The Node - */ - public Node getNode() - { - return this.browseBean.getDocument(); - } - - /** - * @param multilingualContentService the multilingual ContentService to set - */ - public void setMultilingualContentService(MultilingualContentService multilingualContentService) - { - this.multilingualContentService = multilingualContentService; - } - - /** - * @return multilingualContentService - */ - protected MultilingualContentService getMultilingualContentService() - { - //check for null for cluster environment - if (multilingualContentService == null) - { - multilingualContentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getMultilingualContentService(); - } - return multilingualContentService; - } - - /** - * @param contentFilterLanguagesService The Content Filter Languages Service to set. - */ - public void setContentFilterLanguagesService(ContentFilterLanguagesService contentFilterLanguagesService) - { - this.contentFilterLanguagesService = contentFilterLanguagesService; - } - - /** - * @return contentFilterLanguagesService - */ - protected ContentFilterLanguagesService getContentFilterLanguagesService() - { - //check for null for cluster environment - if (contentFilterLanguagesService == null) - { - contentFilterLanguagesService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentFilterLanguagesService(); - } - return contentFilterLanguagesService; - } - - /** - * @param editionService The Edition Service to set. - */ - public void setEditionService(EditionService editionService) - { - this.editionService = editionService; - } - - /** - * @return editionService - */ - protected EditionService getEditionService() - { - //check for null for cluster environment - if (editionService == null) - { - editionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getEditionService(); - } - return editionService; - } - - /** - * Sets the version service instance the bean should use - * - * @param versionService The VersionService - */ - public void setVersionService(VersionService versionService) - { - this.versionService = versionService; - } - - /** - * @return versionService - */ - protected VersionService getVersionService() - { - //check for null for cluster environment - if (versionService == null) - { - versionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getVersionService(); - } - return versionService; - } - - /** - * Before opening the ml container details, remeber the translation - * from which the action comes. - * - * @param node - */ - public void setTranslationDocument(Node node) - { - this.translationDocument = node; - } - - /** - * @return Returns the panels expanded state map. - */ - public Map getPanels() - { - return this.panels; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // TODO Auto-generated method stub - return null; - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_MANAGE_DETAILS_FOR) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } - - /** - * Returns a list of objects representing the translations of the current document - * - * @return List of translations - */ - public List getTranslations() - { - List translations = new ArrayList(); - - Node document = getDocument(); - - boolean canNewEdtion = MultilingualUtils.canStartNewEditon(document, FacesContext.getCurrentInstance()); - - if (document.hasAspect(ContentModel.ASPECT_MULTILINGUAL_DOCUMENT) || ContentModel.TYPE_MULTILINGUAL_CONTAINER.equals(document.getType())) - { - Map translationsMap = getMultilingualContentService().getTranslations(getDocument().getNodeRef()); - - if (translationsMap != null && translationsMap.size() > 0) - { - for (Map.Entry entry : translationsMap.entrySet()) - { - NodeRef nodeRef = (NodeRef) entry.getValue(); - - // create a map node representation of the translation - MapNode mapNode = new MapNode(nodeRef); - - Locale locale = (Locale) getNodeService().getProperty(nodeRef, ContentModel.PROP_LOCALE); - - String lgge = (locale != null) ? - // convert the locale into new ISO codes - getContentFilterLanguagesService().convertToNewISOCode(locale.getLanguage()).toUpperCase() - : null; - - mapNode.put("name", getNodeService().getProperty(nodeRef, ContentModel.PROP_NAME)); - mapNode.put("language", lgge); - mapNode.put("url", DownloadContentServlet.generateBrowserURL(nodeRef, mapNode.getName())); - - boolean isEmpty = new Boolean(getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)); - - mapNode.put("notEmpty", !isEmpty); - mapNode.put("userHasRight", new Boolean(canNewEdtion && !isEmpty)); - // add the client side version to the list - translations.add(mapNode); - } - } - } - - return translations; - } - - /** - * Init the mlContainer histories and returns an empty list to fill a rich list value without content. - * - * @return an empty list - */ - public List getEmptyListAndInitEditions() - { - // this call ensures that the edition of the mlContainer must be - // re-initialized. - - // remove each old mlContainer's translations of the panel list - List panelsToRemove = new ArrayList(); - for(Map.Entry panel : panels.entrySet()) - { - if(panel.getKey().startsWith(ML_VERSION_PANEL_ID)) - { - //panels.remove(panel.getKey()); - panelsToRemove.add(panel.getKey()); - } - } - - for(String panelId : panelsToRemove) - { - panels.remove(panelId); - } - - // init the Edition histories - initEditionHistory(); - currentEditionCursorPosition = -1; - - return new ArrayList(0); - } - - /** - * For the client side iteration on the edition hitories list, returns the number of editions. - * - * @return the number of edition of the current mlContainer - */ - public int getEditionSize() - { - // return the size of the list - return editionHistory.size(); - } - - /** - * For the client side iteration on the edition hitories list, - * return the next edition history. - * - * @return a light weight representation of an edition history - */ - public SingleEditionBean getNextSingleEditionBean() - { - currentEditionCursorPosition++; - - return getCurrentSingleEditionBean(); - } - - /** - * For the client side iteration on the edition hitories list, - * return the current edition history. - * - * @return a light weight representation of an edition history - */ - public SingleEditionBean getCurrentSingleEditionBean() - { - if (currentEditionCursorPosition < getEditionSize()) - { - return editionHistory.get(currentEditionCursorPosition); - } - - return null; - } - - /** - * Restore the translationf from which the ml container - * details dialog comes. - */ - public void resetMLDocument(ActionEvent event) - { - this.browseBean.setupCommonBindingProperties(this.translationDocument); - this.browseBean.setDocument(this.translationDocument); - } - - /** - * Action handler to remove a custom view template from the current node - */ - public void removeTemplate(ActionEvent event) - { - try - { - // clear template property - this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, null); - this.getNodeService().removeAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE); - - // reset node details for next refresh of details page - getNode().reset(); - } - catch (Exception e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); - } - } - - /** - * Save the state of the panel that was expanded/collapsed - */ - public void expandPanel(ActionEvent event) - { - if (event instanceof ExpandedEvent) - { - String id = event.getComponent().getId(); - // we prefix some panels with "no-" which we remove to give consistent behaviour in the UI - if (id.startsWith("no-") == true) - { - id = id.substring(3); - } - this.panels.put(id, ((ExpandedEvent)event).State); - } - - String id = event.getComponent().getId(); - - if(id.startsWith(ML_VERSION_PANEL_ID)) - { - this.currentEditionCursorPosition = Integer.parseInt(id.substring("ml-versions-panel".length())) - 1; - } - } - - - /** - * Returns the ml container of the document this bean is currently representing - * - * @return The document multilingual container NodeRef - */ - public Node getDocumentMlContainer() - { - Node currentNode = getNode(); - - if(ContentModel.TYPE_MULTILINGUAL_CONTAINER.equals(currentNode.getType())) - { - return currentNode; - } - else - { - NodeRef nodeRef = getNode().getNodeRef(); - - return new Node(getMultilingualContentService().getTranslationContainer(nodeRef)); - } - } - - /** - * Constructs a list of objects representing the editions of the - * logical document - * - * @return List of editions - */ - private List initEditionHistory() - { - // get the mlContainer - NodeRef mlContainer = getDocumentMlContainer().getNodeRef(); - - // get all editions (in descending order - ie. most recent first) - List orderedEditionList = new ArrayList(getEditionService().getEditions(mlContainer).getAllVersions()); - - // the list of Single Edition Bean to return - editionHistory = new ArrayList(orderedEditionList.size()); - - boolean firstEdition = true; - - // for each edition, init a SingleEditionBean - for (Version edition : orderedEditionList) - { - SingleEditionBean editionBean = new SingleEditionBean(); - - MapNode clientEdition = new MapNode(edition.getFrozenStateNodeRef()); - - String editionLabel = edition.getVersionLabel(); - if (firstEdition) - { - editionLabel += " (" + Application.getMessage(FacesContext.getCurrentInstance(), MSG_CURRENT) + ")"; - } - - clientEdition.put("editionLabel", editionLabel); - clientEdition.put("editionNotes", edition.getDescription()); - clientEdition.put("editionAuthor", edition.getCreator()); - clientEdition.put("editionDate", edition.getCreatedDate()); - - // Set the edition of the edition bean - editionBean.setEdition(clientEdition); - - // get translations - List translationHistories = null; - - if (firstEdition) - { - // Get the translations because the current edition doesn't content link with its - // translation in the version store. - Map translations = getMultilingualContentService().getTranslations(mlContainer); - translationHistories = new ArrayList(translations.size()); - for (NodeRef translation : translations.values()) - { - translationHistories.add(getVersionService().getVersionHistory(translation)); - } - } - else - { - translationHistories = getEditionService().getVersionedTranslations(edition); - } - - // add each translation in the SingleEditionBean - for (VersionHistory versionHistory : translationHistories) - { - for (Version checkVersion : versionHistory.getAllVersions()) - { - NodeRef frozenStateNodeRef = checkVersion.getFrozenStateNodeRef(); - if (frozenStateNodeRef.getStoreRef().getIdentifier().equals("lightWeightVersionStore")) - { - // It's the old one pulled back by serialization - // Repopulate the version history - NodeRef versionedNodeRef = checkVersion.getVersionedNodeRef(); - versionHistory = versionService.getVersionHistory(versionedNodeRef); - break; - } - } - - // get the list of versions (in descending order - ie. most recent first) - List orderedVersions = new ArrayList(versionHistory.getAllVersions()); - - // the last version (ie. most recent) is the first version of the list - Version lastVersion = orderedVersions.get(0); - - // get the properties of the lastVersion - Map lastVersionProperties = getEditionService().getVersionedMetadatas(lastVersion); - Locale language = (Locale) lastVersionProperties.get(ContentModel.PROP_LOCALE); - - // create a map node representation of the last version - MapNode clientLastVersion = new MapNode(lastVersion.getFrozenStateNodeRef()); - - clientLastVersion.put("versionName", lastVersionProperties.get(ContentModel.PROP_NAME)); - // use the node service for the description to ensure that the returned value is a text and not a MLText - clientLastVersion.put("versionDescription", getNodeService().getProperty(lastVersion.getFrozenStateNodeRef(), ContentModel.PROP_DESCRIPTION)); - clientLastVersion.put("versionAuthor", lastVersionProperties.get(ContentModel.PROP_AUTHOR)); - clientLastVersion.put("versionCreatedDate", lastVersionProperties.get(ContentModel.PROP_CREATED)); - clientLastVersion.put("versionModifiedDate", lastVersionProperties.get(ContentModel.PROP_MODIFIED)); - clientLastVersion.put("versionLanguage", getContentFilterLanguagesService().convertToNewISOCode(language.getLanguage()).toUpperCase()); - - if(getNodeService().hasAspect(lastVersion.getFrozenStateNodeRef(), ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) - { - clientLastVersion.put("versionUrl", null); - } - else - { - clientLastVersion.put("versionUrl", DownloadContentServlet.generateBrowserURL(lastVersion.getFrozenStateNodeRef(), clientLastVersion.getName())); - } - - // add a translation of the editionBean - editionBean.addTranslations(clientLastVersion); - } - editionHistory.add(editionBean); - firstEdition = false; - } - - return editionHistory; - } - @Override - protected String getDefaultCancelOutcome() - { - resetMLDocument(null); - return "dialog:close"; - } -} +package org.alfresco.web.bean.ml; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.ml.ContentFilterLanguagesService; +import org.alfresco.service.cmr.ml.EditionService; +import org.alfresco.service.cmr.ml.MultilingualContentService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.version.Version; +import org.alfresco.service.cmr.version.VersionHistory; +import org.alfresco.service.cmr.version.VersionService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.DownloadContentServlet; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.MapNode; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.UIPanel.ExpandedEvent; + +public class MultilingualManageDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 4168804472130450812L; + + private final String MSG_MANAGE_DETAILS_FOR="manage_multilingual_details_for"; + private static final String MSG_CURRENT = "current"; + private static final String ML_VERSION_PANEL_ID = "ml-versions-panel"; + private static final String MSG_CLOSE = "close"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + protected Map panels = new HashMap(4, 1.0f); + + transient private MultilingualContentService multilingualContentService; + transient private ContentFilterLanguagesService contentFilterLanguagesService; + transient private EditionService editionService; + transient private VersionService versionService; + + private Node translationDocument; + + /** For the client side iteration on the edition hitories list, it represents the index of the list */ + private int currentEditionCursorPosition; + + /** List of client light weight edition histories */ + private List editionHistory = null; + + /** + * Returns the document this bean is currently representing + * + * @return The document Node + */ + public Node getDocument() + { + return this.getNode(); + } + + /** + * Returns the Node this bean is currently representing + * + * @return The Node + */ + public Node getNode() + { + return this.browseBean.getDocument(); + } + + /** + * @param multilingualContentService the multilingual ContentService to set + */ + public void setMultilingualContentService(MultilingualContentService multilingualContentService) + { + this.multilingualContentService = multilingualContentService; + } + + /** + * @return multilingualContentService + */ + protected MultilingualContentService getMultilingualContentService() + { + //check for null for cluster environment + if (multilingualContentService == null) + { + multilingualContentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getMultilingualContentService(); + } + return multilingualContentService; + } + + /** + * @param contentFilterLanguagesService The Content Filter Languages Service to set. + */ + public void setContentFilterLanguagesService(ContentFilterLanguagesService contentFilterLanguagesService) + { + this.contentFilterLanguagesService = contentFilterLanguagesService; + } + + /** + * @return contentFilterLanguagesService + */ + protected ContentFilterLanguagesService getContentFilterLanguagesService() + { + //check for null for cluster environment + if (contentFilterLanguagesService == null) + { + contentFilterLanguagesService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentFilterLanguagesService(); + } + return contentFilterLanguagesService; + } + + /** + * @param editionService The Edition Service to set. + */ + public void setEditionService(EditionService editionService) + { + this.editionService = editionService; + } + + /** + * @return editionService + */ + protected EditionService getEditionService() + { + //check for null for cluster environment + if (editionService == null) + { + editionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getEditionService(); + } + return editionService; + } + + /** + * Sets the version service instance the bean should use + * + * @param versionService The VersionService + */ + public void setVersionService(VersionService versionService) + { + this.versionService = versionService; + } + + /** + * @return versionService + */ + protected VersionService getVersionService() + { + //check for null for cluster environment + if (versionService == null) + { + versionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getVersionService(); + } + return versionService; + } + + /** + * Before opening the ml container details, remeber the translation + * from which the action comes. + * + * @param node + */ + public void setTranslationDocument(Node node) + { + this.translationDocument = node; + } + + /** + * @return Returns the panels expanded state map. + */ + public Map getPanels() + { + return this.panels; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // TODO Auto-generated method stub + return null; + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_MANAGE_DETAILS_FOR) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } + + /** + * Returns a list of objects representing the translations of the current document + * + * @return List of translations + */ + public List getTranslations() + { + List translations = new ArrayList(); + + Node document = getDocument(); + + boolean canNewEdtion = MultilingualUtils.canStartNewEditon(document, FacesContext.getCurrentInstance()); + + if (document.hasAspect(ContentModel.ASPECT_MULTILINGUAL_DOCUMENT) || ContentModel.TYPE_MULTILINGUAL_CONTAINER.equals(document.getType())) + { + Map translationsMap = getMultilingualContentService().getTranslations(getDocument().getNodeRef()); + + if (translationsMap != null && translationsMap.size() > 0) + { + for (Map.Entry entry : translationsMap.entrySet()) + { + NodeRef nodeRef = (NodeRef) entry.getValue(); + + // create a map node representation of the translation + MapNode mapNode = new MapNode(nodeRef); + + Locale locale = (Locale) getNodeService().getProperty(nodeRef, ContentModel.PROP_LOCALE); + + String lgge = (locale != null) ? + // convert the locale into new ISO codes + getContentFilterLanguagesService().convertToNewISOCode(locale.getLanguage()).toUpperCase() + : null; + + mapNode.put("name", getNodeService().getProperty(nodeRef, ContentModel.PROP_NAME)); + mapNode.put("language", lgge); + mapNode.put("url", DownloadContentServlet.generateBrowserURL(nodeRef, mapNode.getName())); + + boolean isEmpty = new Boolean(getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)); + + mapNode.put("notEmpty", !isEmpty); + mapNode.put("userHasRight", new Boolean(canNewEdtion && !isEmpty)); + // add the client side version to the list + translations.add(mapNode); + } + } + } + + return translations; + } + + /** + * Init the mlContainer histories and returns an empty list to fill a rich list value without content. + * + * @return an empty list + */ + public List getEmptyListAndInitEditions() + { + // this call ensures that the edition of the mlContainer must be + // re-initialized. + + // remove each old mlContainer's translations of the panel list + List panelsToRemove = new ArrayList(); + for(Map.Entry panel : panels.entrySet()) + { + if(panel.getKey().startsWith(ML_VERSION_PANEL_ID)) + { + //panels.remove(panel.getKey()); + panelsToRemove.add(panel.getKey()); + } + } + + for(String panelId : panelsToRemove) + { + panels.remove(panelId); + } + + // init the Edition histories + initEditionHistory(); + currentEditionCursorPosition = -1; + + return new ArrayList(0); + } + + /** + * For the client side iteration on the edition hitories list, returns the number of editions. + * + * @return the number of edition of the current mlContainer + */ + public int getEditionSize() + { + // return the size of the list + return editionHistory.size(); + } + + /** + * For the client side iteration on the edition hitories list, + * return the next edition history. + * + * @return a light weight representation of an edition history + */ + public SingleEditionBean getNextSingleEditionBean() + { + currentEditionCursorPosition++; + + return getCurrentSingleEditionBean(); + } + + /** + * For the client side iteration on the edition hitories list, + * return the current edition history. + * + * @return a light weight representation of an edition history + */ + public SingleEditionBean getCurrentSingleEditionBean() + { + if (currentEditionCursorPosition < getEditionSize()) + { + return editionHistory.get(currentEditionCursorPosition); + } + + return null; + } + + /** + * Restore the translationf from which the ml container + * details dialog comes. + */ + public void resetMLDocument(ActionEvent event) + { + this.browseBean.setupCommonBindingProperties(this.translationDocument); + this.browseBean.setDocument(this.translationDocument); + } + + /** + * Action handler to remove a custom view template from the current node + */ + public void removeTemplate(ActionEvent event) + { + try + { + // clear template property + this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, null); + this.getNodeService().removeAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE); + + // reset node details for next refresh of details page + getNode().reset(); + } + catch (Exception e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); + } + } + + /** + * Save the state of the panel that was expanded/collapsed + */ + public void expandPanel(ActionEvent event) + { + if (event instanceof ExpandedEvent) + { + String id = event.getComponent().getId(); + // we prefix some panels with "no-" which we remove to give consistent behaviour in the UI + if (id.startsWith("no-") == true) + { + id = id.substring(3); + } + this.panels.put(id, ((ExpandedEvent)event).State); + } + + String id = event.getComponent().getId(); + + if(id.startsWith(ML_VERSION_PANEL_ID)) + { + this.currentEditionCursorPosition = Integer.parseInt(id.substring("ml-versions-panel".length())) - 1; + } + } + + + /** + * Returns the ml container of the document this bean is currently representing + * + * @return The document multilingual container NodeRef + */ + public Node getDocumentMlContainer() + { + Node currentNode = getNode(); + + if(ContentModel.TYPE_MULTILINGUAL_CONTAINER.equals(currentNode.getType())) + { + return currentNode; + } + else + { + NodeRef nodeRef = getNode().getNodeRef(); + + return new Node(getMultilingualContentService().getTranslationContainer(nodeRef)); + } + } + + /** + * Constructs a list of objects representing the editions of the + * logical document + * + * @return List of editions + */ + private List initEditionHistory() + { + // get the mlContainer + NodeRef mlContainer = getDocumentMlContainer().getNodeRef(); + + // get all editions (in descending order - ie. most recent first) + List orderedEditionList = new ArrayList(getEditionService().getEditions(mlContainer).getAllVersions()); + + // the list of Single Edition Bean to return + editionHistory = new ArrayList(orderedEditionList.size()); + + boolean firstEdition = true; + + // for each edition, init a SingleEditionBean + for (Version edition : orderedEditionList) + { + SingleEditionBean editionBean = new SingleEditionBean(); + + MapNode clientEdition = new MapNode(edition.getFrozenStateNodeRef()); + + String editionLabel = edition.getVersionLabel(); + if (firstEdition) + { + editionLabel += " (" + Application.getMessage(FacesContext.getCurrentInstance(), MSG_CURRENT) + ")"; + } + + clientEdition.put("editionLabel", editionLabel); + clientEdition.put("editionNotes", edition.getDescription()); + clientEdition.put("editionAuthor", edition.getCreator()); + clientEdition.put("editionDate", edition.getCreatedDate()); + + // Set the edition of the edition bean + editionBean.setEdition(clientEdition); + + // get translations + List translationHistories = null; + + if (firstEdition) + { + // Get the translations because the current edition doesn't content link with its + // translation in the version store. + Map translations = getMultilingualContentService().getTranslations(mlContainer); + translationHistories = new ArrayList(translations.size()); + for (NodeRef translation : translations.values()) + { + translationHistories.add(getVersionService().getVersionHistory(translation)); + } + } + else + { + translationHistories = getEditionService().getVersionedTranslations(edition); + } + + // add each translation in the SingleEditionBean + for (VersionHistory versionHistory : translationHistories) + { + for (Version checkVersion : versionHistory.getAllVersions()) + { + NodeRef frozenStateNodeRef = checkVersion.getFrozenStateNodeRef(); + if (frozenStateNodeRef.getStoreRef().getIdentifier().equals("lightWeightVersionStore")) + { + // It's the old one pulled back by serialization + // Repopulate the version history + NodeRef versionedNodeRef = checkVersion.getVersionedNodeRef(); + versionHistory = versionService.getVersionHistory(versionedNodeRef); + break; + } + } + + // get the list of versions (in descending order - ie. most recent first) + List orderedVersions = new ArrayList(versionHistory.getAllVersions()); + + // the last version (ie. most recent) is the first version of the list + Version lastVersion = orderedVersions.get(0); + + // get the properties of the lastVersion + Map lastVersionProperties = getEditionService().getVersionedMetadatas(lastVersion); + Locale language = (Locale) lastVersionProperties.get(ContentModel.PROP_LOCALE); + + // create a map node representation of the last version + MapNode clientLastVersion = new MapNode(lastVersion.getFrozenStateNodeRef()); + + clientLastVersion.put("versionName", lastVersionProperties.get(ContentModel.PROP_NAME)); + // use the node service for the description to ensure that the returned value is a text and not a MLText + clientLastVersion.put("versionDescription", getNodeService().getProperty(lastVersion.getFrozenStateNodeRef(), ContentModel.PROP_DESCRIPTION)); + clientLastVersion.put("versionAuthor", lastVersionProperties.get(ContentModel.PROP_AUTHOR)); + clientLastVersion.put("versionCreatedDate", lastVersionProperties.get(ContentModel.PROP_CREATED)); + clientLastVersion.put("versionModifiedDate", lastVersionProperties.get(ContentModel.PROP_MODIFIED)); + clientLastVersion.put("versionLanguage", getContentFilterLanguagesService().convertToNewISOCode(language.getLanguage()).toUpperCase()); + + if(getNodeService().hasAspect(lastVersion.getFrozenStateNodeRef(), ContentModel.ASPECT_MULTILINGUAL_EMPTY_TRANSLATION)) + { + clientLastVersion.put("versionUrl", null); + } + else + { + clientLastVersion.put("versionUrl", DownloadContentServlet.generateBrowserURL(lastVersion.getFrozenStateNodeRef(), clientLastVersion.getName())); + } + + // add a translation of the editionBean + editionBean.addTranslations(clientLastVersion); + } + editionHistory.add(editionBean); + firstEdition = false; + } + + return editionHistory; + } + @Override + protected String getDefaultCancelOutcome() + { + resetMLDocument(null); + return "dialog:close"; + } +} diff --git a/source/java/org/alfresco/web/bean/repository/Preferences.java b/source/java/org/alfresco/web/bean/repository/Preferences.java index 44a94587c8..3ee10d311c 100644 --- a/source/java/org/alfresco/web/bean/repository/Preferences.java +++ b/source/java/org/alfresco/web/bean/repository/Preferences.java @@ -1,109 +1,109 @@ -package org.alfresco.web.bean.repository; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.transaction.UserTransaction; - -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; - -/** - * Wraps the notion of preferences and settings for a User. - * Caches values until they are overwritten with a new value. - * - * @author Kevin Roast - */ -public final class Preferences implements Serializable -{ - private static final long serialVersionUID = 722840612660970723L; - - private NodeRef preferencesRef; - private transient NodeService nodeService; - private Map cache = new HashMap(16, 1.0f); - - /** - * Package level constructor - */ - Preferences(NodeRef prefRef) - { - this.preferencesRef = prefRef; - } - - /** - * Get a serialized preferences value. - * - * @param name Name of the value to retrieve. - * - * @return The value or null if not found/set. - */ - public Serializable getValue(String name) - { - Serializable value = null; - - if (this.preferencesRef != null) - { - value = this.cache.get(name); - - if (value == null) - { - QName qname = QName.createQName(NamespaceService.APP_MODEL_1_0_URI, name); - value = getNodeService().getProperty(this.preferencesRef, qname); - this.cache.put(name, value); - } - } - - return value; - } - - /** - * Set a serialized preference value. - * - * @param name Name of the value to set. - * @param value Value to set. - */ - public void setValue(String name, Serializable value) - { - if (this.preferencesRef != null) - { - QName qname = QName.createQName(NamespaceService.APP_MODEL_1_0_URI, name); - - // persist the property to the repo - UserTransaction tx = null; - try - { - FacesContext context = FacesContext.getCurrentInstance(); - tx = Repository.getUserTransaction(context); - tx.begin(); - - getNodeService().setProperty(this.preferencesRef, qname, value); - - tx.commit(); - - // update the cache - this.cache.put(name, value); - } - catch (Throwable err) - { - // we cannot update the properties if a user is no longer authenticated - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - } - } - - /** - * @return the NodeService instance. - */ - private NodeService getNodeService() - { - if (this.nodeService == null) - { - this.nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return this.nodeService; - } -} +package org.alfresco.web.bean.repository; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.transaction.UserTransaction; + +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; + +/** + * Wraps the notion of preferences and settings for a User. + * Caches values until they are overwritten with a new value. + * + * @author Kevin Roast + */ +public final class Preferences implements Serializable +{ + private static final long serialVersionUID = 722840612660970723L; + + private NodeRef preferencesRef; + private transient NodeService nodeService; + private Map cache = new HashMap(16, 1.0f); + + /** + * Package level constructor + */ + Preferences(NodeRef prefRef) + { + this.preferencesRef = prefRef; + } + + /** + * Get a serialized preferences value. + * + * @param name Name of the value to retrieve. + * + * @return The value or null if not found/set. + */ + public Serializable getValue(String name) + { + Serializable value = null; + + if (this.preferencesRef != null) + { + value = this.cache.get(name); + + if (value == null) + { + QName qname = QName.createQName(NamespaceService.APP_MODEL_1_0_URI, name); + value = getNodeService().getProperty(this.preferencesRef, qname); + this.cache.put(name, value); + } + } + + return value; + } + + /** + * Set a serialized preference value. + * + * @param name Name of the value to set. + * @param value Value to set. + */ + public void setValue(String name, Serializable value) + { + if (this.preferencesRef != null) + { + QName qname = QName.createQName(NamespaceService.APP_MODEL_1_0_URI, name); + + // persist the property to the repo + UserTransaction tx = null; + try + { + FacesContext context = FacesContext.getCurrentInstance(); + tx = Repository.getUserTransaction(context); + tx.begin(); + + getNodeService().setProperty(this.preferencesRef, qname, value); + + tx.commit(); + + // update the cache + this.cache.put(name, value); + } + catch (Throwable err) + { + // we cannot update the properties if a user is no longer authenticated + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + } + } + + /** + * @return the NodeService instance. + */ + private NodeService getNodeService() + { + if (this.nodeService == null) + { + this.nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return this.nodeService; + } +} diff --git a/source/java/org/alfresco/web/bean/repository/PreferencesService.java b/source/java/org/alfresco/web/bean/repository/PreferencesService.java index 4332f92b90..01c6089129 100644 --- a/source/java/org/alfresco/web/bean/repository/PreferencesService.java +++ b/source/java/org/alfresco/web/bean/repository/PreferencesService.java @@ -1,49 +1,49 @@ -package org.alfresco.web.bean.repository; - -import javax.faces.context.FacesContext; -import javax.servlet.http.HttpSession; - -import org.alfresco.web.app.Application; - -/** - * Simple client service to retrieve the Preferences object for the current User. - * - * @author Kevin Roast - */ -public final class PreferencesService -{ - /** - * Private constructor - */ - private PreferencesService() - { - } - - /** - * @return The Preferences for the current User instance. - */ - public static Preferences getPreferences() - { - return getPreferences(FacesContext.getCurrentInstance()); - } - - /** - * @param fc FacesContext - * @return The Preferences for the current User instance. - */ - public static Preferences getPreferences(FacesContext fc) - { - User user = Application.getCurrentUser(fc); - return user != null ? user.getPreferences(fc) : null; - } - - /** - * @param session Http session - * @return The Preferences for the current User instance. - */ - public static Preferences getPreferences(HttpSession session) - { - User user = Application.getCurrentUser(session); - return user != null ? user.getPreferences(session.getServletContext()) : null; - } -} +package org.alfresco.web.bean.repository; + +import javax.faces.context.FacesContext; +import javax.servlet.http.HttpSession; + +import org.alfresco.web.app.Application; + +/** + * Simple client service to retrieve the Preferences object for the current User. + * + * @author Kevin Roast + */ +public final class PreferencesService +{ + /** + * Private constructor + */ + private PreferencesService() + { + } + + /** + * @return The Preferences for the current User instance. + */ + public static Preferences getPreferences() + { + return getPreferences(FacesContext.getCurrentInstance()); + } + + /** + * @param fc FacesContext + * @return The Preferences for the current User instance. + */ + public static Preferences getPreferences(FacesContext fc) + { + User user = Application.getCurrentUser(fc); + return user != null ? user.getPreferences(fc) : null; + } + + /** + * @param session Http session + * @return The Preferences for the current User instance. + */ + public static Preferences getPreferences(HttpSession session) + { + User user = Application.getCurrentUser(session); + return user != null ? user.getPreferences(session.getServletContext()) : null; + } +} diff --git a/source/java/org/alfresco/web/bean/repository/TransientMapNode.java b/source/java/org/alfresco/web/bean/repository/TransientMapNode.java index 31db09effa..ba6dde50a4 100644 --- a/source/java/org/alfresco/web/bean/repository/TransientMapNode.java +++ b/source/java/org/alfresco/web/bean/repository/TransientMapNode.java @@ -1,149 +1,149 @@ -package org.alfresco.web.bean.repository; - -import java.io.Serializable; -import java.util.Collection; -import java.util.Map; -import java.util.Set; - -import org.alfresco.service.namespace.QName; - -/** - * Represents a transient node i.e. it is not and will not be present in the repository. - *

- * This type of node is typically used to drive rich lists where the Map implementation - * is required for sorting columns. - *

- * - * @author gavinc - */ -public class TransientMapNode extends TransientNode implements Map -{ - private static final long serialVersionUID = 1120307465342597322L; - - /** - * Constructor. - *

- * NOTE: The name is NOT automatically added to the map of properties, - * if you need the name of this node to be in the map then add it to - * the map passed in to this constructor. - *

- * - * @param type The type this node will represent - * @param name The name of the node - * @param data The properties and associations this node will have - */ - public TransientMapNode(QName type, String name, Map data) - { - super(type, name, data); - } - - @Override - public String toString() - { - return "Transient map node of type: " + getType() + - "\nProperties: " + this.getProperties().toString(); - } - - // ------------------------------------------------------------------------------ - // Map implementation - allows the Node bean to be accessed using JSF expression syntax - - /** - * @see java.util.Map#clear() - */ - public void clear() - { - getProperties().clear(); - } - - /** - * @see java.util.Map#containsKey(java.lang.Object) - */ - public boolean containsKey(Object key) - { - return getProperties().containsKey(key); - } - - /** - * @see java.util.Map#containsValue(java.lang.Object) - */ - public boolean containsValue(Object value) - { - return getProperties().containsKey(value); - } - - /** - * @see java.util.Map#entrySet() - */ - @SuppressWarnings("unchecked") - public Set entrySet() - { - return getProperties().entrySet(); - } - - /** - * @see java.util.Map#get(java.lang.Object) - */ - public Object get(Object key) - { - return getProperties().get(key); - } - - /** - * @see java.util.Map#isEmpty() - */ - public boolean isEmpty() - { - return getProperties().isEmpty(); - } - - /** - * @see java.util.Map#keySet() - */ - @SuppressWarnings("unchecked") - public Set keySet() - { - return getProperties().keySet(); - } - - /** - * @see java.util.Map#put(java.lang.Object, java.lang.Object) - */ - public Object put(String key, Object value) - { - return getProperties().put(key, value); - } - - /** - * @see java.util.Map#putAll(java.util.Map) - */ - @SuppressWarnings("unchecked") - public void putAll(Map t) - { - getProperties().putAll(t); - } - - /** - * @see java.util.Map#remove(java.lang.Object) - */ - public Object remove(Object key) - { - return getProperties().remove(key); - } - - /** - * @see java.util.Map#size() - */ - public int size() - { - return getProperties().size(); - } - - /** - * @see java.util.Map#values() - */ - @SuppressWarnings("unchecked") - public Collection values() - { - return getProperties().values(); - } -} +package org.alfresco.web.bean.repository; + +import java.io.Serializable; +import java.util.Collection; +import java.util.Map; +import java.util.Set; + +import org.alfresco.service.namespace.QName; + +/** + * Represents a transient node i.e. it is not and will not be present in the repository. + *

+ * This type of node is typically used to drive rich lists where the Map implementation + * is required for sorting columns. + *

+ * + * @author gavinc + */ +public class TransientMapNode extends TransientNode implements Map +{ + private static final long serialVersionUID = 1120307465342597322L; + + /** + * Constructor. + *

+ * NOTE: The name is NOT automatically added to the map of properties, + * if you need the name of this node to be in the map then add it to + * the map passed in to this constructor. + *

+ * + * @param type The type this node will represent + * @param name The name of the node + * @param data The properties and associations this node will have + */ + public TransientMapNode(QName type, String name, Map data) + { + super(type, name, data); + } + + @Override + public String toString() + { + return "Transient map node of type: " + getType() + + "\nProperties: " + this.getProperties().toString(); + } + + // ------------------------------------------------------------------------------ + // Map implementation - allows the Node bean to be accessed using JSF expression syntax + + /** + * @see java.util.Map#clear() + */ + public void clear() + { + getProperties().clear(); + } + + /** + * @see java.util.Map#containsKey(java.lang.Object) + */ + public boolean containsKey(Object key) + { + return getProperties().containsKey(key); + } + + /** + * @see java.util.Map#containsValue(java.lang.Object) + */ + public boolean containsValue(Object value) + { + return getProperties().containsKey(value); + } + + /** + * @see java.util.Map#entrySet() + */ + @SuppressWarnings("unchecked") + public Set entrySet() + { + return getProperties().entrySet(); + } + + /** + * @see java.util.Map#get(java.lang.Object) + */ + public Object get(Object key) + { + return getProperties().get(key); + } + + /** + * @see java.util.Map#isEmpty() + */ + public boolean isEmpty() + { + return getProperties().isEmpty(); + } + + /** + * @see java.util.Map#keySet() + */ + @SuppressWarnings("unchecked") + public Set keySet() + { + return getProperties().keySet(); + } + + /** + * @see java.util.Map#put(java.lang.Object, java.lang.Object) + */ + public Object put(String key, Object value) + { + return getProperties().put(key, value); + } + + /** + * @see java.util.Map#putAll(java.util.Map) + */ + @SuppressWarnings("unchecked") + public void putAll(Map t) + { + getProperties().putAll(t); + } + + /** + * @see java.util.Map#remove(java.lang.Object) + */ + public Object remove(Object key) + { + return getProperties().remove(key); + } + + /** + * @see java.util.Map#size() + */ + public int size() + { + return getProperties().size(); + } + + /** + * @see java.util.Map#values() + */ + @SuppressWarnings("unchecked") + public Collection values() + { + return getProperties().values(); + } +} diff --git a/source/java/org/alfresco/web/bean/repository/TransientNode.java b/source/java/org/alfresco/web/bean/repository/TransientNode.java index 76eddd6604..69947ec958 100644 --- a/source/java/org/alfresco/web/bean/repository/TransientNode.java +++ b/source/java/org/alfresco/web/bean/repository/TransientNode.java @@ -1,288 +1,288 @@ -package org.alfresco.web.bean.repository; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.cmr.dictionary.AspectDefinition; -import org.alfresco.service.cmr.dictionary.AssociationDefinition; -import org.alfresco.service.cmr.dictionary.ClassDefinition; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.service.cmr.dictionary.TypeDefinition; -import org.alfresco.service.cmr.repository.AssociationRef; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; -import org.alfresco.service.namespace.QName; -import org.alfresco.util.GUID; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Represents a transient node i.e. it is not and will not be present in the repository. - *

- * This type of node is typically used to drive the property sheet when data collection - * is required for a type but the node does not need to be stored in the repository. An - * example use is the workflow, transient nodes are used to collect workitem metadata. - *

- * - * @author gavinc - */ -public class TransientNode extends Node -{ - private static final long serialVersionUID = 2140554155948154106L; - - private static final Log logger = LogFactory.getLog(TransientNode.class); - - /** - * Constructor. - *

- * NOTE: The name is NOT automatically added to the map of properties, - * if you need the name of this node to be in the map then add it to - * the map passed in to this constructor. - *

- * - * @param type The type this node will represent - * @param name The name of the node - * @param data The properties and associations this node will have - */ - public TransientNode(QName type, String name, Map data) - { - // create a dummy NodeRef to pass to the constructor - super(new NodeRef(Repository.getStoreRef(), GUID.generate())); - - this.type = type; - this.name = name; - - // initialise the node - initNode(data); - } - - /** - * Construct a transient node for an item yet to be created in the Repository. - * - * This will apply any one-time initialisation required upon creation of the node - * e.g. assignment of default values. - * - * @param dictionaryService dictionary service - * @param typeDef The type definition this node will represent - * @param name The name of the node - * @param data The properties and associations this node will have - * @return transient node - */ - public static TransientNode createNew(DictionaryService dictionaryService, TypeDefinition typeDef, String name, Map data) - { - // build a complete anonymous type for the start task - List aspects = typeDef.getDefaultAspects(); - List aspectNames = new ArrayList(aspects.size()); - getMandatoryAspects(typeDef, aspectNames); - ClassDefinition startTaskDef = dictionaryService.getAnonymousType(typeDef.getName(), aspectNames); - - // initialise start task values - Map startValues = new HashMap(); - if (data != null) - { - startValues.putAll(data); - } - - // apply default values - Map propertyDefs = startTaskDef.getProperties(); - for (Map.Entry entry : propertyDefs.entrySet()) - { - String defaultValue = entry.getValue().getDefaultValue(); - if (defaultValue != null) - { - if (startValues.get(entry.getKey()) == null) - { - startValues.put(entry.getKey(), (Serializable)DefaultTypeConverter.INSTANCE.convert(entry.getValue().getDataType(), defaultValue)); - } - } - } - - return new TransientNode(typeDef.getName(), name, startValues); - } - - /** - * Gets a flattened list of all mandatory aspects for a given class - * - * @param classDef the class - * @param aspects a list to hold the mandatory aspects - */ - private static void getMandatoryAspects(ClassDefinition classDef, List aspects) - { - for (AspectDefinition aspect : classDef.getDefaultAspects()) - { - QName aspectName = aspect.getName(); - if (!aspects.contains(aspectName)) - { - aspects.add(aspect.getName()); - getMandatoryAspects(aspect, aspects); - } - } - } - - /** - * Initialises the node. - * - * @param data The properties and associations to initialise the node with - */ - protected void initNode(Map data) - { - // setup the transient node so that the super class methods work - // and do not need to go back to the repository - - if (logger.isDebugEnabled()) - logger.debug("Initialising transient node with data: " + data); - - DictionaryService ddService = this.getServiceRegistry().getDictionaryService(); - - // marshall the given properties and associations into the internal maps - this.associations = new QNameNodeMap(this, this); - this.childAssociations = new QNameNodeMap(this, this); - - if (data != null) - { - // go through all data items and allocate to the correct internal list - for (QName item : data.keySet()) - { - PropertyDefinition propDef = ddService.getProperty(item); - if (propDef != null) - { - this.properties.put(item, data.get(item)); - } - else - { - // see if the item is either type of association - AssociationDefinition assocDef = ddService.getAssociation(item); - if (assocDef != null) - { - if (assocDef.isChild()) - { - Object obj = data.get(item); - if (obj instanceof NodeRef) - { - NodeRef child = (NodeRef)obj; - - // create a child association reference, add it to a list and add the list - // to the list of child associations for this node - List assocs = new ArrayList(1); - ChildAssociationRef childRef = new ChildAssociationRef(assocDef.getName(), this.nodeRef, - null, child); - assocs.add(childRef); - - this.childAssociations.put(item, assocs); - } - else if (obj instanceof List) - { - List targets = (List)obj; - - List assocs = new ArrayList(targets.size()); - - for (Object target : targets) - { - if (target instanceof NodeRef) - { - NodeRef currentChild = (NodeRef)target; - ChildAssociationRef childRef = new ChildAssociationRef(assocDef.getName(), - this.nodeRef, null, currentChild); - assocs.add(childRef); - } - } - - if (assocs.size() > 0) - { - this.childAssociations.put(item, assocs); - } - } - } - else - { - Object obj = data.get(item); - if (obj instanceof NodeRef) - { - NodeRef target = (NodeRef)obj; - - // create a association reference, add it to a list and add the list - // to the list of associations for this node - List assocs = new ArrayList(1); - AssociationRef assocRef = new AssociationRef(null, this.nodeRef, assocDef.getName(), target); - assocs.add(assocRef); - - this.associations.put(item, assocs); - } - else if (obj instanceof List) - { - List targets = (List)obj; - - List assocs = new ArrayList(targets.size()); - - for (Object target : targets) - { - if (target instanceof NodeRef) - { - NodeRef currentTarget = (NodeRef)target; - AssociationRef assocRef = new AssociationRef(null, this.nodeRef, assocDef.getName(), currentTarget); - assocs.add(assocRef); - } - } - - if (assocs.size() > 0) - { - this.associations.put(item, assocs); - } - } - } - } - } - } - } - - // show that the maps have been initialised - this.propsRetrieved = true; - this.assocsRetrieved = true; - this.childAssocsRetrieved = true; - - // setup the list of aspects the node would have - TypeDefinition typeDef = ddService.getType(this.type); - if (typeDef == null) - { - throw new AlfrescoRuntimeException("Failed to find type definition: " + this.type); - } - - // get flat list of all aspects for the type - List defaultAspects = new ArrayList(16); - getMandatoryAspects(typeDef, defaultAspects); - - this.aspects = new HashSet(defaultAspects); - - // setup remaining variables - this.path = null; - this.locked = Boolean.FALSE; - this.workingCopyOwner = Boolean.FALSE; - } - - @Override - public boolean hasPermission(String permission) - { - return true; - } - - @Override - public void reset() - { - // don't reset anything otherwise we'll lose our data - // with no way of getting it back!! - } - - @Override - public String toString() - { - return "Transient node of type: " + getType() + - "\nProperties: " + this.getProperties().toString(); - } -} +package org.alfresco.web.bean.repository; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.cmr.dictionary.AspectDefinition; +import org.alfresco.service.cmr.dictionary.AssociationDefinition; +import org.alfresco.service.cmr.dictionary.ClassDefinition; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.service.cmr.dictionary.TypeDefinition; +import org.alfresco.service.cmr.repository.AssociationRef; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; +import org.alfresco.service.namespace.QName; +import org.alfresco.util.GUID; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Represents a transient node i.e. it is not and will not be present in the repository. + *

+ * This type of node is typically used to drive the property sheet when data collection + * is required for a type but the node does not need to be stored in the repository. An + * example use is the workflow, transient nodes are used to collect workitem metadata. + *

+ * + * @author gavinc + */ +public class TransientNode extends Node +{ + private static final long serialVersionUID = 2140554155948154106L; + + private static final Log logger = LogFactory.getLog(TransientNode.class); + + /** + * Constructor. + *

+ * NOTE: The name is NOT automatically added to the map of properties, + * if you need the name of this node to be in the map then add it to + * the map passed in to this constructor. + *

+ * + * @param type The type this node will represent + * @param name The name of the node + * @param data The properties and associations this node will have + */ + public TransientNode(QName type, String name, Map data) + { + // create a dummy NodeRef to pass to the constructor + super(new NodeRef(Repository.getStoreRef(), GUID.generate())); + + this.type = type; + this.name = name; + + // initialise the node + initNode(data); + } + + /** + * Construct a transient node for an item yet to be created in the Repository. + * + * This will apply any one-time initialisation required upon creation of the node + * e.g. assignment of default values. + * + * @param dictionaryService dictionary service + * @param typeDef The type definition this node will represent + * @param name The name of the node + * @param data The properties and associations this node will have + * @return transient node + */ + public static TransientNode createNew(DictionaryService dictionaryService, TypeDefinition typeDef, String name, Map data) + { + // build a complete anonymous type for the start task + List aspects = typeDef.getDefaultAspects(); + List aspectNames = new ArrayList(aspects.size()); + getMandatoryAspects(typeDef, aspectNames); + ClassDefinition startTaskDef = dictionaryService.getAnonymousType(typeDef.getName(), aspectNames); + + // initialise start task values + Map startValues = new HashMap(); + if (data != null) + { + startValues.putAll(data); + } + + // apply default values + Map propertyDefs = startTaskDef.getProperties(); + for (Map.Entry entry : propertyDefs.entrySet()) + { + String defaultValue = entry.getValue().getDefaultValue(); + if (defaultValue != null) + { + if (startValues.get(entry.getKey()) == null) + { + startValues.put(entry.getKey(), (Serializable)DefaultTypeConverter.INSTANCE.convert(entry.getValue().getDataType(), defaultValue)); + } + } + } + + return new TransientNode(typeDef.getName(), name, startValues); + } + + /** + * Gets a flattened list of all mandatory aspects for a given class + * + * @param classDef the class + * @param aspects a list to hold the mandatory aspects + */ + private static void getMandatoryAspects(ClassDefinition classDef, List aspects) + { + for (AspectDefinition aspect : classDef.getDefaultAspects()) + { + QName aspectName = aspect.getName(); + if (!aspects.contains(aspectName)) + { + aspects.add(aspect.getName()); + getMandatoryAspects(aspect, aspects); + } + } + } + + /** + * Initialises the node. + * + * @param data The properties and associations to initialise the node with + */ + protected void initNode(Map data) + { + // setup the transient node so that the super class methods work + // and do not need to go back to the repository + + if (logger.isDebugEnabled()) + logger.debug("Initialising transient node with data: " + data); + + DictionaryService ddService = this.getServiceRegistry().getDictionaryService(); + + // marshall the given properties and associations into the internal maps + this.associations = new QNameNodeMap(this, this); + this.childAssociations = new QNameNodeMap(this, this); + + if (data != null) + { + // go through all data items and allocate to the correct internal list + for (QName item : data.keySet()) + { + PropertyDefinition propDef = ddService.getProperty(item); + if (propDef != null) + { + this.properties.put(item, data.get(item)); + } + else + { + // see if the item is either type of association + AssociationDefinition assocDef = ddService.getAssociation(item); + if (assocDef != null) + { + if (assocDef.isChild()) + { + Object obj = data.get(item); + if (obj instanceof NodeRef) + { + NodeRef child = (NodeRef)obj; + + // create a child association reference, add it to a list and add the list + // to the list of child associations for this node + List assocs = new ArrayList(1); + ChildAssociationRef childRef = new ChildAssociationRef(assocDef.getName(), this.nodeRef, + null, child); + assocs.add(childRef); + + this.childAssociations.put(item, assocs); + } + else if (obj instanceof List) + { + List targets = (List)obj; + + List assocs = new ArrayList(targets.size()); + + for (Object target : targets) + { + if (target instanceof NodeRef) + { + NodeRef currentChild = (NodeRef)target; + ChildAssociationRef childRef = new ChildAssociationRef(assocDef.getName(), + this.nodeRef, null, currentChild); + assocs.add(childRef); + } + } + + if (assocs.size() > 0) + { + this.childAssociations.put(item, assocs); + } + } + } + else + { + Object obj = data.get(item); + if (obj instanceof NodeRef) + { + NodeRef target = (NodeRef)obj; + + // create a association reference, add it to a list and add the list + // to the list of associations for this node + List assocs = new ArrayList(1); + AssociationRef assocRef = new AssociationRef(null, this.nodeRef, assocDef.getName(), target); + assocs.add(assocRef); + + this.associations.put(item, assocs); + } + else if (obj instanceof List) + { + List targets = (List)obj; + + List assocs = new ArrayList(targets.size()); + + for (Object target : targets) + { + if (target instanceof NodeRef) + { + NodeRef currentTarget = (NodeRef)target; + AssociationRef assocRef = new AssociationRef(null, this.nodeRef, assocDef.getName(), currentTarget); + assocs.add(assocRef); + } + } + + if (assocs.size() > 0) + { + this.associations.put(item, assocs); + } + } + } + } + } + } + } + + // show that the maps have been initialised + this.propsRetrieved = true; + this.assocsRetrieved = true; + this.childAssocsRetrieved = true; + + // setup the list of aspects the node would have + TypeDefinition typeDef = ddService.getType(this.type); + if (typeDef == null) + { + throw new AlfrescoRuntimeException("Failed to find type definition: " + this.type); + } + + // get flat list of all aspects for the type + List defaultAspects = new ArrayList(16); + getMandatoryAspects(typeDef, defaultAspects); + + this.aspects = new HashSet(defaultAspects); + + // setup remaining variables + this.path = null; + this.locked = Boolean.FALSE; + this.workingCopyOwner = Boolean.FALSE; + } + + @Override + public boolean hasPermission(String permission) + { + return true; + } + + @Override + public void reset() + { + // don't reset anything otherwise we'll lose our data + // with no way of getting it back!! + } + + @Override + public String toString() + { + return "Transient node of type: " + getType() + + "\nProperties: " + this.getProperties().toString(); + } +} diff --git a/source/java/org/alfresco/web/bean/rules/CreateCompositeRuleWizard.java b/source/java/org/alfresco/web/bean/rules/CreateCompositeRuleWizard.java index e67065f126..843be8f2c6 100644 --- a/source/java/org/alfresco/web/bean/rules/CreateCompositeRuleWizard.java +++ b/source/java/org/alfresco/web/bean/rules/CreateCompositeRuleWizard.java @@ -1,427 +1,427 @@ -package org.alfresco.web.bean.rules; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.model.DataModel; -import javax.faces.model.ListDataModel; -import javax.faces.model.SelectItem; - -import org.springframework.extensions.config.Config; -import org.springframework.extensions.config.ConfigService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.actions.IHandler; -import org.alfresco.web.bean.rules.handlers.BaseConditionHandler; -import org.alfresco.web.bean.rules.handlers.CompositeConditionHandler; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -public class CreateCompositeRuleWizard extends CreateRuleWizard -{ - private static final Log logger = LogFactory.getLog(CreateCompositeRuleWizard.class); - - private List compositeConditions; - - // Right now the UI only supports one level of recursion, although the - // backend supports unlimited recursion for composites. - // This limitation is introduced by the fact that we are have two "current" - // conditions - either normal condition, or composite conditions - // basically, the UI will have to store conditions in a more native way - // (instead of DataModel) to get unlimited number of composite conditions recursing - protected DataModel currentCompositeConditionsDataModel; - protected List> currentCompositeConditionPropertiesList; - - private boolean addingCompositeCondition; - private boolean editCurrentCompositeCondition; - - private int rowIndex = -1; - - - public CreateCompositeRuleWizard() - { - } - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.setAddingCompositeCondition(false); - this.currentCompositeConditionsDataModel = null; - this.currentCompositeConditionPropertiesList = null; - } - - public void setupCompositeConditionsMode() - { - this.setAddingCompositeCondition(true); - this.currentCompositeConditionsDataModel = new ListDataModel(); - this.currentCompositeConditionPropertiesList = new ArrayList>(); - } - - private void clearCompositeConditionMode() - { - // reset the action drop down - this.selectedCondition = null; - // this.currentConditionProperties = null; - this.currentCompositeConditionsDataModel = null; - this.currentCompositeConditionPropertiesList = null; - this.setAddingCompositeCondition(false); - } - - /** - * Returns the properties for all the conditions as a JSF DataModel - * - * @return JSF DataModel representing the condition properties - */ - public DataModel getAllCompositeConditionsDataModel() - { - if (this.currentCompositeConditionsDataModel == null) - { - this.currentCompositeConditionsDataModel = new ListDataModel(); - } - - this.currentCompositeConditionsDataModel.setWrappedData(this.currentCompositeConditionPropertiesList); - - return this.currentCompositeConditionsDataModel; - } - - /** - * Displays the settings page for the current condition being added (if - * required) - */ - @Override - public void promptForConditionValues() - { - if (CompositeConditionHandler.NAME.equals(this.selectedCondition)) - { - setupCompositeConditionsMode(); - } - - super.promptForConditionValues(); - } - - public void finishAddingCompositeCondition() - { - if (logger.isDebugEnabled()) - logger.debug("Finishing Adding Composite Condition."); - - // reset the effective chosen condition to composite-condition - this.selectedCondition = CompositeConditionHandler.NAME; - - FacesContext context = FacesContext.getCurrentInstance(); - returnViewId = getWizardContainerViewId(context); - - printConditionState(); - - if (logger.isDebugEnabled()) - logger.debug("\tAdding Condition '" + selectedCondition + "'"); - - IHandler handler = this.conditionHandlers.get(this.selectedCondition); - - // creating object temporarily so we can pass it to CompositeConditionHandler - currentConditionProperties.put(CompositeConditionHandler.PROP_COMPOSITE_CONDITION, - (Serializable) this.currentCompositeConditionPropertiesList); - currentConditionProperties.put(PROP_CONDITION_NAME, this.selectedCondition); - - // this is called from the actions page so there must be a handler - // present so there's no need to check for null - String summary = handler.generateSummary(context, this, currentConditionProperties); - - if (summary != null) - { - currentConditionProperties.put(PROP_CONDITION_SUMMARY, summary); - } - if (logger.isDebugEnabled()) - logger.debug("Generated Summary - [" + summary + "] + selectedCondition " + this.selectedCondition); - - if (this.editCurrentCompositeCondition == true) - { - if (rowIndex != -1) - { - this.allConditionsPropertiesList.remove(rowIndex); - this.allConditionsPropertiesList.add(rowIndex, currentConditionProperties); - } - } - else - { - this.allConditionsPropertiesList.add(currentConditionProperties); - } - - this.editCurrentCompositeCondition = false; - this.rowIndex = -1; - clearCompositeConditionMode(); - // refresh the wizard - goToPage(context, this.returnViewId); - } - - private String getWizardContainerViewId(FacesContext context) - { - String viewId = null; - ConfigService configSvc = Application.getConfigService(context); - Config globalConfig = configSvc.getGlobalConfig(); - if (globalConfig != null) - { - viewId = globalConfig.getConfigElement("wizard-container").getValue(); - } - else - { - logger.error("plain-dialog-container configuraion setting is not found"); - } - return viewId; - } - - @Override - public void cancelAddCondition() - { - this.editCurrentCompositeCondition = false; - this.rowIndex = -1; - if (isAddingCompositeCondition()) - { - // don't clear when editing, since we are looking at a REFERENCE to an existing condition - if (this.editingCondition == false) - { - this.currentConditionProperties.clear(); - } - - // reset the action drop down - this.selectedCondition = null; - - // determine what page to go back to - FacesContext context = FacesContext.getCurrentInstance(); - String currentViewId = context.getViewRoot().getViewId(); - - IHandler handler = this.conditionHandlers.get(CompositeConditionHandler.NAME); - String compositePage = handler.getJSPPath(); - - if (currentViewId.equals(compositePage)) - { - this.returnViewId = getWizardContainerViewId(context); - } - - goToPage(FacesContext.getCurrentInstance(), this.returnViewId); - } - else - { - super.cancelAddCondition(); - return; - } - } - - /** - * Adds the condition just setup by the user to the list of composite - * conditions This gathers the composite conditions in the - */ - @Override - public void addCondition() - { - if (!isAddingCompositeCondition()) - { - super.addCondition(); - printConditionState(); - return; - } - - if (logger.isDebugEnabled()) - logger.debug("Adding Condition to Composite Condition. "); - - FacesContext context = FacesContext.getCurrentInstance(); - - // this is called from the actions page so there must be a handler - // present so there's no need to check for null - IHandler handler = this.conditionHandlers.get(this.selectedCondition); - - if (handler != null) - { - String summary = handler.generateSummary(context, this, this.currentConditionProperties); - this.currentConditionProperties.put(PROP_CONDITION_SUMMARY, summary); - } - else - { - if (logger.isWarnEnabled()) - logger.warn("No Summary could be generated for rule condition " + this.selectedCondition); - - this.currentConditionProperties.put(PROP_CONDITION_SUMMARY, "ERROR - No Summary for " + this.selectedCondition); - } - - if (editingCondition == false) - { - //this check is needed to prevent an condition when you are editing a composite, to prevent it from adding twice - currentCompositeConditionPropertiesList.add(this.currentConditionProperties); - if (logger.isDebugEnabled()) - logger.debug("\tAdded condition to Composite condition."); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("\tEdited composite condition. "); - } - - this.currentConditionProperties = new HashMap(3); - - // resetting it for composite condition - // TODO: this is not persistent currently, which causes a minor bug - this.currentConditionProperties.put(PROP_CONDITION_NAME, CompositeConditionHandler.NAME); - this.currentConditionProperties.put(BaseConditionHandler.PROP_CONDITION_NOT, Boolean.FALSE); - - // reset the action drop down - this.selectedCondition = null; - - // refresh the wizard - printConditionState(); - goToPage(context, this.returnViewId); - } - - /** - * Sets up the context for editing existing composite condition values - */ - @SuppressWarnings("unchecked") - public void editCondition() - { - this.editingCondition = true; - - if (logger.isDebugEnabled()) - logger.debug("Editing Conditions. isAddingCompositeConditions - " + isAddingCompositeCondition()); - - //if user is on main conditions screen, check if the condition to be edited is a composite condition - if (!isAddingCompositeCondition()) - { - Map condition = (Map) this.allConditionsDataModel.getRowData(); - this.rowIndex = this.allConditionsDataModel.getRowIndex(); - this.editCurrentCompositeCondition = true; - - if (condition.get(PROP_CONDITION_NAME).equals(CompositeConditionHandler.NAME)) - { - logger.debug("Composite Condition selected, enabling CompositeCondition Mode"); - currentCompositeConditionPropertiesList = (List>) condition - .get(CompositeConditionHandler.PROP_COMPOSITE_CONDITION); - addingCompositeCondition = true; - } - super.editCondition(condition ); - return; - } - else - { - Map subCondition = (Map) currentCompositeConditionsDataModel.getRowData(); - super.editCondition(subCondition); - } - } - - public List getCompositeConditions() - { - if (this.compositeConditions == null) - { - this.compositeConditions = new ArrayList(); - List tempConditions = this.getConditions(); // loads up the conditions - for (SelectItem item : tempConditions) - { - if (!((item.getValue().equals(CompositeConditionHandler.NAME)) || (item.getValue().equals("no-condition")))) - { - this.compositeConditions.add(item); - } - } - } - - return this.compositeConditions; - } - - protected boolean isAddingCompositeCondition() - { - return addingCompositeCondition; - } - - protected void setAddingCompositeCondition(boolean addingCompositeCondition) - { - if (logger.isDebugEnabled()) - logger.debug("Setting addingCompositeCondition to " + addingCompositeCondition); - - this.addingCompositeCondition = addingCompositeCondition; - } - - /** - * Removes the requested condition from the list - */ - public void removeCondition() - { - if (!isAddingCompositeCondition()) - { - super.removeCondition(); - return; - } - - if (logger.isDebugEnabled()) - logger.debug("Removing Composite Conditions"); - - // use the built in JSF support for retrieving the object for the - // row that was clicked by the user - Map conditionToRemove = (Map) this.currentCompositeConditionsDataModel.getRowData(); - this.currentCompositeConditionPropertiesList.remove(conditionToRemove); - // reset the action drop down - this.selectedCondition = null; - - // refresh the wizard - FacesContext context = FacesContext.getCurrentInstance(); - goToPage(context, context.getViewRoot().getViewId()); - } - - protected void printConditionState() - { - if (logger.isDebugEnabled()) - { - logger.debug("\t\t*** GLOBAL ***"); - - logger.debug("\t\tallConditionsProperties"); - if (allConditionsPropertiesList == null) - { - logger.debug("\t\t\tempty"); - } - else - { - for (Object obj : allConditionsPropertiesList) - { - logger.debug("\t\t\t" + obj.toString()); - } - } - - logger.debug("\t\t*** COMPOSITE ***"); - logger.debug("\t\taddingCompositeCondition " + addingCompositeCondition); - - logger.debug("\t\tcurrentCompositeConditionsProperties"); - if (currentCompositeConditionPropertiesList == null) - { - logger.debug("\t\t\t EMPTY"); - } - else - { - int i = 1; - for (Map cond : currentCompositeConditionPropertiesList) - { - logger.debug("\t\t\tCondition" + i++); - - for (String key : cond.keySet()) - { - logger.debug("\t\t\t\tkey - {" + key + "} value - {" + cond.get(key) + "}"); - } - } - } - - logger.debug("\t\t*** BOTH ***"); - - logger.debug("\t\tcurrentConditionsProperties"); - if (currentConditionProperties == null) - { - logger.debug("\t\t\t EMPTY"); - } - else - { - for (String key : this.currentConditionProperties.keySet()) - { - logger.debug("\t\t\tkey - {" + key + "} value - {" + this.currentConditionProperties.get(key) + "}"); - } - } - } - } -} +package org.alfresco.web.bean.rules; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.model.DataModel; +import javax.faces.model.ListDataModel; +import javax.faces.model.SelectItem; + +import org.springframework.extensions.config.Config; +import org.springframework.extensions.config.ConfigService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.actions.IHandler; +import org.alfresco.web.bean.rules.handlers.BaseConditionHandler; +import org.alfresco.web.bean.rules.handlers.CompositeConditionHandler; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class CreateCompositeRuleWizard extends CreateRuleWizard +{ + private static final Log logger = LogFactory.getLog(CreateCompositeRuleWizard.class); + + private List compositeConditions; + + // Right now the UI only supports one level of recursion, although the + // backend supports unlimited recursion for composites. + // This limitation is introduced by the fact that we are have two "current" + // conditions - either normal condition, or composite conditions + // basically, the UI will have to store conditions in a more native way + // (instead of DataModel) to get unlimited number of composite conditions recursing + protected DataModel currentCompositeConditionsDataModel; + protected List> currentCompositeConditionPropertiesList; + + private boolean addingCompositeCondition; + private boolean editCurrentCompositeCondition; + + private int rowIndex = -1; + + + public CreateCompositeRuleWizard() + { + } + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.setAddingCompositeCondition(false); + this.currentCompositeConditionsDataModel = null; + this.currentCompositeConditionPropertiesList = null; + } + + public void setupCompositeConditionsMode() + { + this.setAddingCompositeCondition(true); + this.currentCompositeConditionsDataModel = new ListDataModel(); + this.currentCompositeConditionPropertiesList = new ArrayList>(); + } + + private void clearCompositeConditionMode() + { + // reset the action drop down + this.selectedCondition = null; + // this.currentConditionProperties = null; + this.currentCompositeConditionsDataModel = null; + this.currentCompositeConditionPropertiesList = null; + this.setAddingCompositeCondition(false); + } + + /** + * Returns the properties for all the conditions as a JSF DataModel + * + * @return JSF DataModel representing the condition properties + */ + public DataModel getAllCompositeConditionsDataModel() + { + if (this.currentCompositeConditionsDataModel == null) + { + this.currentCompositeConditionsDataModel = new ListDataModel(); + } + + this.currentCompositeConditionsDataModel.setWrappedData(this.currentCompositeConditionPropertiesList); + + return this.currentCompositeConditionsDataModel; + } + + /** + * Displays the settings page for the current condition being added (if + * required) + */ + @Override + public void promptForConditionValues() + { + if (CompositeConditionHandler.NAME.equals(this.selectedCondition)) + { + setupCompositeConditionsMode(); + } + + super.promptForConditionValues(); + } + + public void finishAddingCompositeCondition() + { + if (logger.isDebugEnabled()) + logger.debug("Finishing Adding Composite Condition."); + + // reset the effective chosen condition to composite-condition + this.selectedCondition = CompositeConditionHandler.NAME; + + FacesContext context = FacesContext.getCurrentInstance(); + returnViewId = getWizardContainerViewId(context); + + printConditionState(); + + if (logger.isDebugEnabled()) + logger.debug("\tAdding Condition '" + selectedCondition + "'"); + + IHandler handler = this.conditionHandlers.get(this.selectedCondition); + + // creating object temporarily so we can pass it to CompositeConditionHandler + currentConditionProperties.put(CompositeConditionHandler.PROP_COMPOSITE_CONDITION, + (Serializable) this.currentCompositeConditionPropertiesList); + currentConditionProperties.put(PROP_CONDITION_NAME, this.selectedCondition); + + // this is called from the actions page so there must be a handler + // present so there's no need to check for null + String summary = handler.generateSummary(context, this, currentConditionProperties); + + if (summary != null) + { + currentConditionProperties.put(PROP_CONDITION_SUMMARY, summary); + } + if (logger.isDebugEnabled()) + logger.debug("Generated Summary - [" + summary + "] + selectedCondition " + this.selectedCondition); + + if (this.editCurrentCompositeCondition == true) + { + if (rowIndex != -1) + { + this.allConditionsPropertiesList.remove(rowIndex); + this.allConditionsPropertiesList.add(rowIndex, currentConditionProperties); + } + } + else + { + this.allConditionsPropertiesList.add(currentConditionProperties); + } + + this.editCurrentCompositeCondition = false; + this.rowIndex = -1; + clearCompositeConditionMode(); + // refresh the wizard + goToPage(context, this.returnViewId); + } + + private String getWizardContainerViewId(FacesContext context) + { + String viewId = null; + ConfigService configSvc = Application.getConfigService(context); + Config globalConfig = configSvc.getGlobalConfig(); + if (globalConfig != null) + { + viewId = globalConfig.getConfigElement("wizard-container").getValue(); + } + else + { + logger.error("plain-dialog-container configuraion setting is not found"); + } + return viewId; + } + + @Override + public void cancelAddCondition() + { + this.editCurrentCompositeCondition = false; + this.rowIndex = -1; + if (isAddingCompositeCondition()) + { + // don't clear when editing, since we are looking at a REFERENCE to an existing condition + if (this.editingCondition == false) + { + this.currentConditionProperties.clear(); + } + + // reset the action drop down + this.selectedCondition = null; + + // determine what page to go back to + FacesContext context = FacesContext.getCurrentInstance(); + String currentViewId = context.getViewRoot().getViewId(); + + IHandler handler = this.conditionHandlers.get(CompositeConditionHandler.NAME); + String compositePage = handler.getJSPPath(); + + if (currentViewId.equals(compositePage)) + { + this.returnViewId = getWizardContainerViewId(context); + } + + goToPage(FacesContext.getCurrentInstance(), this.returnViewId); + } + else + { + super.cancelAddCondition(); + return; + } + } + + /** + * Adds the condition just setup by the user to the list of composite + * conditions This gathers the composite conditions in the + */ + @Override + public void addCondition() + { + if (!isAddingCompositeCondition()) + { + super.addCondition(); + printConditionState(); + return; + } + + if (logger.isDebugEnabled()) + logger.debug("Adding Condition to Composite Condition. "); + + FacesContext context = FacesContext.getCurrentInstance(); + + // this is called from the actions page so there must be a handler + // present so there's no need to check for null + IHandler handler = this.conditionHandlers.get(this.selectedCondition); + + if (handler != null) + { + String summary = handler.generateSummary(context, this, this.currentConditionProperties); + this.currentConditionProperties.put(PROP_CONDITION_SUMMARY, summary); + } + else + { + if (logger.isWarnEnabled()) + logger.warn("No Summary could be generated for rule condition " + this.selectedCondition); + + this.currentConditionProperties.put(PROP_CONDITION_SUMMARY, "ERROR - No Summary for " + this.selectedCondition); + } + + if (editingCondition == false) + { + //this check is needed to prevent an condition when you are editing a composite, to prevent it from adding twice + currentCompositeConditionPropertiesList.add(this.currentConditionProperties); + if (logger.isDebugEnabled()) + logger.debug("\tAdded condition to Composite condition."); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("\tEdited composite condition. "); + } + + this.currentConditionProperties = new HashMap(3); + + // resetting it for composite condition + // TODO: this is not persistent currently, which causes a minor bug + this.currentConditionProperties.put(PROP_CONDITION_NAME, CompositeConditionHandler.NAME); + this.currentConditionProperties.put(BaseConditionHandler.PROP_CONDITION_NOT, Boolean.FALSE); + + // reset the action drop down + this.selectedCondition = null; + + // refresh the wizard + printConditionState(); + goToPage(context, this.returnViewId); + } + + /** + * Sets up the context for editing existing composite condition values + */ + @SuppressWarnings("unchecked") + public void editCondition() + { + this.editingCondition = true; + + if (logger.isDebugEnabled()) + logger.debug("Editing Conditions. isAddingCompositeConditions - " + isAddingCompositeCondition()); + + //if user is on main conditions screen, check if the condition to be edited is a composite condition + if (!isAddingCompositeCondition()) + { + Map condition = (Map) this.allConditionsDataModel.getRowData(); + this.rowIndex = this.allConditionsDataModel.getRowIndex(); + this.editCurrentCompositeCondition = true; + + if (condition.get(PROP_CONDITION_NAME).equals(CompositeConditionHandler.NAME)) + { + logger.debug("Composite Condition selected, enabling CompositeCondition Mode"); + currentCompositeConditionPropertiesList = (List>) condition + .get(CompositeConditionHandler.PROP_COMPOSITE_CONDITION); + addingCompositeCondition = true; + } + super.editCondition(condition ); + return; + } + else + { + Map subCondition = (Map) currentCompositeConditionsDataModel.getRowData(); + super.editCondition(subCondition); + } + } + + public List getCompositeConditions() + { + if (this.compositeConditions == null) + { + this.compositeConditions = new ArrayList(); + List tempConditions = this.getConditions(); // loads up the conditions + for (SelectItem item : tempConditions) + { + if (!((item.getValue().equals(CompositeConditionHandler.NAME)) || (item.getValue().equals("no-condition")))) + { + this.compositeConditions.add(item); + } + } + } + + return this.compositeConditions; + } + + protected boolean isAddingCompositeCondition() + { + return addingCompositeCondition; + } + + protected void setAddingCompositeCondition(boolean addingCompositeCondition) + { + if (logger.isDebugEnabled()) + logger.debug("Setting addingCompositeCondition to " + addingCompositeCondition); + + this.addingCompositeCondition = addingCompositeCondition; + } + + /** + * Removes the requested condition from the list + */ + public void removeCondition() + { + if (!isAddingCompositeCondition()) + { + super.removeCondition(); + return; + } + + if (logger.isDebugEnabled()) + logger.debug("Removing Composite Conditions"); + + // use the built in JSF support for retrieving the object for the + // row that was clicked by the user + Map conditionToRemove = (Map) this.currentCompositeConditionsDataModel.getRowData(); + this.currentCompositeConditionPropertiesList.remove(conditionToRemove); + // reset the action drop down + this.selectedCondition = null; + + // refresh the wizard + FacesContext context = FacesContext.getCurrentInstance(); + goToPage(context, context.getViewRoot().getViewId()); + } + + protected void printConditionState() + { + if (logger.isDebugEnabled()) + { + logger.debug("\t\t*** GLOBAL ***"); + + logger.debug("\t\tallConditionsProperties"); + if (allConditionsPropertiesList == null) + { + logger.debug("\t\t\tempty"); + } + else + { + for (Object obj : allConditionsPropertiesList) + { + logger.debug("\t\t\t" + obj.toString()); + } + } + + logger.debug("\t\t*** COMPOSITE ***"); + logger.debug("\t\taddingCompositeCondition " + addingCompositeCondition); + + logger.debug("\t\tcurrentCompositeConditionsProperties"); + if (currentCompositeConditionPropertiesList == null) + { + logger.debug("\t\t\t EMPTY"); + } + else + { + int i = 1; + for (Map cond : currentCompositeConditionPropertiesList) + { + logger.debug("\t\t\tCondition" + i++); + + for (String key : cond.keySet()) + { + logger.debug("\t\t\t\tkey - {" + key + "} value - {" + cond.get(key) + "}"); + } + } + } + + logger.debug("\t\t*** BOTH ***"); + + logger.debug("\t\tcurrentConditionsProperties"); + if (currentConditionProperties == null) + { + logger.debug("\t\t\t EMPTY"); + } + else + { + for (String key : this.currentConditionProperties.keySet()) + { + logger.debug("\t\t\tkey - {" + key + "} value - {" + this.currentConditionProperties.get(key) + "}"); + } + } + } + } +} diff --git a/source/java/org/alfresco/web/bean/rules/handlers/CompositeConditionHandler.java b/source/java/org/alfresco/web/bean/rules/handlers/CompositeConditionHandler.java index ca5bd49f0f..97caecd420 100644 --- a/source/java/org/alfresco/web/bean/rules/handlers/CompositeConditionHandler.java +++ b/source/java/org/alfresco/web/bean/rules/handlers/CompositeConditionHandler.java @@ -1,107 +1,107 @@ -package org.alfresco.web.bean.rules.handlers; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.repo.action.ActionModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.wizard.IWizardBean; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * @author Jean Barmash - * This class has no equivalent evaluator, since it - * - */ -public class CompositeConditionHandler extends BaseConditionHandler -{ - public static final String NAME = "composite-condition"; - public static final String PROP_COMPOSITE_CONDITION = "composite-condition"; - - private static final Log logger = LogFactory.getLog(CompositeConditionHandler.class); - - public static final String PROP_CONDITION_OR = "orconditions"; - - /* (non-Javadoc) - * @see org.alfresco.web.bean.actions.IHandler#generateSummary(javax.faces.context.FacesContext, org.alfresco.web.bean.wizard.IWizardBean, java.util.Map) - */ - public String generateSummary(FacesContext context, IWizardBean wizard, - Map props) - { - List conditionPropertiesList = (List) props.get(PROP_COMPOSITE_CONDITION); - if (conditionPropertiesList == null ) - { - logger.error("Error - composite condition has no sub-conditions"); - - if (logger.isDebugEnabled()) - { - for (String str : props.keySet()) - { - logger.debug("\t key - "+ str + " value " + props.get(str)); - } - } - - return Application.getMessage(context, "condition_composite_error"); - } - - Boolean not = (Boolean) props.get(PROP_CONDITION_NOT); - Boolean orconditions = (Boolean) props.get(PROP_CONDITION_OR); - - String msgId = not.booleanValue() ? "condition_composite_summary_not" : "condition_composite_summary"; - return MessageFormat.format(Application.getMessage(context, msgId), - new Object[] {conditionPropertiesList.size(), orconditions.booleanValue()?"ORed":"ANDed"}); - } - - /* (non-Javadoc) - * @see org.alfresco.web.bean.actions.IHandler#getJSPPath() - */ - public String getJSPPath() - { - return getJSPPath(CompositeConditionHandler.NAME); - } - - /* (non-Javadoc) - * @see org.alfresco.web.bean.actions.IHandler#prepareForEdit(java.util.Map, java.util.Map) - */ - public void prepareForEdit(Map uiConditionProps, - Map repoProps) - { - if (logger.isDebugEnabled()) - logger.debug("Preparing Composite Condition for Edit"); - - Boolean orconditions = (Boolean) repoProps.get(PROP_CONDITION_OR); - if (orconditions == null) - { - if (logger.isWarnEnabled()) - logger.warn("orconditions is NULL, it should not be. Defaulting to false"); - - orconditions = Boolean.FALSE; - } - - uiConditionProps.put(PROP_CONDITION_OR, orconditions); - } - - public void prepareForSave(Map uiConditionProps, - Map repoProps) - { - if (logger.isDebugEnabled()) - logger.debug("Saving Composite Condition"); - - // put the selected category in the condition params - Boolean orconditions = (Boolean)uiConditionProps.get(PROP_CONDITION_OR); - if (orconditions == null) - { - if (logger.isWarnEnabled()) - logger.warn("orconditions is NULL, it should not be. Defaulting to false"); - - orconditions = Boolean.FALSE; - } - - repoProps.put(PROP_CONDITION_OR, orconditions); - } -} +package org.alfresco.web.bean.rules.handlers; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.repo.action.ActionModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.wizard.IWizardBean; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * @author Jean Barmash + * This class has no equivalent evaluator, since it + * + */ +public class CompositeConditionHandler extends BaseConditionHandler +{ + public static final String NAME = "composite-condition"; + public static final String PROP_COMPOSITE_CONDITION = "composite-condition"; + + private static final Log logger = LogFactory.getLog(CompositeConditionHandler.class); + + public static final String PROP_CONDITION_OR = "orconditions"; + + /* (non-Javadoc) + * @see org.alfresco.web.bean.actions.IHandler#generateSummary(javax.faces.context.FacesContext, org.alfresco.web.bean.wizard.IWizardBean, java.util.Map) + */ + public String generateSummary(FacesContext context, IWizardBean wizard, + Map props) + { + List conditionPropertiesList = (List) props.get(PROP_COMPOSITE_CONDITION); + if (conditionPropertiesList == null ) + { + logger.error("Error - composite condition has no sub-conditions"); + + if (logger.isDebugEnabled()) + { + for (String str : props.keySet()) + { + logger.debug("\t key - "+ str + " value " + props.get(str)); + } + } + + return Application.getMessage(context, "condition_composite_error"); + } + + Boolean not = (Boolean) props.get(PROP_CONDITION_NOT); + Boolean orconditions = (Boolean) props.get(PROP_CONDITION_OR); + + String msgId = not.booleanValue() ? "condition_composite_summary_not" : "condition_composite_summary"; + return MessageFormat.format(Application.getMessage(context, msgId), + new Object[] {conditionPropertiesList.size(), orconditions.booleanValue()?"ORed":"ANDed"}); + } + + /* (non-Javadoc) + * @see org.alfresco.web.bean.actions.IHandler#getJSPPath() + */ + public String getJSPPath() + { + return getJSPPath(CompositeConditionHandler.NAME); + } + + /* (non-Javadoc) + * @see org.alfresco.web.bean.actions.IHandler#prepareForEdit(java.util.Map, java.util.Map) + */ + public void prepareForEdit(Map uiConditionProps, + Map repoProps) + { + if (logger.isDebugEnabled()) + logger.debug("Preparing Composite Condition for Edit"); + + Boolean orconditions = (Boolean) repoProps.get(PROP_CONDITION_OR); + if (orconditions == null) + { + if (logger.isWarnEnabled()) + logger.warn("orconditions is NULL, it should not be. Defaulting to false"); + + orconditions = Boolean.FALSE; + } + + uiConditionProps.put(PROP_CONDITION_OR, orconditions); + } + + public void prepareForSave(Map uiConditionProps, + Map repoProps) + { + if (logger.isDebugEnabled()) + logger.debug("Saving Composite Condition"); + + // put the selected category in the condition params + Boolean orconditions = (Boolean)uiConditionProps.get(PROP_CONDITION_OR); + if (orconditions == null) + { + if (logger.isWarnEnabled()) + logger.warn("orconditions is NULL, it should not be. Defaulting to false"); + + orconditions = Boolean.FALSE; + } + + repoProps.put(PROP_CONDITION_OR, orconditions); + } +} diff --git a/source/java/org/alfresco/web/bean/search/EditSearchDialog.java b/source/java/org/alfresco/web/bean/search/EditSearchDialog.java index ce5993a7da..23c9e4355e 100644 --- a/source/java/org/alfresco/web/bean/search/EditSearchDialog.java +++ b/source/java/org/alfresco/web/bean/search/EditSearchDialog.java @@ -1,97 +1,97 @@ -package org.alfresco.web.bean.search; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class EditSearchDialog extends AdvancedSearchDialog -{ - private static final long serialVersionUID = -8914819218709478527L; - - private static final String MSG_ERROR_SAVE_SEARCH = "error_save_search"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return saveEditSearchOK(context, outcome); - } - - @Override - public String getFinishButtonLabel() - { - return super.getFinishButtonLabel(); - } - - public String saveEditSearchOK(FacesContext newContext, String newOutcome) - { - String outcome = newOutcome; - - final SearchContext search = this.navigator.getSearchContext(); - if (search != null) - { - try - { - final FacesContext context = newContext; - - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // handle Edit e.g. Overwrite of existing search - // detect if was previously selected saved search (e.g. - // NodeRef not null) - NodeRef searchRef = new NodeRef(Repository.getStoreRef(), properties.getSavedSearch()); - if (getNodeService().exists(searchRef)) - { - Map props = getNodeService().getProperties(searchRef); - props.put(ContentModel.PROP_NAME, properties.getSearchName()); - props.put(ContentModel.PROP_DESCRIPTION, properties.getSearchDescription()); - getNodeService().setProperties(searchRef, props); - - ContentService contentService = Repository.getServiceRegistry(context).getContentService(); - ContentWriter writer = contentService.getWriter(searchRef, ContentModel.PROP_CONTENT, true); - - // get a writer to our new node ready for XML - // content - writer.setMimetype(MimetypeMap.MIMETYPE_XML); - writer.setEncoding("UTF-8"); - - // output an XML serialized version of the - // SearchContext object - writer.putContent(search.toXML()); - } - return null; - } - }; - callback.execute(); - - properties.getCachedSavedSearches().clear(); - properties.setSavedSearch(null); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, MSG_ERROR_SAVE_SEARCH), e.getMessage()), e); - outcome = null; - this.isFinished = false; - ReportedException.throwIfNecessary(e); - } - } - - return outcome; - } - -} +package org.alfresco.web.bean.search; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class EditSearchDialog extends AdvancedSearchDialog +{ + private static final long serialVersionUID = -8914819218709478527L; + + private static final String MSG_ERROR_SAVE_SEARCH = "error_save_search"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return saveEditSearchOK(context, outcome); + } + + @Override + public String getFinishButtonLabel() + { + return super.getFinishButtonLabel(); + } + + public String saveEditSearchOK(FacesContext newContext, String newOutcome) + { + String outcome = newOutcome; + + final SearchContext search = this.navigator.getSearchContext(); + if (search != null) + { + try + { + final FacesContext context = newContext; + + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // handle Edit e.g. Overwrite of existing search + // detect if was previously selected saved search (e.g. + // NodeRef not null) + NodeRef searchRef = new NodeRef(Repository.getStoreRef(), properties.getSavedSearch()); + if (getNodeService().exists(searchRef)) + { + Map props = getNodeService().getProperties(searchRef); + props.put(ContentModel.PROP_NAME, properties.getSearchName()); + props.put(ContentModel.PROP_DESCRIPTION, properties.getSearchDescription()); + getNodeService().setProperties(searchRef, props); + + ContentService contentService = Repository.getServiceRegistry(context).getContentService(); + ContentWriter writer = contentService.getWriter(searchRef, ContentModel.PROP_CONTENT, true); + + // get a writer to our new node ready for XML + // content + writer.setMimetype(MimetypeMap.MIMETYPE_XML); + writer.setEncoding("UTF-8"); + + // output an XML serialized version of the + // SearchContext object + writer.putContent(search.toXML()); + } + return null; + } + }; + callback.execute(); + + properties.getCachedSavedSearches().clear(); + properties.setSavedSearch(null); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, MSG_ERROR_SAVE_SEARCH), e.getMessage()), e); + outcome = null; + this.isFinished = false; + ReportedException.throwIfNecessary(e); + } + } + + return outcome; + } + +} diff --git a/source/java/org/alfresco/web/bean/search/SaveSearchDialog.java b/source/java/org/alfresco/web/bean/search/SaveSearchDialog.java index 890c987ecd..a86c8fc621 100644 --- a/source/java/org/alfresco/web/bean/search/SaveSearchDialog.java +++ b/source/java/org/alfresco/web/bean/search/SaveSearchDialog.java @@ -1,106 +1,106 @@ -package org.alfresco.web.bean.search; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; - -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class SaveSearchDialog extends AdvancedSearchDialog -{ - - private static final long serialVersionUID = 237262751601280456L; - - private static final String MSG_ERROR_SAVE_SEARCH = "error_save_search"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return saveNewSearchOK(context, outcome); - } - - @Override - public String getFinishButtonLabel() - { - return super.getFinishButtonLabel(); - } - - public String saveNewSearchOK(FacesContext newContext, String newOutcome) - { - String outcome = newOutcome; - - NodeRef searchesRef; - if (properties.isSearchSaveGlobal()) - { - searchesRef = getGlobalSearchesRef(); - } - else - { - searchesRef = getUserSearchesRef(); - } - - final SearchContext search = this.navigator.getSearchContext(); - if (searchesRef != null && search != null) - { - try - { - final FacesContext context = newContext;// FacesContext.getCurrentInstance(); - final NodeRef searchesRefFinal = searchesRef; - - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // create new content node as the saved search object - Map props = new HashMap(2, 1.0f); - props.put(ContentModel.PROP_NAME, properties.getSearchName()); - props.put(ContentModel.PROP_DESCRIPTION, properties.getSearchDescription()); - ChildAssociationRef childRef = getNodeService().createNode(searchesRefFinal, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.ALFRESCO_URI, QName - .createValidLocalName(properties.getSearchName())), ContentModel.TYPE_CONTENT, props); - - ContentService contentService = Repository.getServiceRegistry(context).getContentService(); - ContentWriter writer = contentService.getWriter(childRef.getChildRef(), ContentModel.PROP_CONTENT, true); - - // get a writer to our new node ready for XML content - writer.setMimetype(MimetypeMap.MIMETYPE_XML); - writer.setEncoding("UTF-8"); - - // output an XML serialized version of the SearchContext - // object - writer.putContent(search.toXML()); - return null; - } - }; - callback.execute(); - properties.getCachedSavedSearches().clear(); - properties.setSavedSearch(null); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, MSG_ERROR_SAVE_SEARCH), e.getMessage()), e); - outcome = null; - this.isFinished = false; - ReportedException.throwIfNecessary(e); - } - } - - return outcome; - } - -} +package org.alfresco.web.bean.search; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; + +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class SaveSearchDialog extends AdvancedSearchDialog +{ + + private static final long serialVersionUID = 237262751601280456L; + + private static final String MSG_ERROR_SAVE_SEARCH = "error_save_search"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return saveNewSearchOK(context, outcome); + } + + @Override + public String getFinishButtonLabel() + { + return super.getFinishButtonLabel(); + } + + public String saveNewSearchOK(FacesContext newContext, String newOutcome) + { + String outcome = newOutcome; + + NodeRef searchesRef; + if (properties.isSearchSaveGlobal()) + { + searchesRef = getGlobalSearchesRef(); + } + else + { + searchesRef = getUserSearchesRef(); + } + + final SearchContext search = this.navigator.getSearchContext(); + if (searchesRef != null && search != null) + { + try + { + final FacesContext context = newContext;// FacesContext.getCurrentInstance(); + final NodeRef searchesRefFinal = searchesRef; + + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // create new content node as the saved search object + Map props = new HashMap(2, 1.0f); + props.put(ContentModel.PROP_NAME, properties.getSearchName()); + props.put(ContentModel.PROP_DESCRIPTION, properties.getSearchDescription()); + ChildAssociationRef childRef = getNodeService().createNode(searchesRefFinal, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.ALFRESCO_URI, QName + .createValidLocalName(properties.getSearchName())), ContentModel.TYPE_CONTENT, props); + + ContentService contentService = Repository.getServiceRegistry(context).getContentService(); + ContentWriter writer = contentService.getWriter(childRef.getChildRef(), ContentModel.PROP_CONTENT, true); + + // get a writer to our new node ready for XML content + writer.setMimetype(MimetypeMap.MIMETYPE_XML); + writer.setEncoding("UTF-8"); + + // output an XML serialized version of the SearchContext + // object + writer.putContent(search.toXML()); + return null; + } + }; + callback.execute(); + properties.getCachedSavedSearches().clear(); + properties.setSavedSearch(null); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, MSG_ERROR_SAVE_SEARCH), e.getMessage()), e); + outcome = null; + this.isFinished = false; + ReportedException.throwIfNecessary(e); + } + } + + return outcome; + } + +} diff --git a/source/java/org/alfresco/web/bean/search/SearchProperties.java b/source/java/org/alfresco/web/bean/search/SearchProperties.java index d961f4d786..328b7cc4af 100644 --- a/source/java/org/alfresco/web/bean/search/SearchProperties.java +++ b/source/java/org/alfresco/web/bean/search/SearchProperties.java @@ -1,495 +1,495 @@ -package org.alfresco.web.bean.search; - -import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.Serializable; -import java.util.ArrayList; -import java.util.Date; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.model.DataModel; -import javax.faces.model.ListDataModel; -import javax.faces.model.SelectItem; - -import org.alfresco.service.cmr.dictionary.DataTypeDefinition; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.util.ExpiringValueCache; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.config.AdvancedSearchConfigElement; - -public class SearchProperties implements Serializable -{ - private static final long serialVersionUID = 8583342903708013641L; - - private static final String MODE_ALL = "all"; - private static final String LOOKIN_ALL = "all"; - private static final String SAVED_SEARCHES_USER = "user"; - - /** Client Config reference */ - private AdvancedSearchConfigElement searchConfigElement = null; - - /** Progressive panel UI state */ - private Map panels = new HashMap(5, 1.0f); - - /** Saved search properties */ - private String searchName; - private String searchDescription; - - /** custom property names to values */ - private Map customProperties = new HashMap(5, 1.0f); - - /** - * lookup of custom property QName string to DataTypeDefinition for the property - */ - transient private Map customPropertyLookup = null; - - /** content format list restricting searches */ - private List contentFormats; - - /** content format selection */ - private String contentFormat; - - /** content type selection */ - private String contentType; - - /** content types for restricting searches */ - private List contentTypes; - - /** folder type selection */ - private String folderType; - - /** folder types for restricting searches */ - private List folderTypes; - - /** the text to search for */ - private String text = ""; - - /** search mode */ - private String mode = MODE_ALL; - - /** folder lookin mode */ - private String lookin = LOOKIN_ALL; - - /** Space Selector location */ - private NodeRef location = null; - - /** categories to search */ - private List categories = new ArrayList(2); - - /** datamodel for table of categories to search */ - transient private DataModel categoriesDataModel = null; - - /** title attribute to search */ - private String title = null; - - /** description attribute to search */ - private String description = null; - - /** created attribute to search from */ - private Date createdDateFrom = null; - - /** created attribute to search to */ - private Date createdDateTo = null; - - /** modified attribute to search from */ - private Date modifiedDateFrom = null; - - /** modified attribute to search to */ - private Date modifiedDateTo = null; - - /** true to search location children as well as location */ - private boolean locationChildren = true; - - /** author (creator) attribute to search */ - private String author = null; - - private boolean modifiedDateChecked = false; - private boolean createdDateChecked = false; - - /** cached ref to the global saved searches folder */ - private NodeRef globalSearchesRef = null; - - /** cached ref to the current users saved searches folder */ - private NodeRef userSearchesRef = null; - - /** ID to the last selected saved search */ - private String savedSearch = null; - - /** ModeList component value for selecting user/global searches */ - private String savedSearchMode = SAVED_SEARCHES_USER; - - /** name of the saved search to edit */ - private String editSearchName = null; - - /** form field for saving search as user/global */ - private boolean searchSaveGlobal = false; - - /** auto-expiring cache of the list of saved searches */ - private ExpiringValueCache> cachedSavedSearches = new ExpiringValueCache>(); - - - public AdvancedSearchConfigElement getSearchConfigElement() - { - return searchConfigElement; - } - - public void setSearchConfigElement(AdvancedSearchConfigElement searchConfigElement) - { - this.searchConfigElement = searchConfigElement; - } - - public Map getPanels() - { - return panels; - } - - public void setPanels(Map panels) - { - this.panels = panels; - } - - public String getSearchName() - { - return searchName; - } - - public void setSearchName(String searchName) - { - this.searchName = searchName; - } - - public String getSearchDescription() - { - return searchDescription; - } - - public void setSearchDescription(String searchDescription) - { - this.searchDescription = searchDescription; - } - - public Map getCustomProperties() - { - return customProperties; - } - - public void setCustomProperties(Map customProperties) - { - this.customProperties = customProperties; - } - - public Map getCustomPropertyLookup() - { - return customPropertyLookup; - } - - public void setCustomPropertyLookup(Map customPropertyLookup) - { - this.customPropertyLookup = customPropertyLookup; - } - - public List getContentFormats() - { - return contentFormats; - } - - public void setContentFormats(List contentFormats) - { - this.contentFormats = contentFormats; - } - - public String getContentFormat() - { - return contentFormat; - } - - public void setContentFormat(String contentFormat) - { - this.contentFormat = contentFormat; - } - - public String getContentType() - { - return contentType; - } - - public void setContentType(String contentType) - { - this.contentType = contentType; - } - - public List getContentTypes() - { - return contentTypes; - } - - public void setContentTypes(List contentTypes) - { - this.contentTypes = contentTypes; - } - - public String getFolderType() - { - return folderType; - } - - public void setFolderType(String folderType) - { - this.folderType = folderType; - } - - public List getFolderTypes() - { - return folderTypes; - } - - public void setFolderTypes(List folderTypes) - { - this.folderTypes = folderTypes; - } - - public String getText() - { - return text; - } - - public void setText(String text) - { - this.text = text; - } - - public String getMode() - { - return mode; - } - - public void setMode(String mode) - { - this.mode = mode; - } - - public String getLookin() - { - return lookin; - } - - public void setLookin(String lookin) - { - this.lookin = lookin; - } - - public NodeRef getLocation() - { - return location; - } - - public void setLocation(NodeRef location) - { - this.location = location; - } - - public List getCategories() - { - return categories; - } - - public void setCategories(List categories) - { - this.categories = categories; - } - - public DataModel getCategoriesDataModel() - { - if (categoriesDataModel == null) - { - categoriesDataModel = new ListDataModel(); - } - - return categoriesDataModel; - } - - public void setCategoriesDataModel(DataModel categoriesDataModel) - { - this.categoriesDataModel = categoriesDataModel; - } - - public String getTitle() - { - return title; - } - - public void setTitle(String title) - { - this.title = title; - } - - public String getDescription() - { - return description; - } - - public void setDescription(String description) - { - this.description = description; - } - - public Date getCreatedDateFrom() - { - return createdDateFrom; - } - - public void setCreatedDateFrom(Date createdDateFrom) - { - this.createdDateFrom = createdDateFrom; - } - - public Date getCreatedDateTo() - { - return createdDateTo; - } - - public void setCreatedDateTo(Date createdDateTo) - { - this.createdDateTo = createdDateTo; - } - - public Date getModifiedDateFrom() - { - return modifiedDateFrom; - } - - public void setModifiedDateFrom(Date modifiedDateFrom) - { - this.modifiedDateFrom = modifiedDateFrom; - } - - public Date getModifiedDateTo() - { - return modifiedDateTo; - } - - public void setModifiedDateTo(Date modifiedDateTo) - { - this.modifiedDateTo = modifiedDateTo; - } - - public boolean isLocationChildren() - { - return locationChildren; - } - - public void setLocationChildren(boolean locationChildren) - { - this.locationChildren = locationChildren; - } - - public String getAuthor() - { - return author; - } - - public void setAuthor(String author) - { - this.author = author; - } - - public boolean isModifiedDateChecked() - { - return modifiedDateChecked; - } - - public void setModifiedDateChecked(boolean modifiedDateChecked) - { - this.modifiedDateChecked = modifiedDateChecked; - } - - public boolean isCreatedDateChecked() - { - return createdDateChecked; - } - - public void setCreatedDateChecked(boolean createdDateChecked) - { - this.createdDateChecked = createdDateChecked; - } - - public NodeRef getGlobalSearchesRef() - { - return globalSearchesRef; - } - - public void setGlobalSearchesRef(NodeRef globalSearchesRef) - { - this.globalSearchesRef = globalSearchesRef; - } - - public NodeRef getUserSearchesRef() - { - return userSearchesRef; - } - - public void setUserSearchesRef(NodeRef userSearchesRef) - { - this.userSearchesRef = userSearchesRef; - } - - public String getSavedSearch() - { - return savedSearch; - } - - public void setSavedSearch(String savedSearch) - { - this.savedSearch = savedSearch; - } - - public String getSavedSearchMode() - { - return savedSearchMode; - } - - public void setSavedSearchMode(String savedSearchMode) - { - this.savedSearchMode = savedSearchMode; - } - - public String getEditSearchName() - { - return editSearchName; - } - - public void setEditSearchName(String editSearchName) - { - this.editSearchName = editSearchName; - } - - public boolean isSearchSaveGlobal() - { - return searchSaveGlobal; - } - - public void setSearchSaveGlobal(boolean searchSaveGlobal) - { - this.searchSaveGlobal = searchSaveGlobal; - } - - public ExpiringValueCache> getCachedSavedSearches() - { - return cachedSavedSearches; - } - - public void setCachedSavedSearches(ExpiringValueCache> cachedSavedSearches) - { - this.cachedSavedSearches = cachedSavedSearches; - } - - private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException - { - in.defaultReadObject(); - - categoriesDataModel = new ListDataModel(); - } - -} +package org.alfresco.web.bean.search; + +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.model.DataModel; +import javax.faces.model.ListDataModel; +import javax.faces.model.SelectItem; + +import org.alfresco.service.cmr.dictionary.DataTypeDefinition; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.util.ExpiringValueCache; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.config.AdvancedSearchConfigElement; + +public class SearchProperties implements Serializable +{ + private static final long serialVersionUID = 8583342903708013641L; + + private static final String MODE_ALL = "all"; + private static final String LOOKIN_ALL = "all"; + private static final String SAVED_SEARCHES_USER = "user"; + + /** Client Config reference */ + private AdvancedSearchConfigElement searchConfigElement = null; + + /** Progressive panel UI state */ + private Map panels = new HashMap(5, 1.0f); + + /** Saved search properties */ + private String searchName; + private String searchDescription; + + /** custom property names to values */ + private Map customProperties = new HashMap(5, 1.0f); + + /** + * lookup of custom property QName string to DataTypeDefinition for the property + */ + transient private Map customPropertyLookup = null; + + /** content format list restricting searches */ + private List contentFormats; + + /** content format selection */ + private String contentFormat; + + /** content type selection */ + private String contentType; + + /** content types for restricting searches */ + private List contentTypes; + + /** folder type selection */ + private String folderType; + + /** folder types for restricting searches */ + private List folderTypes; + + /** the text to search for */ + private String text = ""; + + /** search mode */ + private String mode = MODE_ALL; + + /** folder lookin mode */ + private String lookin = LOOKIN_ALL; + + /** Space Selector location */ + private NodeRef location = null; + + /** categories to search */ + private List categories = new ArrayList(2); + + /** datamodel for table of categories to search */ + transient private DataModel categoriesDataModel = null; + + /** title attribute to search */ + private String title = null; + + /** description attribute to search */ + private String description = null; + + /** created attribute to search from */ + private Date createdDateFrom = null; + + /** created attribute to search to */ + private Date createdDateTo = null; + + /** modified attribute to search from */ + private Date modifiedDateFrom = null; + + /** modified attribute to search to */ + private Date modifiedDateTo = null; + + /** true to search location children as well as location */ + private boolean locationChildren = true; + + /** author (creator) attribute to search */ + private String author = null; + + private boolean modifiedDateChecked = false; + private boolean createdDateChecked = false; + + /** cached ref to the global saved searches folder */ + private NodeRef globalSearchesRef = null; + + /** cached ref to the current users saved searches folder */ + private NodeRef userSearchesRef = null; + + /** ID to the last selected saved search */ + private String savedSearch = null; + + /** ModeList component value for selecting user/global searches */ + private String savedSearchMode = SAVED_SEARCHES_USER; + + /** name of the saved search to edit */ + private String editSearchName = null; + + /** form field for saving search as user/global */ + private boolean searchSaveGlobal = false; + + /** auto-expiring cache of the list of saved searches */ + private ExpiringValueCache> cachedSavedSearches = new ExpiringValueCache>(); + + + public AdvancedSearchConfigElement getSearchConfigElement() + { + return searchConfigElement; + } + + public void setSearchConfigElement(AdvancedSearchConfigElement searchConfigElement) + { + this.searchConfigElement = searchConfigElement; + } + + public Map getPanels() + { + return panels; + } + + public void setPanels(Map panels) + { + this.panels = panels; + } + + public String getSearchName() + { + return searchName; + } + + public void setSearchName(String searchName) + { + this.searchName = searchName; + } + + public String getSearchDescription() + { + return searchDescription; + } + + public void setSearchDescription(String searchDescription) + { + this.searchDescription = searchDescription; + } + + public Map getCustomProperties() + { + return customProperties; + } + + public void setCustomProperties(Map customProperties) + { + this.customProperties = customProperties; + } + + public Map getCustomPropertyLookup() + { + return customPropertyLookup; + } + + public void setCustomPropertyLookup(Map customPropertyLookup) + { + this.customPropertyLookup = customPropertyLookup; + } + + public List getContentFormats() + { + return contentFormats; + } + + public void setContentFormats(List contentFormats) + { + this.contentFormats = contentFormats; + } + + public String getContentFormat() + { + return contentFormat; + } + + public void setContentFormat(String contentFormat) + { + this.contentFormat = contentFormat; + } + + public String getContentType() + { + return contentType; + } + + public void setContentType(String contentType) + { + this.contentType = contentType; + } + + public List getContentTypes() + { + return contentTypes; + } + + public void setContentTypes(List contentTypes) + { + this.contentTypes = contentTypes; + } + + public String getFolderType() + { + return folderType; + } + + public void setFolderType(String folderType) + { + this.folderType = folderType; + } + + public List getFolderTypes() + { + return folderTypes; + } + + public void setFolderTypes(List folderTypes) + { + this.folderTypes = folderTypes; + } + + public String getText() + { + return text; + } + + public void setText(String text) + { + this.text = text; + } + + public String getMode() + { + return mode; + } + + public void setMode(String mode) + { + this.mode = mode; + } + + public String getLookin() + { + return lookin; + } + + public void setLookin(String lookin) + { + this.lookin = lookin; + } + + public NodeRef getLocation() + { + return location; + } + + public void setLocation(NodeRef location) + { + this.location = location; + } + + public List getCategories() + { + return categories; + } + + public void setCategories(List categories) + { + this.categories = categories; + } + + public DataModel getCategoriesDataModel() + { + if (categoriesDataModel == null) + { + categoriesDataModel = new ListDataModel(); + } + + return categoriesDataModel; + } + + public void setCategoriesDataModel(DataModel categoriesDataModel) + { + this.categoriesDataModel = categoriesDataModel; + } + + public String getTitle() + { + return title; + } + + public void setTitle(String title) + { + this.title = title; + } + + public String getDescription() + { + return description; + } + + public void setDescription(String description) + { + this.description = description; + } + + public Date getCreatedDateFrom() + { + return createdDateFrom; + } + + public void setCreatedDateFrom(Date createdDateFrom) + { + this.createdDateFrom = createdDateFrom; + } + + public Date getCreatedDateTo() + { + return createdDateTo; + } + + public void setCreatedDateTo(Date createdDateTo) + { + this.createdDateTo = createdDateTo; + } + + public Date getModifiedDateFrom() + { + return modifiedDateFrom; + } + + public void setModifiedDateFrom(Date modifiedDateFrom) + { + this.modifiedDateFrom = modifiedDateFrom; + } + + public Date getModifiedDateTo() + { + return modifiedDateTo; + } + + public void setModifiedDateTo(Date modifiedDateTo) + { + this.modifiedDateTo = modifiedDateTo; + } + + public boolean isLocationChildren() + { + return locationChildren; + } + + public void setLocationChildren(boolean locationChildren) + { + this.locationChildren = locationChildren; + } + + public String getAuthor() + { + return author; + } + + public void setAuthor(String author) + { + this.author = author; + } + + public boolean isModifiedDateChecked() + { + return modifiedDateChecked; + } + + public void setModifiedDateChecked(boolean modifiedDateChecked) + { + this.modifiedDateChecked = modifiedDateChecked; + } + + public boolean isCreatedDateChecked() + { + return createdDateChecked; + } + + public void setCreatedDateChecked(boolean createdDateChecked) + { + this.createdDateChecked = createdDateChecked; + } + + public NodeRef getGlobalSearchesRef() + { + return globalSearchesRef; + } + + public void setGlobalSearchesRef(NodeRef globalSearchesRef) + { + this.globalSearchesRef = globalSearchesRef; + } + + public NodeRef getUserSearchesRef() + { + return userSearchesRef; + } + + public void setUserSearchesRef(NodeRef userSearchesRef) + { + this.userSearchesRef = userSearchesRef; + } + + public String getSavedSearch() + { + return savedSearch; + } + + public void setSavedSearch(String savedSearch) + { + this.savedSearch = savedSearch; + } + + public String getSavedSearchMode() + { + return savedSearchMode; + } + + public void setSavedSearchMode(String savedSearchMode) + { + this.savedSearchMode = savedSearchMode; + } + + public String getEditSearchName() + { + return editSearchName; + } + + public void setEditSearchName(String editSearchName) + { + this.editSearchName = editSearchName; + } + + public boolean isSearchSaveGlobal() + { + return searchSaveGlobal; + } + + public void setSearchSaveGlobal(boolean searchSaveGlobal) + { + this.searchSaveGlobal = searchSaveGlobal; + } + + public ExpiringValueCache> getCachedSavedSearches() + { + return cachedSavedSearches; + } + + public void setCachedSavedSearches(ExpiringValueCache> cachedSavedSearches) + { + this.cachedSavedSearches = cachedSavedSearches; + } + + private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException + { + in.defaultReadObject(); + + categoriesDataModel = new ListDataModel(); + } + +} diff --git a/source/java/org/alfresco/web/bean/spaces/ApplyDocTemplateDialog.java b/source/java/org/alfresco/web/bean/spaces/ApplyDocTemplateDialog.java index 4b3dfc043f..4bcbaa7247 100644 --- a/source/java/org/alfresco/web/bean/spaces/ApplyDocTemplateDialog.java +++ b/source/java/org/alfresco/web/bean/spaces/ApplyDocTemplateDialog.java @@ -1,87 +1,87 @@ -package org.alfresco.web.bean.spaces; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.TemplateSupportBean; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class ApplyDocTemplateDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -9098279672434597354L; - - private static final String DIALOG_CLOSE = "dialog:close"; - private static final String MSG_APPLY_TEMPLATE = "apply_template"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - protected String template; - - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) - { - try - { - // apply the templatable aspect if required - if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE) == false) - { - this.getNodeService().addAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE, null); - } - - // get the selected template from the Template Picker - NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); - - // set the template NodeRef into the templatable aspect property - this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, templateRef); - - // reset node details for next refresh of details page - getNode().reset(); - } - catch (Exception e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } - return DIALOG_CLOSE; - } - - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_APPLY_TEMPLATE) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - public String getTemplate() - { - // return current template if it exists - NodeRef ref = (NodeRef) getNode().getProperties().get(ContentModel.PROP_TEMPLATE); - return ref != null ? ref.getId() : this.template; - } - - public void setTemplate(String template) - { - this.template = template; - } - - public Node getNode() - { - return this.browseBean.getDocument(); - } - - public String getName() - { - return getNode().getName(); - } +package org.alfresco.web.bean.spaces; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.TemplateSupportBean; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class ApplyDocTemplateDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -9098279672434597354L; + + private static final String DIALOG_CLOSE = "dialog:close"; + private static final String MSG_APPLY_TEMPLATE = "apply_template"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + protected String template; + + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) + { + try + { + // apply the templatable aspect if required + if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE) == false) + { + this.getNodeService().addAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE, null); + } + + // get the selected template from the Template Picker + NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); + + // set the template NodeRef into the templatable aspect property + this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, templateRef); + + // reset node details for next refresh of details page + getNode().reset(); + } + catch (Exception e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } + return DIALOG_CLOSE; + } + + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_APPLY_TEMPLATE) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + public String getTemplate() + { + // return current template if it exists + NodeRef ref = (NodeRef) getNode().getProperties().get(ContentModel.PROP_TEMPLATE); + return ref != null ? ref.getId() : this.template; + } + + public void setTemplate(String template) + { + this.template = template; + } + + public Node getNode() + { + return this.browseBean.getDocument(); + } + + public String getName() + { + return getNode().getName(); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/bean/spaces/ApplyRssTemplateDialog.java b/source/java/org/alfresco/web/bean/spaces/ApplyRssTemplateDialog.java index c3a7bef1b1..8e2cbdcfb1 100644 --- a/source/java/org/alfresco/web/bean/spaces/ApplyRssTemplateDialog.java +++ b/source/java/org/alfresco/web/bean/spaces/ApplyRssTemplateDialog.java @@ -1,96 +1,96 @@ -package org.alfresco.web.bean.spaces; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.TemplateSupportBean; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class ApplyRssTemplateDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 9207265799149337182L; - - private static final String DIALOG_CLOSE = "dialog:close"; - private static final String MSG_APPLY_RSS_FEED = "apply_rss_feed"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private String rssTemplate; - - - public void setRSSTemplate(String rssTemplate) - { - this.rssTemplate = rssTemplate; - } - - /** - * @return Returns the current RSS Template ID. - */ - public String getRSSTemplate() - { - // return current template if it exists - NodeRef ref = (NodeRef) getNode().getProperties().get(ApplicationModel.PROP_FEEDTEMPLATE); - return ref != null ? ref.getId() : this.rssTemplate; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - applyRSSTemplate(null); - return DIALOG_CLOSE; - } - - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_APPLY_RSS_FEED) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + getNode().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - public void applyRSSTemplate(ActionEvent event) - { - if (this.rssTemplate != null && this.rssTemplate.equals(TemplateSupportBean.NO_SELECTION) == false) - { - try - { - // apply the feedsource aspect if required - if (getNode().hasAspect(ApplicationModel.ASPECT_FEEDSOURCE) == false) - { - this.getNodeService().addAspect(getNode().getNodeRef(), ApplicationModel.ASPECT_FEEDSOURCE, null); - } - - // get the selected template Id from the Template Picker - NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.rssTemplate); - - // set the template NodeRef into the templatable aspect property - this.getNodeService().setProperty(getNode().getNodeRef(), ApplicationModel.PROP_FEEDTEMPLATE, templateRef); - - // reset node details for next refresh of details page - getNode().reset(); - } - catch (Exception e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } - } - - /** - * Returns the Node this bean is currently representing - * - * @return The Node - */ - public Node getNode() - { - return this.browseBean.getActionSpace(); - } +package org.alfresco.web.bean.spaces; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.TemplateSupportBean; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class ApplyRssTemplateDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 9207265799149337182L; + + private static final String DIALOG_CLOSE = "dialog:close"; + private static final String MSG_APPLY_RSS_FEED = "apply_rss_feed"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private String rssTemplate; + + + public void setRSSTemplate(String rssTemplate) + { + this.rssTemplate = rssTemplate; + } + + /** + * @return Returns the current RSS Template ID. + */ + public String getRSSTemplate() + { + // return current template if it exists + NodeRef ref = (NodeRef) getNode().getProperties().get(ApplicationModel.PROP_FEEDTEMPLATE); + return ref != null ? ref.getId() : this.rssTemplate; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + applyRSSTemplate(null); + return DIALOG_CLOSE; + } + + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_APPLY_RSS_FEED) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + getNode().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + public void applyRSSTemplate(ActionEvent event) + { + if (this.rssTemplate != null && this.rssTemplate.equals(TemplateSupportBean.NO_SELECTION) == false) + { + try + { + // apply the feedsource aspect if required + if (getNode().hasAspect(ApplicationModel.ASPECT_FEEDSOURCE) == false) + { + this.getNodeService().addAspect(getNode().getNodeRef(), ApplicationModel.ASPECT_FEEDSOURCE, null); + } + + // get the selected template Id from the Template Picker + NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.rssTemplate); + + // set the template NodeRef into the templatable aspect property + this.getNodeService().setProperty(getNode().getNodeRef(), ApplicationModel.PROP_FEEDTEMPLATE, templateRef); + + // reset node details for next refresh of details page + getNode().reset(); + } + catch (Exception e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } + } + + /** + * Returns the Node this bean is currently representing + * + * @return The Node + */ + public Node getNode() + { + return this.browseBean.getActionSpace(); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/bean/spaces/ApplySpaceTemplateDialog.java b/source/java/org/alfresco/web/bean/spaces/ApplySpaceTemplateDialog.java index 5b3ac989fe..36e6259a79 100644 --- a/source/java/org/alfresco/web/bean/spaces/ApplySpaceTemplateDialog.java +++ b/source/java/org/alfresco/web/bean/spaces/ApplySpaceTemplateDialog.java @@ -1,87 +1,87 @@ -package org.alfresco.web.bean.spaces; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.TemplateSupportBean; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class ApplySpaceTemplateDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -3019234033026890265L; - - private static final String DIALOG_CLOSE = "dialog:close"; - private static final String MSG_APPLY_TEMPLATE = "apply_template"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - protected String template; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - applyTemplate(null); - return DIALOG_CLOSE; - } - - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_APPLY_TEMPLATE) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + getNode().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - public void applyTemplate(ActionEvent event) - { - if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) - { - try - { - // apply the templatable aspect if required - if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE) == false) - { - this.getNodeService().addAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE, null); - } - - // get the selected template from the Template Picker - NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); - - // set the template NodeRef into the templatable aspect property - this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, templateRef); - - // reset node details for next refresh of details page - getNode().reset(); - } - catch (Exception e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } - } - - public Node getNode() - { - return this.browseBean.getActionSpace(); - } - - public String getTemplate() - { - // return current template if it exists - NodeRef ref = (NodeRef) getNode().getProperties().get(ContentModel.PROP_TEMPLATE); - return ref != null ? ref.getId() : this.template; - } - - public void setTemplate(String template) - { - this.template = template; - } +package org.alfresco.web.bean.spaces; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.TemplateSupportBean; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class ApplySpaceTemplateDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -3019234033026890265L; + + private static final String DIALOG_CLOSE = "dialog:close"; + private static final String MSG_APPLY_TEMPLATE = "apply_template"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + protected String template; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + applyTemplate(null); + return DIALOG_CLOSE; + } + + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_APPLY_TEMPLATE) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + getNode().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + public void applyTemplate(ActionEvent event) + { + if (this.template != null && this.template.equals(TemplateSupportBean.NO_SELECTION) == false) + { + try + { + // apply the templatable aspect if required + if (getNode().hasAspect(ContentModel.ASPECT_TEMPLATABLE) == false) + { + this.getNodeService().addAspect(getNode().getNodeRef(), ContentModel.ASPECT_TEMPLATABLE, null); + } + + // get the selected template from the Template Picker + NodeRef templateRef = new NodeRef(Repository.getStoreRef(), this.template); + + // set the template NodeRef into the templatable aspect property + this.getNodeService().setProperty(getNode().getNodeRef(), ContentModel.PROP_TEMPLATE, templateRef); + + // reset node details for next refresh of details page + getNode().reset(); + } + catch (Exception e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } + } + + public Node getNode() + { + return this.browseBean.getActionSpace(); + } + + public String getTemplate() + { + // return current template if it exists + NodeRef ref = (NodeRef) getNode().getProperties().get(ContentModel.PROP_TEMPLATE); + return ref != null ? ref.getId() : this.template; + } + + public void setTemplate(String template) + { + this.template = template; + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/bean/spaces/DeleteSpaceDialog.java b/source/java/org/alfresco/web/bean/spaces/DeleteSpaceDialog.java index 7455a487f8..34a9a693d5 100644 --- a/source/java/org/alfresco/web/bean/spaces/DeleteSpaceDialog.java +++ b/source/java/org/alfresco/web/bean/spaces/DeleteSpaceDialog.java @@ -1,320 +1,320 @@ -package org.alfresco.web.bean.spaces; - -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.TypeDefinition; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.service.namespace.RegexQNamePattern; -import org.alfresco.service.transaction.TransactionService; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.content.DeleteContentDialog; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation for the "Delete Space" dialog - * - * @author gavinc - */ -public class DeleteSpaceDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 5960844637376808571L; - - private static final Log logger = LogFactory.getLog(DeleteContentDialog.class); - - private static final String DELETE_ALL = "all"; - private static final String DELETE_FILES = "files"; - private static final String DELETE_FOLDERS = "folders"; - private static final String DELETE_CONTENTS = "contents"; - - private String deleteMode = DELETE_ALL; - private boolean executeRules = true; - private boolean archiveNodes = true; - - protected boolean hasMultipleParents = false; - - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.hasMultipleParents = false; - - String strHasMultipleParents = this.parameters.get("hasMultipleParents"); - if (strHasMultipleParents != null && "true".equals(strHasMultipleParents)) - { - this.hasMultipleParents = true; - } - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - final boolean isAdmin = this.navigator.getCurrentUser().isAdmin(); - // get the space to delete - Node node = this.browseBean.getActionSpace(); - if (node != null) - { - // force cache of name property so we can use it after the delete - node.getName(); - - if (logger.isDebugEnabled()) - logger.debug("Trying to delete space: " + node.getId() + " using delete mode: " + this.deleteMode); - - try - { - if (isAdmin && !this.executeRules) - { - Repository.getServiceRegistry(context).getRuleService().disableRules(); - } - if (DELETE_ALL.equals(this.deleteMode)) - { - NodeRef nodeRef = node.getNodeRef(); - // Check the node still exists - if (this.getNodeService().exists(nodeRef)) - { - if (isAdmin && !this.archiveNodes) - { - this.getNodeService().addAspect(node.getNodeRef(), ContentModel.ASPECT_TEMPORARY, null); - } - - // ensure the node still exists before deleting - if (this.getNodeService().exists(node.getNodeRef())) - { - this.getNodeService().deleteNode(node.getNodeRef()); - } - } - } - else - { - List childRefs = this.getNodeService().getChildAssocs(node.getNodeRef(), - ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL); - List deleteRefs = new ArrayList(childRefs.size()); - for (ChildAssociationRef ref : childRefs) - { - NodeRef nodeRef = ref.getChildRef(); - - if (this.getNodeService().exists(nodeRef)) - { - if (DELETE_CONTENTS.equals(this.deleteMode)) - { - deleteRefs.add(nodeRef); - } - else - { - // find it's type so we can see if it's a node we are interested in - QName type = this.getNodeService().getType(nodeRef); - - // make sure the type is defined in the data dictionary - TypeDefinition typeDef = this.getDictionaryService().getType(type); - - if (typeDef != null) - { - if (DELETE_FOLDERS.equals(this.deleteMode)) - { - // look for folder type - if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_FOLDER) == true && - this.getDictionaryService().isSubClass(type, ContentModel.TYPE_SYSTEM_FOLDER) == false) - { - deleteRefs.add(nodeRef); - } - } - else if (DELETE_FILES.equals(this.deleteMode)) - { - // look for content file type - if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_CONTENT)) - { - deleteRefs.add(nodeRef); - } - } - } - } - } - } - - // delete the list of refs - TransactionService txService = Repository.getServiceRegistry(context).getTransactionService(); - for (NodeRef nodeRef : deleteRefs) - { - UserTransaction tx = null; - - try - { - tx = txService.getNonPropagatingUserTransaction(); - tx.begin(); - - if (isAdmin && !this.archiveNodes) - { - this.getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TEMPORARY, null); - } - - // ensure the node still exists before deleting - if (this.getNodeService().exists(node.getNodeRef())) - { - this.getNodeService().deleteNode(nodeRef); - } - - tx.commit(); - } - catch (Throwable err) - { - try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} - } - } - } - } - finally - { - if (isAdmin && !this.executeRules) - { - Repository.getServiceRegistry(context).getRuleService().enableRules(); - } - } - } - else - { - logger.warn("WARNING: delete called without a current Space!"); - } - - return outcome; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - Node node = this.browseBean.getActionSpace(); - - if (node != null && this.getNodeService().exists(node.getNodeRef()) == false) - { - // remove this node from the breadcrumb if required - this.browseBean.removeSpaceFromBreadcrumb(node); - - // clear action context - this.browseBean.setActionSpace(null); - - // setting the outcome will show the browse view again - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + - AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "browse"; - } - else - { - return outcome; - } - } - - @Override - protected String getErrorMessageId() - { - return "error_delete_space"; - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - protected String getConfirmMessageId() - { - return "delete_space_confirm"; - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns the confirmation to display to the user before deleting the content. - * - * @return The formatted message to display - */ - public String getConfirmMessage() - { - String fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - getConfirmMessageId()); - - Node node = this.browseBean.getActionSpace(); - if (node != null) - { - return MessageFormat.format(fileConfirmMsg, new Object[] {node.getName()}); - } - else - { - return Application.getMessage(FacesContext.getCurrentInstance(), - "delete_node_not_found"); - } - } - - /** - * @return Returns the delete operation mode. - */ - public String getDeleteMode() - { - return this.deleteMode; - } - - /** - * @param deleteMode The delete operation mode to set. - */ - public void setDeleteMode(String deleteMode) - { - this.deleteMode = deleteMode; - } - - /** - * @return true if the space has multiple parents - */ - public boolean getHasMultipleParents() - { - return this.hasMultipleParents; - } - - /** - * @return true to execute rules during delete - */ - public boolean getExecuteRules() - { - return this.executeRules; - } - - /** - * @param executeRules execute rules during delete - */ - public void setExecuteRules(boolean executeRules) - { - this.executeRules = executeRules; - } - - /** - * @return true to archive nodes during delete - */ - public boolean getArchiveNodes() - { - return this.archiveNodes; - } - - /** - * @param archiveNodes archive nodes during delete - */ - public void setArchiveNodes(boolean archiveNodes) - { - this.archiveNodes = archiveNodes; - } -} +package org.alfresco.web.bean.spaces; + +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.TypeDefinition; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.service.namespace.RegexQNamePattern; +import org.alfresco.service.transaction.TransactionService; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.content.DeleteContentDialog; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation for the "Delete Space" dialog + * + * @author gavinc + */ +public class DeleteSpaceDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 5960844637376808571L; + + private static final Log logger = LogFactory.getLog(DeleteContentDialog.class); + + private static final String DELETE_ALL = "all"; + private static final String DELETE_FILES = "files"; + private static final String DELETE_FOLDERS = "folders"; + private static final String DELETE_CONTENTS = "contents"; + + private String deleteMode = DELETE_ALL; + private boolean executeRules = true; + private boolean archiveNodes = true; + + protected boolean hasMultipleParents = false; + + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.hasMultipleParents = false; + + String strHasMultipleParents = this.parameters.get("hasMultipleParents"); + if (strHasMultipleParents != null && "true".equals(strHasMultipleParents)) + { + this.hasMultipleParents = true; + } + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + final boolean isAdmin = this.navigator.getCurrentUser().isAdmin(); + // get the space to delete + Node node = this.browseBean.getActionSpace(); + if (node != null) + { + // force cache of name property so we can use it after the delete + node.getName(); + + if (logger.isDebugEnabled()) + logger.debug("Trying to delete space: " + node.getId() + " using delete mode: " + this.deleteMode); + + try + { + if (isAdmin && !this.executeRules) + { + Repository.getServiceRegistry(context).getRuleService().disableRules(); + } + if (DELETE_ALL.equals(this.deleteMode)) + { + NodeRef nodeRef = node.getNodeRef(); + // Check the node still exists + if (this.getNodeService().exists(nodeRef)) + { + if (isAdmin && !this.archiveNodes) + { + this.getNodeService().addAspect(node.getNodeRef(), ContentModel.ASPECT_TEMPORARY, null); + } + + // ensure the node still exists before deleting + if (this.getNodeService().exists(node.getNodeRef())) + { + this.getNodeService().deleteNode(node.getNodeRef()); + } + } + } + else + { + List childRefs = this.getNodeService().getChildAssocs(node.getNodeRef(), + ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL); + List deleteRefs = new ArrayList(childRefs.size()); + for (ChildAssociationRef ref : childRefs) + { + NodeRef nodeRef = ref.getChildRef(); + + if (this.getNodeService().exists(nodeRef)) + { + if (DELETE_CONTENTS.equals(this.deleteMode)) + { + deleteRefs.add(nodeRef); + } + else + { + // find it's type so we can see if it's a node we are interested in + QName type = this.getNodeService().getType(nodeRef); + + // make sure the type is defined in the data dictionary + TypeDefinition typeDef = this.getDictionaryService().getType(type); + + if (typeDef != null) + { + if (DELETE_FOLDERS.equals(this.deleteMode)) + { + // look for folder type + if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_FOLDER) == true && + this.getDictionaryService().isSubClass(type, ContentModel.TYPE_SYSTEM_FOLDER) == false) + { + deleteRefs.add(nodeRef); + } + } + else if (DELETE_FILES.equals(this.deleteMode)) + { + // look for content file type + if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_CONTENT)) + { + deleteRefs.add(nodeRef); + } + } + } + } + } + } + + // delete the list of refs + TransactionService txService = Repository.getServiceRegistry(context).getTransactionService(); + for (NodeRef nodeRef : deleteRefs) + { + UserTransaction tx = null; + + try + { + tx = txService.getNonPropagatingUserTransaction(); + tx.begin(); + + if (isAdmin && !this.archiveNodes) + { + this.getNodeService().addAspect(nodeRef, ContentModel.ASPECT_TEMPORARY, null); + } + + // ensure the node still exists before deleting + if (this.getNodeService().exists(node.getNodeRef())) + { + this.getNodeService().deleteNode(nodeRef); + } + + tx.commit(); + } + catch (Throwable err) + { + try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} + } + } + } + } + finally + { + if (isAdmin && !this.executeRules) + { + Repository.getServiceRegistry(context).getRuleService().enableRules(); + } + } + } + else + { + logger.warn("WARNING: delete called without a current Space!"); + } + + return outcome; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + Node node = this.browseBean.getActionSpace(); + + if (node != null && this.getNodeService().exists(node.getNodeRef()) == false) + { + // remove this node from the breadcrumb if required + this.browseBean.removeSpaceFromBreadcrumb(node); + + // clear action context + this.browseBean.setActionSpace(null); + + // setting the outcome will show the browse view again + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME + + AlfrescoNavigationHandler.OUTCOME_SEPARATOR + "browse"; + } + else + { + return outcome; + } + } + + @Override + protected String getErrorMessageId() + { + return "error_delete_space"; + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + protected String getConfirmMessageId() + { + return "delete_space_confirm"; + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns the confirmation to display to the user before deleting the content. + * + * @return The formatted message to display + */ + public String getConfirmMessage() + { + String fileConfirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + getConfirmMessageId()); + + Node node = this.browseBean.getActionSpace(); + if (node != null) + { + return MessageFormat.format(fileConfirmMsg, new Object[] {node.getName()}); + } + else + { + return Application.getMessage(FacesContext.getCurrentInstance(), + "delete_node_not_found"); + } + } + + /** + * @return Returns the delete operation mode. + */ + public String getDeleteMode() + { + return this.deleteMode; + } + + /** + * @param deleteMode The delete operation mode to set. + */ + public void setDeleteMode(String deleteMode) + { + this.deleteMode = deleteMode; + } + + /** + * @return true if the space has multiple parents + */ + public boolean getHasMultipleParents() + { + return this.hasMultipleParents; + } + + /** + * @return true to execute rules during delete + */ + public boolean getExecuteRules() + { + return this.executeRules; + } + + /** + * @param executeRules execute rules during delete + */ + public void setExecuteRules(boolean executeRules) + { + this.executeRules = executeRules; + } + + /** + * @return true to archive nodes during delete + */ + public boolean getArchiveNodes() + { + return this.archiveNodes; + } + + /** + * @param archiveNodes archive nodes during delete + */ + public void setArchiveNodes(boolean archiveNodes) + { + this.archiveNodes = archiveNodes; + } +} diff --git a/source/java/org/alfresco/web/bean/spaces/EditSimpleWorkflowDialog.java b/source/java/org/alfresco/web/bean/spaces/EditSimpleWorkflowDialog.java index 4f7a4c1d90..e29c9caa9a 100644 --- a/source/java/org/alfresco/web/bean/spaces/EditSimpleWorkflowDialog.java +++ b/source/java/org/alfresco/web/bean/spaces/EditSimpleWorkflowDialog.java @@ -1,176 +1,176 @@ -package org.alfresco.web.bean.spaces; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.actions.handlers.SimpleWorkflowHandler; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class EditSimpleWorkflowDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 5997327694341960824L; - - protected Map workflowProperties; - - private static final String MSG_ERROR_UPDATE_SIMPLEWORKFLOW = "error_update_simpleworkflow"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - saveWorkflow(); - return outcome; - } - - public boolean getFinishButtonDisabled() - { - return false; - } - - public String saveWorkflow() - { - String outcome = "cancel"; - - try - { - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - // firstly retrieve all the properties for the current node - Map updateProps = getNodeService().getProperties(getNode().getNodeRef()); - - // update the simple workflow properties - - // set the approve step name - updateProps.put(ApplicationModel.PROP_APPROVE_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME)); - - // specify whether the approve step will copy or move the content - boolean approveMove = true; - String approveAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_ACTION); - if (approveAction != null && approveAction.equals("copy")) - { - approveMove = false; - } - updateProps.put(ApplicationModel.PROP_APPROVE_MOVE, Boolean.valueOf(approveMove)); - - // create node ref representation of the destination folder - updateProps.put(ApplicationModel.PROP_APPROVE_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_FOLDER)); - - // determine whether there should be a reject step - boolean requireReject = true; - String rejectStepPresent = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT); - if (rejectStepPresent != null && rejectStepPresent.equals("no")) - { - requireReject = false; - } - - if (requireReject) - { - // set the reject step name - updateProps.put(ApplicationModel.PROP_REJECT_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME)); - - // specify whether the reject step will copy or move the content - boolean rejectMove = true; - String rejectAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_ACTION); - if (rejectAction != null && rejectAction.equals("copy")) - { - rejectMove = false; - } - updateProps.put(ApplicationModel.PROP_REJECT_MOVE, Boolean.valueOf(rejectMove)); - - // create node ref representation of the destination folder - updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_FOLDER)); - } - else - { - // set all the reject properties to null to signify there should - // be no reject step - updateProps.put(ApplicationModel.PROP_REJECT_STEP, null); - updateProps.put(ApplicationModel.PROP_REJECT_MOVE, null); - updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, null); - } - - // set the properties on the node - getNodeService().setProperties(getNode().getNodeRef(), updateProps); - return null; - } - }; - txnHelper.doInTransaction(callback); - - // reset the state of the current node so it reflects the changes just made - getNode().reset(); - - outcome = "finish"; - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), MSG_ERROR_UPDATE_SIMPLEWORKFLOW), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - - return outcome; - } - - /** - * Returns the properties for the attached workflow as a map - * - * @return Properties of the attached workflow, null if there is no workflow - */ - public Map getWorkflowProperties() - { - if (this.workflowProperties == null && getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) - { - // get the exisiting properties for the node - Map props = getNode().getProperties(); - - String approveStepName = (String) props.get(ApplicationModel.PROP_APPROVE_STEP.toString()); - String rejectStepName = (String) props.get(ApplicationModel.PROP_REJECT_STEP.toString()); - - Boolean approveMove = (Boolean) props.get(ApplicationModel.PROP_APPROVE_MOVE.toString()); - Boolean rejectMove = (Boolean) props.get(ApplicationModel.PROP_REJECT_MOVE.toString()); - - NodeRef approveFolder = (NodeRef) props.get(ApplicationModel.PROP_APPROVE_FOLDER.toString()); - NodeRef rejectFolder = (NodeRef) props.get(ApplicationModel.PROP_REJECT_FOLDER.toString()); - - // put the workflow properties in a separate map for use by the JSP - this.workflowProperties = new HashMap(7); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME, approveStepName); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_ACTION, approveMove ? "move" : "copy"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_FOLDER, approveFolder); - - if (rejectStepName == null || rejectMove == null || rejectFolder == null) - { - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "no"); - } - else - { - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "yes"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME, rejectStepName); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_ACTION, rejectMove ? "move" : "copy"); - this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_FOLDER, rejectFolder); - } - } - - return this.workflowProperties; - } - - public Node getNode() - { - return this.browseBean.getActionSpace(); - } -} +package org.alfresco.web.bean.spaces; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.actions.handlers.SimpleWorkflowHandler; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class EditSimpleWorkflowDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 5997327694341960824L; + + protected Map workflowProperties; + + private static final String MSG_ERROR_UPDATE_SIMPLEWORKFLOW = "error_update_simpleworkflow"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + saveWorkflow(); + return outcome; + } + + public boolean getFinishButtonDisabled() + { + return false; + } + + public String saveWorkflow() + { + String outcome = "cancel"; + + try + { + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(FacesContext.getCurrentInstance()); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + // firstly retrieve all the properties for the current node + Map updateProps = getNodeService().getProperties(getNode().getNodeRef()); + + // update the simple workflow properties + + // set the approve step name + updateProps.put(ApplicationModel.PROP_APPROVE_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME)); + + // specify whether the approve step will copy or move the content + boolean approveMove = true; + String approveAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_ACTION); + if (approveAction != null && approveAction.equals("copy")) + { + approveMove = false; + } + updateProps.put(ApplicationModel.PROP_APPROVE_MOVE, Boolean.valueOf(approveMove)); + + // create node ref representation of the destination folder + updateProps.put(ApplicationModel.PROP_APPROVE_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_APPROVE_FOLDER)); + + // determine whether there should be a reject step + boolean requireReject = true; + String rejectStepPresent = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT); + if (rejectStepPresent != null && rejectStepPresent.equals("no")) + { + requireReject = false; + } + + if (requireReject) + { + // set the reject step name + updateProps.put(ApplicationModel.PROP_REJECT_STEP, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME)); + + // specify whether the reject step will copy or move the content + boolean rejectMove = true; + String rejectAction = (String) workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_ACTION); + if (rejectAction != null && rejectAction.equals("copy")) + { + rejectMove = false; + } + updateProps.put(ApplicationModel.PROP_REJECT_MOVE, Boolean.valueOf(rejectMove)); + + // create node ref representation of the destination folder + updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, workflowProperties.get(SimpleWorkflowHandler.PROP_REJECT_FOLDER)); + } + else + { + // set all the reject properties to null to signify there should + // be no reject step + updateProps.put(ApplicationModel.PROP_REJECT_STEP, null); + updateProps.put(ApplicationModel.PROP_REJECT_MOVE, null); + updateProps.put(ApplicationModel.PROP_REJECT_FOLDER, null); + } + + // set the properties on the node + getNodeService().setProperties(getNode().getNodeRef(), updateProps); + return null; + } + }; + txnHelper.doInTransaction(callback); + + // reset the state of the current node so it reflects the changes just made + getNode().reset(); + + outcome = "finish"; + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), MSG_ERROR_UPDATE_SIMPLEWORKFLOW), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + + return outcome; + } + + /** + * Returns the properties for the attached workflow as a map + * + * @return Properties of the attached workflow, null if there is no workflow + */ + public Map getWorkflowProperties() + { + if (this.workflowProperties == null && getNode().hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) + { + // get the exisiting properties for the node + Map props = getNode().getProperties(); + + String approveStepName = (String) props.get(ApplicationModel.PROP_APPROVE_STEP.toString()); + String rejectStepName = (String) props.get(ApplicationModel.PROP_REJECT_STEP.toString()); + + Boolean approveMove = (Boolean) props.get(ApplicationModel.PROP_APPROVE_MOVE.toString()); + Boolean rejectMove = (Boolean) props.get(ApplicationModel.PROP_REJECT_MOVE.toString()); + + NodeRef approveFolder = (NodeRef) props.get(ApplicationModel.PROP_APPROVE_FOLDER.toString()); + NodeRef rejectFolder = (NodeRef) props.get(ApplicationModel.PROP_REJECT_FOLDER.toString()); + + // put the workflow properties in a separate map for use by the JSP + this.workflowProperties = new HashMap(7); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_STEP_NAME, approveStepName); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_ACTION, approveMove ? "move" : "copy"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_APPROVE_FOLDER, approveFolder); + + if (rejectStepName == null || rejectMove == null || rejectFolder == null) + { + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "no"); + } + else + { + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_PRESENT, "yes"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_STEP_NAME, rejectStepName); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_ACTION, rejectMove ? "move" : "copy"); + this.workflowProperties.put(SimpleWorkflowHandler.PROP_REJECT_FOLDER, rejectFolder); + } + } + + return this.workflowProperties; + } + + public Node getNode() + { + return this.browseBean.getActionSpace(); + } +} diff --git a/source/java/org/alfresco/web/bean/spaces/EditSpaceDialog.java b/source/java/org/alfresco/web/bean/spaces/EditSpaceDialog.java index b76a8ab0d5..a0f6018575 100644 --- a/source/java/org/alfresco/web/bean/spaces/EditSpaceDialog.java +++ b/source/java/org/alfresco/web/bean/spaces/EditSpaceDialog.java @@ -1,181 +1,181 @@ -package org.alfresco.web.bean.spaces; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Iterator; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DataTypeDefinition; -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.service.cmr.repository.AssociationRef; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; - -/** - * Dialog bean to edit an existing space. - * - * @author gavinc - */ -public class EditSpaceDialog extends CreateSpaceDialog -{ - private static final long serialVersionUID = 6090397957979372269L; - - protected Node editableNode; - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // setup the space being edited - this.editableNode = initEditableNode(); - this.spaceType = this.editableNode.getType().toString(); - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - /** - * Init the editable Node - */ - protected Node initEditableNode() - { - return new Node(this.browseBean.getActionSpace().getNodeRef()); - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // update the existing node in the repository - NodeRef nodeRef = this.editableNode.getNodeRef(); - Map editedProps = this.editableNode.getProperties(); - - // handle the name property separately, perform a rename in case it changed - String name = (String)editedProps.get(ContentModel.PROP_NAME); - if (name != null) - { - this.getFileFolderService().rename(nodeRef, name); - } - - // build the properties to add to the repository - Map repoProps = new HashMap(7); - - // overwrite the current properties with the edited ones - Iterator iterProps = editedProps.keySet().iterator(); - while (iterProps.hasNext()) - { - String propName = iterProps.next(); - QName qname = QName.createQName(propName); - - // make sure the property is represented correctly - Serializable propValue = (Serializable)editedProps.get(propName); - - // check for empty strings when using number types, set to null in this case - if ((propValue != null) && (propValue instanceof String) && - (propValue.toString().length() == 0)) - { - PropertyDefinition propDef = this.getDictionaryService().getProperty(qname); - if (propDef != null) - { - if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || - propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || - propDef.getDataType().getName().equals(DataTypeDefinition.INT) || - propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) - { - propValue = null; - } - } - } - - repoProps.put(qname, propValue); - } - - // add the new properties back to the repository - this.getNodeService().addProperties(nodeRef, repoProps); - - // we also need to persist any association changes that may have been made - - // add any associations added in the UI - Map> addedAssocs = this.editableNode.getAddedAssociations(); - for (Map typedAssoc : addedAssocs.values()) - { - for (AssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().createAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); - } - } - - // remove any association removed in the UI - Map> removedAssocs = this.editableNode.getRemovedAssociations(); - for (Map typedAssoc : removedAssocs.values()) - { - for (AssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().removeAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); - } - } - - // add any child associations added in the UI - Map> addedChildAssocs = this.editableNode.getAddedChildAssociations(); - for (Map typedAssoc : addedChildAssocs.values()) - { - for (ChildAssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().addChild(assoc.getParentRef(), assoc.getChildRef(), assoc.getTypeQName(), assoc.getTypeQName()); - } - } - - // remove any child association removed in the UI - Map> removedChildAssocs = this.editableNode.getRemovedChildAssociations(); - for (Map typedAssoc : removedChildAssocs.values()) - { - for (ChildAssociationRef assoc : typedAssoc.values()) - { - this.getNodeService().removeChild(assoc.getParentRef(), assoc.getChildRef()); - } - } - - // do nothing by default, subclasses can override if necessary - return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; - } - - @Override - protected String doPostCommitProcessing(FacesContext context, String outcome) - { - this.browseBean.getActionSpace().reset(); - - return outcome; - } - - - // ------------------------------------------------------------------------------ - // Bean getters and setters - - /** - * Returns the node being edited - * - * @return The node being edited - */ - public Node getEditableNode() - { - return this.editableNode; - } - -} +package org.alfresco.web.bean.spaces; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DataTypeDefinition; +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.service.cmr.repository.AssociationRef; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; + +/** + * Dialog bean to edit an existing space. + * + * @author gavinc + */ +public class EditSpaceDialog extends CreateSpaceDialog +{ + private static final long serialVersionUID = 6090397957979372269L; + + protected Node editableNode; + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // setup the space being edited + this.editableNode = initEditableNode(); + this.spaceType = this.editableNode.getType().toString(); + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + /** + * Init the editable Node + */ + protected Node initEditableNode() + { + return new Node(this.browseBean.getActionSpace().getNodeRef()); + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "ok"); + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // update the existing node in the repository + NodeRef nodeRef = this.editableNode.getNodeRef(); + Map editedProps = this.editableNode.getProperties(); + + // handle the name property separately, perform a rename in case it changed + String name = (String)editedProps.get(ContentModel.PROP_NAME); + if (name != null) + { + this.getFileFolderService().rename(nodeRef, name); + } + + // build the properties to add to the repository + Map repoProps = new HashMap(7); + + // overwrite the current properties with the edited ones + Iterator iterProps = editedProps.keySet().iterator(); + while (iterProps.hasNext()) + { + String propName = iterProps.next(); + QName qname = QName.createQName(propName); + + // make sure the property is represented correctly + Serializable propValue = (Serializable)editedProps.get(propName); + + // check for empty strings when using number types, set to null in this case + if ((propValue != null) && (propValue instanceof String) && + (propValue.toString().length() == 0)) + { + PropertyDefinition propDef = this.getDictionaryService().getProperty(qname); + if (propDef != null) + { + if (propDef.getDataType().getName().equals(DataTypeDefinition.DOUBLE) || + propDef.getDataType().getName().equals(DataTypeDefinition.FLOAT) || + propDef.getDataType().getName().equals(DataTypeDefinition.INT) || + propDef.getDataType().getName().equals(DataTypeDefinition.LONG)) + { + propValue = null; + } + } + } + + repoProps.put(qname, propValue); + } + + // add the new properties back to the repository + this.getNodeService().addProperties(nodeRef, repoProps); + + // we also need to persist any association changes that may have been made + + // add any associations added in the UI + Map> addedAssocs = this.editableNode.getAddedAssociations(); + for (Map typedAssoc : addedAssocs.values()) + { + for (AssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().createAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); + } + } + + // remove any association removed in the UI + Map> removedAssocs = this.editableNode.getRemovedAssociations(); + for (Map typedAssoc : removedAssocs.values()) + { + for (AssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().removeAssociation(assoc.getSourceRef(), assoc.getTargetRef(), assoc.getTypeQName()); + } + } + + // add any child associations added in the UI + Map> addedChildAssocs = this.editableNode.getAddedChildAssociations(); + for (Map typedAssoc : addedChildAssocs.values()) + { + for (ChildAssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().addChild(assoc.getParentRef(), assoc.getChildRef(), assoc.getTypeQName(), assoc.getTypeQName()); + } + } + + // remove any child association removed in the UI + Map> removedChildAssocs = this.editableNode.getRemovedChildAssociations(); + for (Map typedAssoc : removedChildAssocs.values()) + { + for (ChildAssociationRef assoc : typedAssoc.values()) + { + this.getNodeService().removeChild(assoc.getParentRef(), assoc.getChildRef()); + } + } + + // do nothing by default, subclasses can override if necessary + return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; + } + + @Override + protected String doPostCommitProcessing(FacesContext context, String outcome) + { + this.browseBean.getActionSpace().reset(); + + return outcome; + } + + + // ------------------------------------------------------------------------------ + // Bean getters and setters + + /** + * Returns the node being edited + * + * @return The node being edited + */ + public Node getEditableNode() + { + return this.editableNode; + } + +} diff --git a/source/java/org/alfresco/web/bean/spaces/InviteSpaceUsersWizard.java b/source/java/org/alfresco/web/bean/spaces/InviteSpaceUsersWizard.java index 801409581b..1b8774dc3a 100644 --- a/source/java/org/alfresco/web/bean/spaces/InviteSpaceUsersWizard.java +++ b/source/java/org/alfresco/web/bean/spaces/InviteSpaceUsersWizard.java @@ -1,43 +1,43 @@ -package org.alfresco.web.bean.spaces; - -import java.util.Set; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.wizard.BaseInviteUsersWizard; - -/** - * Concrete implementation providing the ability to invite users to a space. - * - * @author gavinc - */ -public class InviteSpaceUsersWizard extends BaseInviteUsersWizard -{ - private static final long serialVersionUID = -1584891656721183347L; - - @Override - protected Set getPermissionsForType() - { - // Let the permission service do the caching to allow for dynamic model updates, etc. - return this.permissionService.getSettablePermissions(getNode().getType()); - } - - @Override - protected Node getNode() - { - return this.browseBean.getActionSpace(); - } - - @Override - protected String getEmailTemplateXPath() - { - FacesContext fc = FacesContext.getCurrentInstance(); - String xpath = Application.getRootPath(fc) + "/" + - Application.getGlossaryFolderName(fc) + "/" + - Application.getEmailTemplatesFolderName(fc) + "/" + - Application.getInviteEmailTemplatesFolderName(fc) + "//*"; - return xpath; - } -} +package org.alfresco.web.bean.spaces; + +import java.util.Set; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.wizard.BaseInviteUsersWizard; + +/** + * Concrete implementation providing the ability to invite users to a space. + * + * @author gavinc + */ +public class InviteSpaceUsersWizard extends BaseInviteUsersWizard +{ + private static final long serialVersionUID = -1584891656721183347L; + + @Override + protected Set getPermissionsForType() + { + // Let the permission service do the caching to allow for dynamic model updates, etc. + return this.permissionService.getSettablePermissions(getNode().getType()); + } + + @Override + protected Node getNode() + { + return this.browseBean.getActionSpace(); + } + + @Override + protected String getEmailTemplateXPath() + { + FacesContext fc = FacesContext.getCurrentInstance(); + String xpath = Application.getRootPath(fc) + "/" + + Application.getGlossaryFolderName(fc) + "/" + + Application.getEmailTemplatesFolderName(fc) + "/" + + Application.getInviteEmailTemplatesFolderName(fc) + "//*"; + return xpath; + } +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteAllItemsDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteAllItemsDialog.java index 467a7b7b5d..fc95ca8e02 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteAllItemsDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteAllItemsDialog.java @@ -1,69 +1,69 @@ -package org.alfresco.web.bean.trashcan; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class TrashcanDeleteAllItemsDialog extends TrashcanDialog -{ - private static final long serialVersionUID = 2537803727179629546L; - - private static final String MSG_YES = "yes"; - private static final String MSG_NO = "no"; - - private String deleteAllItems(FacesContext context, String outcome) - { - if (property.isInProgress()) - return null; - - property.setInProgress(true); - - try - { - property.getNodeArchiveService().purgeAllArchivedNodes(Repository.getStoreRef()); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); - ReportedException.throwIfNecessary(err); - } - finally - { - property.setInProgress(false); - } - - return outcome; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return deleteAllItems(context, outcome); - - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); - } - - @Override - public boolean getFinishButtonDisabled() - { - - return false; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); - } - -} +package org.alfresco.web.bean.trashcan; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class TrashcanDeleteAllItemsDialog extends TrashcanDialog +{ + private static final long serialVersionUID = 2537803727179629546L; + + private static final String MSG_YES = "yes"; + private static final String MSG_NO = "no"; + + private String deleteAllItems(FacesContext context, String outcome) + { + if (property.isInProgress()) + return null; + + property.setInProgress(true); + + try + { + property.getNodeArchiveService().purgeAllArchivedNodes(Repository.getStoreRef()); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); + ReportedException.throwIfNecessary(err); + } + finally + { + property.setInProgress(false); + } + + return outcome; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return deleteAllItems(context, outcome); + + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); + } + + @Override + public boolean getFinishButtonDisabled() + { + + return false; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); + } + +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteItemDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteItemDialog.java index 65b9b7bddd..ef0c0c19fe 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteItemDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteItemDialog.java @@ -1,88 +1,88 @@ -package org.alfresco.web.bean.trashcan; - -import java.text.MessageFormat; - -import javax.faces.application.FacesMessage; -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class TrashcanDeleteItemDialog extends TrashcanDialog -{ - private static final long serialVersionUID = 519967126630923155L; - - private static final String RICHLIST_ID = "trashcan-list"; - private static final String RICHLIST_MSG_ID = "trashcan" + ':' + RICHLIST_ID; - private static final String MSG_YES = "yes"; - private static final String MSG_NO = "no"; - private static final String MSG_DELETE_ITEM = "delete_item"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private String deleteItem(FacesContext newContext, String newOutcome) - { - Node item = property.getItem(); - if (item != null) - { - try - { - property.getNodeArchiveService().purgeArchivedNode(item.getNodeRef()); - - FacesContext fc = newContext; - String msg = MessageFormat.format(Application.getMessage(fc, "delete_item_success"), item.getName()); - FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_INFO, msg, msg); - fc.addMessage(RICHLIST_MSG_ID, facesMsg); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, Repository.ERROR_GENERIC), err.getMessage()), err); - ReportedException.throwIfNecessary(err); - } - } - return newOutcome; - } - - @Override - protected String getDefaultFinishOutcome() - { - return "dialog:close[2]"; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return deleteItem(context, outcome); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); - } - - @Override - public boolean getFinishButtonDisabled() - { - - return false; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_DELETE_ITEM) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + property.getItem().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - -} +package org.alfresco.web.bean.trashcan; + +import java.text.MessageFormat; + +import javax.faces.application.FacesMessage; +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class TrashcanDeleteItemDialog extends TrashcanDialog +{ + private static final long serialVersionUID = 519967126630923155L; + + private static final String RICHLIST_ID = "trashcan-list"; + private static final String RICHLIST_MSG_ID = "trashcan" + ':' + RICHLIST_ID; + private static final String MSG_YES = "yes"; + private static final String MSG_NO = "no"; + private static final String MSG_DELETE_ITEM = "delete_item"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private String deleteItem(FacesContext newContext, String newOutcome) + { + Node item = property.getItem(); + if (item != null) + { + try + { + property.getNodeArchiveService().purgeArchivedNode(item.getNodeRef()); + + FacesContext fc = newContext; + String msg = MessageFormat.format(Application.getMessage(fc, "delete_item_success"), item.getName()); + FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_INFO, msg, msg); + fc.addMessage(RICHLIST_MSG_ID, facesMsg); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, Repository.ERROR_GENERIC), err.getMessage()), err); + ReportedException.throwIfNecessary(err); + } + } + return newOutcome; + } + + @Override + protected String getDefaultFinishOutcome() + { + return "dialog:close[2]"; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return deleteItem(context, outcome); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); + } + + @Override + public boolean getFinishButtonDisabled() + { + + return false; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_DELETE_ITEM) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + property.getItem().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteListedItemsDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteListedItemsDialog.java index e2b3ce8b4d..b9656fcf05 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteListedItemsDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanDeleteListedItemsDialog.java @@ -1,78 +1,78 @@ -package org.alfresco.web.bean.trashcan; - -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.List; - -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class TrashcanDeleteListedItemsDialog extends TrashcanDialog -{ - private static final long serialVersionUID = 5576836588148974609L; - - private static final String MSG_YES = "yes"; - private static final String MSG_NO = "no"; - - private String deleteListedItems(FacesContext context, String outcome) - { - if (property.isInProgress()) - return null; - - property.setInProgress(true); - - try - { - List nodeRefs = new ArrayList(property.getListedItems().size()); - for (Node node : property.getListedItems()) - { - nodeRefs.add(node.getNodeRef()); - } - property.getNodeArchiveService().purgeArchivedNodes(nodeRefs); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); - ReportedException.throwIfNecessary(err); - } - finally - { - property.setInProgress(false); - } - - return outcome; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return deleteListedItems(context, outcome); - - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); - } - - @Override - public boolean getFinishButtonDisabled() - { - - return false; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); - } - -} +package org.alfresco.web.bean.trashcan; + +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.List; + +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class TrashcanDeleteListedItemsDialog extends TrashcanDialog +{ + private static final long serialVersionUID = 5576836588148974609L; + + private static final String MSG_YES = "yes"; + private static final String MSG_NO = "no"; + + private String deleteListedItems(FacesContext context, String outcome) + { + if (property.isInProgress()) + return null; + + property.setInProgress(true); + + try + { + List nodeRefs = new ArrayList(property.getListedItems().size()); + for (Node node : property.getListedItems()) + { + nodeRefs.add(node.getNodeRef()); + } + property.getNodeArchiveService().purgeArchivedNodes(nodeRefs); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); + ReportedException.throwIfNecessary(err); + } + finally + { + property.setInProgress(false); + } + + return outcome; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return deleteListedItems(context, outcome); + + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); + } + + @Override + public boolean getFinishButtonDisabled() + { + + return false; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); + } + +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanDialog.java index be2f82f290..e70adb0059 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanDialog.java @@ -1,881 +1,881 @@ -package org.alfresco.web.bean.trashcan; - -import java.text.MessageFormat; -import java.text.SimpleDateFormat; -import java.util.ArrayList; -import java.util.Collections; -import java.util.Date; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.node.archive.RestoreNodeReport; -import org.alfresco.repo.node.archive.RestoreNodeReport.RestoreStatus; -import org.alfresco.repo.web.scripts.FileTypeImageUtils; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.ContentData; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.search.ResultSet; -import org.alfresco.service.cmr.search.ResultSetRow; -import org.alfresco.service.cmr.search.SearchParameters; -import org.alfresco.service.cmr.search.SearchService; -import org.alfresco.service.cmr.security.AccessStatus; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.namespace.QName; -import org.alfresco.util.CachingDateFormat; -import org.alfresco.util.SearchLanguageConversion; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.IContextListener; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.bean.BrowseBean; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.MapNode; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.NodePropertyResolver; -import org.alfresco.web.bean.repository.QNameNodeMap; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.spaces.CreateSpaceWizard; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.Utils.URLMode; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.alfresco.web.ui.common.component.UIModeList; - -/** - * Backing bean for the Manage Deleted Items (soft delete and archiving) pages. - * - * @author Kevin Roast - */ -public class TrashcanDialog extends BaseDialogBean implements IContextListener -{ - private static final long serialVersionUID = -7783683979079046969L; - - protected TrashcanDialogProperty property; - - private static final String MSG_DELETED_ITEMS_FOR = "deleted_items_for"; - private static final String MSG_DELETED_ITEMS = "deleted_items"; - private static final String MSG_RECOVERED_ITEM_DUPLICATE_S = "recovered_item_duplicate_short"; - private static final String MSG_RECOVERED_ITEM_INTEGRITY_S = "recovered_item_integrity_short"; - private static final String MSG_RECOVERED_ITEM_PERMISSION_S = "recovered_item_permission_short"; - private static final String MSG_RECOVERED_ITEM_PARENT_S = "recovered_item_parent_short"; - private static final String MSG_RECOVERED_ITEM_FAILURE_S = "recovered_item_failure_short"; - private static final String MSG_RECOVERY_REASON = "recovery_report_reason"; - private static final String MSG_LOCATION = "location"; - private static final String MSG_NAME = "name"; - private final static String MSG_CLOSE = "close"; - - private static final String PROP_RECOVERSTATUS = "recoverstatus"; - private static final String PROP_RECOVERERRORMESSAGE = "recovererrormessage"; - - private static final String FILTER_DATE_ALL = "all"; - private static final String FILTER_DATE_TODAY = "today"; - private static final String FILTER_DATE_WEEK = "week"; - private static final String FILTER_DATE_MONTH = "month"; - private static final String FILTER_USER_USER = "user"; - - private static final String OUTCOME_DIALOGCLOSE = "dialog:close"; - - private final static String NAME_ATTR = Repository.escapeQName(ContentModel.PROP_NAME); - private final static String USER_ATTR = Repository.escapeQName(ContentModel.PROP_ARCHIVED_BY); - private final static String DATE_ATTR = Repository.escapeQName(ContentModel.PROP_ARCHIVED_DATE); - - private final static String SEARCH_ALL = "PARENT:\"%s\" AND ASPECT:\"%s\""; - private final static String SEARCH_NAME = "PARENT:\"%s\" AND ASPECT:\"%s\" AND (@" + NAME_ATTR + ":*%s* @" + NAME_ATTR + ":\"*%s*\")"; - private final static String SEARCH_TEXT = "PARENT:\"%s\" AND ASPECT:\"%s\" AND TEXT:%s"; - private final static String SEARCH_NAME_QUOTED = "PARENT:\"%s\" AND ASPECT:\"%s\" AND @" + NAME_ATTR + ":\"%s\""; - private final static String SEARCH_TEXT_QUOTED = "PARENT:\"%s\" AND ASPECT:\"%s\" AND TEXT:\"%s\""; - private final static String SEARCH_USERPREFIX = "@" + USER_ATTR + ":%s AND "; - - /** maximum number of failed items to report to the user */ - private static final int MAX_FAILURE_REPORTS = 25; - - /** The PermissionService reference */ - transient protected PermissionService permissionService; - - - /** - * @param permissionService The PermissionService to set. - */ - public void setPermissionService(PermissionService permissionService) - { - this.permissionService = permissionService; - } - - protected PermissionService getPermissionService() - { - if (permissionService == null) - { - permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); - } - return permissionService; - } - - public void setProperty(TrashcanDialogProperty property) - { - this.property = property; - } - - public TrashcanDialogProperty getProperty() - { - return property; - } - - /** - * @return Message to display in the title of the panel area - */ - public String getPanelMessage() - { - FacesContext fc = FacesContext.getCurrentInstance(); - String msg = Application.getMessage(fc, MSG_DELETED_ITEMS); - if (isAdminUser() == false) - { - msg = msg + ' ' + MessageFormat.format( - Application.getMessage(fc, MSG_DELETED_ITEMS_FOR), Application.getCurrentUser(fc).getUserName()); - } - return msg; - } - - /** - * Returns the URL to the content for the current document item - * - * @return Content url to the current document item - */ - public String getItemBrowserUrl() - { - return Utils.generateURL(FacesContext.getCurrentInstance(), property.getItem(), URLMode.HTTP_INLINE); - } - - /** - * Returns the download URL to the content for the current document item - * - * @return Download url to the current document item - */ - public String getItemDownloadUrl() - { - return Utils.generateURL(FacesContext.getCurrentInstance(), property.getItem(), URLMode.HTTP_DOWNLOAD); - } - - /** - * Return the Alfresco NodeRef URL for the current item node - * - * @return the Alfresco NodeRef URL - */ - public String getItemNodeRefUrl() - { - return property.getItem().getNodeRef().toString(); - } - - /** - * @return HTML table of the listed items - */ - public String getListedItemsTable() - { - return buildItemsTable(property.getListedItems(), "recoveredItemsList", false, true); - } - - /** - * @return HTML table of the items successfully recovered - */ - public String getSuccessItemsTable() - { - return buildItemsTable(property.getSuccessItems(), "recoveredItemsList", false, false); - } - - /** - * @return HTML table of the items that failed to recover - */ - public String getFailureItemsTable() - { - return buildItemsTable(property.getFailureItems(), "failedItemsList", true, false); - } - - /** - * @return the list of deleted items to display - */ - public List getItems() - { - // to get deleted items from deleted items store - // use a search to find the items - also filters by name/username - List itemNodes = null; - - UserTransaction tx = null; - ResultSet results = null; - try - { - tx = Repository.getUserTransaction(FacesContext.getCurrentInstance(), true); - tx.begin(); - - // get the root node to the deleted items store - if (getArchiveRootRef() != null && property.isShowItems()) - { - String query = buildSearchQuery(); - SearchParameters sp = new SearchParameters(); - sp.setLanguage(SearchService.LANGUAGE_LUCENE); - sp.setQuery(query); - sp.addStore(getArchiveRootRef().getStoreRef()); // the Archived Node store - - results = getSearchService().query(sp); - itemNodes = new ArrayList(results.length()); - } - - if (results != null && results.length() != 0) - { - for (ResultSetRow row : results) - { - NodeRef nodeRef = row.getNodeRef(); - - if (getNodeService().exists(nodeRef)) - { - QName type = getNodeService().getType(nodeRef); - - MapNode node = new MapNode(nodeRef, getNodeService(), false); - - node.addPropertyResolver("locationPath", resolverLocationPath); - node.addPropertyResolver("displayPath", resolverDisplayPath); - node.addPropertyResolver("deletedDate", resolverDeletedDate); - node.addPropertyResolver("deletedBy", resolverDeletedBy); - node.addPropertyResolver("isFolder", resolverIsFolder); - - if (getDictionaryService().isSubClass(type, ContentModel.TYPE_FOLDER) == true && - getDictionaryService().isSubClass(type, ContentModel.TYPE_SYSTEM_FOLDER) == false) - { - node.addPropertyResolver("typeIcon", this.resolverSmallIcon); - } - else - { - node.addPropertyResolver("typeIcon", this.resolverFileType16); - } - itemNodes.add(node); - } - } - } - - tx.commit(); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), new Object[] {err.getMessage()}), err ); - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - finally - { - if (results != null) - { - results.close(); - } - } - - property.setListedItems((itemNodes != null ? itemNodes : Collections. emptyList())); - - return property.getListedItems(); - } - - private NodePropertyResolver resolverLocationPath = new NodePropertyResolver() - { - private static final long serialVersionUID = -2501720368642759082L; - - public Object get(Node node) - { - ChildAssociationRef childRef = (ChildAssociationRef)node.getProperties().get(ContentModel.PROP_ARCHIVED_ORIGINAL_PARENT_ASSOC); - if (getPermissionService().hasPermission(childRef.getParentRef(), PermissionService.READ).equals(AccessStatus.ALLOWED) && - getNodeService().exists(childRef.getParentRef())) - { - return getNodeService().getPath(childRef.getParentRef()); - } - else - { - return null; - } - } - }; - - private NodePropertyResolver resolverDisplayPath = new NodePropertyResolver() - { - private static final long serialVersionUID = 9178556770343499694L; - - public Object get(Node node) - { - ChildAssociationRef childRef = (ChildAssociationRef)node.getProperties().get(ContentModel.PROP_ARCHIVED_ORIGINAL_PARENT_ASSOC); - if (getPermissionService().hasPermission(childRef.getParentRef(), PermissionService.READ).equals(AccessStatus.ALLOWED) && - getNodeService().exists(childRef.getParentRef())) - { - return Repository.getDisplayPath(getNodeService().getPath(childRef.getParentRef()), true); - } - else - { - return ""; - } - } - }; - - private NodePropertyResolver resolverFileType16 = new NodePropertyResolver() - { - private static final long serialVersionUID = 7462526266770371703L; - - public Object get(Node node) - { - return FileTypeImageUtils.getFileTypeImage(node.getName(), true); - } - }; - - private NodePropertyResolver resolverSmallIcon = new NodePropertyResolver() - { - private static final long serialVersionUID = 5528945140207247127L; - - @SuppressWarnings("unchecked") - public Object get(Node node) - { - QNameNodeMap props = (QNameNodeMap)node.getProperties(); - String icon = (String) props.getRaw("app:icon"); - return "/images/icons/" + (icon != null ? icon + "-16.gif" : BrowseBean.SPACE_SMALL_DEFAULT + ".gif"); - } - }; - - private NodePropertyResolver resolverFileType32 = new NodePropertyResolver() - { - private static final long serialVersionUID = -5681639025578263060L; - - public Object get(Node node) - { - return FileTypeImageUtils.getFileTypeImage(node.getName(), false); - } - }; - - private NodePropertyResolver resolverLargeIcon = new NodePropertyResolver() - { - private static final long serialVersionUID = -8334570770580388654L; - - @SuppressWarnings("unchecked") - public Object get(Node node) - { - QNameNodeMap props = (QNameNodeMap)node.getProperties(); - String icon = (String) props.getRaw("app:icon"); - return "/images/icons/" + (icon != null ? icon : CreateSpaceWizard.DEFAULT_SPACE_ICON_NAME) + ".gif"; - } - }; - - private NodePropertyResolver resolverMimetype = new NodePropertyResolver() - { - private static final long serialVersionUID = -5892550146037635522L; - - public Object get(Node node) - { - ContentData content = (ContentData)node.getProperties().get(ContentModel.PROP_CONTENT); - return (content != null ? content.getMimetype() : null); - } - }; - - private NodePropertyResolver resolverSize = new NodePropertyResolver() - { - private static final long serialVersionUID = -191591211947393578L; - - public Object get(Node node) - { - ContentData content = (ContentData)node.getProperties().get(ContentModel.PROP_CONTENT); - return (content != null ? new Long(content.getSize()) : 0L); - } - }; - - private NodePropertyResolver resolverEncoding = new NodePropertyResolver() - { - private static final long serialVersionUID = -1594354572323978873L; - - public Object get(Node node) - { - ContentData content = (ContentData)node.getProperties().get(ContentModel.PROP_CONTENT); - return (content != null ? content.getEncoding() : null); - } - }; - - private NodePropertyResolver resolverDeletedDate = new NodePropertyResolver() - { - private static final long serialVersionUID = 3240286507786251191L; - - public Object get(Node node) - { - return node.getProperties().get(ContentModel.PROP_ARCHIVED_DATE); - } - }; - - private NodePropertyResolver resolverDeletedBy = new NodePropertyResolver() - { - private static final long serialVersionUID = -8678755146743606599L; - - public Object get(Node node) - { - return node.getProperties().get(ContentModel.PROP_ARCHIVED_BY); - } - }; - - private NodePropertyResolver resolverIsFolder = new NodePropertyResolver() - { - private static final long serialVersionUID = -9181535522349485509L; - - public Object get(Node node) - { - return getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_FOLDER); - } - }; - - - // ------------------------------------------------------------------------------ - // Action handlers - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return null; - } - - /** - * Search the deleted item store by name - */ - public void searchName(ActionEvent event) - { - // simply clear the current list and refresh the screen - // the search query text will be found and processed by the getItems() method - contextUpdated(); - property.setShowItems(true); - property.setFullTextSearch(false); - } - - /** - * Search the deleted item store by text - */ - public void searchContent(ActionEvent event) - { - // simply clear the current list and refresh the screen - // the search query text will be found and processed by the getItems() method - contextUpdated(); - property.setShowItems(true); - property.setFullTextSearch(true); - } - - /** - * Action handler to clear the current search results and show all items - */ - public void clearSearch(ActionEvent event) - { - contextUpdated(); - property.setSearchText(null); - property.setShowItems(true); - } - - /** - * Action handler called to prepare the selected item for an action - */ - public void setupItemAction(ActionEvent event) - { - UIActionLink link = (UIActionLink)event.getComponent(); - Map params = link.getParameterMap(); - String id = params.get("id"); - if (id != null && id.length() != 0) - { - try - { - // create the node ref, then our node representation - NodeRef ref = new NodeRef(getArchiveRootRef().getStoreRef(), id); - Node node = new Node(ref); - - node.addPropertyResolver("locationPath", resolverLocationPath); - node.addPropertyResolver("deletedDate", resolverDeletedDate); - node.addPropertyResolver("deletedBy", resolverDeletedBy); - node.addPropertyResolver("isFolder", resolverIsFolder); - node.addPropertyResolver("mimetype", resolverMimetype); - node.addPropertyResolver("size", resolverSize); - node.addPropertyResolver("encoding", resolverEncoding); - - if (getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_FOLDER) == true && - getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_SYSTEM_FOLDER) == false) - { - node.addPropertyResolver("icon", this.resolverLargeIcon); - } - else - { - node.addPropertyResolver("icon", this.resolverFileType32); - } - - // prepare a node for the action context - property.setItem(node); - property.setDestination(null); - } - catch (InvalidNodeRefException refErr) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {id})); - } - } - else - { - property.setItem(null); - } - - // clear the UI state in preparation for finishing the next action - contextUpdated(); - } - - /** - * Action handler to setup actions that act on lists - */ - public void setupListAction(ActionEvent event) - { - // clear the UI state in preparation for finishing the next action - property.setDestination(null); - contextUpdated(); - } - - /** - * @return outcome to close the main list screen and reset other beans ready for display - */ - public String close() - { - // call beans to update UI context for other screens - UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); - return OUTCOME_DIALOGCLOSE; - } - - /** - * Action handler to initially setup the trashcan screen - */ - public void setupTrashcan(ActionEvent event) - { - contextUpdated(); - } - - /** - * Action handler called when the Date filter is changed by the user - */ - public void dateFilterChanged(ActionEvent event) - { - UIModeList filterComponent = (UIModeList)event.getComponent(); - property.setDateFilter(filterComponent.getValue().toString()); - contextUpdated(); - property.setShowItems(true); - } - - /** - * Action handler called when the User filter is changed by the user - */ - public void userFilterChanged(ActionEvent event) - { - UIModeList filterComponent = (UIModeList)event.getComponent(); - property.setUserFilter(filterComponent.getValue().toString()); - contextUpdated(); - property.setShowItems(true); - } - - - // ------------------------------------------------------------------------------ - // Private helpers - - /** - * @return the archive store root node ref - */ - private NodeRef getArchiveRootRef() - { - if (property.getArchiveRootRef() == null) - { - property.setArchiveRootRef(property.getNodeArchiveService().getStoreArchiveNode(Repository.getStoreRef())); - } - return property.getArchiveRootRef(); - } - - /** - * @return the search query to use when displaying the list of deleted items - */ - @SuppressWarnings("deprecation") - private String buildSearchQuery() - { - String query; - if (property.getSearchText() == null || property.getSearchText().length() == 0) - { - // search for ALL items in the archive store - query = String.format(SEARCH_ALL, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED); - } - else - { - // search by name in the archive store - String safeText = SearchLanguageConversion.escapeLuceneQuery(property.getSearchText()); - if (safeText.indexOf(' ') == -1) - { - if (property.isFullTextSearch()) - { - query = String.format(SEARCH_TEXT, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText); - } - else - { - query = String.format(SEARCH_NAME, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText, safeText); - } - } - else - { - if (property.isFullTextSearch()) - { - query = String.format(SEARCH_TEXT_QUOTED, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText); - } - else - { - query = String.format(SEARCH_NAME_QUOTED, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText); - } - } - } - - // append user search clause - String username = null; - if (isAdminUser() == false) - { - // prefix the current username - username = Application.getCurrentUser(FacesContext.getCurrentInstance()).getUserName(); - } - else if (FILTER_USER_USER.equals(property.getUserFilter())) - { - // append the entered user if admin has requested a search - username = property.getUserSearchText(); - } - if (username != null && username.length() != 0) - { - query = String.format(SEARCH_USERPREFIX, username) + query; - } - - // append date search clause - if (FILTER_DATE_ALL.equals(property.getDateFilter()) == false) - { - Date toDate = new Date(); - Date fromDate = null; - if (FILTER_DATE_TODAY.equals(property.getDateFilter())) - { - fromDate = new Date(toDate.getYear(), toDate.getMonth(), toDate.getDate(), 0, 0, 0); - } - else if (FILTER_DATE_WEEK.equals(property.getDateFilter())) - { - fromDate = new Date(toDate.getTime() - (1000L*60L*60L*24L*7L)); - } - else if (FILTER_DATE_MONTH.equals(property.getDateFilter())) - { - fromDate = new Date(toDate.getTime() - (1000L*60L*60L*24L*30L)); - } - if (fromDate != null) - { - SimpleDateFormat df = CachingDateFormat.getDateFormat(); - String strFromDate = SearchLanguageConversion.escapeLuceneQuery(df.format(fromDate)); - String strToDate = SearchLanguageConversion.escapeLuceneQuery(df.format(toDate)); - StringBuilder buf = new StringBuilder(128); - buf.append("@").append(DATE_ATTR) - .append(":").append("[").append(strFromDate) - .append(" TO ").append(strToDate).append("] AND "); - - query = buf.toString() + query; - } - } - - return query; - } - - /** - * Save the detail of the items that were successfully or unsuccessfully restored - * - * @param reports The List of RestoreNodeReport objects to walk for results - */ - protected void saveReportDetail(List reports) - { - // store the results ready for the next dialog page - int failureItemsCount = 0; - property.setSuccessItems(new ArrayList(reports.size())); - property.setFailureItems(new ArrayList(reports.size())); - for (RestoreNodeReport report : reports) - { - if (RestoreStatus.SUCCESS == report.getStatus()) - { - Node node = new Node(report.getRestoredNodeRef()); - node.getProperties().put(PROP_RECOVERSTATUS, report.getStatus()); - property.getSuccessItems().add(node); - } - else - { - if (failureItemsCount < MAX_FAILURE_REPORTS) - { - Node node = new Node(report.getArchivedNodeRef()); - node.getProperties().put(PROP_RECOVERSTATUS, report.getStatus()); - node.getProperties().put(PROP_RECOVERERRORMESSAGE, report.getCause().getMessage()); - property.getFailureItems().add(node); - failureItemsCount++; - } - } - } - } - - /** - * Build an HTML table of the items that are to be or have been recovered. - * - * @param items List of Node objects to display in the table - * @param cssClass CSS style to apply to the table - * @param report Set true to report the reason for any failure. This flag requires that the Node - * object has a pseudo property "recoverstatus" containing the RestoreStatus. - * @param archivedPath Set true to show the path from the 'sys:archivedOriginalParentAssoc' property, - * else the current Node Path will be used. - * - * - * @return HTML table of node info - */ - private String buildItemsTable(List items, String cssClass, boolean report, boolean archivedPath) - { - FacesContext fc = FacesContext.getCurrentInstance(); - String contextPath = fc.getExternalContext().getRequestContextPath(); - - StringBuilder buf = new StringBuilder(1024); - - // outer table - buf.append(""); - // title row - buf.append(""); - if (report == true) - { - buf.append(""); - } - else - { - buf.append(""); - } - buf.append(""); - for (Node node : items) - { - // listed item rows - buf.append(""); - - if (report) - { - buf.append(""); - } - else - { - buf.append(""); - } - - buf.append(""); - } - // end table - buf.append("
"); - buf.append(Application.getMessage(fc, MSG_NAME)); - buf.append(""); - buf.append(Application.getMessage(fc, MSG_RECOVERY_REASON)); - buf.append(""); - buf.append(Application.getMessage(fc, MSG_LOCATION)); - buf.append("
"); - String img; - if (getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_FOLDER)) - { - String icon = (String)node.getProperties().get("app:icon"); - img = "/images/icons/" + (icon != null ? icon + "-16.gif" : BrowseBean.SPACE_SMALL_DEFAULT + ".gif"); - } - else - { - img = FileTypeImageUtils.getFileTypeImage(node.getName(), true); - } - buf.append(""); - buf.append(""); - buf.append(Utils.encode(node.getName())); - buf.append(""); - String msg; - RestoreStatus status = (RestoreStatus) node.getProperties().get(PROP_RECOVERSTATUS); - String message = (String) node.getProperties().get(PROP_RECOVERERRORMESSAGE); - switch (status) - { - case FAILURE_INVALID_PARENT: - msg = MSG_RECOVERED_ITEM_PARENT_S; - break; - - case FAILURE_PERMISSION: - msg = MSG_RECOVERED_ITEM_PERMISSION_S; - break; - - case FAILURE_INTEGRITY: - msg = MSG_RECOVERED_ITEM_INTEGRITY_S; - break; - - case FAILURE_DUPLICATE_CHILD_NODE_NAME: - msg = MSG_RECOVERED_ITEM_DUPLICATE_S; - break; - - default: - msg = MSG_RECOVERED_ITEM_FAILURE_S; - break; - } - buf.append(Application.getMessage(fc, msg)); - buf.append(": "); - buf.append(message); - buf.append(""); - if (archivedPath) - { - ChildAssociationRef childRef = (ChildAssociationRef)node.getProperties().get(ContentModel.PROP_ARCHIVED_ORIGINAL_PARENT_ASSOC); - if (getNodeService().exists(childRef.getParentRef())) - { - buf.append(Utils.encode(Repository.getNamePath(getNodeService(), getNodeService().getPath(childRef.getParentRef()), null, "/", null))); - } - } - else - { - buf.append(Utils.encode(Repository.getNamePath(getNodeService(), getNodeService().getPath(node.getNodeRef()), null, "/", null))); - } - buf.append("
"); - - return buf.toString(); - } - - private boolean isAdminUser() - { - return Application.getCurrentUser(FacesContext.getCurrentInstance()).isAdmin(); - } - - - // ------------------------------------------------------------------------------ - // IContextListener implementation - - /** - * @see org.alfresco.web.app.context.IContextListener#contextUpdated() - */ - public void contextUpdated() - { - if (property.getItemsRichList() != null) - { - property.getItemsRichList().setValue(null); - } - property.setShowItems(false); - } - - /** - * @see org.alfresco.web.app.context.IContextListener#areaChanged() - */ - public void areaChanged() - { - // nothing to do - } - - /** - * @see org.alfresco.web.app.context.IContextListener#spaceChanged() - */ - public void spaceChanged() - { - // nothing to do - } - - @Override - public String cancel() - { - close(); - return super.cancel(); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } - +package org.alfresco.web.bean.trashcan; + +import java.text.MessageFormat; +import java.text.SimpleDateFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.node.archive.RestoreNodeReport; +import org.alfresco.repo.node.archive.RestoreNodeReport.RestoreStatus; +import org.alfresco.repo.web.scripts.FileTypeImageUtils; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.ContentData; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.search.ResultSet; +import org.alfresco.service.cmr.search.ResultSetRow; +import org.alfresco.service.cmr.search.SearchParameters; +import org.alfresco.service.cmr.search.SearchService; +import org.alfresco.service.cmr.security.AccessStatus; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.namespace.QName; +import org.alfresco.util.CachingDateFormat; +import org.alfresco.util.SearchLanguageConversion; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.IContextListener; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.bean.BrowseBean; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.MapNode; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.NodePropertyResolver; +import org.alfresco.web.bean.repository.QNameNodeMap; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.spaces.CreateSpaceWizard; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.Utils.URLMode; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.alfresco.web.ui.common.component.UIModeList; + +/** + * Backing bean for the Manage Deleted Items (soft delete and archiving) pages. + * + * @author Kevin Roast + */ +public class TrashcanDialog extends BaseDialogBean implements IContextListener +{ + private static final long serialVersionUID = -7783683979079046969L; + + protected TrashcanDialogProperty property; + + private static final String MSG_DELETED_ITEMS_FOR = "deleted_items_for"; + private static final String MSG_DELETED_ITEMS = "deleted_items"; + private static final String MSG_RECOVERED_ITEM_DUPLICATE_S = "recovered_item_duplicate_short"; + private static final String MSG_RECOVERED_ITEM_INTEGRITY_S = "recovered_item_integrity_short"; + private static final String MSG_RECOVERED_ITEM_PERMISSION_S = "recovered_item_permission_short"; + private static final String MSG_RECOVERED_ITEM_PARENT_S = "recovered_item_parent_short"; + private static final String MSG_RECOVERED_ITEM_FAILURE_S = "recovered_item_failure_short"; + private static final String MSG_RECOVERY_REASON = "recovery_report_reason"; + private static final String MSG_LOCATION = "location"; + private static final String MSG_NAME = "name"; + private final static String MSG_CLOSE = "close"; + + private static final String PROP_RECOVERSTATUS = "recoverstatus"; + private static final String PROP_RECOVERERRORMESSAGE = "recovererrormessage"; + + private static final String FILTER_DATE_ALL = "all"; + private static final String FILTER_DATE_TODAY = "today"; + private static final String FILTER_DATE_WEEK = "week"; + private static final String FILTER_DATE_MONTH = "month"; + private static final String FILTER_USER_USER = "user"; + + private static final String OUTCOME_DIALOGCLOSE = "dialog:close"; + + private final static String NAME_ATTR = Repository.escapeQName(ContentModel.PROP_NAME); + private final static String USER_ATTR = Repository.escapeQName(ContentModel.PROP_ARCHIVED_BY); + private final static String DATE_ATTR = Repository.escapeQName(ContentModel.PROP_ARCHIVED_DATE); + + private final static String SEARCH_ALL = "PARENT:\"%s\" AND ASPECT:\"%s\""; + private final static String SEARCH_NAME = "PARENT:\"%s\" AND ASPECT:\"%s\" AND (@" + NAME_ATTR + ":*%s* @" + NAME_ATTR + ":\"*%s*\")"; + private final static String SEARCH_TEXT = "PARENT:\"%s\" AND ASPECT:\"%s\" AND TEXT:%s"; + private final static String SEARCH_NAME_QUOTED = "PARENT:\"%s\" AND ASPECT:\"%s\" AND @" + NAME_ATTR + ":\"%s\""; + private final static String SEARCH_TEXT_QUOTED = "PARENT:\"%s\" AND ASPECT:\"%s\" AND TEXT:\"%s\""; + private final static String SEARCH_USERPREFIX = "@" + USER_ATTR + ":%s AND "; + + /** maximum number of failed items to report to the user */ + private static final int MAX_FAILURE_REPORTS = 25; + + /** The PermissionService reference */ + transient protected PermissionService permissionService; + + + /** + * @param permissionService The PermissionService to set. + */ + public void setPermissionService(PermissionService permissionService) + { + this.permissionService = permissionService; + } + + protected PermissionService getPermissionService() + { + if (permissionService == null) + { + permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); + } + return permissionService; + } + + public void setProperty(TrashcanDialogProperty property) + { + this.property = property; + } + + public TrashcanDialogProperty getProperty() + { + return property; + } + + /** + * @return Message to display in the title of the panel area + */ + public String getPanelMessage() + { + FacesContext fc = FacesContext.getCurrentInstance(); + String msg = Application.getMessage(fc, MSG_DELETED_ITEMS); + if (isAdminUser() == false) + { + msg = msg + ' ' + MessageFormat.format( + Application.getMessage(fc, MSG_DELETED_ITEMS_FOR), Application.getCurrentUser(fc).getUserName()); + } + return msg; + } + + /** + * Returns the URL to the content for the current document item + * + * @return Content url to the current document item + */ + public String getItemBrowserUrl() + { + return Utils.generateURL(FacesContext.getCurrentInstance(), property.getItem(), URLMode.HTTP_INLINE); + } + + /** + * Returns the download URL to the content for the current document item + * + * @return Download url to the current document item + */ + public String getItemDownloadUrl() + { + return Utils.generateURL(FacesContext.getCurrentInstance(), property.getItem(), URLMode.HTTP_DOWNLOAD); + } + + /** + * Return the Alfresco NodeRef URL for the current item node + * + * @return the Alfresco NodeRef URL + */ + public String getItemNodeRefUrl() + { + return property.getItem().getNodeRef().toString(); + } + + /** + * @return HTML table of the listed items + */ + public String getListedItemsTable() + { + return buildItemsTable(property.getListedItems(), "recoveredItemsList", false, true); + } + + /** + * @return HTML table of the items successfully recovered + */ + public String getSuccessItemsTable() + { + return buildItemsTable(property.getSuccessItems(), "recoveredItemsList", false, false); + } + + /** + * @return HTML table of the items that failed to recover + */ + public String getFailureItemsTable() + { + return buildItemsTable(property.getFailureItems(), "failedItemsList", true, false); + } + + /** + * @return the list of deleted items to display + */ + public List getItems() + { + // to get deleted items from deleted items store + // use a search to find the items - also filters by name/username + List itemNodes = null; + + UserTransaction tx = null; + ResultSet results = null; + try + { + tx = Repository.getUserTransaction(FacesContext.getCurrentInstance(), true); + tx.begin(); + + // get the root node to the deleted items store + if (getArchiveRootRef() != null && property.isShowItems()) + { + String query = buildSearchQuery(); + SearchParameters sp = new SearchParameters(); + sp.setLanguage(SearchService.LANGUAGE_LUCENE); + sp.setQuery(query); + sp.addStore(getArchiveRootRef().getStoreRef()); // the Archived Node store + + results = getSearchService().query(sp); + itemNodes = new ArrayList(results.length()); + } + + if (results != null && results.length() != 0) + { + for (ResultSetRow row : results) + { + NodeRef nodeRef = row.getNodeRef(); + + if (getNodeService().exists(nodeRef)) + { + QName type = getNodeService().getType(nodeRef); + + MapNode node = new MapNode(nodeRef, getNodeService(), false); + + node.addPropertyResolver("locationPath", resolverLocationPath); + node.addPropertyResolver("displayPath", resolverDisplayPath); + node.addPropertyResolver("deletedDate", resolverDeletedDate); + node.addPropertyResolver("deletedBy", resolverDeletedBy); + node.addPropertyResolver("isFolder", resolverIsFolder); + + if (getDictionaryService().isSubClass(type, ContentModel.TYPE_FOLDER) == true && + getDictionaryService().isSubClass(type, ContentModel.TYPE_SYSTEM_FOLDER) == false) + { + node.addPropertyResolver("typeIcon", this.resolverSmallIcon); + } + else + { + node.addPropertyResolver("typeIcon", this.resolverFileType16); + } + itemNodes.add(node); + } + } + } + + tx.commit(); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), new Object[] {err.getMessage()}), err ); + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + finally + { + if (results != null) + { + results.close(); + } + } + + property.setListedItems((itemNodes != null ? itemNodes : Collections. emptyList())); + + return property.getListedItems(); + } + + private NodePropertyResolver resolverLocationPath = new NodePropertyResolver() + { + private static final long serialVersionUID = -2501720368642759082L; + + public Object get(Node node) + { + ChildAssociationRef childRef = (ChildAssociationRef)node.getProperties().get(ContentModel.PROP_ARCHIVED_ORIGINAL_PARENT_ASSOC); + if (getPermissionService().hasPermission(childRef.getParentRef(), PermissionService.READ).equals(AccessStatus.ALLOWED) && + getNodeService().exists(childRef.getParentRef())) + { + return getNodeService().getPath(childRef.getParentRef()); + } + else + { + return null; + } + } + }; + + private NodePropertyResolver resolverDisplayPath = new NodePropertyResolver() + { + private static final long serialVersionUID = 9178556770343499694L; + + public Object get(Node node) + { + ChildAssociationRef childRef = (ChildAssociationRef)node.getProperties().get(ContentModel.PROP_ARCHIVED_ORIGINAL_PARENT_ASSOC); + if (getPermissionService().hasPermission(childRef.getParentRef(), PermissionService.READ).equals(AccessStatus.ALLOWED) && + getNodeService().exists(childRef.getParentRef())) + { + return Repository.getDisplayPath(getNodeService().getPath(childRef.getParentRef()), true); + } + else + { + return ""; + } + } + }; + + private NodePropertyResolver resolverFileType16 = new NodePropertyResolver() + { + private static final long serialVersionUID = 7462526266770371703L; + + public Object get(Node node) + { + return FileTypeImageUtils.getFileTypeImage(node.getName(), true); + } + }; + + private NodePropertyResolver resolverSmallIcon = new NodePropertyResolver() + { + private static final long serialVersionUID = 5528945140207247127L; + + @SuppressWarnings("unchecked") + public Object get(Node node) + { + QNameNodeMap props = (QNameNodeMap)node.getProperties(); + String icon = (String) props.getRaw("app:icon"); + return "/images/icons/" + (icon != null ? icon + "-16.gif" : BrowseBean.SPACE_SMALL_DEFAULT + ".gif"); + } + }; + + private NodePropertyResolver resolverFileType32 = new NodePropertyResolver() + { + private static final long serialVersionUID = -5681639025578263060L; + + public Object get(Node node) + { + return FileTypeImageUtils.getFileTypeImage(node.getName(), false); + } + }; + + private NodePropertyResolver resolverLargeIcon = new NodePropertyResolver() + { + private static final long serialVersionUID = -8334570770580388654L; + + @SuppressWarnings("unchecked") + public Object get(Node node) + { + QNameNodeMap props = (QNameNodeMap)node.getProperties(); + String icon = (String) props.getRaw("app:icon"); + return "/images/icons/" + (icon != null ? icon : CreateSpaceWizard.DEFAULT_SPACE_ICON_NAME) + ".gif"; + } + }; + + private NodePropertyResolver resolverMimetype = new NodePropertyResolver() + { + private static final long serialVersionUID = -5892550146037635522L; + + public Object get(Node node) + { + ContentData content = (ContentData)node.getProperties().get(ContentModel.PROP_CONTENT); + return (content != null ? content.getMimetype() : null); + } + }; + + private NodePropertyResolver resolverSize = new NodePropertyResolver() + { + private static final long serialVersionUID = -191591211947393578L; + + public Object get(Node node) + { + ContentData content = (ContentData)node.getProperties().get(ContentModel.PROP_CONTENT); + return (content != null ? new Long(content.getSize()) : 0L); + } + }; + + private NodePropertyResolver resolverEncoding = new NodePropertyResolver() + { + private static final long serialVersionUID = -1594354572323978873L; + + public Object get(Node node) + { + ContentData content = (ContentData)node.getProperties().get(ContentModel.PROP_CONTENT); + return (content != null ? content.getEncoding() : null); + } + }; + + private NodePropertyResolver resolverDeletedDate = new NodePropertyResolver() + { + private static final long serialVersionUID = 3240286507786251191L; + + public Object get(Node node) + { + return node.getProperties().get(ContentModel.PROP_ARCHIVED_DATE); + } + }; + + private NodePropertyResolver resolverDeletedBy = new NodePropertyResolver() + { + private static final long serialVersionUID = -8678755146743606599L; + + public Object get(Node node) + { + return node.getProperties().get(ContentModel.PROP_ARCHIVED_BY); + } + }; + + private NodePropertyResolver resolverIsFolder = new NodePropertyResolver() + { + private static final long serialVersionUID = -9181535522349485509L; + + public Object get(Node node) + { + return getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_FOLDER); + } + }; + + + // ------------------------------------------------------------------------------ + // Action handlers + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return null; + } + + /** + * Search the deleted item store by name + */ + public void searchName(ActionEvent event) + { + // simply clear the current list and refresh the screen + // the search query text will be found and processed by the getItems() method + contextUpdated(); + property.setShowItems(true); + property.setFullTextSearch(false); + } + + /** + * Search the deleted item store by text + */ + public void searchContent(ActionEvent event) + { + // simply clear the current list and refresh the screen + // the search query text will be found and processed by the getItems() method + contextUpdated(); + property.setShowItems(true); + property.setFullTextSearch(true); + } + + /** + * Action handler to clear the current search results and show all items + */ + public void clearSearch(ActionEvent event) + { + contextUpdated(); + property.setSearchText(null); + property.setShowItems(true); + } + + /** + * Action handler called to prepare the selected item for an action + */ + public void setupItemAction(ActionEvent event) + { + UIActionLink link = (UIActionLink)event.getComponent(); + Map params = link.getParameterMap(); + String id = params.get("id"); + if (id != null && id.length() != 0) + { + try + { + // create the node ref, then our node representation + NodeRef ref = new NodeRef(getArchiveRootRef().getStoreRef(), id); + Node node = new Node(ref); + + node.addPropertyResolver("locationPath", resolverLocationPath); + node.addPropertyResolver("deletedDate", resolverDeletedDate); + node.addPropertyResolver("deletedBy", resolverDeletedBy); + node.addPropertyResolver("isFolder", resolverIsFolder); + node.addPropertyResolver("mimetype", resolverMimetype); + node.addPropertyResolver("size", resolverSize); + node.addPropertyResolver("encoding", resolverEncoding); + + if (getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_FOLDER) == true && + getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_SYSTEM_FOLDER) == false) + { + node.addPropertyResolver("icon", this.resolverLargeIcon); + } + else + { + node.addPropertyResolver("icon", this.resolverFileType32); + } + + // prepare a node for the action context + property.setItem(node); + property.setDestination(null); + } + catch (InvalidNodeRefException refErr) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {id})); + } + } + else + { + property.setItem(null); + } + + // clear the UI state in preparation for finishing the next action + contextUpdated(); + } + + /** + * Action handler to setup actions that act on lists + */ + public void setupListAction(ActionEvent event) + { + // clear the UI state in preparation for finishing the next action + property.setDestination(null); + contextUpdated(); + } + + /** + * @return outcome to close the main list screen and reset other beans ready for display + */ + public String close() + { + // call beans to update UI context for other screens + UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); + return OUTCOME_DIALOGCLOSE; + } + + /** + * Action handler to initially setup the trashcan screen + */ + public void setupTrashcan(ActionEvent event) + { + contextUpdated(); + } + + /** + * Action handler called when the Date filter is changed by the user + */ + public void dateFilterChanged(ActionEvent event) + { + UIModeList filterComponent = (UIModeList)event.getComponent(); + property.setDateFilter(filterComponent.getValue().toString()); + contextUpdated(); + property.setShowItems(true); + } + + /** + * Action handler called when the User filter is changed by the user + */ + public void userFilterChanged(ActionEvent event) + { + UIModeList filterComponent = (UIModeList)event.getComponent(); + property.setUserFilter(filterComponent.getValue().toString()); + contextUpdated(); + property.setShowItems(true); + } + + + // ------------------------------------------------------------------------------ + // Private helpers + + /** + * @return the archive store root node ref + */ + private NodeRef getArchiveRootRef() + { + if (property.getArchiveRootRef() == null) + { + property.setArchiveRootRef(property.getNodeArchiveService().getStoreArchiveNode(Repository.getStoreRef())); + } + return property.getArchiveRootRef(); + } + + /** + * @return the search query to use when displaying the list of deleted items + */ + @SuppressWarnings("deprecation") + private String buildSearchQuery() + { + String query; + if (property.getSearchText() == null || property.getSearchText().length() == 0) + { + // search for ALL items in the archive store + query = String.format(SEARCH_ALL, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED); + } + else + { + // search by name in the archive store + String safeText = SearchLanguageConversion.escapeLuceneQuery(property.getSearchText()); + if (safeText.indexOf(' ') == -1) + { + if (property.isFullTextSearch()) + { + query = String.format(SEARCH_TEXT, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText); + } + else + { + query = String.format(SEARCH_NAME, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText, safeText); + } + } + else + { + if (property.isFullTextSearch()) + { + query = String.format(SEARCH_TEXT_QUOTED, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText); + } + else + { + query = String.format(SEARCH_NAME_QUOTED, property.getArchiveRootRef(), ContentModel.ASPECT_ARCHIVED, safeText); + } + } + } + + // append user search clause + String username = null; + if (isAdminUser() == false) + { + // prefix the current username + username = Application.getCurrentUser(FacesContext.getCurrentInstance()).getUserName(); + } + else if (FILTER_USER_USER.equals(property.getUserFilter())) + { + // append the entered user if admin has requested a search + username = property.getUserSearchText(); + } + if (username != null && username.length() != 0) + { + query = String.format(SEARCH_USERPREFIX, username) + query; + } + + // append date search clause + if (FILTER_DATE_ALL.equals(property.getDateFilter()) == false) + { + Date toDate = new Date(); + Date fromDate = null; + if (FILTER_DATE_TODAY.equals(property.getDateFilter())) + { + fromDate = new Date(toDate.getYear(), toDate.getMonth(), toDate.getDate(), 0, 0, 0); + } + else if (FILTER_DATE_WEEK.equals(property.getDateFilter())) + { + fromDate = new Date(toDate.getTime() - (1000L*60L*60L*24L*7L)); + } + else if (FILTER_DATE_MONTH.equals(property.getDateFilter())) + { + fromDate = new Date(toDate.getTime() - (1000L*60L*60L*24L*30L)); + } + if (fromDate != null) + { + SimpleDateFormat df = CachingDateFormat.getDateFormat(); + String strFromDate = SearchLanguageConversion.escapeLuceneQuery(df.format(fromDate)); + String strToDate = SearchLanguageConversion.escapeLuceneQuery(df.format(toDate)); + StringBuilder buf = new StringBuilder(128); + buf.append("@").append(DATE_ATTR) + .append(":").append("[").append(strFromDate) + .append(" TO ").append(strToDate).append("] AND "); + + query = buf.toString() + query; + } + } + + return query; + } + + /** + * Save the detail of the items that were successfully or unsuccessfully restored + * + * @param reports The List of RestoreNodeReport objects to walk for results + */ + protected void saveReportDetail(List reports) + { + // store the results ready for the next dialog page + int failureItemsCount = 0; + property.setSuccessItems(new ArrayList(reports.size())); + property.setFailureItems(new ArrayList(reports.size())); + for (RestoreNodeReport report : reports) + { + if (RestoreStatus.SUCCESS == report.getStatus()) + { + Node node = new Node(report.getRestoredNodeRef()); + node.getProperties().put(PROP_RECOVERSTATUS, report.getStatus()); + property.getSuccessItems().add(node); + } + else + { + if (failureItemsCount < MAX_FAILURE_REPORTS) + { + Node node = new Node(report.getArchivedNodeRef()); + node.getProperties().put(PROP_RECOVERSTATUS, report.getStatus()); + node.getProperties().put(PROP_RECOVERERRORMESSAGE, report.getCause().getMessage()); + property.getFailureItems().add(node); + failureItemsCount++; + } + } + } + } + + /** + * Build an HTML table of the items that are to be or have been recovered. + * + * @param items List of Node objects to display in the table + * @param cssClass CSS style to apply to the table + * @param report Set true to report the reason for any failure. This flag requires that the Node + * object has a pseudo property "recoverstatus" containing the RestoreStatus. + * @param archivedPath Set true to show the path from the 'sys:archivedOriginalParentAssoc' property, + * else the current Node Path will be used. + * + * + * @return HTML table of node info + */ + private String buildItemsTable(List items, String cssClass, boolean report, boolean archivedPath) + { + FacesContext fc = FacesContext.getCurrentInstance(); + String contextPath = fc.getExternalContext().getRequestContextPath(); + + StringBuilder buf = new StringBuilder(1024); + + // outer table + buf.append(""); + // title row + buf.append(""); + if (report == true) + { + buf.append(""); + } + else + { + buf.append(""); + } + buf.append(""); + for (Node node : items) + { + // listed item rows + buf.append(""); + + if (report) + { + buf.append(""); + } + else + { + buf.append(""); + } + + buf.append(""); + } + // end table + buf.append("
"); + buf.append(Application.getMessage(fc, MSG_NAME)); + buf.append(""); + buf.append(Application.getMessage(fc, MSG_RECOVERY_REASON)); + buf.append(""); + buf.append(Application.getMessage(fc, MSG_LOCATION)); + buf.append("
"); + String img; + if (getDictionaryService().isSubClass(node.getType(), ContentModel.TYPE_FOLDER)) + { + String icon = (String)node.getProperties().get("app:icon"); + img = "/images/icons/" + (icon != null ? icon + "-16.gif" : BrowseBean.SPACE_SMALL_DEFAULT + ".gif"); + } + else + { + img = FileTypeImageUtils.getFileTypeImage(node.getName(), true); + } + buf.append(""); + buf.append(""); + buf.append(Utils.encode(node.getName())); + buf.append(""); + String msg; + RestoreStatus status = (RestoreStatus) node.getProperties().get(PROP_RECOVERSTATUS); + String message = (String) node.getProperties().get(PROP_RECOVERERRORMESSAGE); + switch (status) + { + case FAILURE_INVALID_PARENT: + msg = MSG_RECOVERED_ITEM_PARENT_S; + break; + + case FAILURE_PERMISSION: + msg = MSG_RECOVERED_ITEM_PERMISSION_S; + break; + + case FAILURE_INTEGRITY: + msg = MSG_RECOVERED_ITEM_INTEGRITY_S; + break; + + case FAILURE_DUPLICATE_CHILD_NODE_NAME: + msg = MSG_RECOVERED_ITEM_DUPLICATE_S; + break; + + default: + msg = MSG_RECOVERED_ITEM_FAILURE_S; + break; + } + buf.append(Application.getMessage(fc, msg)); + buf.append(": "); + buf.append(message); + buf.append(""); + if (archivedPath) + { + ChildAssociationRef childRef = (ChildAssociationRef)node.getProperties().get(ContentModel.PROP_ARCHIVED_ORIGINAL_PARENT_ASSOC); + if (getNodeService().exists(childRef.getParentRef())) + { + buf.append(Utils.encode(Repository.getNamePath(getNodeService(), getNodeService().getPath(childRef.getParentRef()), null, "/", null))); + } + } + else + { + buf.append(Utils.encode(Repository.getNamePath(getNodeService(), getNodeService().getPath(node.getNodeRef()), null, "/", null))); + } + buf.append("
"); + + return buf.toString(); + } + + private boolean isAdminUser() + { + return Application.getCurrentUser(FacesContext.getCurrentInstance()).isAdmin(); + } + + + // ------------------------------------------------------------------------------ + // IContextListener implementation + + /** + * @see org.alfresco.web.app.context.IContextListener#contextUpdated() + */ + public void contextUpdated() + { + if (property.getItemsRichList() != null) + { + property.getItemsRichList().setValue(null); + } + property.setShowItems(false); + } + + /** + * @see org.alfresco.web.app.context.IContextListener#areaChanged() + */ + public void areaChanged() + { + // nothing to do + } + + /** + * @see org.alfresco.web.app.context.IContextListener#spaceChanged() + */ + public void spaceChanged() + { + // nothing to do + } + + @Override + public String cancel() + { + close(); + return super.cancel(); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } + } \ No newline at end of file diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanDialogProperty.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanDialogProperty.java index dd6f602593..8bfed20fe3 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanDialogProperty.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanDialogProperty.java @@ -1,290 +1,290 @@ -package org.alfresco.web.bean.trashcan; - -import java.io.Serializable; -import java.util.Collections; -import java.util.List; - -import javax.faces.context.FacesContext; - -import org.alfresco.repo.node.archive.NodeArchiveService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.component.data.UIRichList; - -public class TrashcanDialogProperty implements Serializable -{ - private static final long serialVersionUID = -8007742798807270570L; - - private static final String FILTER_DATE_ALL = "all"; - private static final String FILTER_USER_ALL = "all"; - - /** NodeArchiveService bean reference */ - transient private NodeArchiveService nodeArchiveService; - - /** Component reference for Deleted Items RichList control */ - protected UIRichList itemsRichList; - - /** Search text */ - private String searchText = null; - - /** We show an empty list until a Search or Show All is executed */ - private boolean showItems = false; - - private boolean fullTextSearch = false; - - /** Currently listed items */ - private List listedItems = Collections. emptyList(); - - private List successItems = Collections. emptyList(); - - private List failureItems = Collections. emptyList(); - - /** Current action context Node */ - private Node actionNode; - - /** Root node to the spaces store archive store */ - private NodeRef archiveRootRef = null; - - /** Alternative destination for recovered items */ - private NodeRef destination = null; - - /** Date filter selection */ - private String dateFilter = FILTER_DATE_ALL; - - /** User filter selection */ - private String userFilter = FILTER_USER_ALL; - - /** User filter search box text */ - private String userSearchText = null; - - private boolean inProgress = false; - - /** - * @param nodeArchiveService The nodeArchiveService to set. - */ - public void setNodeArchiveService(NodeArchiveService nodeArchiveService) - { - this.nodeArchiveService = nodeArchiveService; - } - - /** - * @return Returns the itemsRichList. - */ - public UIRichList getItemsRichList() - { - return this.itemsRichList; - } - - /** - * @param itemsRichList The itemsRichList to set. - */ - public void setItemsRichList(UIRichList itemsRichList) - { - this.itemsRichList = itemsRichList; - } - - /** - * @return Returns the searchText. - */ - public String getSearchText() - { - return this.searchText; - } - - /** - * @param searchText The searchText to set. - */ - public void setSearchText(String searchText) - { - this.searchText = searchText; - } - - /** - * @return Returns the alternative destination to use if recovery fails. - */ - public NodeRef getDestination() - { - return this.destination; - } - - /** - * @param destination The alternative destination to use if recovery fails. - */ - public void setDestination(NodeRef destination) - { - this.destination = destination; - } - - /** - * @return Returns the dateFilter. - */ - public String getDateFilter() - { - return this.dateFilter; - } - - /** - * @param dateFilter The dateFilter to set. - */ - public void setDateFilter(String dateFilter) - { - this.dateFilter = dateFilter; - } - - /** - * @return Returns the userFilter. - */ - public String getUserFilter() - { - return this.userFilter; - } - - /** - * @param userFilter The userFilter to set. - */ - public void setUserFilter(String userFilter) - { - this.userFilter = userFilter; - } - - /** - * @return Returns the userSearchText. - */ - public String getUserSearchText() - { - return this.userSearchText; - } - - /** - * @param userSearchText The userSearchText to set. - */ - public void setUserSearchText(String userSearchText) - { - this.userSearchText = userSearchText; - } - - /** - * @return Returns the listed items. - */ - public List getListedItems() - { - return this.listedItems; - } - - /** - * @param listedItems The listed items to set. - */ - public void setListedItems(List listedItems) - { - this.listedItems = listedItems; - } - - /** - * @return count of the items that failed to recover - */ - public int getFailureItemsCount() - { - return this.failureItems.size(); - } - - /** - * @param node The item context for the current action - */ - public void setItem(Node node) - { - this.actionNode = node; - } - - /** - * @return the item context for the current action - */ - public Node getItem() - { - return this.actionNode; - } - - public boolean isShowItems() - { - return showItems; - } - - public void setShowItems(boolean showItems) - { - this.showItems = showItems; - } - - public boolean isFullTextSearch() - { - return fullTextSearch; - } - - public void setFullTextSearch(boolean fullTextSearch) - { - this.fullTextSearch = fullTextSearch; - } - - public List getSuccessItems() - { - return successItems; - } - - public void setSuccessItems(List successItems) - { - this.successItems = successItems; - } - - public List getFailureItems() - { - return failureItems; - } - - public void setFailureItems(List failureItems) - { - this.failureItems = failureItems; - } - - public Node getActionNode() - { - return actionNode; - } - - public void setActionNode(Node actionNode) - { - this.actionNode = actionNode; - } - - public NodeRef getArchiveRootRef() - { - return archiveRootRef; - } - - public void setArchiveRootRef(NodeRef archiveRootRef) - { - this.archiveRootRef = archiveRootRef; - } - - public boolean isInProgress() - { - return inProgress; - } - - public void setInProgress(boolean inProgress) - { - this.inProgress = inProgress; - } - - /** - *@return nodeArchiveService - */ - public NodeArchiveService getNodeArchiveService() - { - //check for null for cluster environment - if (nodeArchiveService == null) - { - nodeArchiveService = (NodeArchiveService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "nodeArchiveService"); - } - return nodeArchiveService; - } - -} +package org.alfresco.web.bean.trashcan; + +import java.io.Serializable; +import java.util.Collections; +import java.util.List; + +import javax.faces.context.FacesContext; + +import org.alfresco.repo.node.archive.NodeArchiveService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.component.data.UIRichList; + +public class TrashcanDialogProperty implements Serializable +{ + private static final long serialVersionUID = -8007742798807270570L; + + private static final String FILTER_DATE_ALL = "all"; + private static final String FILTER_USER_ALL = "all"; + + /** NodeArchiveService bean reference */ + transient private NodeArchiveService nodeArchiveService; + + /** Component reference for Deleted Items RichList control */ + protected UIRichList itemsRichList; + + /** Search text */ + private String searchText = null; + + /** We show an empty list until a Search or Show All is executed */ + private boolean showItems = false; + + private boolean fullTextSearch = false; + + /** Currently listed items */ + private List listedItems = Collections. emptyList(); + + private List successItems = Collections. emptyList(); + + private List failureItems = Collections. emptyList(); + + /** Current action context Node */ + private Node actionNode; + + /** Root node to the spaces store archive store */ + private NodeRef archiveRootRef = null; + + /** Alternative destination for recovered items */ + private NodeRef destination = null; + + /** Date filter selection */ + private String dateFilter = FILTER_DATE_ALL; + + /** User filter selection */ + private String userFilter = FILTER_USER_ALL; + + /** User filter search box text */ + private String userSearchText = null; + + private boolean inProgress = false; + + /** + * @param nodeArchiveService The nodeArchiveService to set. + */ + public void setNodeArchiveService(NodeArchiveService nodeArchiveService) + { + this.nodeArchiveService = nodeArchiveService; + } + + /** + * @return Returns the itemsRichList. + */ + public UIRichList getItemsRichList() + { + return this.itemsRichList; + } + + /** + * @param itemsRichList The itemsRichList to set. + */ + public void setItemsRichList(UIRichList itemsRichList) + { + this.itemsRichList = itemsRichList; + } + + /** + * @return Returns the searchText. + */ + public String getSearchText() + { + return this.searchText; + } + + /** + * @param searchText The searchText to set. + */ + public void setSearchText(String searchText) + { + this.searchText = searchText; + } + + /** + * @return Returns the alternative destination to use if recovery fails. + */ + public NodeRef getDestination() + { + return this.destination; + } + + /** + * @param destination The alternative destination to use if recovery fails. + */ + public void setDestination(NodeRef destination) + { + this.destination = destination; + } + + /** + * @return Returns the dateFilter. + */ + public String getDateFilter() + { + return this.dateFilter; + } + + /** + * @param dateFilter The dateFilter to set. + */ + public void setDateFilter(String dateFilter) + { + this.dateFilter = dateFilter; + } + + /** + * @return Returns the userFilter. + */ + public String getUserFilter() + { + return this.userFilter; + } + + /** + * @param userFilter The userFilter to set. + */ + public void setUserFilter(String userFilter) + { + this.userFilter = userFilter; + } + + /** + * @return Returns the userSearchText. + */ + public String getUserSearchText() + { + return this.userSearchText; + } + + /** + * @param userSearchText The userSearchText to set. + */ + public void setUserSearchText(String userSearchText) + { + this.userSearchText = userSearchText; + } + + /** + * @return Returns the listed items. + */ + public List getListedItems() + { + return this.listedItems; + } + + /** + * @param listedItems The listed items to set. + */ + public void setListedItems(List listedItems) + { + this.listedItems = listedItems; + } + + /** + * @return count of the items that failed to recover + */ + public int getFailureItemsCount() + { + return this.failureItems.size(); + } + + /** + * @param node The item context for the current action + */ + public void setItem(Node node) + { + this.actionNode = node; + } + + /** + * @return the item context for the current action + */ + public Node getItem() + { + return this.actionNode; + } + + public boolean isShowItems() + { + return showItems; + } + + public void setShowItems(boolean showItems) + { + this.showItems = showItems; + } + + public boolean isFullTextSearch() + { + return fullTextSearch; + } + + public void setFullTextSearch(boolean fullTextSearch) + { + this.fullTextSearch = fullTextSearch; + } + + public List getSuccessItems() + { + return successItems; + } + + public void setSuccessItems(List successItems) + { + this.successItems = successItems; + } + + public List getFailureItems() + { + return failureItems; + } + + public void setFailureItems(List failureItems) + { + this.failureItems = failureItems; + } + + public Node getActionNode() + { + return actionNode; + } + + public void setActionNode(Node actionNode) + { + this.actionNode = actionNode; + } + + public NodeRef getArchiveRootRef() + { + return archiveRootRef; + } + + public void setArchiveRootRef(NodeRef archiveRootRef) + { + this.archiveRootRef = archiveRootRef; + } + + public boolean isInProgress() + { + return inProgress; + } + + public void setInProgress(boolean inProgress) + { + this.inProgress = inProgress; + } + + /** + *@return nodeArchiveService + */ + public NodeArchiveService getNodeArchiveService() + { + //check for null for cluster environment + if (nodeArchiveService == null) + { + nodeArchiveService = (NodeArchiveService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "nodeArchiveService"); + } + return nodeArchiveService; + } + +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanItemDetailsDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanItemDetailsDialog.java index cefabc6294..a8c18f28ba 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanItemDetailsDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanItemDetailsDialog.java @@ -1,69 +1,69 @@ -package org.alfresco.web.bean.trashcan; - -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; - -public class TrashcanItemDetailsDialog extends TrashcanDialog -{ - private static final long serialVersionUID = 1767515883530860417L; - - private static final String MSG_DETAILS_OF = "details_of"; - private static final String MSG_CLOSE = "close"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - transient private PermissionService permissionService; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return null; - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_DETAILS_OF) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + - property.getItem().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } - - @Override - public Object getActionsContext() - { - return getItem(); - } - - public Node getItem() - { - return property.getItem(); - } - - public void setPermissionService(PermissionService permissionService) - { - this.permissionService = permissionService; - } - - /** - *@return permissionService - */ - protected PermissionService getPermissionService() - { - //check for null for cluster environment - if (permissionService == null) - { - permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); - } - return permissionService; - } -} +package org.alfresco.web.bean.trashcan; + +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; + +public class TrashcanItemDetailsDialog extends TrashcanDialog +{ + private static final long serialVersionUID = 1767515883530860417L; + + private static final String MSG_DETAILS_OF = "details_of"; + private static final String MSG_CLOSE = "close"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + transient private PermissionService permissionService; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return null; + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_DETAILS_OF) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + property.getItem().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } + + @Override + public Object getActionsContext() + { + return getItem(); + } + + public Node getItem() + { + return property.getItem(); + } + + public void setPermissionService(PermissionService permissionService) + { + this.permissionService = permissionService; + } + + /** + *@return permissionService + */ + protected PermissionService getPermissionService() + { + //check for null for cluster environment + if (permissionService == null) + { + permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); + } + return permissionService; + } +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverItemDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverItemDialog.java index 6c5a4e4457..f2939670fe 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverItemDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverItemDialog.java @@ -1,150 +1,150 @@ -package org.alfresco.web.bean.trashcan; - -import java.text.MessageFormat; - -import javax.faces.application.FacesMessage; -import javax.faces.context.FacesContext; - -import org.alfresco.repo.node.archive.RestoreNodeReport; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.ReportedException; - -public class TrashcanRecoverItemDialog extends TrashcanDialog -{ - private static final long serialVersionUID = -8237457079397611071L; - - private static final String RICHLIST_ID = "trashcan-list"; - private static final String RICHLIST_MSG_ID = "trashcan" + ':' + RICHLIST_ID; - private static final String MSG_RECOVERED_ITEM_SUCCESS = "recovered_item_success"; - private static final String MSG_RECOVERED_ITEM_DUPLICATE = "recovered_item_duplicate"; - private static final String MSG_RECOVERED_ITEM_INTEGRITY = "recovered_item_integrity"; - private static final String MSG_RECOVERED_ITEM_PERMISSION = "recovered_item_permission"; - private static final String MSG_RECOVERED_ITEM_PARENT = "recovered_item_parent"; - private static final String MSG_RECOVERED_ITEM_FAILURE = "recovered_item_failure"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private static final String MSG_RECOVER_ITEM = "recover_item"; - private static final String MSG_NO = "no"; - private static final String MSG_YES = "yes"; - - private String recoverItem(FacesContext context, String outcome) - { - Node item = property.getItem(); - if (item != null) - { - FacesContext fc = context; - try - { - String msg; - FacesMessage errorfacesMsg = null; - - // restore the node - the user may have requested a restore to a - // different parent - RestoreNodeReport report; - if (property.getDestination() == null) - { - report = property.getNodeArchiveService().restoreArchivedNode(item.getNodeRef()); - } - else - { - report = property.getNodeArchiveService().restoreArchivedNode(item.getNodeRef(), property.getDestination(), null, null); - } - switch (report.getStatus()) - { - case SUCCESS: - msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_SUCCESS), item.getName()); - FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_INFO, msg, msg); - fc.addMessage(RICHLIST_MSG_ID, facesMsg); - - break; - - case FAILURE_INVALID_PARENT: - msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_PARENT), item.getName()); - errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); - break; - - case FAILURE_PERMISSION: - msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_PERMISSION), item.getName()); - errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); - break; - - case FAILURE_INTEGRITY: - msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_INTEGRITY), item.getName()); - errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); - break; - - case FAILURE_DUPLICATE_CHILD_NODE_NAME: - msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_DUPLICATE), item.getName()); - errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); - break; - - default: - String reason = report.getCause().getMessage(); - msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_FAILURE), item.getName(), reason); - errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); - break; - } - - // report the failure if one occured we stay on the current - // screen - if (errorfacesMsg != null) - { - fc.addMessage(null, errorfacesMsg); - } - } - catch (Throwable err) - { - // most exceptions will be caught and returned as - // RestoreNodeReport objects by the service - String reason = err.getMessage(); - String msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_FAILURE), item.getName(), reason); - FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); - fc.addMessage(null, facesMsg); - ReportedException.throwIfNecessary(err); - } - } - - return outcome; - } - - @Override - protected String getDefaultFinishOutcome() - { - return "dialog:close[2]"; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return recoverItem(context, outcome); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_RECOVER_ITEM) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + property.getItem().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); - } - -} +package org.alfresco.web.bean.trashcan; + +import java.text.MessageFormat; + +import javax.faces.application.FacesMessage; +import javax.faces.context.FacesContext; + +import org.alfresco.repo.node.archive.RestoreNodeReport; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.ReportedException; + +public class TrashcanRecoverItemDialog extends TrashcanDialog +{ + private static final long serialVersionUID = -8237457079397611071L; + + private static final String RICHLIST_ID = "trashcan-list"; + private static final String RICHLIST_MSG_ID = "trashcan" + ':' + RICHLIST_ID; + private static final String MSG_RECOVERED_ITEM_SUCCESS = "recovered_item_success"; + private static final String MSG_RECOVERED_ITEM_DUPLICATE = "recovered_item_duplicate"; + private static final String MSG_RECOVERED_ITEM_INTEGRITY = "recovered_item_integrity"; + private static final String MSG_RECOVERED_ITEM_PERMISSION = "recovered_item_permission"; + private static final String MSG_RECOVERED_ITEM_PARENT = "recovered_item_parent"; + private static final String MSG_RECOVERED_ITEM_FAILURE = "recovered_item_failure"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private static final String MSG_RECOVER_ITEM = "recover_item"; + private static final String MSG_NO = "no"; + private static final String MSG_YES = "yes"; + + private String recoverItem(FacesContext context, String outcome) + { + Node item = property.getItem(); + if (item != null) + { + FacesContext fc = context; + try + { + String msg; + FacesMessage errorfacesMsg = null; + + // restore the node - the user may have requested a restore to a + // different parent + RestoreNodeReport report; + if (property.getDestination() == null) + { + report = property.getNodeArchiveService().restoreArchivedNode(item.getNodeRef()); + } + else + { + report = property.getNodeArchiveService().restoreArchivedNode(item.getNodeRef(), property.getDestination(), null, null); + } + switch (report.getStatus()) + { + case SUCCESS: + msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_SUCCESS), item.getName()); + FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_INFO, msg, msg); + fc.addMessage(RICHLIST_MSG_ID, facesMsg); + + break; + + case FAILURE_INVALID_PARENT: + msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_PARENT), item.getName()); + errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); + break; + + case FAILURE_PERMISSION: + msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_PERMISSION), item.getName()); + errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); + break; + + case FAILURE_INTEGRITY: + msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_INTEGRITY), item.getName()); + errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); + break; + + case FAILURE_DUPLICATE_CHILD_NODE_NAME: + msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_DUPLICATE), item.getName()); + errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); + break; + + default: + String reason = report.getCause().getMessage(); + msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_FAILURE), item.getName(), reason); + errorfacesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); + break; + } + + // report the failure if one occured we stay on the current + // screen + if (errorfacesMsg != null) + { + fc.addMessage(null, errorfacesMsg); + } + } + catch (Throwable err) + { + // most exceptions will be caught and returned as + // RestoreNodeReport objects by the service + String reason = err.getMessage(); + String msg = MessageFormat.format(Application.getMessage(fc, MSG_RECOVERED_ITEM_FAILURE), item.getName(), reason); + FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, msg); + fc.addMessage(null, facesMsg); + ReportedException.throwIfNecessary(err); + } + } + + return outcome; + } + + @Override + protected String getDefaultFinishOutcome() + { + return "dialog:close[2]"; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return recoverItem(context, outcome); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_RECOVER_ITEM) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + property.getItem().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); + } + +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverListedItemsDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverListedItemsDialog.java index f4235db994..100d2879b4 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverListedItemsDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoverListedItemsDialog.java @@ -1,85 +1,85 @@ -package org.alfresco.web.bean.trashcan; - -import java.util.ArrayList; -import java.util.List; - -import javax.faces.context.FacesContext; - -import org.alfresco.repo.node.archive.RestoreNodeReport; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; - -public class TrashcanRecoverListedItemsDialog extends TrashcanDialog -{ - private static final long serialVersionUID = 5500454626559426051L; - - private static final String OUTCOME_RECOVERY_REPORT = "dialog:recoveryReport"; - private static final String MSG_NO = "no"; - private static final String MSG_YES = "yes"; - - private String recoverListedItems(FacesContext context, String outcome) - { - if (property.isInProgress()) - return null; - - property.setInProgress(true); - - try - { - - // restore the nodes - the user may have requested a restore to a - // different parent - List nodeRefs = new ArrayList(property.getListedItems().size()); - for (Node node : property.getListedItems()) - { - nodeRefs.add(node.getNodeRef()); - } - List reports; - if (property.getDestination() == null) - { - reports = property.getNodeArchiveService().restoreArchivedNodes(nodeRefs); - } - else - { - reports = property.getNodeArchiveService().restoreArchivedNodes(nodeRefs, property.getDestination(), null, null); - } - - saveReportDetail(reports); - - } - finally - { - property.setInProgress(false); - } - - return OUTCOME_RECOVERY_REPORT; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - - return recoverListedItems(context, outcome); - - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); - } - -} +package org.alfresco.web.bean.trashcan; + +import java.util.ArrayList; +import java.util.List; + +import javax.faces.context.FacesContext; + +import org.alfresco.repo.node.archive.RestoreNodeReport; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; + +public class TrashcanRecoverListedItemsDialog extends TrashcanDialog +{ + private static final long serialVersionUID = 5500454626559426051L; + + private static final String OUTCOME_RECOVERY_REPORT = "dialog:recoveryReport"; + private static final String MSG_NO = "no"; + private static final String MSG_YES = "yes"; + + private String recoverListedItems(FacesContext context, String outcome) + { + if (property.isInProgress()) + return null; + + property.setInProgress(true); + + try + { + + // restore the nodes - the user may have requested a restore to a + // different parent + List nodeRefs = new ArrayList(property.getListedItems().size()); + for (Node node : property.getListedItems()) + { + nodeRefs.add(node.getNodeRef()); + } + List reports; + if (property.getDestination() == null) + { + reports = property.getNodeArchiveService().restoreArchivedNodes(nodeRefs); + } + else + { + reports = property.getNodeArchiveService().restoreArchivedNodes(nodeRefs, property.getDestination(), null, null); + } + + saveReportDetail(reports); + + } + finally + { + property.setInProgress(false); + } + + return OUTCOME_RECOVERY_REPORT; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + + return recoverListedItems(context, outcome); + + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_NO); + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_YES); + } + +} diff --git a/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoveryReportDialog.java b/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoveryReportDialog.java index 2de3e49a47..6930b17122 100644 --- a/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoveryReportDialog.java +++ b/source/java/org/alfresco/web/bean/trashcan/TrashcanRecoveryReportDialog.java @@ -1,32 +1,32 @@ -package org.alfresco.web.bean.trashcan; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; - -public class TrashcanRecoveryReportDialog extends TrashcanDialog -{ - - private static final long serialVersionUID = -3381444990908748991L; - - private final static String MSG_CLOSE = "close"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return outcome; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } - - @Override - protected String getDefaultCancelOutcome() - { - return "dialog:close[2]"; - } - -} +package org.alfresco.web.bean.trashcan; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; + +public class TrashcanRecoveryReportDialog extends TrashcanDialog +{ + + private static final long serialVersionUID = -3381444990908748991L; + + private final static String MSG_CLOSE = "close"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return outcome; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } + + @Override + protected String getDefaultCancelOutcome() + { + return "dialog:close[2]"; + } + +} diff --git a/source/java/org/alfresco/web/bean/users/ChangeMyPasswordDialog.java b/source/java/org/alfresco/web/bean/users/ChangeMyPasswordDialog.java index 7852d6ffc8..129fd448a2 100644 --- a/source/java/org/alfresco/web/bean/users/ChangeMyPasswordDialog.java +++ b/source/java/org/alfresco/web/bean/users/ChangeMyPasswordDialog.java @@ -1,70 +1,70 @@ -package org.alfresco.web.bean.users; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class ChangeMyPasswordDialog extends UsersDialog -{ - - private static final long serialVersionUID = 1965846039555088108L; - - private static final String MSG_FINISH_BUTTON = "finish_button"; - private static final String MSG_ERROR_INCORRECT_OLD_PASSWORD = "error_incorrect_old_password"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - String result = changeMyPasswordOK(outcome, context); - if (result == null) - { - isFinished = false; - } - return result; - } - - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_FINISH_BUTTON); - } - - public boolean getFinishButtonDisabled() - { - return false; - } - - /** - * Action handler called for OK button press on Change My Password screen For this screen the user is required to enter their old password - effectively login. - */ - public String changeMyPasswordOK(String newOutcome, FacesContext newContext) - { - String outcome = newOutcome; - - if (properties.getPassword() != null && properties.getConfirm() != null && properties.getPassword().equals(properties.getConfirm())) - { - try - { - String userName = (String) properties.getPerson().getProperties().get(ContentModel.PROP_USERNAME); - properties.getAuthenticationService().updateAuthentication(userName, properties.getOldPassword().toCharArray(), properties.getPassword().toCharArray()); - } - catch (Exception e) - { - outcome = null; - Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), - MSG_ERROR_INCORRECT_OLD_PASSWORD)); - ReportedException.throwIfNecessary(e); - } - } - else - { - outcome = null; - Utils.addErrorMessage(Application.getMessage(newContext, ERROR_PASSWORD_MATCH)); - } - - return outcome; - } - -} +package org.alfresco.web.bean.users; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class ChangeMyPasswordDialog extends UsersDialog +{ + + private static final long serialVersionUID = 1965846039555088108L; + + private static final String MSG_FINISH_BUTTON = "finish_button"; + private static final String MSG_ERROR_INCORRECT_OLD_PASSWORD = "error_incorrect_old_password"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + String result = changeMyPasswordOK(outcome, context); + if (result == null) + { + isFinished = false; + } + return result; + } + + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_FINISH_BUTTON); + } + + public boolean getFinishButtonDisabled() + { + return false; + } + + /** + * Action handler called for OK button press on Change My Password screen For this screen the user is required to enter their old password - effectively login. + */ + public String changeMyPasswordOK(String newOutcome, FacesContext newContext) + { + String outcome = newOutcome; + + if (properties.getPassword() != null && properties.getConfirm() != null && properties.getPassword().equals(properties.getConfirm())) + { + try + { + String userName = (String) properties.getPerson().getProperties().get(ContentModel.PROP_USERNAME); + properties.getAuthenticationService().updateAuthentication(userName, properties.getOldPassword().toCharArray(), properties.getPassword().toCharArray()); + } + catch (Exception e) + { + outcome = null; + Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), + MSG_ERROR_INCORRECT_OLD_PASSWORD)); + ReportedException.throwIfNecessary(e); + } + } + else + { + outcome = null; + Utils.addErrorMessage(Application.getMessage(newContext, ERROR_PASSWORD_MATCH)); + } + + return outcome; + } + +} diff --git a/source/java/org/alfresco/web/bean/users/ChangePasswordDialog.java b/source/java/org/alfresco/web/bean/users/ChangePasswordDialog.java index 227ad5e84e..48f2ca252f 100644 --- a/source/java/org/alfresco/web/bean/users/ChangePasswordDialog.java +++ b/source/java/org/alfresco/web/bean/users/ChangePasswordDialog.java @@ -1,70 +1,70 @@ -package org.alfresco.web.bean.users; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -public class ChangePasswordDialog extends UsersDialog -{ - - private static final long serialVersionUID = -1570967895811499123L; - - private static final String MSG_FINISH_BUTTON = "finish_button"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - String result = changePasswordOK(outcome, context); - if (result == null) - { - isFinished = false; - } - return result; - } - - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_FINISH_BUTTON); - } - - public boolean getFinishButtonDisabled() - { - return false; - } - - /** - * Action handler called for OK button press on Change Password screen - */ - public String changePasswordOK(String newOutcome, FacesContext newContext) - { - String outcome = newOutcome; - - if (properties.getPassword() != null && properties.getConfirm() != null && properties.getPassword().equals(properties.getConfirm())) - { - try - { - String userName = (String) properties.getPerson().getProperties().get(ContentModel.PROP_USERNAME); - properties.getAuthenticationService().setAuthentication(userName, properties.getPassword().toCharArray()); - } - catch (Exception e) - { - outcome = null; - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, Repository.ERROR_GENERIC), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - } - else - { - outcome = null; - Utils.addErrorMessage(Application.getMessage(newContext, ERROR_PASSWORD_MATCH)); - } - - return outcome; - } -} +package org.alfresco.web.bean.users; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +public class ChangePasswordDialog extends UsersDialog +{ + + private static final long serialVersionUID = -1570967895811499123L; + + private static final String MSG_FINISH_BUTTON = "finish_button"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + String result = changePasswordOK(outcome, context); + if (result == null) + { + isFinished = false; + } + return result; + } + + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_FINISH_BUTTON); + } + + public boolean getFinishButtonDisabled() + { + return false; + } + + /** + * Action handler called for OK button press on Change Password screen + */ + public String changePasswordOK(String newOutcome, FacesContext newContext) + { + String outcome = newOutcome; + + if (properties.getPassword() != null && properties.getConfirm() != null && properties.getPassword().equals(properties.getConfirm())) + { + try + { + String userName = (String) properties.getPerson().getProperties().get(ContentModel.PROP_USERNAME); + properties.getAuthenticationService().setAuthentication(userName, properties.getPassword().toCharArray()); + } + catch (Exception e) + { + outcome = null; + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(newContext, Repository.ERROR_GENERIC), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + } + else + { + outcome = null; + Utils.addErrorMessage(Application.getMessage(newContext, ERROR_PASSWORD_MATCH)); + } + + return outcome; + } +} diff --git a/source/java/org/alfresco/web/bean/users/ContentUsersBean.java b/source/java/org/alfresco/web/bean/users/ContentUsersBean.java index 0b84cbc8f1..437ab97bd1 100644 --- a/source/java/org/alfresco/web/bean/users/ContentUsersBean.java +++ b/source/java/org/alfresco/web/bean/users/ContentUsersBean.java @@ -1,65 +1,65 @@ -package org.alfresco.web.bean.users; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; - -/** - * Concrete implementation providing access to users of the current content/document. - * - * @author gavinc - */ -public class ContentUsersBean extends UserMembersBean -{ - private static final long serialVersionUID = 5206400236997654181L; - - private final static String MSG_MANAGE_CONTENT_USERS = "manage_content_users"; - private final static String MSG_CONTENT_OWNER = "content_owner"; - private final static String MSG_CLOSE= "close"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - /** - * @return The space to work against - */ - public Node getNode() - { - return this.browseBean.getDocument(); - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return null; - } - - @Override - public Object getActionsContext() - { - return getNode(); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_MANAGE_CONTENT_USERS) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + browseBean.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getContainerSubTitle() - { - String pattern = Application.getMessage(FacesContext.getCurrentInstance(), MSG_CONTENT_OWNER); - return MessageFormat.format(pattern, getOwner()); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } -} +package org.alfresco.web.bean.users; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; + +/** + * Concrete implementation providing access to users of the current content/document. + * + * @author gavinc + */ +public class ContentUsersBean extends UserMembersBean +{ + private static final long serialVersionUID = 5206400236997654181L; + + private final static String MSG_MANAGE_CONTENT_USERS = "manage_content_users"; + private final static String MSG_CONTENT_OWNER = "content_owner"; + private final static String MSG_CLOSE= "close"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + /** + * @return The space to work against + */ + public Node getNode() + { + return this.browseBean.getDocument(); + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return null; + } + + @Override + public Object getActionsContext() + { + return getNode(); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_MANAGE_CONTENT_USERS) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + browseBean.getDocument().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getContainerSubTitle() + { + String pattern = Application.getMessage(FacesContext.getCurrentInstance(), MSG_CONTENT_OWNER); + return MessageFormat.format(pattern, getOwner()); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } +} diff --git a/source/java/org/alfresco/web/bean/users/CreateUserWizard.java b/source/java/org/alfresco/web/bean/users/CreateUserWizard.java index 76f3b23824..5ab53f680e 100644 --- a/source/java/org/alfresco/web/bean/users/CreateUserWizard.java +++ b/source/java/org/alfresco/web/bean/users/CreateUserWizard.java @@ -1,982 +1,982 @@ -package org.alfresco.web.bean.users; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.ResourceBundle; -import java.util.regex.Pattern; - -import javax.faces.application.FacesMessage; -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.faces.validator.ValidatorException; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.security.person.PersonServiceImpl; -import org.alfresco.repo.tenant.TenantDomainMismatchException; -import org.alfresco.repo.tenant.TenantService; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.security.MutableAuthenticationService; -import org.alfresco.service.cmr.security.OwnableService; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.cmr.security.PersonService; -import org.alfresco.service.cmr.usage.ContentUsageService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.util.Pair; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.LoginBean; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.spaces.CreateSpaceWizard; -import org.alfresco.web.bean.wizard.BaseWizardBean; -import org.alfresco.web.config.ClientConfigElement; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.apache.commons.validator.routines.EmailValidator; - -/** - * @author Kevin Roast - */ -public class CreateUserWizard extends BaseWizardBean -{ - private static final long serialVersionUID = 8008464794715380019L; - - private static Log logger = LogFactory.getLog(BaseWizardBean.class); - protected static final String ERROR = "error_person"; - protected static final String ERROR_DOMAIN_MISMATCH = "error_domain_mismatch"; - - private static final String MSG_ERROR_NEWUSER_HOME_SPACE = "error_newuser_home_space"; - private static final String MSG_ERROR_MAIL_NOT_VALID = "email_format_is_not_valid"; - - protected static final String QUOTA_UNITS_KB = "kilobyte"; - protected static final String QUOTA_UNITS_MB = "megabyte"; - protected static final String QUOTA_UNITS_GB = "gigabyte"; - - /** form variables */ - protected String firstName = null; - protected String lastName = null; - protected String userName = null; - protected String password = null; - protected String confirm = null; - protected String email = null; - protected String companyId = null; - protected String homeSpaceName = ""; - protected NodeRef homeSpaceLocation = null; - protected String presenceProvider = null; - protected String presenceUsername = null; - protected String organisation = null; - protected String jobtitle = null; - protected String location = null; - - protected Long sizeQuota = null; // null is also equivalent to -1 (ie. no quota limit set) - protected String sizeQuotaUnits = null; - - /** AuthenticationService bean reference */ - transient private MutableAuthenticationService authenticationService; - - /** PersonService bean reference */ - transient private PersonService personService; - - /** TenantService bean reference */ - transient private TenantService tenantService; - - /** PermissionService bean reference */ - transient private PermissionService permissionService; - - /** OwnableService bean reference */ - transient private OwnableService ownableService; - - /** ContentUsageService bean reference */ - transient private ContentUsageService contentUsageService; - - /** ref to the company home space folder */ - private NodeRef companyHomeSpaceRef = null; - - /** ref to the default home location */ - private NodeRef defaultHomeSpaceRef; - - /** - * @param authenticationService The AuthenticationService to set. - */ - public void setAuthenticationService(MutableAuthenticationService authenticationService) - { - this.authenticationService = authenticationService; - } - - /** - * @return authenticationService - */ - private MutableAuthenticationService getAuthenticationService() - { - if (authenticationService == null) - { - authenticationService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthenticationService(); - } - return authenticationService; - } - - /** - * @param personService The person service. - */ - public void setPersonService(PersonService personService) - { - this.personService = personService; - } - - /** - * @return personService - */ - private PersonService getPersonService() - { - if (personService == null) - { - personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); - } - return personService; - } - - /** - * @param tenantService The tenantService to set. - */ - public void setTenantService(TenantService tenantService) - { - this.tenantService = tenantService; - } - - /** - * @return tenantService - */ - private TenantService getTenantService() - { - if(tenantService == null) - { - tenantService = (TenantService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "tenantService"); - } - return tenantService; - } - - /** - * @param permissionService The PermissionService to set. - */ - public void setPermissionService(PermissionService permissionService) - { - this.permissionService = permissionService; - } - - /** - * @return permissionService - */ - private PermissionService getPermissionService() - { - if (permissionService == null) - { - permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); - } - return permissionService; - } - - /** - * @param ownableService The ownableService to set. - */ - public void setOwnableService(OwnableService ownableService) - { - this.ownableService = ownableService; - } - - /** - * @return ownableService - */ - private OwnableService getOwnableService() - { - if (ownableService == null) - { - ownableService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getOwnableService(); - } - return ownableService; - } - - /** - * @param contentUsageService The contentUsageService to set. - */ - public void setContentUsageService(ContentUsageService contentUsageService) - { - this.contentUsageService = contentUsageService; - } - - /** - * @return contentUsageService - */ - private ContentUsageService getContentUsageService() - { - if (contentUsageService == null) - { - contentUsageService = (ContentUsageService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "ContentUsageService"); - } - return contentUsageService; - } - - /** - * Initialises the wizard - */ - @Override - public void init(Map params) - { - super.init(params); - - // reset all variables - this.firstName = ""; - this.lastName = ""; - this.userName = ""; - this.password = ""; - this.confirm = ""; - this.email = ""; - this.companyId = ""; - this.homeSpaceName = ""; - this.homeSpaceLocation = getDefaultHomeSpace(); - this.presenceProvider = ""; - this.presenceUsername = ""; - this.organisation = ""; - this.jobtitle = ""; - this.location = ""; - - this.sizeQuota = null; - this.sizeQuotaUnits = ""; - } - - /** - * @return Returns the summary data for the wizard. - */ - public String getSummary() - { - ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); - - String homeSpaceLabel = this.homeSpaceName; - if (this.homeSpaceName.length() == 0 && this.homeSpaceLocation != null) - { - homeSpaceLabel = Repository.getNameForNode(this.getNodeService(), this.homeSpaceLocation); - } - - String quotaLabel = ""; - if (this.sizeQuota != null && this.sizeQuota != -1L) - { - quotaLabel = Long.toString(this.sizeQuota) + bundle.getString(this.sizeQuotaUnits); - } - - String presenceLabel = ""; - if (this.presenceProvider != null && this.presenceProvider.length() != 0) - { - presenceLabel = this.presenceUsername + " (" + presenceProvider + ")"; - } - - return buildSummary( - new String[] { - bundle.getString("name"), bundle.getString("username"), - bundle.getString("password"), bundle.getString("homespace"), - bundle.getString("email"), bundle.getString("user_organization"), - bundle.getString("user_jobtitle"), bundle.getString("user_location"), - bundle.getString("presence_username"), bundle.getString("quota")}, - new String[] { - Utils.encode(this.firstName + " " + this.lastName), Utils.encode(this.userName), - "********", Utils.encode(homeSpaceLabel), - Utils.encode(this.email), Utils.encode(this.organisation), - Utils.encode(this.jobtitle), Utils.encode(this.location), - Utils.encode(presenceLabel), quotaLabel}); - } - - /** - * Init the users screen - */ - public void setupUsers(ActionEvent event) - { - invalidateUserList(); - } - - /** - * @return Returns the companyId. - */ - public String getCompanyId() - { - return this.companyId; - } - - /** - * @param companyId The companyId to set. - */ - public void setCompanyId(String companyId) - { - this.companyId = companyId; - } - - /** - * @return Returns the presenceProvider. - */ - public String getPresenceProvider() - { - return this.presenceProvider; - } - - /** - * @param presenceProvider - * The presenceProvider to set. - */ - public void setPresenceProvider(String presenceProvider) - { - this.presenceProvider = presenceProvider; - } - - /** - * @return Returns the presenceUsername. - */ - public String getPresenceUsername() - { - return this.presenceUsername; - } - - /** - * @param presenceUsername - * The presenceUsername to set. - */ - public void setPresenceUsername(String presenceUsername) - { - this.presenceUsername = presenceUsername; - } - - /** - * @return Returns the email. - */ - public String getEmail() - { - return this.email; - } - - /** - * @param email The email to set. - */ - public void setEmail(String email) - { - this.email = email; - } - - /** - * @return Returns the firstName. - */ - public String getFirstName() - { - return this.firstName; - } - - /** - * @param firstName The firstName to set. - */ - public void setFirstName(String firstName) - { - this.firstName = firstName; - } - - /** - * @return Returns the homeSpaceLocation. - */ - public NodeRef getHomeSpaceLocation() - { - return this.homeSpaceLocation; - } - - /** - * @param homeSpaceLocation The homeSpaceLocation to set. - */ - public void setHomeSpaceLocation(NodeRef homeSpaceLocation) - { - this.homeSpaceLocation = homeSpaceLocation; - } - - /** - * @return Returns the homeSpaceName. - */ - public String getHomeSpaceName() - { - return this.homeSpaceName; - } - - /** - * @param homeSpaceName The homeSpaceName to set. - */ - public void setHomeSpaceName(String homeSpaceName) - { - this.homeSpaceName = homeSpaceName; - } - - /** - * @return Returns the lastName. - */ - public String getLastName() - { - return this.lastName; - } - - /** - * @param lastName The lastName to set. - */ - public void setLastName(String lastName) - { - this.lastName = lastName; - } - - /** - * @return Returns the userName. - */ - public String getUserName() - { - return this.userName; - } - - /** - * @param userName The userName to set. - */ - public void setUserName(String userName) - { - this.userName = (userName != null ? userName.trim() : null); - } - - /** - * @return Returns the password. - */ - public String getPassword() - { - return this.password; - } - - /** - * @param password The password to set. - */ - public void setPassword(String password) - { - this.password = password; - } - - /** - * @return Returns the confirm password. - */ - public String getConfirm() - { - return this.confirm; - } - - /** - * @param confirm The confirm password to set. - */ - public void setConfirm(String confirm) - { - this.confirm = confirm; - } - - /** - * @return the jobtitle - */ - public String getJobtitle() - { - return this.jobtitle; - } - - /** - * @param jobtitle the jobtitle to set - */ - public void setJobtitle(String jobtitle) - { - this.jobtitle = jobtitle; - } - - /** - * @return the location - */ - public String getLocation() - { - return this.location; - } - - /** - * @param location the location to set - */ - public void setLocation(String location) - { - this.location = location; - } - - /** - * @return the organisation - */ - public String getOrganization() - { - return this.organisation; - } - - /** - * @param organisation the organisation to set - */ - public void setOrganization(String organisation) - { - this.organisation = organisation; - } - - public Long getSizeQuota() - { - return sizeQuota; - } - - public void setSizeQuota(Long sizeQuota) - { - this.sizeQuota = sizeQuota; - } - - public String getSizeQuotaUnits() - { - return sizeQuotaUnits; - } - - public void setSizeQuotaUnits(String sizeQuotaUnits) - { - this.sizeQuotaUnits = sizeQuotaUnits; - } - - // ------------------------------------------------------------------------------ - // Validator methods - - /** - * Validate password field data is acceptable - * - * @deprecated Method is never used - */ - public void validatePassword(FacesContext context, UIComponent component, Object value) throws ValidatorException - { - int minPasswordLength = Application.getClientConfig(context).getMinPasswordLength(); - int maxPasswordLength = Application.getClientConfig(context).getMaxPasswordLength(); - - String pass = (String)value; - if (pass.length() < minPasswordLength || pass.length() > maxPasswordLength) - { - String err = MessageFormat.format(Application.getMessage(context, LoginBean.MSG_PASSWORD_LENGTH), - new Object[]{minPasswordLength, maxPasswordLength}); - throw new ValidatorException(new FacesMessage(err)); - } - } - - /** - * Validate Username field data is acceptable - */ - public void validateUsername(FacesContext context, UIComponent component, Object value) throws ValidatorException - { - int minUsernameLength = Application.getClientConfig(context).getMinUsernameLength(); - - String name = ((String)value).trim(); - if (name.length() < minUsernameLength || name.length() > 256) - { - String err = MessageFormat.format(Application.getMessage(context, LoginBean.MSG_USERNAME_LENGTH), - new Object[]{minUsernameLength, 256}); - throw new ValidatorException(new FacesMessage(err)); - } - if (name.indexOf('"') != -1 || name.indexOf('\\') != -1) - { - String err = MessageFormat.format(Application.getMessage(context, LoginBean.MSG_USER_ERR), - new Object[]{"\", \\"}); - throw new ValidatorException(new FacesMessage(err)); - } - - try - { - name = PersonServiceImpl.updateUsernameForTenancy( - name, getTenantService() - ); - } - catch(TenantDomainMismatchException e) - { - String err = MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), - ERROR_DOMAIN_MISMATCH), e.getTenantA(), e.getTenantB()); - throw new ValidatorException(new FacesMessage(err)); - } - } - - /** - * Validate Email field data is acceptable - * - * @param context FacesContext - * @param component UIComponent - * @param value Object - * @throws ValidatorException - */ - public void validateEmail(FacesContext context, UIComponent component, Object value) throws ValidatorException - { - String emailRegExp = Application.getClientConfig(context).getEmailRegExp(); - Pattern pattern = Pattern.compile(emailRegExp, Pattern.CASE_INSENSITIVE); - if (!pattern.matcher((CharSequence) value).matches()) - { - String err = Application.getMessage(context, MSG_ERROR_MAIL_NOT_VALID); - throw new ValidatorException(new FacesMessage(err)); - } - } - - // ------------------------------------------------------------------------------ - // Helper methods - - /** - * Helper to return the company home space - * - * @return company home space NodeRef - */ - protected NodeRef getCompanyHomeSpace() - { - if (this.companyHomeSpaceRef == null) - { - String companyXPath = Application.getRootPath(FacesContext.getCurrentInstance()); - - NodeRef rootNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); - List nodes = this.getSearchService().selectNodes(rootNodeRef, companyXPath, null, this.getNamespaceService(), false); - - if (nodes.size() == 0) - { - throw new IllegalStateException("Unable to find company home space path: " + companyXPath); - } - - this.companyHomeSpaceRef = nodes.get(0); - } - - return this.companyHomeSpaceRef; - } - - protected NodeRef getDefaultHomeSpace() - { - if ((this.defaultHomeSpaceRef == null) || !getNodeService().exists(this.defaultHomeSpaceRef)) - { - String defaultHomeSpacePath = Application.getClientConfig(FacesContext.getCurrentInstance()).getDefaultHomeSpacePath(); - - NodeRef rootNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); - List nodes = this.getSearchService().selectNodes(rootNodeRef, defaultHomeSpacePath, null, this.getNamespaceService(), false); - - if (nodes.size() == 0) - { - return getCompanyHomeSpace(); - } - - this.defaultHomeSpaceRef = nodes.get(0); - } - - return this.defaultHomeSpaceRef; - } - - /** - * Create the specified home space if it does not exist, and return the ID - * - * @param locationId Parent location - * @param spaceName Home space to create, can be null to simply return the parent - * @param oldHomeFolderRef the previous home space, for the case where the the user is being updated. - * It may not have changed. - * @param error True to throw an error if the space already exists, else ignore and return - * @return ID of the home space - */ - protected NodeRef createHomeSpace(String locationId, String spaceName, NodeRef oldHomeFolderRef, boolean error) - { - NodeRef homeSpaceNodeRef = null; - if (spaceName != null && spaceName.length() != 0) - { - NodeRef parentRef = new NodeRef(Repository.getStoreRef(), locationId); - - // check for existence of home space with same name - return immediately - // if it exists or throw an exception an give user chance to enter another name - NodeRef childRef = this.getNodeService().getChildByName(parentRef, ContentModel.ASSOC_CONTAINS, spaceName); - if (childRef != null) - { - if (childRef.equals(oldHomeFolderRef)) - { - return oldHomeFolderRef; - } - if (error) - { - throw new AlfrescoRuntimeException("A Home Space with the same name already exists."); - } - else - { - return childRef; - } - } - - // space does not exist already, create a new Space under it with - // the specified name - String qname = QName.createValidLocalName(spaceName); - ChildAssociationRef assocRef = this.getNodeService().createNode(parentRef, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, qname), - ContentModel.TYPE_FOLDER); - - NodeRef nodeRef = assocRef.getChildRef(); - - // set the name property on the node - this.getNodeService().setProperty(nodeRef, ContentModel.PROP_NAME, spaceName); - - if (logger.isDebugEnabled()) - logger.debug("Created Home Space for with name: " + spaceName); - - // apply the uifacets aspect - icon, title and description props - Map uiFacetsProps = new HashMap(3); - uiFacetsProps.put(ApplicationModel.PROP_ICON, CreateSpaceWizard.DEFAULT_SPACE_ICON_NAME); - uiFacetsProps.put(ContentModel.PROP_TITLE, spaceName); - this.getNodeService().addAspect(nodeRef, ApplicationModel.ASPECT_UIFACETS, uiFacetsProps); - - setupHomeSpacePermissions(nodeRef); - - // return the ID of the created space - homeSpaceNodeRef = nodeRef; - } - - return homeSpaceNodeRef; - } - - /** - * Setup the default permissions for this and other users on the Home Space - * - * @param homeSpaceRef Home Space reference - */ - private void setupHomeSpacePermissions(NodeRef homeSpaceRef) - { - // Admin Authority has full permissions by default (automatic - set in the permission config) - // give full permissions to the new user - getPermissionService().setPermission(homeSpaceRef, this.userName, getPermissionService().getAllPermission(), true); - - // by default other users will only have GUEST access to the space contents - // or whatever is configured as the default in the web-client-xml config - String permission = getDefaultPermission(); - if (permission != null && permission.length() != 0) - { - getPermissionService().setPermission(homeSpaceRef, getPermissionService().getAllAuthorities(), permission, true); - } - - // the new user is the OWNER of their own space and always has full permissions - getOwnableService().setOwner(homeSpaceRef, this.userName); - getPermissionService().setPermission(homeSpaceRef, getPermissionService().getOwnerAuthority(), getPermissionService().getAllPermission(), true); - - // now detach (if we did this first we could not set any permissions!) - getPermissionService().setInheritParentPermissions(homeSpaceRef, false); - } - - /** - * @return default permission string to set for other users for a new Home Space - */ - private String getDefaultPermission() - { - ClientConfigElement config = Application.getClientConfig(FacesContext.getCurrentInstance()); - return config.getHomeSpacePermission(); - } - - private void invalidateUserList() - { - UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Throwable - { - // TODO: implement create new Person object from specified details - try - { - if (! this.password.equals(this.confirm)) - { - Utils.addErrorMessage(Application.getMessage(context, UsersDialog.ERROR_PASSWORD_MATCH)); - outcome = null; - } - - if (checkTenantUserName() == false) - { - outcome = null; - } - - if (outcome != null) - { - // create properties for Person type from submitted Form data - Map props = new HashMap(7, 1.0f); - setPersonPropertiesAndCreateHomeSpaceIfNeeded(props, null, context); - - // create the node to represent the Person - getPersonService().createPerson(props); - - // ensure the user can access their own Person object - // getPermissionService().setPermission(newPerson, this.userName, getPermissionService().getAllPermission(), true); - // Not required - now done by the person service. - - if (logger.isDebugEnabled()) - logger.debug("Created Person node for username: " + this.userName); - - // create the ACEGI Authentication instance for the new user - getAuthenticationService().createAuthentication(this.userName, this.password.toCharArray()); - - if (logger.isDebugEnabled()) - logger.debug("Created User Authentication instance for username: " + this.userName); - - if ((this.sizeQuota != null) && (this.sizeQuota < 0L)) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, UsersDialog.ERROR_NEGATIVE_QUOTA), this.sizeQuota)); - outcome = null; - } - else - { - putSizeQuotaProperty(this.userName, this.sizeQuota, this.sizeQuotaUnits); - } - } - invalidateUserList(); - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), ERROR), e.getMessage()), e); - outcome = null; - this.isFinished = false; - ReportedException.throwIfNecessary(e); - } - - if (outcome == null) - { - this.isFinished = false; - } - - return outcome; - } - - protected void setPersonPropertiesAndCreateHomeSpaceIfNeeded( - Map props, NodeRef oldHomeFolderRef, FacesContext context) - { - props.put(ContentModel.PROP_USERNAME, this.userName); - props.put(ContentModel.PROP_FIRSTNAME, this.firstName); - props.put(ContentModel.PROP_LASTNAME, this.lastName); - NodeRef homeSpaceNodeRef; - if (this.homeSpaceLocation != null && this.homeSpaceName.length() != 0) - { - // create new - props.put(ContentModel.PROP_HOME_FOLDER_PROVIDER, "userHomesHomeFolderProvider"); - homeSpaceNodeRef = createHomeSpace(this.homeSpaceLocation.getId(), this.homeSpaceName, oldHomeFolderRef, true); - } - else if (this.homeSpaceLocation != null) - { - // set to existing - first ensure it is NOT "User Homes" space! - if (this.defaultHomeSpaceRef.equals(this.homeSpaceLocation)) - { - throw new AlfrescoRuntimeException(Application.getMessage(context, MSG_ERROR_NEWUSER_HOME_SPACE)); - } - props.put(ContentModel.PROP_HOME_FOLDER_PROVIDER, "companyHomeFolderProvider"); // shared folder - homeSpaceNodeRef = this.homeSpaceLocation; - setupHomeSpacePermissions(homeSpaceNodeRef); - } - else - { - // default to Company Home - props.put(ContentModel.PROP_HOME_FOLDER_PROVIDER, "companyHomeFolderProvider"); // shared folder - homeSpaceNodeRef = getCompanyHomeSpace(); - } - - props.put(ContentModel.PROP_HOMEFOLDER, homeSpaceNodeRef); - props.put(ContentModel.PROP_EMAIL, this.email); - props.put(ContentModel.PROP_ORGID, this.companyId); - props.put(ContentModel.PROP_ORGANIZATION, this.organisation); - props.put(ContentModel.PROP_JOBTITLE, this.jobtitle); - props.put(ContentModel.PROP_LOCATION, this.location); - props.put(ContentModel.PROP_PRESENCEPROVIDER, this.presenceProvider); - props.put(ContentModel.PROP_PRESENCEUSERNAME, this.presenceUsername); - } - - @Override - public boolean getFinishButtonDisabled() - { - if (this.firstName != null && this.lastName != null && this.email != null && this.firstName.length() > 0 && this.lastName.length() > 0 && this.email.length() > 0) - { - return false; - } - return true; - } - - protected void putSizeQuotaProperty(String userName, Long quota, String quotaUnits) - { - if (quota != null) - { - if (quota >= 0L) - { - quota = convertToBytes(quota, quotaUnits); - } - else - { - // ignore negative quota - return; - } - } - - getContentUsageService().setUserQuota(userName, (quota == null ? -1 : quota)); - } - - protected long convertToBytes(long size, String units) - { - if (units != null) - { - if (units.equals(QUOTA_UNITS_KB)) - { - size = size * 1024L; - } - else if (units.equals(QUOTA_UNITS_MB)) - { - size = size * 1048576L; - } - else if (units.equals(QUOTA_UNITS_GB)) - { - size = size * 1073741824L; - } - } - return size; - } - - protected Pair convertFromBytes(long size) - { - String units = null; - if (size <= 0) - { - units = QUOTA_UNITS_GB; - } - else if (size < 999999) - { - size = (long)((double)size / 1024.0d); - units = QUOTA_UNITS_KB; - } - else if (size < 999999999) - { - size = (long)((double)size / 1048576.0d); - units = QUOTA_UNITS_MB; - } - else - { - size = (long)((double)size / 1073741824.0d); - units = QUOTA_UNITS_GB; - } - return new Pair(size, units); - } - - public boolean checkTenantUserName() - { - try - { - this.userName = PersonServiceImpl.updateUsernameForTenancy( - this.userName, getTenantService() - ); - return true; - } - catch(TenantDomainMismatchException e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), ERROR_DOMAIN_MISMATCH), e.getTenantA(), e.getTenantB())); - return false; - } - } - - public Map getPersonPropertiesImmutability() - { - return Collections.EMPTY_MAP; - } -} +package org.alfresco.web.bean.users; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.ResourceBundle; +import java.util.regex.Pattern; + +import javax.faces.application.FacesMessage; +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.faces.validator.ValidatorException; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.security.person.PersonServiceImpl; +import org.alfresco.repo.tenant.TenantDomainMismatchException; +import org.alfresco.repo.tenant.TenantService; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.security.MutableAuthenticationService; +import org.alfresco.service.cmr.security.OwnableService; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.cmr.security.PersonService; +import org.alfresco.service.cmr.usage.ContentUsageService; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.util.Pair; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.LoginBean; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.spaces.CreateSpaceWizard; +import org.alfresco.web.bean.wizard.BaseWizardBean; +import org.alfresco.web.config.ClientConfigElement; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.apache.commons.validator.routines.EmailValidator; + +/** + * @author Kevin Roast + */ +public class CreateUserWizard extends BaseWizardBean +{ + private static final long serialVersionUID = 8008464794715380019L; + + private static Log logger = LogFactory.getLog(BaseWizardBean.class); + protected static final String ERROR = "error_person"; + protected static final String ERROR_DOMAIN_MISMATCH = "error_domain_mismatch"; + + private static final String MSG_ERROR_NEWUSER_HOME_SPACE = "error_newuser_home_space"; + private static final String MSG_ERROR_MAIL_NOT_VALID = "email_format_is_not_valid"; + + protected static final String QUOTA_UNITS_KB = "kilobyte"; + protected static final String QUOTA_UNITS_MB = "megabyte"; + protected static final String QUOTA_UNITS_GB = "gigabyte"; + + /** form variables */ + protected String firstName = null; + protected String lastName = null; + protected String userName = null; + protected String password = null; + protected String confirm = null; + protected String email = null; + protected String companyId = null; + protected String homeSpaceName = ""; + protected NodeRef homeSpaceLocation = null; + protected String presenceProvider = null; + protected String presenceUsername = null; + protected String organisation = null; + protected String jobtitle = null; + protected String location = null; + + protected Long sizeQuota = null; // null is also equivalent to -1 (ie. no quota limit set) + protected String sizeQuotaUnits = null; + + /** AuthenticationService bean reference */ + transient private MutableAuthenticationService authenticationService; + + /** PersonService bean reference */ + transient private PersonService personService; + + /** TenantService bean reference */ + transient private TenantService tenantService; + + /** PermissionService bean reference */ + transient private PermissionService permissionService; + + /** OwnableService bean reference */ + transient private OwnableService ownableService; + + /** ContentUsageService bean reference */ + transient private ContentUsageService contentUsageService; + + /** ref to the company home space folder */ + private NodeRef companyHomeSpaceRef = null; + + /** ref to the default home location */ + private NodeRef defaultHomeSpaceRef; + + /** + * @param authenticationService The AuthenticationService to set. + */ + public void setAuthenticationService(MutableAuthenticationService authenticationService) + { + this.authenticationService = authenticationService; + } + + /** + * @return authenticationService + */ + private MutableAuthenticationService getAuthenticationService() + { + if (authenticationService == null) + { + authenticationService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthenticationService(); + } + return authenticationService; + } + + /** + * @param personService The person service. + */ + public void setPersonService(PersonService personService) + { + this.personService = personService; + } + + /** + * @return personService + */ + private PersonService getPersonService() + { + if (personService == null) + { + personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); + } + return personService; + } + + /** + * @param tenantService The tenantService to set. + */ + public void setTenantService(TenantService tenantService) + { + this.tenantService = tenantService; + } + + /** + * @return tenantService + */ + private TenantService getTenantService() + { + if(tenantService == null) + { + tenantService = (TenantService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "tenantService"); + } + return tenantService; + } + + /** + * @param permissionService The PermissionService to set. + */ + public void setPermissionService(PermissionService permissionService) + { + this.permissionService = permissionService; + } + + /** + * @return permissionService + */ + private PermissionService getPermissionService() + { + if (permissionService == null) + { + permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); + } + return permissionService; + } + + /** + * @param ownableService The ownableService to set. + */ + public void setOwnableService(OwnableService ownableService) + { + this.ownableService = ownableService; + } + + /** + * @return ownableService + */ + private OwnableService getOwnableService() + { + if (ownableService == null) + { + ownableService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getOwnableService(); + } + return ownableService; + } + + /** + * @param contentUsageService The contentUsageService to set. + */ + public void setContentUsageService(ContentUsageService contentUsageService) + { + this.contentUsageService = contentUsageService; + } + + /** + * @return contentUsageService + */ + private ContentUsageService getContentUsageService() + { + if (contentUsageService == null) + { + contentUsageService = (ContentUsageService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "ContentUsageService"); + } + return contentUsageService; + } + + /** + * Initialises the wizard + */ + @Override + public void init(Map params) + { + super.init(params); + + // reset all variables + this.firstName = ""; + this.lastName = ""; + this.userName = ""; + this.password = ""; + this.confirm = ""; + this.email = ""; + this.companyId = ""; + this.homeSpaceName = ""; + this.homeSpaceLocation = getDefaultHomeSpace(); + this.presenceProvider = ""; + this.presenceUsername = ""; + this.organisation = ""; + this.jobtitle = ""; + this.location = ""; + + this.sizeQuota = null; + this.sizeQuotaUnits = ""; + } + + /** + * @return Returns the summary data for the wizard. + */ + public String getSummary() + { + ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); + + String homeSpaceLabel = this.homeSpaceName; + if (this.homeSpaceName.length() == 0 && this.homeSpaceLocation != null) + { + homeSpaceLabel = Repository.getNameForNode(this.getNodeService(), this.homeSpaceLocation); + } + + String quotaLabel = ""; + if (this.sizeQuota != null && this.sizeQuota != -1L) + { + quotaLabel = Long.toString(this.sizeQuota) + bundle.getString(this.sizeQuotaUnits); + } + + String presenceLabel = ""; + if (this.presenceProvider != null && this.presenceProvider.length() != 0) + { + presenceLabel = this.presenceUsername + " (" + presenceProvider + ")"; + } + + return buildSummary( + new String[] { + bundle.getString("name"), bundle.getString("username"), + bundle.getString("password"), bundle.getString("homespace"), + bundle.getString("email"), bundle.getString("user_organization"), + bundle.getString("user_jobtitle"), bundle.getString("user_location"), + bundle.getString("presence_username"), bundle.getString("quota")}, + new String[] { + Utils.encode(this.firstName + " " + this.lastName), Utils.encode(this.userName), + "********", Utils.encode(homeSpaceLabel), + Utils.encode(this.email), Utils.encode(this.organisation), + Utils.encode(this.jobtitle), Utils.encode(this.location), + Utils.encode(presenceLabel), quotaLabel}); + } + + /** + * Init the users screen + */ + public void setupUsers(ActionEvent event) + { + invalidateUserList(); + } + + /** + * @return Returns the companyId. + */ + public String getCompanyId() + { + return this.companyId; + } + + /** + * @param companyId The companyId to set. + */ + public void setCompanyId(String companyId) + { + this.companyId = companyId; + } + + /** + * @return Returns the presenceProvider. + */ + public String getPresenceProvider() + { + return this.presenceProvider; + } + + /** + * @param presenceProvider + * The presenceProvider to set. + */ + public void setPresenceProvider(String presenceProvider) + { + this.presenceProvider = presenceProvider; + } + + /** + * @return Returns the presenceUsername. + */ + public String getPresenceUsername() + { + return this.presenceUsername; + } + + /** + * @param presenceUsername + * The presenceUsername to set. + */ + public void setPresenceUsername(String presenceUsername) + { + this.presenceUsername = presenceUsername; + } + + /** + * @return Returns the email. + */ + public String getEmail() + { + return this.email; + } + + /** + * @param email The email to set. + */ + public void setEmail(String email) + { + this.email = email; + } + + /** + * @return Returns the firstName. + */ + public String getFirstName() + { + return this.firstName; + } + + /** + * @param firstName The firstName to set. + */ + public void setFirstName(String firstName) + { + this.firstName = firstName; + } + + /** + * @return Returns the homeSpaceLocation. + */ + public NodeRef getHomeSpaceLocation() + { + return this.homeSpaceLocation; + } + + /** + * @param homeSpaceLocation The homeSpaceLocation to set. + */ + public void setHomeSpaceLocation(NodeRef homeSpaceLocation) + { + this.homeSpaceLocation = homeSpaceLocation; + } + + /** + * @return Returns the homeSpaceName. + */ + public String getHomeSpaceName() + { + return this.homeSpaceName; + } + + /** + * @param homeSpaceName The homeSpaceName to set. + */ + public void setHomeSpaceName(String homeSpaceName) + { + this.homeSpaceName = homeSpaceName; + } + + /** + * @return Returns the lastName. + */ + public String getLastName() + { + return this.lastName; + } + + /** + * @param lastName The lastName to set. + */ + public void setLastName(String lastName) + { + this.lastName = lastName; + } + + /** + * @return Returns the userName. + */ + public String getUserName() + { + return this.userName; + } + + /** + * @param userName The userName to set. + */ + public void setUserName(String userName) + { + this.userName = (userName != null ? userName.trim() : null); + } + + /** + * @return Returns the password. + */ + public String getPassword() + { + return this.password; + } + + /** + * @param password The password to set. + */ + public void setPassword(String password) + { + this.password = password; + } + + /** + * @return Returns the confirm password. + */ + public String getConfirm() + { + return this.confirm; + } + + /** + * @param confirm The confirm password to set. + */ + public void setConfirm(String confirm) + { + this.confirm = confirm; + } + + /** + * @return the jobtitle + */ + public String getJobtitle() + { + return this.jobtitle; + } + + /** + * @param jobtitle the jobtitle to set + */ + public void setJobtitle(String jobtitle) + { + this.jobtitle = jobtitle; + } + + /** + * @return the location + */ + public String getLocation() + { + return this.location; + } + + /** + * @param location the location to set + */ + public void setLocation(String location) + { + this.location = location; + } + + /** + * @return the organisation + */ + public String getOrganization() + { + return this.organisation; + } + + /** + * @param organisation the organisation to set + */ + public void setOrganization(String organisation) + { + this.organisation = organisation; + } + + public Long getSizeQuota() + { + return sizeQuota; + } + + public void setSizeQuota(Long sizeQuota) + { + this.sizeQuota = sizeQuota; + } + + public String getSizeQuotaUnits() + { + return sizeQuotaUnits; + } + + public void setSizeQuotaUnits(String sizeQuotaUnits) + { + this.sizeQuotaUnits = sizeQuotaUnits; + } + + // ------------------------------------------------------------------------------ + // Validator methods + + /** + * Validate password field data is acceptable + * + * @deprecated Method is never used + */ + public void validatePassword(FacesContext context, UIComponent component, Object value) throws ValidatorException + { + int minPasswordLength = Application.getClientConfig(context).getMinPasswordLength(); + int maxPasswordLength = Application.getClientConfig(context).getMaxPasswordLength(); + + String pass = (String)value; + if (pass.length() < minPasswordLength || pass.length() > maxPasswordLength) + { + String err = MessageFormat.format(Application.getMessage(context, LoginBean.MSG_PASSWORD_LENGTH), + new Object[]{minPasswordLength, maxPasswordLength}); + throw new ValidatorException(new FacesMessage(err)); + } + } + + /** + * Validate Username field data is acceptable + */ + public void validateUsername(FacesContext context, UIComponent component, Object value) throws ValidatorException + { + int minUsernameLength = Application.getClientConfig(context).getMinUsernameLength(); + + String name = ((String)value).trim(); + if (name.length() < minUsernameLength || name.length() > 256) + { + String err = MessageFormat.format(Application.getMessage(context, LoginBean.MSG_USERNAME_LENGTH), + new Object[]{minUsernameLength, 256}); + throw new ValidatorException(new FacesMessage(err)); + } + if (name.indexOf('"') != -1 || name.indexOf('\\') != -1) + { + String err = MessageFormat.format(Application.getMessage(context, LoginBean.MSG_USER_ERR), + new Object[]{"\", \\"}); + throw new ValidatorException(new FacesMessage(err)); + } + + try + { + name = PersonServiceImpl.updateUsernameForTenancy( + name, getTenantService() + ); + } + catch(TenantDomainMismatchException e) + { + String err = MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), + ERROR_DOMAIN_MISMATCH), e.getTenantA(), e.getTenantB()); + throw new ValidatorException(new FacesMessage(err)); + } + } + + /** + * Validate Email field data is acceptable + * + * @param context FacesContext + * @param component UIComponent + * @param value Object + * @throws ValidatorException + */ + public void validateEmail(FacesContext context, UIComponent component, Object value) throws ValidatorException + { + String emailRegExp = Application.getClientConfig(context).getEmailRegExp(); + Pattern pattern = Pattern.compile(emailRegExp, Pattern.CASE_INSENSITIVE); + if (!pattern.matcher((CharSequence) value).matches()) + { + String err = Application.getMessage(context, MSG_ERROR_MAIL_NOT_VALID); + throw new ValidatorException(new FacesMessage(err)); + } + } + + // ------------------------------------------------------------------------------ + // Helper methods + + /** + * Helper to return the company home space + * + * @return company home space NodeRef + */ + protected NodeRef getCompanyHomeSpace() + { + if (this.companyHomeSpaceRef == null) + { + String companyXPath = Application.getRootPath(FacesContext.getCurrentInstance()); + + NodeRef rootNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); + List nodes = this.getSearchService().selectNodes(rootNodeRef, companyXPath, null, this.getNamespaceService(), false); + + if (nodes.size() == 0) + { + throw new IllegalStateException("Unable to find company home space path: " + companyXPath); + } + + this.companyHomeSpaceRef = nodes.get(0); + } + + return this.companyHomeSpaceRef; + } + + protected NodeRef getDefaultHomeSpace() + { + if ((this.defaultHomeSpaceRef == null) || !getNodeService().exists(this.defaultHomeSpaceRef)) + { + String defaultHomeSpacePath = Application.getClientConfig(FacesContext.getCurrentInstance()).getDefaultHomeSpacePath(); + + NodeRef rootNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef()); + List nodes = this.getSearchService().selectNodes(rootNodeRef, defaultHomeSpacePath, null, this.getNamespaceService(), false); + + if (nodes.size() == 0) + { + return getCompanyHomeSpace(); + } + + this.defaultHomeSpaceRef = nodes.get(0); + } + + return this.defaultHomeSpaceRef; + } + + /** + * Create the specified home space if it does not exist, and return the ID + * + * @param locationId Parent location + * @param spaceName Home space to create, can be null to simply return the parent + * @param oldHomeFolderRef the previous home space, for the case where the the user is being updated. + * It may not have changed. + * @param error True to throw an error if the space already exists, else ignore and return + * @return ID of the home space + */ + protected NodeRef createHomeSpace(String locationId, String spaceName, NodeRef oldHomeFolderRef, boolean error) + { + NodeRef homeSpaceNodeRef = null; + if (spaceName != null && spaceName.length() != 0) + { + NodeRef parentRef = new NodeRef(Repository.getStoreRef(), locationId); + + // check for existence of home space with same name - return immediately + // if it exists or throw an exception an give user chance to enter another name + NodeRef childRef = this.getNodeService().getChildByName(parentRef, ContentModel.ASSOC_CONTAINS, spaceName); + if (childRef != null) + { + if (childRef.equals(oldHomeFolderRef)) + { + return oldHomeFolderRef; + } + if (error) + { + throw new AlfrescoRuntimeException("A Home Space with the same name already exists."); + } + else + { + return childRef; + } + } + + // space does not exist already, create a new Space under it with + // the specified name + String qname = QName.createValidLocalName(spaceName); + ChildAssociationRef assocRef = this.getNodeService().createNode(parentRef, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, qname), + ContentModel.TYPE_FOLDER); + + NodeRef nodeRef = assocRef.getChildRef(); + + // set the name property on the node + this.getNodeService().setProperty(nodeRef, ContentModel.PROP_NAME, spaceName); + + if (logger.isDebugEnabled()) + logger.debug("Created Home Space for with name: " + spaceName); + + // apply the uifacets aspect - icon, title and description props + Map uiFacetsProps = new HashMap(3); + uiFacetsProps.put(ApplicationModel.PROP_ICON, CreateSpaceWizard.DEFAULT_SPACE_ICON_NAME); + uiFacetsProps.put(ContentModel.PROP_TITLE, spaceName); + this.getNodeService().addAspect(nodeRef, ApplicationModel.ASPECT_UIFACETS, uiFacetsProps); + + setupHomeSpacePermissions(nodeRef); + + // return the ID of the created space + homeSpaceNodeRef = nodeRef; + } + + return homeSpaceNodeRef; + } + + /** + * Setup the default permissions for this and other users on the Home Space + * + * @param homeSpaceRef Home Space reference + */ + private void setupHomeSpacePermissions(NodeRef homeSpaceRef) + { + // Admin Authority has full permissions by default (automatic - set in the permission config) + // give full permissions to the new user + getPermissionService().setPermission(homeSpaceRef, this.userName, getPermissionService().getAllPermission(), true); + + // by default other users will only have GUEST access to the space contents + // or whatever is configured as the default in the web-client-xml config + String permission = getDefaultPermission(); + if (permission != null && permission.length() != 0) + { + getPermissionService().setPermission(homeSpaceRef, getPermissionService().getAllAuthorities(), permission, true); + } + + // the new user is the OWNER of their own space and always has full permissions + getOwnableService().setOwner(homeSpaceRef, this.userName); + getPermissionService().setPermission(homeSpaceRef, getPermissionService().getOwnerAuthority(), getPermissionService().getAllPermission(), true); + + // now detach (if we did this first we could not set any permissions!) + getPermissionService().setInheritParentPermissions(homeSpaceRef, false); + } + + /** + * @return default permission string to set for other users for a new Home Space + */ + private String getDefaultPermission() + { + ClientConfigElement config = Application.getClientConfig(FacesContext.getCurrentInstance()); + return config.getHomeSpacePermission(); + } + + private void invalidateUserList() + { + UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Throwable + { + // TODO: implement create new Person object from specified details + try + { + if (! this.password.equals(this.confirm)) + { + Utils.addErrorMessage(Application.getMessage(context, UsersDialog.ERROR_PASSWORD_MATCH)); + outcome = null; + } + + if (checkTenantUserName() == false) + { + outcome = null; + } + + if (outcome != null) + { + // create properties for Person type from submitted Form data + Map props = new HashMap(7, 1.0f); + setPersonPropertiesAndCreateHomeSpaceIfNeeded(props, null, context); + + // create the node to represent the Person + getPersonService().createPerson(props); + + // ensure the user can access their own Person object + // getPermissionService().setPermission(newPerson, this.userName, getPermissionService().getAllPermission(), true); + // Not required - now done by the person service. + + if (logger.isDebugEnabled()) + logger.debug("Created Person node for username: " + this.userName); + + // create the ACEGI Authentication instance for the new user + getAuthenticationService().createAuthentication(this.userName, this.password.toCharArray()); + + if (logger.isDebugEnabled()) + logger.debug("Created User Authentication instance for username: " + this.userName); + + if ((this.sizeQuota != null) && (this.sizeQuota < 0L)) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, UsersDialog.ERROR_NEGATIVE_QUOTA), this.sizeQuota)); + outcome = null; + } + else + { + putSizeQuotaProperty(this.userName, this.sizeQuota, this.sizeQuotaUnits); + } + } + invalidateUserList(); + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), ERROR), e.getMessage()), e); + outcome = null; + this.isFinished = false; + ReportedException.throwIfNecessary(e); + } + + if (outcome == null) + { + this.isFinished = false; + } + + return outcome; + } + + protected void setPersonPropertiesAndCreateHomeSpaceIfNeeded( + Map props, NodeRef oldHomeFolderRef, FacesContext context) + { + props.put(ContentModel.PROP_USERNAME, this.userName); + props.put(ContentModel.PROP_FIRSTNAME, this.firstName); + props.put(ContentModel.PROP_LASTNAME, this.lastName); + NodeRef homeSpaceNodeRef; + if (this.homeSpaceLocation != null && this.homeSpaceName.length() != 0) + { + // create new + props.put(ContentModel.PROP_HOME_FOLDER_PROVIDER, "userHomesHomeFolderProvider"); + homeSpaceNodeRef = createHomeSpace(this.homeSpaceLocation.getId(), this.homeSpaceName, oldHomeFolderRef, true); + } + else if (this.homeSpaceLocation != null) + { + // set to existing - first ensure it is NOT "User Homes" space! + if (this.defaultHomeSpaceRef.equals(this.homeSpaceLocation)) + { + throw new AlfrescoRuntimeException(Application.getMessage(context, MSG_ERROR_NEWUSER_HOME_SPACE)); + } + props.put(ContentModel.PROP_HOME_FOLDER_PROVIDER, "companyHomeFolderProvider"); // shared folder + homeSpaceNodeRef = this.homeSpaceLocation; + setupHomeSpacePermissions(homeSpaceNodeRef); + } + else + { + // default to Company Home + props.put(ContentModel.PROP_HOME_FOLDER_PROVIDER, "companyHomeFolderProvider"); // shared folder + homeSpaceNodeRef = getCompanyHomeSpace(); + } + + props.put(ContentModel.PROP_HOMEFOLDER, homeSpaceNodeRef); + props.put(ContentModel.PROP_EMAIL, this.email); + props.put(ContentModel.PROP_ORGID, this.companyId); + props.put(ContentModel.PROP_ORGANIZATION, this.organisation); + props.put(ContentModel.PROP_JOBTITLE, this.jobtitle); + props.put(ContentModel.PROP_LOCATION, this.location); + props.put(ContentModel.PROP_PRESENCEPROVIDER, this.presenceProvider); + props.put(ContentModel.PROP_PRESENCEUSERNAME, this.presenceUsername); + } + + @Override + public boolean getFinishButtonDisabled() + { + if (this.firstName != null && this.lastName != null && this.email != null && this.firstName.length() > 0 && this.lastName.length() > 0 && this.email.length() > 0) + { + return false; + } + return true; + } + + protected void putSizeQuotaProperty(String userName, Long quota, String quotaUnits) + { + if (quota != null) + { + if (quota >= 0L) + { + quota = convertToBytes(quota, quotaUnits); + } + else + { + // ignore negative quota + return; + } + } + + getContentUsageService().setUserQuota(userName, (quota == null ? -1 : quota)); + } + + protected long convertToBytes(long size, String units) + { + if (units != null) + { + if (units.equals(QUOTA_UNITS_KB)) + { + size = size * 1024L; + } + else if (units.equals(QUOTA_UNITS_MB)) + { + size = size * 1048576L; + } + else if (units.equals(QUOTA_UNITS_GB)) + { + size = size * 1073741824L; + } + } + return size; + } + + protected Pair convertFromBytes(long size) + { + String units = null; + if (size <= 0) + { + units = QUOTA_UNITS_GB; + } + else if (size < 999999) + { + size = (long)((double)size / 1024.0d); + units = QUOTA_UNITS_KB; + } + else if (size < 999999999) + { + size = (long)((double)size / 1048576.0d); + units = QUOTA_UNITS_MB; + } + else + { + size = (long)((double)size / 1073741824.0d); + units = QUOTA_UNITS_GB; + } + return new Pair(size, units); + } + + public boolean checkTenantUserName() + { + try + { + this.userName = PersonServiceImpl.updateUsernameForTenancy( + this.userName, getTenantService() + ); + return true; + } + catch(TenantDomainMismatchException e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), ERROR_DOMAIN_MISMATCH), e.getTenantA(), e.getTenantB())); + return false; + } + } + + public Map getPersonPropertiesImmutability() + { + return Collections.EMPTY_MAP; + } +} diff --git a/source/java/org/alfresco/web/bean/users/DeleteUserDialog.java b/source/java/org/alfresco/web/bean/users/DeleteUserDialog.java index fb9d75cd6e..b2197b4a00 100644 --- a/source/java/org/alfresco/web/bean/users/DeleteUserDialog.java +++ b/source/java/org/alfresco/web/bean/users/DeleteUserDialog.java @@ -1,279 +1,279 @@ -package org.alfresco.web.bean.users; - -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ContentModel; -import org.alfresco.query.PagingRequest; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.security.AuthenticationService; -import org.alfresco.service.cmr.security.PersonService; -import org.alfresco.service.cmr.security.PersonService.PersonInfo; -import org.alfresco.service.namespace.QName; -import org.alfresco.util.ISO9075; -import org.alfresco.util.Pair; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.MapNode; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -public class DeleteUserDialog extends BaseDialogBean -{ - - private static final long serialVersionUID = -4977064287365766306L; - - private static Log logger = LogFactory.getLog(DeleteUserDialog.class); - - private static final String ERROR_DELETE = "error_delete_user"; - - private static final String BUTTON_YES = "yes"; - - private static final String MSG_TITLE_DELETE_USER = "title_delete_user"; - - private static final String BUTTON_NO = "no"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - transient private AuthenticationService authenticationService; - - private List users = Collections. emptyList(); - - transient private PersonService personService; - - private Node person = null; - - private String searchCriteria = null; - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - try - { - String userName = (String) getPerson().getProperties().get("userName"); - - // delete the associated Person - getPersonService().deletePerson(userName); - - // re-do the search to refresh the list - search(); - } - catch (Throwable e) - { - // rollback the transaction - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, ERROR_DELETE), e.getMessage()), e); - ReportedException.throwIfNecessary(e); - } - - return outcome; - } - - public String search() - { - - if (this.searchCriteria == null || this.searchCriteria.length() == 0) - { - this.users = Collections. emptyList(); - } - else - { - FacesContext context = FacesContext.getCurrentInstance(); - UserTransaction tx = null; - - try - { - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - // define the query to find people by their first or last name - String search = ISO9075.encode(this.searchCriteria); - List> filter = Utils.generatePersonFilter(search); - - if (logger.isDebugEnabled()) - { - logger.debug("Query filter: " + filter); - } - - List persons = getPersonService().getPeople( - filter, - true, - Utils.generatePersonSort(), - new PagingRequest(Utils.getPersonMaxResults(), null) - ).getPage(); - - if (logger.isDebugEnabled()) - { - logger.debug("Found " + persons.size() + " users"); - } - - this.users = new ArrayList(persons.size()); - - for (PersonInfo person : persons) - { - // create our Node representation - MapNode node = new MapNode(person.getNodeRef()); - - // set data binding properties - // this will also force initialisation of the props now during the UserTransaction - // it is much better for performance to do this now rather than during page bind - Map props = node.getProperties(); - props.put("fullName", ((String) props.get("firstName")) + ' ' + ((String) props.get("lastName"))); - NodeRef homeFolderNodeRef = (NodeRef) props.get("homeFolder"); - if (homeFolderNodeRef != null) - { - props.put("homeSpace", homeFolderNodeRef); - } - - this.users.add(node); - } - - // commit the transaction - tx.commit(); - } - catch (InvalidNodeRefException refErr) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_NODEREF), new Object[] { "root" })); - this.users = Collections. emptyList(); - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception tex) - { - } - } - catch (Exception err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); - this.users = Collections. emptyList(); - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception tex) - { - } - } - } - - // return null to stay on the same page - return null; - } - - public void setupUserAction(ActionEvent event) - { - UIActionLink link = (UIActionLink) event.getComponent(); - Map params = link.getParameterMap(); - String id = params.get("id"); - if (id != null && id.length() != 0) - { - if (logger.isDebugEnabled()) - logger.debug("Setup for action, setting current Person to: " + id); - - try - { - // create the node ref, then our node representation - NodeRef ref = new NodeRef(Repository.getStoreRef(), id); - Node node = new Node(ref); - - // remember the Person node - setPerson(node); - } - catch (InvalidNodeRefException refErr) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] { id })); - } - } - else - { - setPerson(null); - } - } - - /** - *@return authenticationService - */ - public AuthenticationService getAuthenticationService() - { - //check for null for cluster environment - if (authenticationService == null) - { - authenticationService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthenticationService(); - } - return authenticationService; - } - - public void setAuthenticationService(AuthenticationService authenticationService) - { - this.authenticationService = authenticationService; - } - - public PersonService getPersonService() - { - if (personService == null) - { - personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); - } - return personService; - } - - public void setPersonService(PersonService personService) - { - this.personService = personService; - } - - public Node getPerson() - { - return person; - } - - public void setPerson(Node person) - { - this.person = person; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_NO); - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_YES); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_TITLE_DELETE_USER) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + getPerson().getProperties().get("userName") + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } -} +package org.alfresco.web.bean.users; + +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ContentModel; +import org.alfresco.query.PagingRequest; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.security.AuthenticationService; +import org.alfresco.service.cmr.security.PersonService; +import org.alfresco.service.cmr.security.PersonService.PersonInfo; +import org.alfresco.service.namespace.QName; +import org.alfresco.util.ISO9075; +import org.alfresco.util.Pair; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.MapNode; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class DeleteUserDialog extends BaseDialogBean +{ + + private static final long serialVersionUID = -4977064287365766306L; + + private static Log logger = LogFactory.getLog(DeleteUserDialog.class); + + private static final String ERROR_DELETE = "error_delete_user"; + + private static final String BUTTON_YES = "yes"; + + private static final String MSG_TITLE_DELETE_USER = "title_delete_user"; + + private static final String BUTTON_NO = "no"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + transient private AuthenticationService authenticationService; + + private List users = Collections. emptyList(); + + transient private PersonService personService; + + private Node person = null; + + private String searchCriteria = null; + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + try + { + String userName = (String) getPerson().getProperties().get("userName"); + + // delete the associated Person + getPersonService().deletePerson(userName); + + // re-do the search to refresh the list + search(); + } + catch (Throwable e) + { + // rollback the transaction + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, ERROR_DELETE), e.getMessage()), e); + ReportedException.throwIfNecessary(e); + } + + return outcome; + } + + public String search() + { + + if (this.searchCriteria == null || this.searchCriteria.length() == 0) + { + this.users = Collections. emptyList(); + } + else + { + FacesContext context = FacesContext.getCurrentInstance(); + UserTransaction tx = null; + + try + { + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + // define the query to find people by their first or last name + String search = ISO9075.encode(this.searchCriteria); + List> filter = Utils.generatePersonFilter(search); + + if (logger.isDebugEnabled()) + { + logger.debug("Query filter: " + filter); + } + + List persons = getPersonService().getPeople( + filter, + true, + Utils.generatePersonSort(), + new PagingRequest(Utils.getPersonMaxResults(), null) + ).getPage(); + + if (logger.isDebugEnabled()) + { + logger.debug("Found " + persons.size() + " users"); + } + + this.users = new ArrayList(persons.size()); + + for (PersonInfo person : persons) + { + // create our Node representation + MapNode node = new MapNode(person.getNodeRef()); + + // set data binding properties + // this will also force initialisation of the props now during the UserTransaction + // it is much better for performance to do this now rather than during page bind + Map props = node.getProperties(); + props.put("fullName", ((String) props.get("firstName")) + ' ' + ((String) props.get("lastName"))); + NodeRef homeFolderNodeRef = (NodeRef) props.get("homeFolder"); + if (homeFolderNodeRef != null) + { + props.put("homeSpace", homeFolderNodeRef); + } + + this.users.add(node); + } + + // commit the transaction + tx.commit(); + } + catch (InvalidNodeRefException refErr) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_NODEREF), new Object[] { "root" })); + this.users = Collections. emptyList(); + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception tex) + { + } + } + catch (Exception err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); + this.users = Collections. emptyList(); + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception tex) + { + } + } + } + + // return null to stay on the same page + return null; + } + + public void setupUserAction(ActionEvent event) + { + UIActionLink link = (UIActionLink) event.getComponent(); + Map params = link.getParameterMap(); + String id = params.get("id"); + if (id != null && id.length() != 0) + { + if (logger.isDebugEnabled()) + logger.debug("Setup for action, setting current Person to: " + id); + + try + { + // create the node ref, then our node representation + NodeRef ref = new NodeRef(Repository.getStoreRef(), id); + Node node = new Node(ref); + + // remember the Person node + setPerson(node); + } + catch (InvalidNodeRefException refErr) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] { id })); + } + } + else + { + setPerson(null); + } + } + + /** + *@return authenticationService + */ + public AuthenticationService getAuthenticationService() + { + //check for null for cluster environment + if (authenticationService == null) + { + authenticationService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthenticationService(); + } + return authenticationService; + } + + public void setAuthenticationService(AuthenticationService authenticationService) + { + this.authenticationService = authenticationService; + } + + public PersonService getPersonService() + { + if (personService == null) + { + personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); + } + return personService; + } + + public void setPersonService(PersonService personService) + { + this.personService = personService; + } + + public Node getPerson() + { + return person; + } + + public void setPerson(Node person) + { + this.person = person; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_NO); + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_YES); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_TITLE_DELETE_USER) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + getPerson().getProperties().get("userName") + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } +} diff --git a/source/java/org/alfresco/web/bean/users/EditContentUserRolesDialog.java b/source/java/org/alfresco/web/bean/users/EditContentUserRolesDialog.java index 159ede5cbc..a81c7c9c85 100644 --- a/source/java/org/alfresco/web/bean/users/EditContentUserRolesDialog.java +++ b/source/java/org/alfresco/web/bean/users/EditContentUserRolesDialog.java @@ -1,57 +1,57 @@ -package org.alfresco.web.bean.users; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.faces.model.DataModel; - -import org.alfresco.web.bean.dialog.BaseDialogBean; - -public class EditContentUserRolesDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -1690749440382024258L; - - ContentUsersBean contentUsersBean; - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - public ContentUsersBean getContentUsersBean() - { - return contentUsersBean; - } - - public void setContentUsersBean(ContentUsersBean contentUsersBean) - { - this.contentUsersBean = contentUsersBean; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - contentUsersBean.finishOK(); - return outcome; - } - - public void addRole(ActionEvent event) - { - contentUsersBean.addRole(event); - } - - public void setupUserAction(ActionEvent event) - { - contentUsersBean.setupUserAction(event); - } - - public void removeRole(ActionEvent event) - { - contentUsersBean.removeRole(event); - } - - public DataModel getPersonRolesDataModel() - { - return contentUsersBean.getPersonRolesDataModel(); - } - -} +package org.alfresco.web.bean.users; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.faces.model.DataModel; + +import org.alfresco.web.bean.dialog.BaseDialogBean; + +public class EditContentUserRolesDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -1690749440382024258L; + + ContentUsersBean contentUsersBean; + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + public ContentUsersBean getContentUsersBean() + { + return contentUsersBean; + } + + public void setContentUsersBean(ContentUsersBean contentUsersBean) + { + this.contentUsersBean = contentUsersBean; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + contentUsersBean.finishOK(); + return outcome; + } + + public void addRole(ActionEvent event) + { + contentUsersBean.addRole(event); + } + + public void setupUserAction(ActionEvent event) + { + contentUsersBean.setupUserAction(event); + } + + public void removeRole(ActionEvent event) + { + contentUsersBean.removeRole(event); + } + + public DataModel getPersonRolesDataModel() + { + return contentUsersBean.getPersonRolesDataModel(); + } + +} diff --git a/source/java/org/alfresco/web/bean/users/EditFileDialog.java b/source/java/org/alfresco/web/bean/users/EditFileDialog.java index d2e352e761..9b7f3ab291 100644 --- a/source/java/org/alfresco/web/bean/users/EditFileDialog.java +++ b/source/java/org/alfresco/web/bean/users/EditFileDialog.java @@ -1,19 +1,19 @@ -package org.alfresco.web.bean.users; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.bean.dialog.BaseDialogBean; - -public class EditFileDialog extends BaseDialogBean -{ - - private static final long serialVersionUID = -4237199472024493269L; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // TODO Auto-generated method stub - return null; - } - -} +package org.alfresco.web.bean.users; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.bean.dialog.BaseDialogBean; + +public class EditFileDialog extends BaseDialogBean +{ + + private static final long serialVersionUID = -4237199472024493269L; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // TODO Auto-generated method stub + return null; + } + +} diff --git a/source/java/org/alfresco/web/bean/users/EditUserDetailsDialog.java b/source/java/org/alfresco/web/bean/users/EditUserDetailsDialog.java index e7796f2ea3..d9616ad7fb 100644 --- a/source/java/org/alfresco/web/bean/users/EditUserDetailsDialog.java +++ b/source/java/org/alfresco/web/bean/users/EditUserDetailsDialog.java @@ -1,193 +1,193 @@ -package org.alfresco.web.bean.users; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.repository.AssociationRef; -import org.alfresco.service.cmr.repository.ContentReader; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.ContentWriter; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; - -/** - * @author YanO - * - */ -public class EditUserDetailsDialog extends BaseDialogBean -{ - private static final long serialVersionUID = 8663254425262484L; - - private Node person; - protected UsersBeanProperties properties; - private NodeRef photoRef; - private String personDescription; - - /** - * @param properties the properties to set - */ - public void setProperties(UsersBeanProperties properties) - { - this.properties = properties; - } - - @Override - public void init(Map parameters) - { - super.init(parameters); - this.person = this.properties.getPerson(); - this.photoRef = null; - this.personDescription = null; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - try - { - ServiceRegistry services = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); - DictionaryService dd = services.getDictionaryService(); - Map props = getNodeService().getProperties(getPerson().getNodeRef()); - for (String key : getPerson().getProperties().keySet()) - { - QName propQName = QName.createQName(key); - if (dd.getProperty(propQName) == null || dd.getProperty(propQName).isProtected() == false) - { - props.put(propQName, (Serializable)getPerson().getProperties().get(key)); - } - } - - // persist all property changes - NodeRef personRef = getPerson().getNodeRef(); - this.getNodeService().setProperties(personRef, props); - - // save person description content field - if (this.personDescription != null) - { - ContentService cs = services.getContentService(); - ContentWriter writer = cs.getWriter(personRef, ContentModel.PROP_PERSONDESC, true); - writer.setMimetype(MimetypeMap.MIMETYPE_HTML); - writer.putContent(this.personDescription); - } - - // setup user avatar association - if (this.photoRef != null) - { - List refs = this.getNodeService().getTargetAssocs(personRef, ContentModel.ASSOC_AVATAR); - // remove old association if it exists - if (refs.size() == 1) - { - NodeRef existingRef = refs.get(0).getTargetRef(); - this.getNodeService().removeAssociation( - personRef, existingRef, ContentModel.ASSOC_AVATAR); - } - // setup new association - this.getNodeService().createAssociation(personRef, this.photoRef, ContentModel.ASSOC_AVATAR); - } - - // if the above calls were successful, then reset Person Node in the session - Application.getCurrentUser(context).reset(); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); - outcome = null; - ReportedException.throwIfNecessary(err); - } - return outcome; - } - - public Node getPerson() - { - return person; - } - - public String getEmail() - { - Object value = person.getProperties().get(ContentModel.PROP_EMAIL); - return value == null ? null : value.toString(); - } - - public void setEmail(String email) - { - person.getProperties().put(ContentModel.PROP_EMAIL.toString(), email); - } - - public String getFirstName() - { - Object value = person.getProperties().get(ContentModel.PROP_FIRSTNAME); - return value == null ? null : value.toString(); - } - - public void setFirstName(String firstName) - { - person.getProperties().put(ContentModel.PROP_FIRSTNAME.toString(), firstName); - } - - public String getLastName() - { - Object value = person.getProperties().get(ContentModel.PROP_LASTNAME); - return value == null ? null : value.toString(); - } - - public String getPersonDescription() - { - if (personDescription == null) - { - ContentService cs = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); - ContentReader reader = cs.getReader(this.person.getNodeRef(), ContentModel.PROP_PERSONDESC); - if (reader != null && reader.exists()) - { - personDescription = reader.getContentString(); - } - } - return personDescription; - } - - public void setPersonDescription(String s) - { - this.personDescription = s; - } - - public void setLastName(String lastName) - { - person.getProperties().put(ContentModel.PROP_LASTNAME.toString(), lastName); - } - - public Map getPersonProperties() - { - return person.getProperties(); - } - - public NodeRef getPersonPhotoRef() - { - if (this.photoRef == null) - { - List refs = this.getNodeService().getTargetAssocs(person.getNodeRef(), ContentModel.ASSOC_AVATAR); - if (refs.size() == 1) - { - this.photoRef = refs.get(0).getTargetRef(); - } - } - return this.photoRef; - } - - public void setPersonPhotoRef(NodeRef ref) - { - this.photoRef = ref; - } -} +package org.alfresco.web.bean.users; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.repository.AssociationRef; +import org.alfresco.service.cmr.repository.ContentReader; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.ContentWriter; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; + +/** + * @author YanO + * + */ +public class EditUserDetailsDialog extends BaseDialogBean +{ + private static final long serialVersionUID = 8663254425262484L; + + private Node person; + protected UsersBeanProperties properties; + private NodeRef photoRef; + private String personDescription; + + /** + * @param properties the properties to set + */ + public void setProperties(UsersBeanProperties properties) + { + this.properties = properties; + } + + @Override + public void init(Map parameters) + { + super.init(parameters); + this.person = this.properties.getPerson(); + this.photoRef = null; + this.personDescription = null; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + try + { + ServiceRegistry services = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); + DictionaryService dd = services.getDictionaryService(); + Map props = getNodeService().getProperties(getPerson().getNodeRef()); + for (String key : getPerson().getProperties().keySet()) + { + QName propQName = QName.createQName(key); + if (dd.getProperty(propQName) == null || dd.getProperty(propQName).isProtected() == false) + { + props.put(propQName, (Serializable)getPerson().getProperties().get(key)); + } + } + + // persist all property changes + NodeRef personRef = getPerson().getNodeRef(); + this.getNodeService().setProperties(personRef, props); + + // save person description content field + if (this.personDescription != null) + { + ContentService cs = services.getContentService(); + ContentWriter writer = cs.getWriter(personRef, ContentModel.PROP_PERSONDESC, true); + writer.setMimetype(MimetypeMap.MIMETYPE_HTML); + writer.putContent(this.personDescription); + } + + // setup user avatar association + if (this.photoRef != null) + { + List refs = this.getNodeService().getTargetAssocs(personRef, ContentModel.ASSOC_AVATAR); + // remove old association if it exists + if (refs.size() == 1) + { + NodeRef existingRef = refs.get(0).getTargetRef(); + this.getNodeService().removeAssociation( + personRef, existingRef, ContentModel.ASSOC_AVATAR); + } + // setup new association + this.getNodeService().createAssociation(personRef, this.photoRef, ContentModel.ASSOC_AVATAR); + } + + // if the above calls were successful, then reset Person Node in the session + Application.getCurrentUser(context).reset(); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC), err.getMessage()), err); + outcome = null; + ReportedException.throwIfNecessary(err); + } + return outcome; + } + + public Node getPerson() + { + return person; + } + + public String getEmail() + { + Object value = person.getProperties().get(ContentModel.PROP_EMAIL); + return value == null ? null : value.toString(); + } + + public void setEmail(String email) + { + person.getProperties().put(ContentModel.PROP_EMAIL.toString(), email); + } + + public String getFirstName() + { + Object value = person.getProperties().get(ContentModel.PROP_FIRSTNAME); + return value == null ? null : value.toString(); + } + + public void setFirstName(String firstName) + { + person.getProperties().put(ContentModel.PROP_FIRSTNAME.toString(), firstName); + } + + public String getLastName() + { + Object value = person.getProperties().get(ContentModel.PROP_LASTNAME); + return value == null ? null : value.toString(); + } + + public String getPersonDescription() + { + if (personDescription == null) + { + ContentService cs = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); + ContentReader reader = cs.getReader(this.person.getNodeRef(), ContentModel.PROP_PERSONDESC); + if (reader != null && reader.exists()) + { + personDescription = reader.getContentString(); + } + } + return personDescription; + } + + public void setPersonDescription(String s) + { + this.personDescription = s; + } + + public void setLastName(String lastName) + { + person.getProperties().put(ContentModel.PROP_LASTNAME.toString(), lastName); + } + + public Map getPersonProperties() + { + return person.getProperties(); + } + + public NodeRef getPersonPhotoRef() + { + if (this.photoRef == null) + { + List refs = this.getNodeService().getTargetAssocs(person.getNodeRef(), ContentModel.ASSOC_AVATAR); + if (refs.size() == 1) + { + this.photoRef = refs.get(0).getTargetRef(); + } + } + return this.photoRef; + } + + public void setPersonPhotoRef(NodeRef ref) + { + this.photoRef = ref; + } +} diff --git a/source/java/org/alfresco/web/bean/users/EditUserRolesDialog.java b/source/java/org/alfresco/web/bean/users/EditUserRolesDialog.java index db8166a1e3..c9ecf3be97 100644 --- a/source/java/org/alfresco/web/bean/users/EditUserRolesDialog.java +++ b/source/java/org/alfresco/web/bean/users/EditUserRolesDialog.java @@ -1,62 +1,62 @@ -package org.alfresco.web.bean.users; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.faces.model.DataModel; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; - -public class EditUserRolesDialog extends BaseDialogBean { - - private static final long serialVersionUID = 614541023231055676L; - - private static final String MSG_MODIFY_USER_ROLE = "modify_user_roles"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - SpaceUsersBean spaceUsersBean; - - @Override - public boolean getFinishButtonDisabled() { - return false; - } - - public SpaceUsersBean getSpaceUsersBean() { - return spaceUsersBean; - } - - public void setSpaceUsersBean(SpaceUsersBean spaceUsersBean) { - this.spaceUsersBean = spaceUsersBean; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception { - spaceUsersBean.finishOK(); - return outcome; - } - - public void addRole(ActionEvent event) { - spaceUsersBean.addRole(event); - } - - public void setupUserAction(ActionEvent event) { - spaceUsersBean.setupUserAction(event); - } - - public void removeRole(ActionEvent event) { - spaceUsersBean.removeRole(event); - } - - public DataModel getPersonRolesDataModel() { - return spaceUsersBean.getPersonRolesDataModel(); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_MODIFY_USER_ROLE) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + spaceUsersBean.getPersonName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } -} +package org.alfresco.web.bean.users; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.faces.model.DataModel; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; + +public class EditUserRolesDialog extends BaseDialogBean { + + private static final long serialVersionUID = 614541023231055676L; + + private static final String MSG_MODIFY_USER_ROLE = "modify_user_roles"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + SpaceUsersBean spaceUsersBean; + + @Override + public boolean getFinishButtonDisabled() { + return false; + } + + public SpaceUsersBean getSpaceUsersBean() { + return spaceUsersBean; + } + + public void setSpaceUsersBean(SpaceUsersBean spaceUsersBean) { + this.spaceUsersBean = spaceUsersBean; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception { + spaceUsersBean.finishOK(); + return outcome; + } + + public void addRole(ActionEvent event) { + spaceUsersBean.addRole(event); + } + + public void setupUserAction(ActionEvent event) { + spaceUsersBean.setupUserAction(event); + } + + public void removeRole(ActionEvent event) { + spaceUsersBean.removeRole(event); + } + + public DataModel getPersonRolesDataModel() { + return spaceUsersBean.getPersonRolesDataModel(); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_MODIFY_USER_ROLE) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + spaceUsersBean.getPersonName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } +} diff --git a/source/java/org/alfresco/web/bean/users/EditUserWizard.java b/source/java/org/alfresco/web/bean/users/EditUserWizard.java index 0c4b2cda5d..d529ddf96b 100644 --- a/source/java/org/alfresco/web/bean/users/EditUserWizard.java +++ b/source/java/org/alfresco/web/bean/users/EditUserWizard.java @@ -1,153 +1,153 @@ -package org.alfresco.web.bean.users; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.ChildAssociationRef; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.namespace.QName; -import org.alfresco.util.Pair; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * @author YanO - * - */ -public class EditUserWizard extends CreateUserWizard -{ - private static final long serialVersionUID = 7529989488476324511L; - - private static Log logger = LogFactory.getLog(EditUserWizard.class); - - protected UsersBeanProperties properties; - - /** - * @param properties the properties to set - */ - public void setProperties(UsersBeanProperties properties) - { - this.properties = properties; - } - - @Override - public void init(Map arg0) - { - super.init(arg0); - - // set values for edit mode - Map props = properties.getPerson().getProperties(); - - this.firstName = (String) props.get("firstName"); - this.lastName = (String) props.get("lastName"); - this.userName = (String) props.get("userName"); - this.email = (String) props.get("email"); - this.companyId = (String) props.get("organizationId"); - this.organisation = (String) props.get("organization"); - this.jobtitle = (String) props.get("jobtitle"); - this.location = (String) props.get("location"); - this.presenceProvider = (String) props.get("presenceProvider"); - this.presenceUsername = (String) props.get("presenceUsername"); - this.sizeQuota = (Long) props.get("sizeQuota"); - if (this.sizeQuota != null && this.sizeQuota == -1L) - { - this.sizeQuota = null; - } - - if (this.sizeQuota != null) - { - Pair size = convertFromBytes(this.sizeQuota); - this.sizeQuota = size.getFirst(); - this.sizeQuotaUnits = size.getSecond(); - } - - // calculate home space name and parent space Id from homeFolderId - this.homeSpaceLocation = null; // default to Company root space - NodeRef homeFolderRef = (NodeRef) props.get("homeFolder"); - if (homeFolderRef != null && this.getNodeService().exists(homeFolderRef) == true) - { - ChildAssociationRef childAssocRef = this.getNodeService().getPrimaryParent(homeFolderRef); - NodeRef parentRef = childAssocRef.getParentRef(); - if (this.getNodeService().getRootNode(Repository.getStoreRef()).equals(parentRef) == false) - { - this.homeSpaceLocation = parentRef; - this.homeSpaceName = Repository.getNameForNode(getNodeService(), homeFolderRef); - } - else - { - this.homeSpaceLocation = homeFolderRef; - } - } - - if (logger.isDebugEnabled()) - logger.debug("Edit user home space location: " + homeSpaceLocation + " home space name: " + homeSpaceName); - - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - try - { - // update the existing node in the repository - NodeRef nodeRef = properties.getPerson().getNodeRef(); - - // Note: The previous approach was to try a move the home folder if changed, - // but this was problematic as other users that shared the same folder - // moved too. We cannot tell if it is shared. Decided it is better to just - // create a new folder or reuse the folder pointed to just like the initial - // creation in CreateUserWizard. It is always possible to move the contents - // of the old home folder by hand later. - Map props = this.getNodeService().getProperties(nodeRef); - NodeRef oldHomeFolderRef = (NodeRef) this.getNodeService().getProperty(nodeRef, ContentModel.PROP_HOMEFOLDER); - if (oldHomeFolderRef != null && getNodeService().exists(oldHomeFolderRef) == false) - { - oldHomeFolderRef = null; - } - setPersonPropertiesAndCreateHomeSpaceIfNeeded(props, oldHomeFolderRef, context); - - // update the node that represents the Person - this.getNodeService().setProperties(nodeRef, props); - - // TODO: RESET HomeSpace Ref found in top-level navigation bar! - // NOTE: not need cos only admin can do this? - - if ((this.sizeQuota != null) && (this.sizeQuota < 0L)) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, UsersDialog.ERROR_NEGATIVE_QUOTA), this.sizeQuota)); - outcome = null; - } - else - { - putSizeQuotaProperty(this.userName, this.sizeQuota, this.sizeQuotaUnits); - } - } - catch (Throwable e) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), ERROR), e.getMessage()), e); - outcome = null; - ReportedException.throwIfNecessary(e); - } - - if (outcome == null) - { - this.isFinished = false; - } - - return outcome; - } - - @Override - public Map getPersonPropertiesImmutability() - { - return this.properties.getImmutability(); - } -} +package org.alfresco.web.bean.users; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.ChildAssociationRef; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.QName; +import org.alfresco.util.Pair; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * @author YanO + * + */ +public class EditUserWizard extends CreateUserWizard +{ + private static final long serialVersionUID = 7529989488476324511L; + + private static Log logger = LogFactory.getLog(EditUserWizard.class); + + protected UsersBeanProperties properties; + + /** + * @param properties the properties to set + */ + public void setProperties(UsersBeanProperties properties) + { + this.properties = properties; + } + + @Override + public void init(Map arg0) + { + super.init(arg0); + + // set values for edit mode + Map props = properties.getPerson().getProperties(); + + this.firstName = (String) props.get("firstName"); + this.lastName = (String) props.get("lastName"); + this.userName = (String) props.get("userName"); + this.email = (String) props.get("email"); + this.companyId = (String) props.get("organizationId"); + this.organisation = (String) props.get("organization"); + this.jobtitle = (String) props.get("jobtitle"); + this.location = (String) props.get("location"); + this.presenceProvider = (String) props.get("presenceProvider"); + this.presenceUsername = (String) props.get("presenceUsername"); + this.sizeQuota = (Long) props.get("sizeQuota"); + if (this.sizeQuota != null && this.sizeQuota == -1L) + { + this.sizeQuota = null; + } + + if (this.sizeQuota != null) + { + Pair size = convertFromBytes(this.sizeQuota); + this.sizeQuota = size.getFirst(); + this.sizeQuotaUnits = size.getSecond(); + } + + // calculate home space name and parent space Id from homeFolderId + this.homeSpaceLocation = null; // default to Company root space + NodeRef homeFolderRef = (NodeRef) props.get("homeFolder"); + if (homeFolderRef != null && this.getNodeService().exists(homeFolderRef) == true) + { + ChildAssociationRef childAssocRef = this.getNodeService().getPrimaryParent(homeFolderRef); + NodeRef parentRef = childAssocRef.getParentRef(); + if (this.getNodeService().getRootNode(Repository.getStoreRef()).equals(parentRef) == false) + { + this.homeSpaceLocation = parentRef; + this.homeSpaceName = Repository.getNameForNode(getNodeService(), homeFolderRef); + } + else + { + this.homeSpaceLocation = homeFolderRef; + } + } + + if (logger.isDebugEnabled()) + logger.debug("Edit user home space location: " + homeSpaceLocation + " home space name: " + homeSpaceName); + + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + try + { + // update the existing node in the repository + NodeRef nodeRef = properties.getPerson().getNodeRef(); + + // Note: The previous approach was to try a move the home folder if changed, + // but this was problematic as other users that shared the same folder + // moved too. We cannot tell if it is shared. Decided it is better to just + // create a new folder or reuse the folder pointed to just like the initial + // creation in CreateUserWizard. It is always possible to move the contents + // of the old home folder by hand later. + Map props = this.getNodeService().getProperties(nodeRef); + NodeRef oldHomeFolderRef = (NodeRef) this.getNodeService().getProperty(nodeRef, ContentModel.PROP_HOMEFOLDER); + if (oldHomeFolderRef != null && getNodeService().exists(oldHomeFolderRef) == false) + { + oldHomeFolderRef = null; + } + setPersonPropertiesAndCreateHomeSpaceIfNeeded(props, oldHomeFolderRef, context); + + // update the node that represents the Person + this.getNodeService().setProperties(nodeRef, props); + + // TODO: RESET HomeSpace Ref found in top-level navigation bar! + // NOTE: not need cos only admin can do this? + + if ((this.sizeQuota != null) && (this.sizeQuota < 0L)) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, UsersDialog.ERROR_NEGATIVE_QUOTA), this.sizeQuota)); + outcome = null; + } + else + { + putSizeQuotaProperty(this.userName, this.sizeQuota, this.sizeQuotaUnits); + } + } + catch (Throwable e) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), ERROR), e.getMessage()), e); + outcome = null; + ReportedException.throwIfNecessary(e); + } + + if (outcome == null) + { + this.isFinished = false; + } + + return outcome; + } + + @Override + public Map getPersonPropertiesImmutability() + { + return this.properties.getImmutability(); + } +} diff --git a/source/java/org/alfresco/web/bean/users/EmailSpaceUsersDialog.java b/source/java/org/alfresco/web/bean/users/EmailSpaceUsersDialog.java index deeabbbc47..d563919359 100644 --- a/source/java/org/alfresco/web/bean/users/EmailSpaceUsersDialog.java +++ b/source/java/org/alfresco/web/bean/users/EmailSpaceUsersDialog.java @@ -1,604 +1,604 @@ -package org.alfresco.web.bean.users; - -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.Collections; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Map; -import java.util.Set; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.security.authentication.AuthenticationUtil; -import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.security.AccessPermission; -import org.alfresco.service.cmr.security.AccessStatus; -import org.alfresco.service.cmr.security.AuthorityService; -import org.alfresco.service.cmr.security.AuthorityType; -import org.alfresco.service.cmr.security.PermissionService; -import org.alfresco.service.cmr.security.PersonService; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.IContextListener; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.TemplateMailHelperBean; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.MapNode; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.User; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.repo.WebResources; -import org.alfresco.web.ui.repo.component.UIUserGroupPicker; -import org.alfresco.web.ui.repo.component.UIUserGroupPicker.PickerEvent; -import org.springframework.mail.javamail.JavaMailSender; - -/** - * Dialog bean managing the state for the Email Space Users page. Calculates the user/groups - * that are invited to a space and builds the data structures needed to display and modify - * the list in the web-client UI. Notifies the selected user/groups with a templatable email. - * - * @author Kevin Roast - */ -public class EmailSpaceUsersDialog extends BaseDialogBean implements IContextListener -{ - private static final long serialVersionUID = 7925542142116904285L; - - private static final String PROP_DUPLICATE = "duplicate"; - private static final String PROP_PARENT = "parent"; - private static final String PROP_ID = "id"; - private static final String PROP_ISGROUP = "isGroup"; - private static final String PROP_ICON = "icon"; - private static final String PROP_FULLNAME = "fullName"; - private static final String PROP_ROLES = "roles"; - private static final String PROP_EXPANDED = "expanded"; - private static final String PROP_SELECTED = "selected"; - private static final String PROP_USERNAME = "userName"; - - /** Injected Bean references */ - transient private PermissionService permissionService; - transient private PersonService personService; - transient private AuthorityService authorityService; - transient private JavaMailSender mailSender; - - /** Helper providing template based mailing facilities */ - protected TemplateMailHelperBean mailHelper; - - /** List of user/group property map/node instances */ - private List usersGroups = null; - - /** Quick lookup table of authority to user/group instance */ - private Map userGroupLookup = new HashMap(); - - - /** - * Default constructor - */ - public EmailSpaceUsersDialog() - { - UIContextService.getInstance(FacesContext.getCurrentInstance()).registerBean(this); - } - - /** - * Setup the dialog - */ - public void init(Map parameters) - { - super.init(parameters); - - mailHelper = new TemplateMailHelperBean(); - mailHelper.setMailSender(getMailSender()); - mailHelper.setNodeService(getNodeService()); - } - - /** - * @see org.alfresco.web.bean.dialog.BaseDialogBean#finishImpl(javax.faces.context.FacesContext, java.lang.String) - */ - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - // get the space ref this mail applies to - NodeRef spaceRef = getSpace().getNodeRef(); - - // calculate the 'from' email address - User user = Application.getCurrentUser(context); - String from = (String)this.getNodeService().getProperty(user.getPerson(), ContentModel.PROP_EMAIL); - if (from == null || from.length() == 0) - { - // if the user does not have an email address get the default one from the config service - from = Application.getClientConfig(context).getFromEmailAddress(); - } - - Set mailedAuthorities = new HashSet(usersGroups.size()); - - // walk the list of users/groups to notify - handle duplicates along the way - for (Map node : usersGroups) - { - String authority = (String)node.get(PROP_USERNAME); - boolean selected = (Boolean)node.get(PROP_SELECTED); - - // if User, email then, else if Group get all members and email them - AuthorityType authType = AuthorityType.getAuthorityType(authority); - if (authType.equals(AuthorityType.USER)) - { - if (selected == true && this.getPersonService().personExists(authority)) - { - if (mailedAuthorities.contains(authority) == false) - { - this.mailHelper.notifyUser( - this.getPersonService().getPerson(authority), spaceRef, from, (String)node.get(PROP_ROLES)); - mailedAuthorities.add(authority); - } - } - } - else if (authType.equals(AuthorityType.GROUP)) - { - // is the group expanded? if so we'll deal with the child authorities instead - boolean expanded = (Boolean)node.get(PROP_EXPANDED); - if (expanded == false && selected == true) - { - // notify all members of the group - Set users = this.getAuthorityService().getContainedAuthorities(AuthorityType.USER, authority, false); - for (String userAuth : users) - { - if (this.getPersonService().personExists(userAuth) == true) - { - if (mailedAuthorities.contains(userAuth) == false) - { - this.mailHelper.notifyUser( - this.getPersonService().getPerson(userAuth), spaceRef, from, (String)node.get(PROP_ROLES)); - mailedAuthorities.add(userAuth); - } - } - } - } - } - } - - return outcome; - } - - - // ------------------------------------------------------------------------------ - // IContextListener implementation - - /** - * @see org.alfresco.web.app.context.IContextListener#contextUpdated() - */ - public void contextUpdated() - { - this.usersGroups = null; - this.userGroupLookup = new HashMap(); - } - - /** - * @see org.alfresco.web.app.context.IContextListener#areaChanged() - */ - public void areaChanged() - { - // nothing to do - } - - /** - * @see org.alfresco.web.app.context.IContextListener#spaceChanged() - */ - public void spaceChanged() - { - // nothing to do - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * @param permissionService The PermissionService to set - */ - public void setPermissionService(PermissionService permissionService) - { - this.permissionService = permissionService; - } - - protected PermissionService getPermissionService() - { - if (permissionService == null) - { - permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); - } - return permissionService; - } - - /** - * @param personService The PersonService to set - */ - public void setPersonService(PersonService personService) - { - this.personService = personService; - } - - protected PersonService getPersonService() - { - if (personService == null) - { - personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); - } - return personService; - } - - /** - * @param mailSender The JavaMailSender to set. - */ - public void setMailSender(JavaMailSender mailSender) - { - this.mailSender = mailSender; - } - - protected JavaMailSender getMailSender() - { - if (mailSender == null) - { - mailSender = (JavaMailSender) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "mailService"); - } - return mailSender; - } - - /** - * @param authorityService The AuthorityService to set. - */ - public void setAuthorityService(AuthorityService authorityService) - { - this.authorityService = authorityService; - } - - protected AuthorityService getAuthorityService() - { - if (authorityService == null) - { - authorityService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthorityService(); - } - return authorityService; - } - - /** - * @return The space to email users for - */ - public Node getSpace() - { - return this.browseBean.getActionSpace(); - } - - /** - * Return the List of objects representing the Users and Groups invited to this space. - * The picker is then responsible for rendering a view to represent those users and groups - * which allows the users to select and deselect users and groups, also to expand groups - * to show sub-groups and users. - * - * @return List of Map objects representing the users/groups assigned to the current space - */ - public List getUsersGroups() - { - if (this.usersGroups == null) - { - FacesContext context = FacesContext.getCurrentInstance(); - - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - // Return all the permissions set against the current node for any authentication - // instance (user/group), walking the parent space inheritance chain. - // Then combine them into a single list for each authentication found. - final String currentAuthority = Application.getCurrentUser(context).getUserName(); - Map> permissionMap = AuthenticationUtil.runAs(new RunAsWork>>() - { - public Map> doWork() throws Exception - { - NodeRef spaceRef = getSpace().getNodeRef(); - Map> permissionMap = new HashMap>(8, 1.0f); - while (spaceRef != null) - { - Set permissions = getPermissionService().getAllSetPermissions(spaceRef); - for (AccessPermission permission : permissions) - { - // we are only interested in Allow and not Guest/Everyone/owner - if (permission.getAccessStatus() == AccessStatus.ALLOWED && - (permission.getAuthorityType() == AuthorityType.USER || - permission.getAuthorityType() == AuthorityType.GROUP)) - { - String authority = permission.getAuthority(); - - if (currentAuthority.equals(authority) == false) - { - List userPermissions = permissionMap.get(authority); - if (userPermissions == null) - { - // create for first time - userPermissions = new ArrayList(4); - permissionMap.put(authority, userPermissions); - } - // add the permission name for this authority - userPermissions.add(permission.getPermission()); - } - } - } - - // walk parent inheritance chain until root or no longer inherits - if (getPermissionService().getInheritParentPermissions(spaceRef)) - { - spaceRef = getNodeService().getPrimaryParent(spaceRef).getParentRef(); - } - else - { - spaceRef = null; - } - } - return permissionMap; - } - }, AuthenticationUtil.SYSTEM_USER_NAME); - - // create the structure as a linked list for fast insert/removal of items - this.usersGroups = new LinkedList(); - - // for each authentication (username/group key) found we get the Person - // node represented by it and use that for our list databinding object - for (String authority : permissionMap.keySet()) - { - Map node = buildAuthorityMap(authority, UserMembersBean.roleListToString(context, permissionMap.get(authority))); - if (node != null) - { - this.usersGroups.add(node); - } - } - - // commit the transaction - tx.commit(); - } - catch (InvalidNodeRefException refErr) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - context, Repository.ERROR_NODEREF), new Object[] {refErr.getNodeRef()}) ); - this.usersGroups = Collections.emptyList(); - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - context, Repository.ERROR_GENERIC), err.getMessage()), err ); - this.usersGroups = Collections.emptyList(); - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - } - return this.usersGroups; - } - - /** - * @return TemplateMailHelperBean instance for this wizard - */ - public TemplateMailHelperBean getMailHelper() - { - return this.mailHelper; - } - - /** - * @return true if any authorities are selected, false otherwise - */ - public boolean getFinishButtonDisabled() - { - boolean disabled = true; - - if (this.usersGroups != null) - { - for (Map userGroup : this.usersGroups) - { - if (((Boolean)userGroup.get(PROP_EXPANDED)) == false && - ((Boolean)userGroup.get(PROP_SELECTED)) == true) - { - disabled = false; - break; - } - } - } - - return disabled; - } - - - // ------------------------------------------------------------------------------ - // Action Event Listeners - - /** - * Action handler for a user/group selector event - */ - public void userGroupSelectorAction(ActionEvent event) - { - if (event instanceof PickerEvent) - { - PickerEvent pickerEvent = (PickerEvent)event; - - // find the user/group this event represents - Map userGroup = null; - int index = 0; - for (; index authorities = getAuthorityService().getContainedAuthorities( - null, pickerEvent.Authority, true); - for (String authority : authorities) - { - if (currentAuthority.equals(authority) == false) - { - if (AuthorityType.getAuthorityType(authority) == AuthorityType.USER || - AuthorityType.getAuthorityType(authority) == AuthorityType.GROUP) - { - Map node = buildAuthorityMap(authority, (String)userGroup.get(PROP_ROLES)); - if (node != null) - { - node.put(PROP_PARENT, userGroup); - node.put(PROP_SELECTED, selected); - this.usersGroups.add(++index, node); - } - } - } - } - } - else - { - // remove the children for the group - for (index++; index props = ((MapNode)node).getProperties(); - props.put(PROP_FULLNAME, ((String)props.get("firstName")) + ' ' + ((String)props.get("lastName"))); - props.put(PROP_ICON, WebResources.IMAGE_PERSON); - props.put(PROP_ISGROUP, false); - } - } - else if (AuthorityType.getAuthorityType(authority) == AuthorityType.GROUP) - { - // need a map (dummy node) to represent props for this Group Authority - node = new HashMap(8, 1.0f); - - String groupDisplayName = this.authorityService.getAuthorityDisplayName(authority); - if (groupDisplayName == null || groupDisplayName.length() == 0) - { - if (authority.startsWith(PermissionService.GROUP_PREFIX) == true) - { - groupDisplayName = authority.substring(PermissionService.GROUP_PREFIX.length()); - } - else - { - groupDisplayName = authority; - } - } - - node.put(PROP_FULLNAME, groupDisplayName); - node.put(PROP_USERNAME, authority); - node.put(PROP_ID, authority); - node.put(PROP_ICON, WebResources.IMAGE_GROUP); - node.put(PROP_ISGROUP, true); - } - if (node != null) - { - // add the common properties - node.put(PROP_ROLES, roles); - node.put(PROP_PARENT, null); - node.put(PROP_EXPANDED, false); - - if (this.userGroupLookup.get(authority) != null) - { - // this authority already exists in the list somewhere else - mark as duplicate - node.put(PROP_DUPLICATE, true); - node.put(PROP_SELECTED, false); - } - else - { - // add to table for the first time, not a duplicate - this.userGroupLookup.put(authority, node); - node.put(PROP_DUPLICATE, false); - node.put(PROP_SELECTED, true); - } - } - - return node; - } - -} +package org.alfresco.web.bean.users; + +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.security.authentication.AuthenticationUtil; +import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.security.AccessPermission; +import org.alfresco.service.cmr.security.AccessStatus; +import org.alfresco.service.cmr.security.AuthorityService; +import org.alfresco.service.cmr.security.AuthorityType; +import org.alfresco.service.cmr.security.PermissionService; +import org.alfresco.service.cmr.security.PersonService; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.IContextListener; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.TemplateMailHelperBean; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.MapNode; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.User; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.repo.WebResources; +import org.alfresco.web.ui.repo.component.UIUserGroupPicker; +import org.alfresco.web.ui.repo.component.UIUserGroupPicker.PickerEvent; +import org.springframework.mail.javamail.JavaMailSender; + +/** + * Dialog bean managing the state for the Email Space Users page. Calculates the user/groups + * that are invited to a space and builds the data structures needed to display and modify + * the list in the web-client UI. Notifies the selected user/groups with a templatable email. + * + * @author Kevin Roast + */ +public class EmailSpaceUsersDialog extends BaseDialogBean implements IContextListener +{ + private static final long serialVersionUID = 7925542142116904285L; + + private static final String PROP_DUPLICATE = "duplicate"; + private static final String PROP_PARENT = "parent"; + private static final String PROP_ID = "id"; + private static final String PROP_ISGROUP = "isGroup"; + private static final String PROP_ICON = "icon"; + private static final String PROP_FULLNAME = "fullName"; + private static final String PROP_ROLES = "roles"; + private static final String PROP_EXPANDED = "expanded"; + private static final String PROP_SELECTED = "selected"; + private static final String PROP_USERNAME = "userName"; + + /** Injected Bean references */ + transient private PermissionService permissionService; + transient private PersonService personService; + transient private AuthorityService authorityService; + transient private JavaMailSender mailSender; + + /** Helper providing template based mailing facilities */ + protected TemplateMailHelperBean mailHelper; + + /** List of user/group property map/node instances */ + private List usersGroups = null; + + /** Quick lookup table of authority to user/group instance */ + private Map userGroupLookup = new HashMap(); + + + /** + * Default constructor + */ + public EmailSpaceUsersDialog() + { + UIContextService.getInstance(FacesContext.getCurrentInstance()).registerBean(this); + } + + /** + * Setup the dialog + */ + public void init(Map parameters) + { + super.init(parameters); + + mailHelper = new TemplateMailHelperBean(); + mailHelper.setMailSender(getMailSender()); + mailHelper.setNodeService(getNodeService()); + } + + /** + * @see org.alfresco.web.bean.dialog.BaseDialogBean#finishImpl(javax.faces.context.FacesContext, java.lang.String) + */ + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + // get the space ref this mail applies to + NodeRef spaceRef = getSpace().getNodeRef(); + + // calculate the 'from' email address + User user = Application.getCurrentUser(context); + String from = (String)this.getNodeService().getProperty(user.getPerson(), ContentModel.PROP_EMAIL); + if (from == null || from.length() == 0) + { + // if the user does not have an email address get the default one from the config service + from = Application.getClientConfig(context).getFromEmailAddress(); + } + + Set mailedAuthorities = new HashSet(usersGroups.size()); + + // walk the list of users/groups to notify - handle duplicates along the way + for (Map node : usersGroups) + { + String authority = (String)node.get(PROP_USERNAME); + boolean selected = (Boolean)node.get(PROP_SELECTED); + + // if User, email then, else if Group get all members and email them + AuthorityType authType = AuthorityType.getAuthorityType(authority); + if (authType.equals(AuthorityType.USER)) + { + if (selected == true && this.getPersonService().personExists(authority)) + { + if (mailedAuthorities.contains(authority) == false) + { + this.mailHelper.notifyUser( + this.getPersonService().getPerson(authority), spaceRef, from, (String)node.get(PROP_ROLES)); + mailedAuthorities.add(authority); + } + } + } + else if (authType.equals(AuthorityType.GROUP)) + { + // is the group expanded? if so we'll deal with the child authorities instead + boolean expanded = (Boolean)node.get(PROP_EXPANDED); + if (expanded == false && selected == true) + { + // notify all members of the group + Set users = this.getAuthorityService().getContainedAuthorities(AuthorityType.USER, authority, false); + for (String userAuth : users) + { + if (this.getPersonService().personExists(userAuth) == true) + { + if (mailedAuthorities.contains(userAuth) == false) + { + this.mailHelper.notifyUser( + this.getPersonService().getPerson(userAuth), spaceRef, from, (String)node.get(PROP_ROLES)); + mailedAuthorities.add(userAuth); + } + } + } + } + } + } + + return outcome; + } + + + // ------------------------------------------------------------------------------ + // IContextListener implementation + + /** + * @see org.alfresco.web.app.context.IContextListener#contextUpdated() + */ + public void contextUpdated() + { + this.usersGroups = null; + this.userGroupLookup = new HashMap(); + } + + /** + * @see org.alfresco.web.app.context.IContextListener#areaChanged() + */ + public void areaChanged() + { + // nothing to do + } + + /** + * @see org.alfresco.web.app.context.IContextListener#spaceChanged() + */ + public void spaceChanged() + { + // nothing to do + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * @param permissionService The PermissionService to set + */ + public void setPermissionService(PermissionService permissionService) + { + this.permissionService = permissionService; + } + + protected PermissionService getPermissionService() + { + if (permissionService == null) + { + permissionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPermissionService(); + } + return permissionService; + } + + /** + * @param personService The PersonService to set + */ + public void setPersonService(PersonService personService) + { + this.personService = personService; + } + + protected PersonService getPersonService() + { + if (personService == null) + { + personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); + } + return personService; + } + + /** + * @param mailSender The JavaMailSender to set. + */ + public void setMailSender(JavaMailSender mailSender) + { + this.mailSender = mailSender; + } + + protected JavaMailSender getMailSender() + { + if (mailSender == null) + { + mailSender = (JavaMailSender) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "mailService"); + } + return mailSender; + } + + /** + * @param authorityService The AuthorityService to set. + */ + public void setAuthorityService(AuthorityService authorityService) + { + this.authorityService = authorityService; + } + + protected AuthorityService getAuthorityService() + { + if (authorityService == null) + { + authorityService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthorityService(); + } + return authorityService; + } + + /** + * @return The space to email users for + */ + public Node getSpace() + { + return this.browseBean.getActionSpace(); + } + + /** + * Return the List of objects representing the Users and Groups invited to this space. + * The picker is then responsible for rendering a view to represent those users and groups + * which allows the users to select and deselect users and groups, also to expand groups + * to show sub-groups and users. + * + * @return List of Map objects representing the users/groups assigned to the current space + */ + public List getUsersGroups() + { + if (this.usersGroups == null) + { + FacesContext context = FacesContext.getCurrentInstance(); + + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + // Return all the permissions set against the current node for any authentication + // instance (user/group), walking the parent space inheritance chain. + // Then combine them into a single list for each authentication found. + final String currentAuthority = Application.getCurrentUser(context).getUserName(); + Map> permissionMap = AuthenticationUtil.runAs(new RunAsWork>>() + { + public Map> doWork() throws Exception + { + NodeRef spaceRef = getSpace().getNodeRef(); + Map> permissionMap = new HashMap>(8, 1.0f); + while (spaceRef != null) + { + Set permissions = getPermissionService().getAllSetPermissions(spaceRef); + for (AccessPermission permission : permissions) + { + // we are only interested in Allow and not Guest/Everyone/owner + if (permission.getAccessStatus() == AccessStatus.ALLOWED && + (permission.getAuthorityType() == AuthorityType.USER || + permission.getAuthorityType() == AuthorityType.GROUP)) + { + String authority = permission.getAuthority(); + + if (currentAuthority.equals(authority) == false) + { + List userPermissions = permissionMap.get(authority); + if (userPermissions == null) + { + // create for first time + userPermissions = new ArrayList(4); + permissionMap.put(authority, userPermissions); + } + // add the permission name for this authority + userPermissions.add(permission.getPermission()); + } + } + } + + // walk parent inheritance chain until root or no longer inherits + if (getPermissionService().getInheritParentPermissions(spaceRef)) + { + spaceRef = getNodeService().getPrimaryParent(spaceRef).getParentRef(); + } + else + { + spaceRef = null; + } + } + return permissionMap; + } + }, AuthenticationUtil.SYSTEM_USER_NAME); + + // create the structure as a linked list for fast insert/removal of items + this.usersGroups = new LinkedList(); + + // for each authentication (username/group key) found we get the Person + // node represented by it and use that for our list databinding object + for (String authority : permissionMap.keySet()) + { + Map node = buildAuthorityMap(authority, UserMembersBean.roleListToString(context, permissionMap.get(authority))); + if (node != null) + { + this.usersGroups.add(node); + } + } + + // commit the transaction + tx.commit(); + } + catch (InvalidNodeRefException refErr) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + context, Repository.ERROR_NODEREF), new Object[] {refErr.getNodeRef()}) ); + this.usersGroups = Collections.emptyList(); + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + context, Repository.ERROR_GENERIC), err.getMessage()), err ); + this.usersGroups = Collections.emptyList(); + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + } + return this.usersGroups; + } + + /** + * @return TemplateMailHelperBean instance for this wizard + */ + public TemplateMailHelperBean getMailHelper() + { + return this.mailHelper; + } + + /** + * @return true if any authorities are selected, false otherwise + */ + public boolean getFinishButtonDisabled() + { + boolean disabled = true; + + if (this.usersGroups != null) + { + for (Map userGroup : this.usersGroups) + { + if (((Boolean)userGroup.get(PROP_EXPANDED)) == false && + ((Boolean)userGroup.get(PROP_SELECTED)) == true) + { + disabled = false; + break; + } + } + } + + return disabled; + } + + + // ------------------------------------------------------------------------------ + // Action Event Listeners + + /** + * Action handler for a user/group selector event + */ + public void userGroupSelectorAction(ActionEvent event) + { + if (event instanceof PickerEvent) + { + PickerEvent pickerEvent = (PickerEvent)event; + + // find the user/group this event represents + Map userGroup = null; + int index = 0; + for (; index authorities = getAuthorityService().getContainedAuthorities( + null, pickerEvent.Authority, true); + for (String authority : authorities) + { + if (currentAuthority.equals(authority) == false) + { + if (AuthorityType.getAuthorityType(authority) == AuthorityType.USER || + AuthorityType.getAuthorityType(authority) == AuthorityType.GROUP) + { + Map node = buildAuthorityMap(authority, (String)userGroup.get(PROP_ROLES)); + if (node != null) + { + node.put(PROP_PARENT, userGroup); + node.put(PROP_SELECTED, selected); + this.usersGroups.add(++index, node); + } + } + } + } + } + else + { + // remove the children for the group + for (index++; index props = ((MapNode)node).getProperties(); + props.put(PROP_FULLNAME, ((String)props.get("firstName")) + ' ' + ((String)props.get("lastName"))); + props.put(PROP_ICON, WebResources.IMAGE_PERSON); + props.put(PROP_ISGROUP, false); + } + } + else if (AuthorityType.getAuthorityType(authority) == AuthorityType.GROUP) + { + // need a map (dummy node) to represent props for this Group Authority + node = new HashMap(8, 1.0f); + + String groupDisplayName = this.authorityService.getAuthorityDisplayName(authority); + if (groupDisplayName == null || groupDisplayName.length() == 0) + { + if (authority.startsWith(PermissionService.GROUP_PREFIX) == true) + { + groupDisplayName = authority.substring(PermissionService.GROUP_PREFIX.length()); + } + else + { + groupDisplayName = authority; + } + } + + node.put(PROP_FULLNAME, groupDisplayName); + node.put(PROP_USERNAME, authority); + node.put(PROP_ID, authority); + node.put(PROP_ICON, WebResources.IMAGE_GROUP); + node.put(PROP_ISGROUP, true); + } + if (node != null) + { + // add the common properties + node.put(PROP_ROLES, roles); + node.put(PROP_PARENT, null); + node.put(PROP_EXPANDED, false); + + if (this.userGroupLookup.get(authority) != null) + { + // this authority already exists in the list somewhere else - mark as duplicate + node.put(PROP_DUPLICATE, true); + node.put(PROP_SELECTED, false); + } + else + { + // add to table for the first time, not a duplicate + this.userGroupLookup.put(authority, node); + node.put(PROP_DUPLICATE, false); + node.put(PROP_SELECTED, true); + } + } + + return node; + } + +} diff --git a/source/java/org/alfresco/web/bean/users/RemoveContentUserDialog.java b/source/java/org/alfresco/web/bean/users/RemoveContentUserDialog.java index 6536770af1..9bc8cd58c2 100644 --- a/source/java/org/alfresco/web/bean/users/RemoveContentUserDialog.java +++ b/source/java/org/alfresco/web/bean/users/RemoveContentUserDialog.java @@ -1,76 +1,76 @@ -package org.alfresco.web.bean.users; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; - -/** - * Implementation of remove content user dialog. - * - * @author gavinc - */ -public class RemoveContentUserDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -3090054828215666084L; - - private static final String MSG_REMOVE_USER = "remove_user"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private ContentUsersBean contentUsersBean; - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - contentUsersBean.removeOK(); - - return outcome; - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_REMOVE_USER) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + this.getPersonName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getContainerSubTitle() - { - return this.browseBean.getDocument().getName(); - } - - public void setupUserAction(ActionEvent event) - { - this.contentUsersBean.setupUserAction(event); - } - - public String getPersonName() - { - return this.contentUsersBean.getPersonName(); - } - - public void setPersonName(String personName) - { - this.contentUsersBean.setPersonName(personName); - } - - public ContentUsersBean getContentUsersBean() - { - return contentUsersBean; - } - - public void setContentUsersBean(ContentUsersBean contentUsersBean) - { - this.contentUsersBean = contentUsersBean; - } -} +package org.alfresco.web.bean.users; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; + +/** + * Implementation of remove content user dialog. + * + * @author gavinc + */ +public class RemoveContentUserDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -3090054828215666084L; + + private static final String MSG_REMOVE_USER = "remove_user"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private ContentUsersBean contentUsersBean; + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + contentUsersBean.removeOK(); + + return outcome; + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_REMOVE_USER) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + this.getPersonName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getContainerSubTitle() + { + return this.browseBean.getDocument().getName(); + } + + public void setupUserAction(ActionEvent event) + { + this.contentUsersBean.setupUserAction(event); + } + + public String getPersonName() + { + return this.contentUsersBean.getPersonName(); + } + + public void setPersonName(String personName) + { + this.contentUsersBean.setPersonName(personName); + } + + public ContentUsersBean getContentUsersBean() + { + return contentUsersBean; + } + + public void setContentUsersBean(ContentUsersBean contentUsersBean) + { + this.contentUsersBean = contentUsersBean; + } +} diff --git a/source/java/org/alfresco/web/bean/users/RemoveInvitedUserDialog.java b/source/java/org/alfresco/web/bean/users/RemoveInvitedUserDialog.java index c08bf90fc2..48050310b9 100644 --- a/source/java/org/alfresco/web/bean/users/RemoveInvitedUserDialog.java +++ b/source/java/org/alfresco/web/bean/users/RemoveInvitedUserDialog.java @@ -1,80 +1,80 @@ -package org.alfresco.web.bean.users; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; - -public class RemoveInvitedUserDialog extends BaseDialogBean -{ - - private static final long serialVersionUID = -7457234588814115434L; - - private static final String BUTTON_NO = "no"; - - private static final String BUTTON_YES = "yes"; - - private static final String MSG_REMOVE_USER = "remove_user"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - private SpaceUsersBean spaceUsersBean; - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return spaceUsersBean.removeOK(); - } - - public void setupUserAction(ActionEvent event) - { - spaceUsersBean.setupUserAction(event); - } - - public String getPersonName() - { - return spaceUsersBean.getPersonName(); - } - - public void setPersonName(String personName) - { - this.spaceUsersBean.setPersonName(personName); - } - - public SpaceUsersBean getSpaceUsersBean() - { - return spaceUsersBean; - } - - public void setSpaceUsersBean(SpaceUsersBean spaceUsersBean) - { - this.spaceUsersBean = spaceUsersBean; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_NO); - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_YES); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_REMOVE_USER) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + spaceUsersBean.getPersonName() - + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } -} +package org.alfresco.web.bean.users; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; + +public class RemoveInvitedUserDialog extends BaseDialogBean +{ + + private static final long serialVersionUID = -7457234588814115434L; + + private static final String BUTTON_NO = "no"; + + private static final String BUTTON_YES = "yes"; + + private static final String MSG_REMOVE_USER = "remove_user"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + private SpaceUsersBean spaceUsersBean; + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return spaceUsersBean.removeOK(); + } + + public void setupUserAction(ActionEvent event) + { + spaceUsersBean.setupUserAction(event); + } + + public String getPersonName() + { + return spaceUsersBean.getPersonName(); + } + + public void setPersonName(String personName) + { + this.spaceUsersBean.setPersonName(personName); + } + + public SpaceUsersBean getSpaceUsersBean() + { + return spaceUsersBean; + } + + public void setSpaceUsersBean(SpaceUsersBean spaceUsersBean) + { + this.spaceUsersBean = spaceUsersBean; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_NO); + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), BUTTON_YES); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_REMOVE_USER) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + spaceUsersBean.getPersonName() + + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } +} diff --git a/source/java/org/alfresco/web/bean/users/SpaceUsersBean.java b/source/java/org/alfresco/web/bean/users/SpaceUsersBean.java index 2195fcb154..68c1f837a6 100644 --- a/source/java/org/alfresco/web/bean/users/SpaceUsersBean.java +++ b/source/java/org/alfresco/web/bean/users/SpaceUsersBean.java @@ -1,65 +1,65 @@ -package org.alfresco.web.bean.users; - -import java.text.MessageFormat; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; - -/** - * Concrete implementation providing access to users of the current space. - * - * @author gavinc - */ -public class SpaceUsersBean extends UserMembersBean -{ - private static final long serialVersionUID = -4847219834289259559L; - - private final static String MSG_MANAGE_INVITED_USERS = "manage_invited_users"; - private final static String MSG_SPACE_OWNER = "space_owner"; - private final static String MSG_CLOSE= "close"; - private final static String MSG_LEFT_QUOTE = "left_qoute"; - private final static String MSG_RIGHT_QUOTE = "right_quote"; - - /** - * @return The space to work against - */ - public Node getNode() - { - return this.browseBean.getActionSpace(); - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return null; - } - - @Override - public Object getActionsContext() - { - return getNode(); - } - - @Override - public String getContainerTitle() - { - FacesContext fc = FacesContext.getCurrentInstance(); - return Application.getMessage(fc, MSG_MANAGE_INVITED_USERS) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) - + browseBean.getActionSpace().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); - } - - @Override - public String getContainerSubTitle() - { - String pattern = Application.getMessage(FacesContext.getCurrentInstance(), MSG_SPACE_OWNER); - return MessageFormat.format(pattern, getOwner()); - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } -} +package org.alfresco.web.bean.users; + +import java.text.MessageFormat; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; + +/** + * Concrete implementation providing access to users of the current space. + * + * @author gavinc + */ +public class SpaceUsersBean extends UserMembersBean +{ + private static final long serialVersionUID = -4847219834289259559L; + + private final static String MSG_MANAGE_INVITED_USERS = "manage_invited_users"; + private final static String MSG_SPACE_OWNER = "space_owner"; + private final static String MSG_CLOSE= "close"; + private final static String MSG_LEFT_QUOTE = "left_qoute"; + private final static String MSG_RIGHT_QUOTE = "right_quote"; + + /** + * @return The space to work against + */ + public Node getNode() + { + return this.browseBean.getActionSpace(); + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return null; + } + + @Override + public Object getActionsContext() + { + return getNode(); + } + + @Override + public String getContainerTitle() + { + FacesContext fc = FacesContext.getCurrentInstance(); + return Application.getMessage(fc, MSG_MANAGE_INVITED_USERS) + " " + Application.getMessage(fc, MSG_LEFT_QUOTE) + + browseBean.getActionSpace().getName() + Application.getMessage(fc, MSG_RIGHT_QUOTE); + } + + @Override + public String getContainerSubTitle() + { + String pattern = Application.getMessage(FacesContext.getCurrentInstance(), MSG_SPACE_OWNER); + return MessageFormat.format(pattern, getOwner()); + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } +} diff --git a/source/java/org/alfresco/web/bean/users/UserConsoleDialog.java b/source/java/org/alfresco/web/bean/users/UserConsoleDialog.java index 7eca90eaad..6d436c835f 100644 --- a/source/java/org/alfresco/web/bean/users/UserConsoleDialog.java +++ b/source/java/org/alfresco/web/bean/users/UserConsoleDialog.java @@ -1,25 +1,25 @@ -package org.alfresco.web.bean.users; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; - -public class UserConsoleDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -217662039833342921L; - - private static final String MSG_CLOSE = "close"; - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - return null; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); - } +package org.alfresco.web.bean.users; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; + +public class UserConsoleDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -217662039833342921L; + + private static final String MSG_CLOSE = "close"; + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + return null; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), MSG_CLOSE); + } } \ No newline at end of file diff --git a/source/java/org/alfresco/web/bean/users/UserPreferencesBean.java b/source/java/org/alfresco/web/bean/users/UserPreferencesBean.java index fd2216cfab..ed6db6f2b4 100644 --- a/source/java/org/alfresco/web/bean/users/UserPreferencesBean.java +++ b/source/java/org/alfresco/web/bean/users/UserPreferencesBean.java @@ -1,394 +1,394 @@ -package org.alfresco.web.bean.users; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.List; -import java.util.Locale; -import java.util.ResourceBundle; - -import javax.faces.context.FacesContext; -import javax.faces.model.SelectItem; - -import org.alfresco.service.cmr.ml.ContentFilterLanguagesService; -import org.alfresco.service.cmr.ml.MultilingualContentService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.context.UIContextService; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.repository.PreferencesService; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.config.LanguagesConfigElement; -import org.springframework.extensions.config.Config; -import org.springframework.extensions.surf.util.I18NUtil; - -/** - * Simple bean backing the user preferences settings. - * - * @author Kevin Roast - */ -public class UserPreferencesBean implements Serializable -{ - private static final long serialVersionUID = -1262481849503163054L; - - public static final String PREF_INTERFACELANGUAGE = "interface-language"; - - private static final String PREF_STARTLOCATION = "start-location"; - private static final String PREF_CONTENTFILTERLANGUAGE = "content-filter-language"; - private static final String PREF_DOWNLOADAUTOMATICALLY = "download-automatically"; - - /** - * Remplacement message for set the filter at 'all languages'. - * Must be considered as a null value. - */ - public static final String MSG_CONTENTALLLANGUAGES = "content_all_languages"; - - /** content language locale selection */ - private String contentFilterLanguage = null; - - /** the injected MultilingualContentService */ - transient private MultilingualContentService multilingualContentService; - - /** the injected ContentFilterLanguagesService */ - transient private ContentFilterLanguagesService contentFilterLanguagesService; - - /** the injected NodeService */ - transient private NodeService nodeService; - - /** - * @return the list of available languages - */ - public SelectItem[] getLanguages() - { - // Get the item selection list for the list of languages - return getLanguageItems(); - } - - /** - * @return Returns the language selection for the current user session. - */ - public String getLanguage() - { - return Application.getLanguage(FacesContext.getCurrentInstance()).toString(); - } - - /** - * @param language The language selection to set. - */ - public void setLanguage(String language) - { - // set the language for the current session - Application.setLanguage(FacesContext.getCurrentInstance(), language); - - // save user preference - if (Application.getCurrentUser(FacesContext.getCurrentInstance()) != null) - { - PreferencesService.getPreferences().setValue(PREF_INTERFACELANGUAGE, language); - } - } - - /** - * @return current content filter language, or null if all languages was selected - */ - public String getContentFilterLanguage() - { - if (this.contentFilterLanguage == null) - { - Locale locale = (Locale) PreferencesService.getPreferences().getValue(PREF_CONTENTFILTERLANGUAGE); - - // Null means All Languages - if (locale == null) - { - this.contentFilterLanguage = null; - } - else - { - this.contentFilterLanguage = locale.toString(); - } - } - - // set the content filter locale on the core - I18NUtil.setContentLocale(I18NUtil.parseLocale(this.contentFilterLanguage)); - - return this.contentFilterLanguage; - } - - /** - * @param contentFilterLanguage A valid locale string or {@link #MSG_CONTENTALLLANGUAGES} - */ - public void setContentFilterLanguage(String contentFilterLanguage) - { - this.contentFilterLanguage = contentFilterLanguage; - Locale language = null; - if (contentFilterLanguage.equals(MSG_CONTENTALLLANGUAGES)) - { - // The generic "All Languages" was selected - persist this as a null - this.contentFilterLanguage = null; - } - else - { - // It should be a proper locale string - language = I18NUtil.parseLocale(contentFilterLanguage); - } - PreferencesService.getPreferences().setValue(PREF_CONTENTFILTERLANGUAGE, language); - - // set the content filter locale on the core - I18NUtil.setContentLocale(language); - - // Ensure a refresh - UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); - } - - /** - * @return list of items for the content filtering language selection include the label 'all langaguages' - */ - public SelectItem[] getContentFilterLanguages() - { - // Get the item selection list - return getContentFilterLanguages(true); - } - - /** - * @param includeAllLanguages if true, the list must include the label 'all languages' - * @return list of items for the content filtering language selection - */ - public SelectItem[] getContentFilterLanguages(boolean includeAllLanguages) - { - FacesContext fc = FacesContext.getCurrentInstance(); - ResourceBundle msg = Application.getBundle(fc); - - // get the list of filter languages - List languages = getContentFilterLanguagesService().getFilterLanguages(); - - // set the item selection list - SelectItem[] items = new SelectItem[(includeAllLanguages) ? languages.size() + 1 : languages.size()]; - int idx = 0; - - // include the item if needed - if (includeAllLanguages) - { - String allLanguagesStr = msg.getString(MSG_CONTENTALLLANGUAGES); - items[idx] = new SelectItem(MSG_CONTENTALLLANGUAGES, allLanguagesStr); - idx++; - } - - for (String lang : languages) - { - String label = getContentFilterLanguagesService().getLabelByCode(lang); - items[idx] = new SelectItem(lang, label); - idx++; - } - - return items; - } - - /** - * return the list of languages in which the given node hasn't be translated yet. - * - * @param translation the translatable node ref - * @param returnTranslationLanguage if true, return the language of the given translation. - * @return the list of languages - */ - public SelectItem[] getAvailablesContentFilterLanguages(NodeRef translation, boolean returnTranslationLanguage) - { - // get the list of missing translation of this node - List missingLocales = getMultilingualContentService().getMissingTranslations(translation, returnTranslationLanguage); - - // set the item selection list - SelectItem[] items = new SelectItem[missingLocales.size()]; - int idx = 0; - - for(Locale locale : missingLocales) - { - String label = getContentFilterLanguagesService().getLabelByCode(locale.getLanguage()); - - items[idx] = new SelectItem( - locale.toString(), - label); - idx++; - } - - return items; - } - - /** - * Helper to return the available language items - * - * @return Array of SelectItem objects - */ - private static SelectItem[] getLanguageItems() - { - FacesContext fc = FacesContext.getCurrentInstance(); - Config config = Application.getConfigService(fc).getConfig("Languages"); - LanguagesConfigElement langConfig = (LanguagesConfigElement)config.getConfigElement( - LanguagesConfigElement.CONFIG_ELEMENT_ID); - - List languages = langConfig.getLanguages(); - List items = new ArrayList(10); - - for (String locale : languages) - { - // get label associated to the locale - String label = langConfig.getLabelForLanguage(locale); - items.add(new SelectItem(locale, label)); - } - - return items.toArray(new SelectItem[items.size()]); - } - - /** - * @return the start location for this user (@see NavigationBean) - */ - public String getStartLocation() - { - String location = (String)PreferencesService.getPreferences().getValue(PREF_STARTLOCATION); - - if (location == null) - { - // default to value from client config - location = Application.getClientConfig(FacesContext.getCurrentInstance()).getInitialLocation(); - } - return location; - } - - /** - * @param location The current start location for this user (@see NavigationBean) - */ - public void setStartLocation(String location) - { - PreferencesService.getPreferences().setValue(PREF_STARTLOCATION, location); - } - - /** - * @return the list of available start locations - */ - public SelectItem[] getStartLocations() - { - FacesContext fc = FacesContext.getCurrentInstance(); - NavigationBean navigator = (NavigationBean)FacesHelper.getManagedBean(fc, "NavigationBean"); - ResourceBundle msg = Application.getBundle(fc); - - List locations = new ArrayList(4); - - // add My Alfresco location - locations.add(new SelectItem( - NavigationBean.LOCATION_MYALFRESCO, msg.getString(NavigationBean.MSG_MYALFRESCO))); - - // add My Home location - locations.add(new SelectItem( - NavigationBean.LOCATION_HOME, msg.getString(NavigationBean.MSG_MYHOME))); - - // add Company Home location if visible - if (navigator.getCompanyHomeVisible()) - { - locations.add(new SelectItem( - NavigationBean.LOCATION_COMPANY, msg.getString(NavigationBean.MSG_COMPANYHOME))); - } - - // add Guest Home location if visible - if (navigator.getGuestHomeVisible()) - { - locations.add(new SelectItem( - NavigationBean.LOCATION_GUEST, msg.getString(NavigationBean.MSG_GUESTHOME))); - } - - return locations.toArray(new SelectItem[locations.size()]); - } - - /** - * @return true if the Guest user is allowed to configure the user preferences - */ - public boolean getAllowGuestConfig() - { - return Application.getClientConfig(FacesContext.getCurrentInstance()).getAllowGuestConfig(); - } - - /** - * @return the multilingualContentService - */ - public MultilingualContentService getMultilingualContentService() - { - if (multilingualContentService == null) - { - multilingualContentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getMultilingualContentService(); - } - - return multilingualContentService; - } - - /** - * @param multilingualContentService the multilingualContentService to set - */ - public void setMultilingualContentService( - MultilingualContentService multilingualContentService) - { - this.multilingualContentService = multilingualContentService; - } - - /** - * @return the nodeService - */ - public NodeService getNodeService() - { - if (nodeService == null) - { - nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - - return nodeService; - } - - /** - * @param nodeService the nodeService to set - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - /** - * @param contentFilterLanguagesService the contentFilterLanguagesService to set - */ - public void setContentFilterLanguagesService( - ContentFilterLanguagesService contentFilterLanguagesService) - { - this.contentFilterLanguagesService = contentFilterLanguagesService; - } - - /** - * @return the contentFilterLanguagesService - */ - ContentFilterLanguagesService getContentFilterLanguagesService() - { - if (contentFilterLanguagesService == null) - { - contentFilterLanguagesService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentFilterLanguagesService(); - } - return contentFilterLanguagesService; - } - - /** - * @return download files automatically for offline editing or not - */ - public boolean isDownloadAutomatically() - { - Boolean downloadAutomatically = (Boolean) PreferencesService.getPreferences().getValue(PREF_DOWNLOADAUTOMATICALLY); - if (downloadAutomatically == null) - { - return true; - } - else - { - return downloadAutomatically.booleanValue(); - } - } - - /** - * @param downloadAutomatically the boolean value to set - */ - public void setDownloadAutomatically(boolean downloadAutomatically) - { - PreferencesService.getPreferences().setValue(PREF_DOWNLOADAUTOMATICALLY, downloadAutomatically); - } -} +package org.alfresco.web.bean.users; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.ResourceBundle; + +import javax.faces.context.FacesContext; +import javax.faces.model.SelectItem; + +import org.alfresco.service.cmr.ml.ContentFilterLanguagesService; +import org.alfresco.service.cmr.ml.MultilingualContentService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.context.UIContextService; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.repository.PreferencesService; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.config.LanguagesConfigElement; +import org.springframework.extensions.config.Config; +import org.springframework.extensions.surf.util.I18NUtil; + +/** + * Simple bean backing the user preferences settings. + * + * @author Kevin Roast + */ +public class UserPreferencesBean implements Serializable +{ + private static final long serialVersionUID = -1262481849503163054L; + + public static final String PREF_INTERFACELANGUAGE = "interface-language"; + + private static final String PREF_STARTLOCATION = "start-location"; + private static final String PREF_CONTENTFILTERLANGUAGE = "content-filter-language"; + private static final String PREF_DOWNLOADAUTOMATICALLY = "download-automatically"; + + /** + * Remplacement message for set the filter at 'all languages'. + * Must be considered as a null value. + */ + public static final String MSG_CONTENTALLLANGUAGES = "content_all_languages"; + + /** content language locale selection */ + private String contentFilterLanguage = null; + + /** the injected MultilingualContentService */ + transient private MultilingualContentService multilingualContentService; + + /** the injected ContentFilterLanguagesService */ + transient private ContentFilterLanguagesService contentFilterLanguagesService; + + /** the injected NodeService */ + transient private NodeService nodeService; + + /** + * @return the list of available languages + */ + public SelectItem[] getLanguages() + { + // Get the item selection list for the list of languages + return getLanguageItems(); + } + + /** + * @return Returns the language selection for the current user session. + */ + public String getLanguage() + { + return Application.getLanguage(FacesContext.getCurrentInstance()).toString(); + } + + /** + * @param language The language selection to set. + */ + public void setLanguage(String language) + { + // set the language for the current session + Application.setLanguage(FacesContext.getCurrentInstance(), language); + + // save user preference + if (Application.getCurrentUser(FacesContext.getCurrentInstance()) != null) + { + PreferencesService.getPreferences().setValue(PREF_INTERFACELANGUAGE, language); + } + } + + /** + * @return current content filter language, or null if all languages was selected + */ + public String getContentFilterLanguage() + { + if (this.contentFilterLanguage == null) + { + Locale locale = (Locale) PreferencesService.getPreferences().getValue(PREF_CONTENTFILTERLANGUAGE); + + // Null means All Languages + if (locale == null) + { + this.contentFilterLanguage = null; + } + else + { + this.contentFilterLanguage = locale.toString(); + } + } + + // set the content filter locale on the core + I18NUtil.setContentLocale(I18NUtil.parseLocale(this.contentFilterLanguage)); + + return this.contentFilterLanguage; + } + + /** + * @param contentFilterLanguage A valid locale string or {@link #MSG_CONTENTALLLANGUAGES} + */ + public void setContentFilterLanguage(String contentFilterLanguage) + { + this.contentFilterLanguage = contentFilterLanguage; + Locale language = null; + if (contentFilterLanguage.equals(MSG_CONTENTALLLANGUAGES)) + { + // The generic "All Languages" was selected - persist this as a null + this.contentFilterLanguage = null; + } + else + { + // It should be a proper locale string + language = I18NUtil.parseLocale(contentFilterLanguage); + } + PreferencesService.getPreferences().setValue(PREF_CONTENTFILTERLANGUAGE, language); + + // set the content filter locale on the core + I18NUtil.setContentLocale(language); + + // Ensure a refresh + UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); + } + + /** + * @return list of items for the content filtering language selection include the label 'all langaguages' + */ + public SelectItem[] getContentFilterLanguages() + { + // Get the item selection list + return getContentFilterLanguages(true); + } + + /** + * @param includeAllLanguages if true, the list must include the label 'all languages' + * @return list of items for the content filtering language selection + */ + public SelectItem[] getContentFilterLanguages(boolean includeAllLanguages) + { + FacesContext fc = FacesContext.getCurrentInstance(); + ResourceBundle msg = Application.getBundle(fc); + + // get the list of filter languages + List languages = getContentFilterLanguagesService().getFilterLanguages(); + + // set the item selection list + SelectItem[] items = new SelectItem[(includeAllLanguages) ? languages.size() + 1 : languages.size()]; + int idx = 0; + + // include the item if needed + if (includeAllLanguages) + { + String allLanguagesStr = msg.getString(MSG_CONTENTALLLANGUAGES); + items[idx] = new SelectItem(MSG_CONTENTALLLANGUAGES, allLanguagesStr); + idx++; + } + + for (String lang : languages) + { + String label = getContentFilterLanguagesService().getLabelByCode(lang); + items[idx] = new SelectItem(lang, label); + idx++; + } + + return items; + } + + /** + * return the list of languages in which the given node hasn't be translated yet. + * + * @param translation the translatable node ref + * @param returnTranslationLanguage if true, return the language of the given translation. + * @return the list of languages + */ + public SelectItem[] getAvailablesContentFilterLanguages(NodeRef translation, boolean returnTranslationLanguage) + { + // get the list of missing translation of this node + List missingLocales = getMultilingualContentService().getMissingTranslations(translation, returnTranslationLanguage); + + // set the item selection list + SelectItem[] items = new SelectItem[missingLocales.size()]; + int idx = 0; + + for(Locale locale : missingLocales) + { + String label = getContentFilterLanguagesService().getLabelByCode(locale.getLanguage()); + + items[idx] = new SelectItem( + locale.toString(), + label); + idx++; + } + + return items; + } + + /** + * Helper to return the available language items + * + * @return Array of SelectItem objects + */ + private static SelectItem[] getLanguageItems() + { + FacesContext fc = FacesContext.getCurrentInstance(); + Config config = Application.getConfigService(fc).getConfig("Languages"); + LanguagesConfigElement langConfig = (LanguagesConfigElement)config.getConfigElement( + LanguagesConfigElement.CONFIG_ELEMENT_ID); + + List languages = langConfig.getLanguages(); + List items = new ArrayList(10); + + for (String locale : languages) + { + // get label associated to the locale + String label = langConfig.getLabelForLanguage(locale); + items.add(new SelectItem(locale, label)); + } + + return items.toArray(new SelectItem[items.size()]); + } + + /** + * @return the start location for this user (@see NavigationBean) + */ + public String getStartLocation() + { + String location = (String)PreferencesService.getPreferences().getValue(PREF_STARTLOCATION); + + if (location == null) + { + // default to value from client config + location = Application.getClientConfig(FacesContext.getCurrentInstance()).getInitialLocation(); + } + return location; + } + + /** + * @param location The current start location for this user (@see NavigationBean) + */ + public void setStartLocation(String location) + { + PreferencesService.getPreferences().setValue(PREF_STARTLOCATION, location); + } + + /** + * @return the list of available start locations + */ + public SelectItem[] getStartLocations() + { + FacesContext fc = FacesContext.getCurrentInstance(); + NavigationBean navigator = (NavigationBean)FacesHelper.getManagedBean(fc, "NavigationBean"); + ResourceBundle msg = Application.getBundle(fc); + + List locations = new ArrayList(4); + + // add My Alfresco location + locations.add(new SelectItem( + NavigationBean.LOCATION_MYALFRESCO, msg.getString(NavigationBean.MSG_MYALFRESCO))); + + // add My Home location + locations.add(new SelectItem( + NavigationBean.LOCATION_HOME, msg.getString(NavigationBean.MSG_MYHOME))); + + // add Company Home location if visible + if (navigator.getCompanyHomeVisible()) + { + locations.add(new SelectItem( + NavigationBean.LOCATION_COMPANY, msg.getString(NavigationBean.MSG_COMPANYHOME))); + } + + // add Guest Home location if visible + if (navigator.getGuestHomeVisible()) + { + locations.add(new SelectItem( + NavigationBean.LOCATION_GUEST, msg.getString(NavigationBean.MSG_GUESTHOME))); + } + + return locations.toArray(new SelectItem[locations.size()]); + } + + /** + * @return true if the Guest user is allowed to configure the user preferences + */ + public boolean getAllowGuestConfig() + { + return Application.getClientConfig(FacesContext.getCurrentInstance()).getAllowGuestConfig(); + } + + /** + * @return the multilingualContentService + */ + public MultilingualContentService getMultilingualContentService() + { + if (multilingualContentService == null) + { + multilingualContentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getMultilingualContentService(); + } + + return multilingualContentService; + } + + /** + * @param multilingualContentService the multilingualContentService to set + */ + public void setMultilingualContentService( + MultilingualContentService multilingualContentService) + { + this.multilingualContentService = multilingualContentService; + } + + /** + * @return the nodeService + */ + public NodeService getNodeService() + { + if (nodeService == null) + { + nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + + return nodeService; + } + + /** + * @param nodeService the nodeService to set + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + /** + * @param contentFilterLanguagesService the contentFilterLanguagesService to set + */ + public void setContentFilterLanguagesService( + ContentFilterLanguagesService contentFilterLanguagesService) + { + this.contentFilterLanguagesService = contentFilterLanguagesService; + } + + /** + * @return the contentFilterLanguagesService + */ + ContentFilterLanguagesService getContentFilterLanguagesService() + { + if (contentFilterLanguagesService == null) + { + contentFilterLanguagesService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentFilterLanguagesService(); + } + return contentFilterLanguagesService; + } + + /** + * @return download files automatically for offline editing or not + */ + public boolean isDownloadAutomatically() + { + Boolean downloadAutomatically = (Boolean) PreferencesService.getPreferences().getValue(PREF_DOWNLOADAUTOMATICALLY); + if (downloadAutomatically == null) + { + return true; + } + else + { + return downloadAutomatically.booleanValue(); + } + } + + /** + * @param downloadAutomatically the boolean value to set + */ + public void setDownloadAutomatically(boolean downloadAutomatically) + { + PreferencesService.getPreferences().setValue(PREF_DOWNLOADAUTOMATICALLY, downloadAutomatically); + } +} diff --git a/source/java/org/alfresco/web/bean/users/UsersBeanProperties.java b/source/java/org/alfresco/web/bean/users/UsersBeanProperties.java index c517e16526..84f60dedae 100644 --- a/source/java/org/alfresco/web/bean/users/UsersBeanProperties.java +++ b/source/java/org/alfresco/web/bean/users/UsersBeanProperties.java @@ -1,470 +1,470 @@ -package org.alfresco.web.bean.users; - -import java.io.Serializable; -import java.util.Collection; -import java.util.List; -import java.util.Map; -import java.util.Set; - -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.security.sync.UserRegistrySynchronizer; -import org.alfresco.repo.transaction.RetryingTransactionHelper; -import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; -import org.alfresco.service.cmr.repository.AssociationRef; -import org.alfresco.service.cmr.repository.ContentReader; -import org.alfresco.service.cmr.repository.ContentService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.search.SearchService; -import org.alfresco.service.cmr.security.MutableAuthenticationService; -import org.alfresco.service.cmr.security.PersonService; -import org.alfresco.service.cmr.usage.ContentUsageService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.servlet.DownloadContentServlet; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.ReportedException; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.data.UIRichList; -import org.springframework.web.jsf.FacesContextUtils; - -/** - * Bean holding the properties for a Person node. - * - * Used by the Create/EditUserWizard, UsersDialog and EditUserDetailsDetails to maitain user state during dialog. - * - * Also provides access to a map of the properties to mutability which is used to disable appropriate controls on edit - * dialogs if properties are externally mapped to LDAP or similar. - */ -public class UsersBeanProperties implements Serializable -{ - private static final long serialVersionUID = 8874192805959149144L; - - /** NodeService bean reference */ - transient private NodeService nodeService; - - /** SearchService bean reference */ - transient private SearchService searchService; - - /** AuthenticationService bean reference */ - transient private MutableAuthenticationService authenticationService; - - /** PersonService bean reference */ - transient private PersonService personService; - - /** ContentUsageService bean reference */ - transient private ContentUsageService contentUsageService; - - /** userRegistrySynchronizer bean reference */ - transient private UserRegistrySynchronizer userRegistrySynchronizer; - - /** Component reference for Users RichList control */ - private UIRichList usersRichList; - - /** action context */ - private Node person = null; - private String password = null; - private String oldPassword = null; - private String confirm = null; - private String searchCriteria = null; - private String userName = null; - private Map immutabilty = null; - - - // ------------------------------------------------------------------------------ - // Bean property getters and setters - - /** - * @return the nodeService - */ - public NodeService getNodeService() - { - if (nodeService == null) - { - nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return nodeService; - } - - /** - * @return the searchService - */ - public SearchService getSearchService() - { - if (searchService == null) - { - searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); - } - return searchService; - } - - /** - * @return the authenticationService - */ - public MutableAuthenticationService getAuthenticationService() - { - if (authenticationService == null) - { - authenticationService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthenticationService(); - } - return authenticationService; - } - - /** - * @return the personService - */ - public PersonService getPersonService() - { - if (personService == null) - { - personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); - } - return personService; - } - - /** - * @return contentUsageService - */ - public ContentUsageService getContentUsageService() - { - if (contentUsageService == null) - { - contentUsageService = (ContentUsageService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "ContentUsageService"); - } - return contentUsageService; - } - - /** - * @return userRegistrySynchronizer - */ - public UserRegistrySynchronizer getUserRegistrySynchronizer() - { - if (userRegistrySynchronizer == null) - { - userRegistrySynchronizer = (UserRegistrySynchronizer)FacesContextUtils.getRequiredWebApplicationContext( - FacesContext.getCurrentInstance()).getBean("userRegistrySynchronizer"); - } - return userRegistrySynchronizer; - } - - /** - * @param nodeService The NodeService to set. - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - /** - * @param searchService the search service - */ - public void setSearchService(SearchService searchService) - { - this.searchService = searchService; - } - - /** - * @param authenticationService The AuthenticationService to set. - */ - public void setAuthenticationService(MutableAuthenticationService authenticationService) - { - this.authenticationService = authenticationService; - } - - /** - * @param personService The PersonService to set. - */ - public void setPersonService(PersonService personService) - { - this.personService = personService; - } - - /** - * @param contentUsageService The ContentUsageService to set. - */ - public void setContentUsageService(ContentUsageService contentUsageService) - { - this.contentUsageService = contentUsageService; - } - - /** - * @param userRegistrySynchronizer UserRegistrySynchronizer - */ - public void setUserRegistrySynchronizer(UserRegistrySynchronizer userRegistrySynchronizer) - { - this.userRegistrySynchronizer = userRegistrySynchronizer; - } - - /** - * @return Returns the usersRichList. - */ - public UIRichList getUsersRichList() - { - return this.usersRichList; - } - - /** - * @param usersRichList The usersRichList to set. - */ - public void setUsersRichList(UIRichList usersRichList) - { - this.usersRichList = usersRichList; - } - - /** - * @return Returns the search criteria - */ - public String getSearchCriteria() - { - return searchCriteria; - } - - /** - * @param searchCriteria The search criteria to select - */ - public void setSearchCriteria(String searchCriteria) - { - this.searchCriteria = searchCriteria; - } - - /** - * @return Returns the confirm password. - */ - public String getConfirm() - { - return this.confirm; - } - - /** - * @param confirm The confirm password to set. - */ - public void setConfirm(String confirm) - { - this.confirm = confirm; - } - - /** - * @return Returns the password. - */ - public String getPassword() - { - return this.password; - } - - /** - * @param password The password to set. - */ - public void setPassword(String password) - { - this.password = password; - } - - /** - * @return Returns the old password. - */ - public String getOldPassword() - { - return this.oldPassword; - } - - /** - * @param oldPassword The old password to set. - */ - public void setOldPassword(String oldPassword) - { - this.oldPassword = oldPassword; - } - - /** - * @return Returns the person context. - */ - public Node getPerson() - { - return this.person; - } - - /** - * @param p The person context to set. - */ - public void setPerson(final Node p) - { - // perform the set in a txn as certain bean calls require it - FacesContext context = FacesContext.getCurrentInstance(); - RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Object execute() throws Throwable - { - person = p; - userName = (String)person.getProperties().get(ContentModel.PROP_USERNAME); - - // rebuild the property immutability map helper object - immutabilty = new PropertyImmutabilityMap( - getUserRegistrySynchronizer().getPersonMappedProperties(userName)); - - return null; - } - }; - try - { - txnHelper.doInTransaction(callback, false); - } - catch (Throwable e) - { - // reset the flag so we can re-attempt the operation - if (e instanceof ReportedException == false) - { - Utils.addErrorMessage(e.getMessage(), e); - } - ReportedException.throwIfNecessary(e); - } - } - - public Long getUserUsage(String userName) - { - long usage = getContentUsageService().getUserUsage(userName); - return (usage == -1 ? null : usage); - } - - public Long getUserUsage() - { - long usage = getContentUsageService().getUserUsage(this.userName); - return (usage == -1 ? null : usage); - } - - public Long getUserQuota() - { - long quota = getContentUsageService().getUserQuota(this.userName); - return (quota == -1 ? null : quota); - } - - public boolean getUsagesEnabled() - { - return getContentUsageService().getEnabled(); - } - - public String getPersonDescription() - { - ContentService cs = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); - ContentReader reader = cs.getReader(this.person.getNodeRef(), ContentModel.PROP_PERSONDESC); - if (reader != null && reader.exists()) - { - return Utils.stripUnsafeHTMLTags(reader.getContentString()).replace("\r\n", "

"); - } - else - { - return null; - } - } - - public String getAvatarUrl() - { - String avatarUrl = null; - - List refs = getNodeService().getTargetAssocs(this.person.getNodeRef(), ContentModel.ASSOC_AVATAR); - if (refs.size() == 1) - { - NodeRef photoRef = refs.get(0).getTargetRef(); - String name = (String) getNodeService().getProperty(photoRef, ContentModel.PROP_NAME); - avatarUrl = DownloadContentServlet.generateBrowserURL(photoRef, name); - } - - return avatarUrl; - } - - public Map getImmutability() - { - return this.immutabilty; - } - - /** - * Map of person property to immutability - * The Map interface is implemented to allow JSF expressions such as - * #{DialogBean.bean.properties.immutability.propertyname} - */ - public class PropertyImmutabilityMap implements Map, Serializable - { - final private Set props; - - PropertyImmutabilityMap(Set props) - { - this.props = props; - } - - public void clear() - { - } - - public boolean containsKey(Object k) - { - boolean contains = false; - if (k instanceof String && ((String)k).length() != 0) - { - String s = (String)k; - if (s.charAt(0) == '{' && s.indexOf('}') != -1) - { - contains = this.props.contains(k); - } - else - { - // simple property name - assume and apply CM namespace - contains = this.props.contains(QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, s)); - } - } - return contains; - } - - public boolean containsValue(Object v) - { - return false; - } - - public Set> entrySet() - { - return null; - } - - public Boolean get(Object k) - { - return containsKey(k); - } - - public boolean isEmpty() - { - return this.props.size() != 0; - } - - public Set keySet() - { - return null; - } - - public Boolean put(String k, Boolean v) - { - return null; - } - - public void putAll(Map m) - { - } - - public Boolean remove(Object k) - { - return null; - } - - public int size() - { - return this.props.size(); - } - - public Collection values() - { - return null; - } - } -} +package org.alfresco.web.bean.users; + +import java.io.Serializable; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.security.sync.UserRegistrySynchronizer; +import org.alfresco.repo.transaction.RetryingTransactionHelper; +import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; +import org.alfresco.service.cmr.repository.AssociationRef; +import org.alfresco.service.cmr.repository.ContentReader; +import org.alfresco.service.cmr.repository.ContentService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.search.SearchService; +import org.alfresco.service.cmr.security.MutableAuthenticationService; +import org.alfresco.service.cmr.security.PersonService; +import org.alfresco.service.cmr.usage.ContentUsageService; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.servlet.DownloadContentServlet; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.ReportedException; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.data.UIRichList; +import org.springframework.web.jsf.FacesContextUtils; + +/** + * Bean holding the properties for a Person node. + * + * Used by the Create/EditUserWizard, UsersDialog and EditUserDetailsDetails to maitain user state during dialog. + * + * Also provides access to a map of the properties to mutability which is used to disable appropriate controls on edit + * dialogs if properties are externally mapped to LDAP or similar. + */ +public class UsersBeanProperties implements Serializable +{ + private static final long serialVersionUID = 8874192805959149144L; + + /** NodeService bean reference */ + transient private NodeService nodeService; + + /** SearchService bean reference */ + transient private SearchService searchService; + + /** AuthenticationService bean reference */ + transient private MutableAuthenticationService authenticationService; + + /** PersonService bean reference */ + transient private PersonService personService; + + /** ContentUsageService bean reference */ + transient private ContentUsageService contentUsageService; + + /** userRegistrySynchronizer bean reference */ + transient private UserRegistrySynchronizer userRegistrySynchronizer; + + /** Component reference for Users RichList control */ + private UIRichList usersRichList; + + /** action context */ + private Node person = null; + private String password = null; + private String oldPassword = null; + private String confirm = null; + private String searchCriteria = null; + private String userName = null; + private Map immutabilty = null; + + + // ------------------------------------------------------------------------------ + // Bean property getters and setters + + /** + * @return the nodeService + */ + public NodeService getNodeService() + { + if (nodeService == null) + { + nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return nodeService; + } + + /** + * @return the searchService + */ + public SearchService getSearchService() + { + if (searchService == null) + { + searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService(); + } + return searchService; + } + + /** + * @return the authenticationService + */ + public MutableAuthenticationService getAuthenticationService() + { + if (authenticationService == null) + { + authenticationService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getAuthenticationService(); + } + return authenticationService; + } + + /** + * @return the personService + */ + public PersonService getPersonService() + { + if (personService == null) + { + personService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getPersonService(); + } + return personService; + } + + /** + * @return contentUsageService + */ + public ContentUsageService getContentUsageService() + { + if (contentUsageService == null) + { + contentUsageService = (ContentUsageService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "ContentUsageService"); + } + return contentUsageService; + } + + /** + * @return userRegistrySynchronizer + */ + public UserRegistrySynchronizer getUserRegistrySynchronizer() + { + if (userRegistrySynchronizer == null) + { + userRegistrySynchronizer = (UserRegistrySynchronizer)FacesContextUtils.getRequiredWebApplicationContext( + FacesContext.getCurrentInstance()).getBean("userRegistrySynchronizer"); + } + return userRegistrySynchronizer; + } + + /** + * @param nodeService The NodeService to set. + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + /** + * @param searchService the search service + */ + public void setSearchService(SearchService searchService) + { + this.searchService = searchService; + } + + /** + * @param authenticationService The AuthenticationService to set. + */ + public void setAuthenticationService(MutableAuthenticationService authenticationService) + { + this.authenticationService = authenticationService; + } + + /** + * @param personService The PersonService to set. + */ + public void setPersonService(PersonService personService) + { + this.personService = personService; + } + + /** + * @param contentUsageService The ContentUsageService to set. + */ + public void setContentUsageService(ContentUsageService contentUsageService) + { + this.contentUsageService = contentUsageService; + } + + /** + * @param userRegistrySynchronizer UserRegistrySynchronizer + */ + public void setUserRegistrySynchronizer(UserRegistrySynchronizer userRegistrySynchronizer) + { + this.userRegistrySynchronizer = userRegistrySynchronizer; + } + + /** + * @return Returns the usersRichList. + */ + public UIRichList getUsersRichList() + { + return this.usersRichList; + } + + /** + * @param usersRichList The usersRichList to set. + */ + public void setUsersRichList(UIRichList usersRichList) + { + this.usersRichList = usersRichList; + } + + /** + * @return Returns the search criteria + */ + public String getSearchCriteria() + { + return searchCriteria; + } + + /** + * @param searchCriteria The search criteria to select + */ + public void setSearchCriteria(String searchCriteria) + { + this.searchCriteria = searchCriteria; + } + + /** + * @return Returns the confirm password. + */ + public String getConfirm() + { + return this.confirm; + } + + /** + * @param confirm The confirm password to set. + */ + public void setConfirm(String confirm) + { + this.confirm = confirm; + } + + /** + * @return Returns the password. + */ + public String getPassword() + { + return this.password; + } + + /** + * @param password The password to set. + */ + public void setPassword(String password) + { + this.password = password; + } + + /** + * @return Returns the old password. + */ + public String getOldPassword() + { + return this.oldPassword; + } + + /** + * @param oldPassword The old password to set. + */ + public void setOldPassword(String oldPassword) + { + this.oldPassword = oldPassword; + } + + /** + * @return Returns the person context. + */ + public Node getPerson() + { + return this.person; + } + + /** + * @param p The person context to set. + */ + public void setPerson(final Node p) + { + // perform the set in a txn as certain bean calls require it + FacesContext context = FacesContext.getCurrentInstance(); + RetryingTransactionHelper txnHelper = Repository.getRetryingTransactionHelper(context); + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Object execute() throws Throwable + { + person = p; + userName = (String)person.getProperties().get(ContentModel.PROP_USERNAME); + + // rebuild the property immutability map helper object + immutabilty = new PropertyImmutabilityMap( + getUserRegistrySynchronizer().getPersonMappedProperties(userName)); + + return null; + } + }; + try + { + txnHelper.doInTransaction(callback, false); + } + catch (Throwable e) + { + // reset the flag so we can re-attempt the operation + if (e instanceof ReportedException == false) + { + Utils.addErrorMessage(e.getMessage(), e); + } + ReportedException.throwIfNecessary(e); + } + } + + public Long getUserUsage(String userName) + { + long usage = getContentUsageService().getUserUsage(userName); + return (usage == -1 ? null : usage); + } + + public Long getUserUsage() + { + long usage = getContentUsageService().getUserUsage(this.userName); + return (usage == -1 ? null : usage); + } + + public Long getUserQuota() + { + long quota = getContentUsageService().getUserQuota(this.userName); + return (quota == -1 ? null : quota); + } + + public boolean getUsagesEnabled() + { + return getContentUsageService().getEnabled(); + } + + public String getPersonDescription() + { + ContentService cs = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService(); + ContentReader reader = cs.getReader(this.person.getNodeRef(), ContentModel.PROP_PERSONDESC); + if (reader != null && reader.exists()) + { + return Utils.stripUnsafeHTMLTags(reader.getContentString()).replace("\r\n", "

"); + } + else + { + return null; + } + } + + public String getAvatarUrl() + { + String avatarUrl = null; + + List refs = getNodeService().getTargetAssocs(this.person.getNodeRef(), ContentModel.ASSOC_AVATAR); + if (refs.size() == 1) + { + NodeRef photoRef = refs.get(0).getTargetRef(); + String name = (String) getNodeService().getProperty(photoRef, ContentModel.PROP_NAME); + avatarUrl = DownloadContentServlet.generateBrowserURL(photoRef, name); + } + + return avatarUrl; + } + + public Map getImmutability() + { + return this.immutabilty; + } + + /** + * Map of person property to immutability + * The Map interface is implemented to allow JSF expressions such as + * #{DialogBean.bean.properties.immutability.propertyname} + */ + public class PropertyImmutabilityMap implements Map, Serializable + { + final private Set props; + + PropertyImmutabilityMap(Set props) + { + this.props = props; + } + + public void clear() + { + } + + public boolean containsKey(Object k) + { + boolean contains = false; + if (k instanceof String && ((String)k).length() != 0) + { + String s = (String)k; + if (s.charAt(0) == '{' && s.indexOf('}') != -1) + { + contains = this.props.contains(k); + } + else + { + // simple property name - assume and apply CM namespace + contains = this.props.contains(QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, s)); + } + } + return contains; + } + + public boolean containsValue(Object v) + { + return false; + } + + public Set> entrySet() + { + return null; + } + + public Boolean get(Object k) + { + return containsKey(k); + } + + public boolean isEmpty() + { + return this.props.size() != 0; + } + + public Set keySet() + { + return null; + } + + public Boolean put(String k, Boolean v) + { + return null; + } + + public void putAll(Map m) + { + } + + public Boolean remove(Object k) + { + return null; + } + + public int size() + { + return this.props.size(); + } + + public Collection values() + { + return null; + } + } +} diff --git a/source/java/org/alfresco/web/bean/wizard/BaseWizardBean.java b/source/java/org/alfresco/web/bean/wizard/BaseWizardBean.java index 10b23e81a4..87e7de9c39 100644 --- a/source/java/org/alfresco/web/bean/wizard/BaseWizardBean.java +++ b/source/java/org/alfresco/web/bean/wizard/BaseWizardBean.java @@ -1,117 +1,117 @@ -package org.alfresco.web.bean.wizard; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.ui.common.Utils; - -/** - * Base class for all wizard beans providing common functionality - * - * @author gavinc - */ -public abstract class BaseWizardBean extends BaseDialogBean implements IWizardBean -{ - private static final String MSG_NOT_SET = "value_not_set"; - - public String next() - { - if (isFinished()) - { - Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), - "error_wizard_completed_already")); - } - - return null; - } - - public String back() - { - if (isFinished()) - { - Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), - "error_wizard_completed_already")); - } - - return null; - } - - public boolean getNextButtonDisabled() - { - return false; - } - - public String getNextButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "next_button"); - } - - public String getBackButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "back_button"); - } - - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "finish_button"); - } - - public String getStepTitle() - { - return null; - } - - public String getStepDescription() - { - return null; - } - - /** - * Build summary table from the specified list of Labels and Values - * - * @param labels Array of labels to display - * @param values Array of values to display - * - * @return summary table HTML - */ - protected String buildSummary(String[] labels, String[] values) - { - if (labels == null || values == null || labels.length != values.length) - { - throw new IllegalArgumentException("Labels and Values passed to summary must be valid and of equal length."); - } - - String msg = Application.getMessage(FacesContext.getCurrentInstance(), MSG_NOT_SET); - String notSetMsg = "<" + msg + ">"; - - StringBuilder buf = new StringBuilder(512); - - buf.append(""); - for (int i=0; i"); - } - buf.append("
"); - buf.append(labels[i]); - buf.append(":"); - buf.append(value != null ? value : notSetMsg); - buf.append("
"); - - return buf.toString(); - } - - @Override - protected String getDefaultCancelOutcome() - { - return AlfrescoNavigationHandler.CLOSE_WIZARD_OUTCOME; - } - - @Override - protected String getDefaultFinishOutcome() - { - return AlfrescoNavigationHandler.CLOSE_WIZARD_OUTCOME; - } -} +package org.alfresco.web.bean.wizard; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.ui.common.Utils; + +/** + * Base class for all wizard beans providing common functionality + * + * @author gavinc + */ +public abstract class BaseWizardBean extends BaseDialogBean implements IWizardBean +{ + private static final String MSG_NOT_SET = "value_not_set"; + + public String next() + { + if (isFinished()) + { + Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), + "error_wizard_completed_already")); + } + + return null; + } + + public String back() + { + if (isFinished()) + { + Utils.addErrorMessage(Application.getMessage(FacesContext.getCurrentInstance(), + "error_wizard_completed_already")); + } + + return null; + } + + public boolean getNextButtonDisabled() + { + return false; + } + + public String getNextButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "next_button"); + } + + public String getBackButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "back_button"); + } + + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "finish_button"); + } + + public String getStepTitle() + { + return null; + } + + public String getStepDescription() + { + return null; + } + + /** + * Build summary table from the specified list of Labels and Values + * + * @param labels Array of labels to display + * @param values Array of values to display + * + * @return summary table HTML + */ + protected String buildSummary(String[] labels, String[] values) + { + if (labels == null || values == null || labels.length != values.length) + { + throw new IllegalArgumentException("Labels and Values passed to summary must be valid and of equal length."); + } + + String msg = Application.getMessage(FacesContext.getCurrentInstance(), MSG_NOT_SET); + String notSetMsg = "<" + msg + ">"; + + StringBuilder buf = new StringBuilder(512); + + buf.append(""); + for (int i=0; i"); + } + buf.append("
"); + buf.append(labels[i]); + buf.append(":"); + buf.append(value != null ? value : notSetMsg); + buf.append("
"); + + return buf.toString(); + } + + @Override + protected String getDefaultCancelOutcome() + { + return AlfrescoNavigationHandler.CLOSE_WIZARD_OUTCOME; + } + + @Override + protected String getDefaultFinishOutcome() + { + return AlfrescoNavigationHandler.CLOSE_WIZARD_OUTCOME; + } +} diff --git a/source/java/org/alfresco/web/bean/wizard/IWizardBean.java b/source/java/org/alfresco/web/bean/wizard/IWizardBean.java index 6c38cf08ed..c99141a19b 100644 --- a/source/java/org/alfresco/web/bean/wizard/IWizardBean.java +++ b/source/java/org/alfresco/web/bean/wizard/IWizardBean.java @@ -1,64 +1,64 @@ -package org.alfresco.web.bean.wizard; - -import org.alfresco.web.bean.dialog.IDialogBean; - -/** - * Interface that defines the contract for a wizard backing bean - * - * @author gavinc - */ -public interface IWizardBean extends IDialogBean -{ - /** - * Called when the next button is pressed by the user - * - * @return Reserved for future use - */ - public String next(); - - /** - * Called when the back button is pressed by the user - * - * @return Reserved for future use - */ - public String back(); - - /** - * Returns the label to use for the next button - * - * @return The next button label - */ - public String getNextButtonLabel(); - - /** - * Returns the label to use for the back button - * - * @return The back button label - */ - public String getBackButtonLabel(); - - /** - * Determines whether the next button on the wizard should be disabled - * - * @return true if the button should be disabled - */ - public boolean getNextButtonDisabled(); - - /** - * Returns the title to be used for the current step - *

If this returns null the WizardManager will - * lookup the title via the dialog configuration

- * - * @return The title or null if the title is to be acquired via configuration - */ - public String getStepTitle(); - - /** - * Returns the description to be used for the current step - *

If this returns null the WizardManager will - * lookup the description via the dialog configuration

- * - * @return The decsription or null if the title is to be acquired via configuration - */ - public String getStepDescription(); -} +package org.alfresco.web.bean.wizard; + +import org.alfresco.web.bean.dialog.IDialogBean; + +/** + * Interface that defines the contract for a wizard backing bean + * + * @author gavinc + */ +public interface IWizardBean extends IDialogBean +{ + /** + * Called when the next button is pressed by the user + * + * @return Reserved for future use + */ + public String next(); + + /** + * Called when the back button is pressed by the user + * + * @return Reserved for future use + */ + public String back(); + + /** + * Returns the label to use for the next button + * + * @return The next button label + */ + public String getNextButtonLabel(); + + /** + * Returns the label to use for the back button + * + * @return The back button label + */ + public String getBackButtonLabel(); + + /** + * Determines whether the next button on the wizard should be disabled + * + * @return true if the button should be disabled + */ + public boolean getNextButtonDisabled(); + + /** + * Returns the title to be used for the current step + *

If this returns null the WizardManager will + * lookup the title via the dialog configuration

+ * + * @return The title or null if the title is to be acquired via configuration + */ + public String getStepTitle(); + + /** + * Returns the description to be used for the current step + *

If this returns null the WizardManager will + * lookup the description via the dialog configuration

+ * + * @return The decsription or null if the title is to be acquired via configuration + */ + public String getStepDescription(); +} diff --git a/source/java/org/alfresco/web/bean/wizard/WizardManager.java b/source/java/org/alfresco/web/bean/wizard/WizardManager.java index 07d6c97b44..3167f5d299 100644 --- a/source/java/org/alfresco/web/bean/wizard/WizardManager.java +++ b/source/java/org/alfresco/web/bean/wizard/WizardManager.java @@ -1,645 +1,645 @@ -package org.alfresco.web.bean.wizard; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.el.ValueBinding; -import javax.faces.event.ActionEvent; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.config.WizardsConfigElement.ConditionalPageConfig; -import org.alfresco.web.config.WizardsConfigElement.PageConfig; -import org.alfresco.web.config.WizardsConfigElement.StepConfig; -import org.alfresco.web.config.WizardsConfigElement.WizardConfig; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.alfresco.web.ui.common.component.UIListItem; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean that manages the wizard framework - * - * @author gavinc - */ -public final class WizardManager implements Serializable -{ - private static final long serialVersionUID = -5029787339914973070L; - - /** public JSF bean name */ - public final static String BEAN_NAME = "WizardManager"; - - private static Log logger = LogFactory.getLog(WizardManager.class); - - private WizardState currentWizardState; - private Map paramsToApply; - - /** - * Sets the parameters the next wizard will initialise with - * - * @param params The parameters - */ - public void setupParameters(Map params) - { - this.paramsToApply = params; - } - - /** - * Action handler used to setup parameters for the wizard being launched - * - * @param event The event containing the parameters - */ - public void setupParameters(ActionEvent event) - { - // check the component the event come from was an action link - UIComponent component = event.getComponent(); - if (component instanceof UIActionLink) - { - // store the parameters - this.paramsToApply = ((UIActionLink)component).getParameterMap(); - - // make sure "null" parameters are actually null, this can occur - // when null parameters are sent to the client and posted back - for (String name : this.paramsToApply.keySet()) - { - String value = this.paramsToApply.get(name); - if (value != null && value.equalsIgnoreCase("null")) - { - this.paramsToApply.put(name, null); - } - } - } - } - - /** - * Sets the current wizard - * - * @param config The configuration for the wizard to set - */ - public void setCurrentWizard(WizardConfig config) - { - // make sure the managed bean is present - String beanName = config.getManagedBean(); - - Object bean = FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), beanName); - - if (bean == null) - { - throw new AlfrescoRuntimeException("Failed to start wizard as managed bean '" + beanName + - "' has not been defined"); - } - - // make sure the bean implements the IWizardBean interface - IWizardBean wizard = null; - if (bean instanceof IWizardBean) - { - wizard = (IWizardBean)bean; - } - else - { - throw new AlfrescoRuntimeException("Failed to start wizard as managed bean '" + beanName + - "' does not implement the required IWizardBean interface"); - } - - // create the WizardState object - this.currentWizardState = new WizardState(config, wizard); - - // initialise the managed bean - wizard.init(this.paramsToApply); - - // reset the current parameters so subsequent wizards don't get them - this.paramsToApply = null; - - // setup the first step - determineCurrentPage(); - } - - /** - * Returns the state of the currently active wizard - * - * @return Current wizard's state - */ - public WizardState getState() - { - return this.currentWizardState; - } - - /** - * Restores the wizard represented by the given WizardState object. - * NOTE: The wizard's restored() method is also called during this - * method. - * - * @param state The WizardState for the wizard to restore - */ - public void restoreState(WizardState state) - { - this.currentWizardState = state; - - // retrieve the wizard and call it's restored() method - this.currentWizardState.getWizard().restored(); - } - - /** - * Returns the config for the current wizard - * - * @return The current wizard config - */ - public WizardConfig getCurrentWizard() - { - return this.currentWizardState.getConfig(); - } - - /** - * Returns the current wizard bean being managed - * - * @return The current managed bean - */ - public IWizardBean getBean() - { - return this.currentWizardState.getWizard(); - } - - /** - * Returns the icon to use for the current wizard - * - * @return The icon - */ - public String getIcon() - { - return this.currentWizardState.getConfig().getIcon(); - } - - /** - * Returns the error message to use in error conditions - * - * @return The error message - */ - public String getErrorMessage() - { - return Application.getMessage(FacesContext.getCurrentInstance(), - this.currentWizardState.getConfig().getErrorMessageId()); - } - - /** - * Returns the resolved title to use for the wizard - * - * @return The title - */ - public String getTitle() - { - // try and get the title directly from the wizard - String title = this.currentWizardState.getWizard().getContainerTitle(); - - if (title == null) - { - // try and get the title via a message bundle key - title = this.currentWizardState.getConfig().getTitleId(); - - if (title != null) - { - title = Application.getMessage(FacesContext.getCurrentInstance(), title); - } - else - { - // try and get the title from the configuration - title = this.currentWizardState.getConfig().getTitle(); - } - } - - return title; - } - - /** - * Returns the resolved subtitle to use for the wizard - * - * @return The subtitle - */ - public String getSubTitle() - { - // try and get the title directly from the wizard - String subTitle = this.currentWizardState.getWizard().getContainerSubTitle(); - - if (subTitle == null) - { - // try and get the title via a message bundle key - subTitle = this.currentWizardState.getConfig().getSubTitleId(); - - if (subTitle != null) - { - subTitle = Application.getMessage(FacesContext.getCurrentInstance(), subTitle); - } - else - { - // try and get the title from the configuration - subTitle = this.currentWizardState.getConfig().getSubTitle(); - } - } - - return subTitle; - } - - /** - * Returns the resolved description to use for the wizard - * - * @return The description - */ - public String getDescription() - { - // try and get the description directly from the dialog - String desc = this.currentWizardState.getWizard().getContainerDescription(); - if (desc == null) - { - // try and get the description via a message bundle key - desc = this.currentWizardState.getConfig().getDescriptionId(); - - if (desc != null) - { - desc = Application.getMessage(FacesContext.getCurrentInstance(), desc); - } - else - { - // try and get the description from the configuration - desc = this.currentWizardState.getConfig().getDescription(); - } - } - - return desc; - } - - /** - * Returns the current step position - * - * @return Current step position - */ - public int getCurrentStep() - { - return this.currentWizardState.getCurrentStep(); - } - - /** - * Returns the current step position as a string for use in the UI - * - * @return Current step position as a string - */ - public String getCurrentStepAsString() - { - return Integer.toString(this.currentWizardState.getCurrentStep()); - } - - /** - * Returns the name of the current step, wizards should use - * the name of the step rather than the step number to discover - * the position as extra steps can be added via configuration. - * - * @return The name of the current step - */ - public String getCurrentStepName() - { - return ((StepConfig)this.currentWizardState.getSteps().get( - this.currentWizardState.getCurrentStep()-1)).getName(); - } - - /** - * Returns a list of UIListItems representing the steps of the wizard - * - * @return List of steps to display in UI - */ - public List getStepItems() - { - List items = new ArrayList(this.currentWizardState.getSteps().size()); - - for (int x = 0; x < this.currentWizardState.getSteps().size(); x++) - { - String uiStepNumber = Integer.toString(x + 1); - StepConfig stepCfg = this.currentWizardState.getSteps().get(x); - UIListItem item = new UIListItem(); - item.setValue(uiStepNumber); - - // get the title for the step - String stepTitle = stepCfg.getTitleId(); - if (stepTitle != null) - { - stepTitle = Application.getMessage(FacesContext.getCurrentInstance(), stepTitle); - } - else - { - stepTitle = stepCfg.getTitle(); - } - - // get the tooltip for the step - String stepTooltip = stepCfg.getDescriptionId(); - if (stepTooltip != null) - { - stepTooltip = Application.getMessage(FacesContext.getCurrentInstance(), stepTooltip); - } - else - { - stepTooltip = stepCfg.getDescription(); - } - - // set the label and tooltip - item.setLabel(uiStepNumber + ". " + stepTitle); - item.setTooltip(stepTooltip); - - items.add(item); - } - - return items; - } - - /** - * Returns the current page of the wizard (depends on the current step position) - * - * @return The page - */ - public String getPage() - { - return this.currentWizardState.getCurrentPageCfg().getPath(); - } - - /** - * Returns the title of the current step - * - * @return The step title - */ - public String getStepTitle() - { - String result = this.currentWizardState.getWizard().getStepTitle(); - if (result == null) - { - result = this.currentWizardState.getCurrentPageCfg().getTitleId(); - result = (result != null - ? Application.getMessage(FacesContext.getCurrentInstance(), result) - : this.currentWizardState.getCurrentPageCfg().getTitle()); - } - return result; - } - - /** - * Returns the description of the current step - * - * @return The step description - */ - public String getStepDescription() - { - String result = this.currentWizardState.getWizard().getStepDescription(); - if (result == null) - { - result = this.currentWizardState.getCurrentPageCfg().getDescriptionId(); - result = (result != null - ? Application.getMessage(FacesContext.getCurrentInstance(), result) - : this.currentWizardState.getCurrentPageCfg().getDescription()); - } - return result; - } - - /** - * Returns the instructions for the current step - * - * @return The step instructions - */ - public String getStepInstructions() - { - String instruction = this.currentWizardState.getCurrentPageCfg().getInstructionId(); - - if (instruction != null) - { - instruction = Application.getMessage(FacesContext.getCurrentInstance(), instruction); - } - else - { - instruction = this.currentWizardState.getCurrentPageCfg().getInstruction(); - } - - return instruction; - } - - /** - * Returns the label to use for the next button - * - * @return The next button label - */ - public String getNextButtonLabel() - { - return this.currentWizardState.getWizard().getNextButtonLabel(); - } - - /** - * Determines whether the next button on the wizard should be disabled - * - * @return true if the button should be disabled - */ - public boolean getNextButtonDisabled() - { - IWizardBean wb = this.currentWizardState.getWizard(); - - if (wb.isFinished()) - { - return true; - } - - return (this.currentWizardState.getCurrentStep() == this.currentWizardState.getSteps().size() || - wb.getNextButtonDisabled()); - } - - /** - * Returns the label to use for the back button - * - * @return The back button label - */ - public String getBackButtonLabel() - { - return this.currentWizardState.getWizard().getBackButtonLabel(); - } - - /** - * Determines whether the back button on the wizard should be disabled - * - * @return true if the button should be disabled - */ - public boolean getBackButtonDisabled() - { - if (this.currentWizardState.getWizard().isFinished()) - { - return true; - } - - return this.currentWizardState.getCurrentStep() == 1; - } - - /** - * Returns the label to use for the cancel button - * - * @return The cancel button label - */ - public String getCancelButtonLabel() - { - return this.currentWizardState.getWizard().getCancelButtonLabel(); - } - - /** - * Returns the label to use for the finish button - * - * @return The finish button label - */ - public String getFinishButtonLabel() - { - return this.currentWizardState.getWizard().getFinishButtonLabel(); - } - - /** - * Determines whether the finish button on the wizard should be disabled - * - * @return true if the button should be disabled - */ - public boolean getFinishButtonDisabled() - { - IWizardBean wb = this.currentWizardState.getWizard(); - - if (wb.isFinished()) - { - return true; - } - - return (this.currentWizardState.getCurrentStep() != this.currentWizardState.getSteps().size() && - wb.getFinishButtonDisabled()); - } - - /** - * Method handler called when the next button of the wizard is pressed - */ - public void next() - { - // calculate next step number and update wizard state - int currentStep = this.currentWizardState.getCurrentStep(); - int noSteps = this.currentWizardState.getSteps().size(); - currentStep++; - - // check we haven't gone past the end (this can happen if the next - // button is pressed too many times) - if (currentStep > noSteps) - { - currentStep = noSteps; - } - - this.currentWizardState.setCurrentStep(currentStep); - - if (logger.isDebugEnabled()) - logger.debug("next called, current step is now: " + this.currentWizardState.getCurrentStep()); - - // tell the wizard the next button has been pressed - this.currentWizardState.getWizard().next(); - - determineCurrentPage(); - } - - /** - * Method handler called when the back button of the wizard is pressed - */ - public void back() - { - // calculate next step number and update wizard state - int currentStep = this.currentWizardState.getCurrentStep(); - currentStep--; - - // check we haven't gone past the beginning (this can - // happen if the back button is pressed too many times) - if (currentStep < 1) - { - currentStep = 1; - } - - this.currentWizardState.setCurrentStep(currentStep); - - if (logger.isDebugEnabled()) - logger.debug("back called, current step is now: " + this.currentWizardState.getCurrentStep()); - - // tell the wizard the back button has been pressed - this.currentWizardState.getWizard().back(); - - determineCurrentPage(); - } - - /** - * Method handler called when the finish button of the wizard is pressed - * - * @return The outcome - */ - public String finish() - { - return this.currentWizardState.getWizard().finish(); - } - - /** - * Method handler called when the cancel button of the wizard is pressed - * - * @return The outcome - */ - public String cancel() - { - return this.currentWizardState.getWizard().cancel(); - } - - /** - * Sets up the current page to show in the wizard - */ - protected void determineCurrentPage() - { - // reset the current page config in the state object - this.currentWizardState.setCurrentPageCfg(null); - - PageConfig currentPageCfg = null; - - // get the config for the current step position - StepConfig stepCfg = this.currentWizardState.getSteps().get( - this.currentWizardState.getCurrentStep()-1); - - // is the step conditional? - if (stepCfg.hasConditionalPages()) - { - FacesContext context = FacesContext.getCurrentInstance(); - - // test each conditional page in turn - List pages = stepCfg.getConditionalPages(); - - for (ConditionalPageConfig pageCfg : pages) - { - String condition = pageCfg.getCondition(); - - if (logger.isDebugEnabled()) - logger.debug("Evaluating condition: " + condition); - - ValueBinding vb = context.getApplication().createValueBinding(condition); - Object obj = vb.getValue(context); - if (obj instanceof Boolean && ((Boolean)obj).booleanValue()) - { - currentPageCfg = pageCfg; - break; - } - } - } - - // if none of the conditions passed use the default page - if (currentPageCfg == null) - { - currentPageCfg = stepCfg.getDefaultPage(); - } - - if (currentPageCfg == null) - { - throw new AlfrescoRuntimeException("Failed to determine page for step '" + stepCfg.getName() + - "'. Make sure a default page is configured."); - } - - // save the current page config in the state object - this.currentWizardState.setCurrentPageCfg(currentPageCfg); - - if (logger.isDebugEnabled()) - logger.debug("Config for current page: " + this.currentWizardState.getCurrentPageCfg()); - } -} +package org.alfresco.web.bean.wizard; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.el.ValueBinding; +import javax.faces.event.ActionEvent; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.config.WizardsConfigElement.ConditionalPageConfig; +import org.alfresco.web.config.WizardsConfigElement.PageConfig; +import org.alfresco.web.config.WizardsConfigElement.StepConfig; +import org.alfresco.web.config.WizardsConfigElement.WizardConfig; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.alfresco.web.ui.common.component.UIListItem; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean that manages the wizard framework + * + * @author gavinc + */ +public final class WizardManager implements Serializable +{ + private static final long serialVersionUID = -5029787339914973070L; + + /** public JSF bean name */ + public final static String BEAN_NAME = "WizardManager"; + + private static Log logger = LogFactory.getLog(WizardManager.class); + + private WizardState currentWizardState; + private Map paramsToApply; + + /** + * Sets the parameters the next wizard will initialise with + * + * @param params The parameters + */ + public void setupParameters(Map params) + { + this.paramsToApply = params; + } + + /** + * Action handler used to setup parameters for the wizard being launched + * + * @param event The event containing the parameters + */ + public void setupParameters(ActionEvent event) + { + // check the component the event come from was an action link + UIComponent component = event.getComponent(); + if (component instanceof UIActionLink) + { + // store the parameters + this.paramsToApply = ((UIActionLink)component).getParameterMap(); + + // make sure "null" parameters are actually null, this can occur + // when null parameters are sent to the client and posted back + for (String name : this.paramsToApply.keySet()) + { + String value = this.paramsToApply.get(name); + if (value != null && value.equalsIgnoreCase("null")) + { + this.paramsToApply.put(name, null); + } + } + } + } + + /** + * Sets the current wizard + * + * @param config The configuration for the wizard to set + */ + public void setCurrentWizard(WizardConfig config) + { + // make sure the managed bean is present + String beanName = config.getManagedBean(); + + Object bean = FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), beanName); + + if (bean == null) + { + throw new AlfrescoRuntimeException("Failed to start wizard as managed bean '" + beanName + + "' has not been defined"); + } + + // make sure the bean implements the IWizardBean interface + IWizardBean wizard = null; + if (bean instanceof IWizardBean) + { + wizard = (IWizardBean)bean; + } + else + { + throw new AlfrescoRuntimeException("Failed to start wizard as managed bean '" + beanName + + "' does not implement the required IWizardBean interface"); + } + + // create the WizardState object + this.currentWizardState = new WizardState(config, wizard); + + // initialise the managed bean + wizard.init(this.paramsToApply); + + // reset the current parameters so subsequent wizards don't get them + this.paramsToApply = null; + + // setup the first step + determineCurrentPage(); + } + + /** + * Returns the state of the currently active wizard + * + * @return Current wizard's state + */ + public WizardState getState() + { + return this.currentWizardState; + } + + /** + * Restores the wizard represented by the given WizardState object. + * NOTE: The wizard's restored() method is also called during this + * method. + * + * @param state The WizardState for the wizard to restore + */ + public void restoreState(WizardState state) + { + this.currentWizardState = state; + + // retrieve the wizard and call it's restored() method + this.currentWizardState.getWizard().restored(); + } + + /** + * Returns the config for the current wizard + * + * @return The current wizard config + */ + public WizardConfig getCurrentWizard() + { + return this.currentWizardState.getConfig(); + } + + /** + * Returns the current wizard bean being managed + * + * @return The current managed bean + */ + public IWizardBean getBean() + { + return this.currentWizardState.getWizard(); + } + + /** + * Returns the icon to use for the current wizard + * + * @return The icon + */ + public String getIcon() + { + return this.currentWizardState.getConfig().getIcon(); + } + + /** + * Returns the error message to use in error conditions + * + * @return The error message + */ + public String getErrorMessage() + { + return Application.getMessage(FacesContext.getCurrentInstance(), + this.currentWizardState.getConfig().getErrorMessageId()); + } + + /** + * Returns the resolved title to use for the wizard + * + * @return The title + */ + public String getTitle() + { + // try and get the title directly from the wizard + String title = this.currentWizardState.getWizard().getContainerTitle(); + + if (title == null) + { + // try and get the title via a message bundle key + title = this.currentWizardState.getConfig().getTitleId(); + + if (title != null) + { + title = Application.getMessage(FacesContext.getCurrentInstance(), title); + } + else + { + // try and get the title from the configuration + title = this.currentWizardState.getConfig().getTitle(); + } + } + + return title; + } + + /** + * Returns the resolved subtitle to use for the wizard + * + * @return The subtitle + */ + public String getSubTitle() + { + // try and get the title directly from the wizard + String subTitle = this.currentWizardState.getWizard().getContainerSubTitle(); + + if (subTitle == null) + { + // try and get the title via a message bundle key + subTitle = this.currentWizardState.getConfig().getSubTitleId(); + + if (subTitle != null) + { + subTitle = Application.getMessage(FacesContext.getCurrentInstance(), subTitle); + } + else + { + // try and get the title from the configuration + subTitle = this.currentWizardState.getConfig().getSubTitle(); + } + } + + return subTitle; + } + + /** + * Returns the resolved description to use for the wizard + * + * @return The description + */ + public String getDescription() + { + // try and get the description directly from the dialog + String desc = this.currentWizardState.getWizard().getContainerDescription(); + if (desc == null) + { + // try and get the description via a message bundle key + desc = this.currentWizardState.getConfig().getDescriptionId(); + + if (desc != null) + { + desc = Application.getMessage(FacesContext.getCurrentInstance(), desc); + } + else + { + // try and get the description from the configuration + desc = this.currentWizardState.getConfig().getDescription(); + } + } + + return desc; + } + + /** + * Returns the current step position + * + * @return Current step position + */ + public int getCurrentStep() + { + return this.currentWizardState.getCurrentStep(); + } + + /** + * Returns the current step position as a string for use in the UI + * + * @return Current step position as a string + */ + public String getCurrentStepAsString() + { + return Integer.toString(this.currentWizardState.getCurrentStep()); + } + + /** + * Returns the name of the current step, wizards should use + * the name of the step rather than the step number to discover + * the position as extra steps can be added via configuration. + * + * @return The name of the current step + */ + public String getCurrentStepName() + { + return ((StepConfig)this.currentWizardState.getSteps().get( + this.currentWizardState.getCurrentStep()-1)).getName(); + } + + /** + * Returns a list of UIListItems representing the steps of the wizard + * + * @return List of steps to display in UI + */ + public List getStepItems() + { + List items = new ArrayList(this.currentWizardState.getSteps().size()); + + for (int x = 0; x < this.currentWizardState.getSteps().size(); x++) + { + String uiStepNumber = Integer.toString(x + 1); + StepConfig stepCfg = this.currentWizardState.getSteps().get(x); + UIListItem item = new UIListItem(); + item.setValue(uiStepNumber); + + // get the title for the step + String stepTitle = stepCfg.getTitleId(); + if (stepTitle != null) + { + stepTitle = Application.getMessage(FacesContext.getCurrentInstance(), stepTitle); + } + else + { + stepTitle = stepCfg.getTitle(); + } + + // get the tooltip for the step + String stepTooltip = stepCfg.getDescriptionId(); + if (stepTooltip != null) + { + stepTooltip = Application.getMessage(FacesContext.getCurrentInstance(), stepTooltip); + } + else + { + stepTooltip = stepCfg.getDescription(); + } + + // set the label and tooltip + item.setLabel(uiStepNumber + ". " + stepTitle); + item.setTooltip(stepTooltip); + + items.add(item); + } + + return items; + } + + /** + * Returns the current page of the wizard (depends on the current step position) + * + * @return The page + */ + public String getPage() + { + return this.currentWizardState.getCurrentPageCfg().getPath(); + } + + /** + * Returns the title of the current step + * + * @return The step title + */ + public String getStepTitle() + { + String result = this.currentWizardState.getWizard().getStepTitle(); + if (result == null) + { + result = this.currentWizardState.getCurrentPageCfg().getTitleId(); + result = (result != null + ? Application.getMessage(FacesContext.getCurrentInstance(), result) + : this.currentWizardState.getCurrentPageCfg().getTitle()); + } + return result; + } + + /** + * Returns the description of the current step + * + * @return The step description + */ + public String getStepDescription() + { + String result = this.currentWizardState.getWizard().getStepDescription(); + if (result == null) + { + result = this.currentWizardState.getCurrentPageCfg().getDescriptionId(); + result = (result != null + ? Application.getMessage(FacesContext.getCurrentInstance(), result) + : this.currentWizardState.getCurrentPageCfg().getDescription()); + } + return result; + } + + /** + * Returns the instructions for the current step + * + * @return The step instructions + */ + public String getStepInstructions() + { + String instruction = this.currentWizardState.getCurrentPageCfg().getInstructionId(); + + if (instruction != null) + { + instruction = Application.getMessage(FacesContext.getCurrentInstance(), instruction); + } + else + { + instruction = this.currentWizardState.getCurrentPageCfg().getInstruction(); + } + + return instruction; + } + + /** + * Returns the label to use for the next button + * + * @return The next button label + */ + public String getNextButtonLabel() + { + return this.currentWizardState.getWizard().getNextButtonLabel(); + } + + /** + * Determines whether the next button on the wizard should be disabled + * + * @return true if the button should be disabled + */ + public boolean getNextButtonDisabled() + { + IWizardBean wb = this.currentWizardState.getWizard(); + + if (wb.isFinished()) + { + return true; + } + + return (this.currentWizardState.getCurrentStep() == this.currentWizardState.getSteps().size() || + wb.getNextButtonDisabled()); + } + + /** + * Returns the label to use for the back button + * + * @return The back button label + */ + public String getBackButtonLabel() + { + return this.currentWizardState.getWizard().getBackButtonLabel(); + } + + /** + * Determines whether the back button on the wizard should be disabled + * + * @return true if the button should be disabled + */ + public boolean getBackButtonDisabled() + { + if (this.currentWizardState.getWizard().isFinished()) + { + return true; + } + + return this.currentWizardState.getCurrentStep() == 1; + } + + /** + * Returns the label to use for the cancel button + * + * @return The cancel button label + */ + public String getCancelButtonLabel() + { + return this.currentWizardState.getWizard().getCancelButtonLabel(); + } + + /** + * Returns the label to use for the finish button + * + * @return The finish button label + */ + public String getFinishButtonLabel() + { + return this.currentWizardState.getWizard().getFinishButtonLabel(); + } + + /** + * Determines whether the finish button on the wizard should be disabled + * + * @return true if the button should be disabled + */ + public boolean getFinishButtonDisabled() + { + IWizardBean wb = this.currentWizardState.getWizard(); + + if (wb.isFinished()) + { + return true; + } + + return (this.currentWizardState.getCurrentStep() != this.currentWizardState.getSteps().size() && + wb.getFinishButtonDisabled()); + } + + /** + * Method handler called when the next button of the wizard is pressed + */ + public void next() + { + // calculate next step number and update wizard state + int currentStep = this.currentWizardState.getCurrentStep(); + int noSteps = this.currentWizardState.getSteps().size(); + currentStep++; + + // check we haven't gone past the end (this can happen if the next + // button is pressed too many times) + if (currentStep > noSteps) + { + currentStep = noSteps; + } + + this.currentWizardState.setCurrentStep(currentStep); + + if (logger.isDebugEnabled()) + logger.debug("next called, current step is now: " + this.currentWizardState.getCurrentStep()); + + // tell the wizard the next button has been pressed + this.currentWizardState.getWizard().next(); + + determineCurrentPage(); + } + + /** + * Method handler called when the back button of the wizard is pressed + */ + public void back() + { + // calculate next step number and update wizard state + int currentStep = this.currentWizardState.getCurrentStep(); + currentStep--; + + // check we haven't gone past the beginning (this can + // happen if the back button is pressed too many times) + if (currentStep < 1) + { + currentStep = 1; + } + + this.currentWizardState.setCurrentStep(currentStep); + + if (logger.isDebugEnabled()) + logger.debug("back called, current step is now: " + this.currentWizardState.getCurrentStep()); + + // tell the wizard the back button has been pressed + this.currentWizardState.getWizard().back(); + + determineCurrentPage(); + } + + /** + * Method handler called when the finish button of the wizard is pressed + * + * @return The outcome + */ + public String finish() + { + return this.currentWizardState.getWizard().finish(); + } + + /** + * Method handler called when the cancel button of the wizard is pressed + * + * @return The outcome + */ + public String cancel() + { + return this.currentWizardState.getWizard().cancel(); + } + + /** + * Sets up the current page to show in the wizard + */ + protected void determineCurrentPage() + { + // reset the current page config in the state object + this.currentWizardState.setCurrentPageCfg(null); + + PageConfig currentPageCfg = null; + + // get the config for the current step position + StepConfig stepCfg = this.currentWizardState.getSteps().get( + this.currentWizardState.getCurrentStep()-1); + + // is the step conditional? + if (stepCfg.hasConditionalPages()) + { + FacesContext context = FacesContext.getCurrentInstance(); + + // test each conditional page in turn + List pages = stepCfg.getConditionalPages(); + + for (ConditionalPageConfig pageCfg : pages) + { + String condition = pageCfg.getCondition(); + + if (logger.isDebugEnabled()) + logger.debug("Evaluating condition: " + condition); + + ValueBinding vb = context.getApplication().createValueBinding(condition); + Object obj = vb.getValue(context); + if (obj instanceof Boolean && ((Boolean)obj).booleanValue()) + { + currentPageCfg = pageCfg; + break; + } + } + } + + // if none of the conditions passed use the default page + if (currentPageCfg == null) + { + currentPageCfg = stepCfg.getDefaultPage(); + } + + if (currentPageCfg == null) + { + throw new AlfrescoRuntimeException("Failed to determine page for step '" + stepCfg.getName() + + "'. Make sure a default page is configured."); + } + + // save the current page config in the state object + this.currentWizardState.setCurrentPageCfg(currentPageCfg); + + if (logger.isDebugEnabled()) + logger.debug("Config for current page: " + this.currentWizardState.getCurrentPageCfg()); + } +} diff --git a/source/java/org/alfresco/web/bean/wizard/WizardState.java b/source/java/org/alfresco/web/bean/wizard/WizardState.java index 423f22ed2b..892fd832be 100644 --- a/source/java/org/alfresco/web/bean/wizard/WizardState.java +++ b/source/java/org/alfresco/web/bean/wizard/WizardState.java @@ -1,116 +1,116 @@ -package org.alfresco.web.bean.wizard; - -import java.io.Serializable; -import java.util.List; - -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.config.WizardsConfigElement.PageConfig; -import org.alfresco.web.config.WizardsConfigElement.StepConfig; -import org.alfresco.web.config.WizardsConfigElement.WizardConfig; - -/** - * Object responsible for holding the current state of an active wizard. - * - * @author gavinc - */ -public final class WizardState implements Serializable -{ - private static final long serialVersionUID = -6816474382767569256L; - - private int currentStep = 1; - private PageConfig currentPageCfg; - private WizardConfig config; - private IWizardBean wizard; - private List steps; - - /** - * Default constructor - * - * @param config The configuration for the wizard - * @param wizard The wizard bean instance - */ - public WizardState(WizardConfig config, IWizardBean wizard) - { - this.config = config; - this.wizard = wizard; - - this.steps = this.config.getStepsAsList(); - } - - /** - * Sets the configuration for the current page of the wizard - * - * @param currentPageCfg The configuration - */ - public void setCurrentPageCfg(PageConfig currentPageCfg) - { - this.currentPageCfg = currentPageCfg; - } - - /** - * Sets the current step the wizard is on - * - * @param currentStep The current step number - */ - public void setCurrentStep(int currentStep) - { - this.currentStep = currentStep; - } - - /** - * Returns the wizard bean instance - * - * @return The wizard bean instance - */ - public IWizardBean getWizard() - { - return this.wizard; - } - - /** - * Returns the configuration for the current wizard - * - * @return The wizard configuration - */ - public WizardConfig getConfig() - { - return this.config; - } - - /** - * Returns the configuration for the current page of the wizard - * - * @return The current page configuration - */ - public PageConfig getCurrentPageCfg() - { - return currentPageCfg; - } - - /** - * The current step the wizard is on - * - * @return The current wizard step - */ - public int getCurrentStep() - { - return currentStep; - } - - /** - * Returns the list of steps the wizard has - * - * @return List of wizard steps - */ - public List getSteps() - { - return steps; - } - - @Override - public String toString() - { - return AlfrescoNavigationHandler.WIZARD_PREFIX + this.config.getName() + - "[" + this.currentStep + "]"; - } -} +package org.alfresco.web.bean.wizard; + +import java.io.Serializable; +import java.util.List; + +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.config.WizardsConfigElement.PageConfig; +import org.alfresco.web.config.WizardsConfigElement.StepConfig; +import org.alfresco.web.config.WizardsConfigElement.WizardConfig; + +/** + * Object responsible for holding the current state of an active wizard. + * + * @author gavinc + */ +public final class WizardState implements Serializable +{ + private static final long serialVersionUID = -6816474382767569256L; + + private int currentStep = 1; + private PageConfig currentPageCfg; + private WizardConfig config; + private IWizardBean wizard; + private List steps; + + /** + * Default constructor + * + * @param config The configuration for the wizard + * @param wizard The wizard bean instance + */ + public WizardState(WizardConfig config, IWizardBean wizard) + { + this.config = config; + this.wizard = wizard; + + this.steps = this.config.getStepsAsList(); + } + + /** + * Sets the configuration for the current page of the wizard + * + * @param currentPageCfg The configuration + */ + public void setCurrentPageCfg(PageConfig currentPageCfg) + { + this.currentPageCfg = currentPageCfg; + } + + /** + * Sets the current step the wizard is on + * + * @param currentStep The current step number + */ + public void setCurrentStep(int currentStep) + { + this.currentStep = currentStep; + } + + /** + * Returns the wizard bean instance + * + * @return The wizard bean instance + */ + public IWizardBean getWizard() + { + return this.wizard; + } + + /** + * Returns the configuration for the current wizard + * + * @return The wizard configuration + */ + public WizardConfig getConfig() + { + return this.config; + } + + /** + * Returns the configuration for the current page of the wizard + * + * @return The current page configuration + */ + public PageConfig getCurrentPageCfg() + { + return currentPageCfg; + } + + /** + * The current step the wizard is on + * + * @return The current wizard step + */ + public int getCurrentStep() + { + return currentStep; + } + + /** + * Returns the list of steps the wizard has + * + * @return List of wizard steps + */ + public List getSteps() + { + return steps; + } + + @Override + public String toString() + { + return AlfrescoNavigationHandler.WIZARD_PREFIX + this.config.getName() + + "[" + this.currentStep + "]"; + } +} diff --git a/source/java/org/alfresco/web/bean/workflow/CancelWorkflowDialog.java b/source/java/org/alfresco/web/bean/workflow/CancelWorkflowDialog.java index a6a73104ad..7e02390827 100644 --- a/source/java/org/alfresco/web/bean/workflow/CancelWorkflowDialog.java +++ b/source/java/org/alfresco/web/bean/workflow/CancelWorkflowDialog.java @@ -1,165 +1,165 @@ -package org.alfresco.web.bean.workflow; - -import java.text.MessageFormat; -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.service.cmr.workflow.WorkflowInstance; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation for the "Cancel Workflow" dialog - * - * @author gavinc - */ -public class CancelWorkflowDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -7875582893750792200L; - - transient private WorkflowInstance workflowInstance; - transient private WorkflowService workflowService; - - private static final Log logger = LogFactory.getLog(CancelWorkflowDialog.class); - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // make sure the workflow instance id has been passed - String workflowInstanceId = this.parameters.get("workflow-instance-id"); - if (workflowInstanceId == null || workflowInstanceId.length() == 0) - { - throw new IllegalArgumentException("Cancel workflow dialog called without workflow instance id"); - } - - this.workflowInstance = getWorkflowService().getWorkflowById(workflowInstanceId); - if (this.workflowInstance == null) - { - throw new IllegalArgumentException("Failed to find workflow instance for id: " + workflowInstanceId); - } - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - if (logger.isDebugEnabled()) - logger.debug("Cancelling workflow with id: " + this.getWorkflowInstance().getId()); - - WorkflowInstance instance = this.getWorkflowInstance(); - if(instance.isActive()) { - // cancel the workflow - this.getWorkflowService().cancelWorkflow(this.getWorkflowInstance().getId()); - } - else - { - // delete the workflow - this.getWorkflowService().deleteWorkflow(this.getWorkflowInstance().getId()); - } - - if (logger.isDebugEnabled()) - logger.debug("Cancelled workflow with id: " + this.getWorkflowInstance().getId()); - - return outcome; - } - - @Override - protected String getErrorMessageId() - { - return "error_cancel_workflow"; - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "no"); - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "yes"); - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns the confirmation to display to the user before deleting the content. - * - * @return The formatted message to display - */ - public String getConfirmMessage() - { - String confirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), - "cancel_workflow_confirm"); - - String workflowLabel = this.getWorkflowInstance().getDefinition().getTitle(); - if (this.getWorkflowInstance().getDescription() != null && this.getWorkflowInstance().getDescription().length() > 0) - { - workflowLabel = workflowLabel + " (" + this.getWorkflowInstance().getDescription() + ")"; - } - - return MessageFormat.format(confirmMsg, new Object[] {workflowLabel}); - } - - /** - * Returns the workflow service instance - * - * @return WorkflowService instance - */ - public WorkflowService getWorkflowService() - { - if (workflowService == null) - { - workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); - } - return workflowService; - } - - /** - * Sets the workflow service to use - * - * @param workflowService The WorkflowService instance - */ - public void setWorkflowService(WorkflowService workflowService) - { - this.workflowService = workflowService; - } - - protected WorkflowInstance getWorkflowInstance() - { - if (workflowInstance == null) - { - String workflowInstanceId = this.parameters.get("workflow-instance-id"); - if (workflowInstanceId == null || workflowInstanceId.length() == 0) - { - throw new IllegalArgumentException("Cancel workflow dialog called without workflow instance id"); - } - - this.workflowInstance = getWorkflowService().getWorkflowById(workflowInstanceId); - if (this.workflowInstance == null) - { - throw new IllegalArgumentException("Failed to find workflow instance for id: " + workflowInstanceId); - } - } - return workflowInstance; - } - -} +package org.alfresco.web.bean.workflow; + +import java.text.MessageFormat; +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.service.cmr.workflow.WorkflowInstance; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.Repository; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation for the "Cancel Workflow" dialog + * + * @author gavinc + */ +public class CancelWorkflowDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -7875582893750792200L; + + transient private WorkflowInstance workflowInstance; + transient private WorkflowService workflowService; + + private static final Log logger = LogFactory.getLog(CancelWorkflowDialog.class); + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // make sure the workflow instance id has been passed + String workflowInstanceId = this.parameters.get("workflow-instance-id"); + if (workflowInstanceId == null || workflowInstanceId.length() == 0) + { + throw new IllegalArgumentException("Cancel workflow dialog called without workflow instance id"); + } + + this.workflowInstance = getWorkflowService().getWorkflowById(workflowInstanceId); + if (this.workflowInstance == null) + { + throw new IllegalArgumentException("Failed to find workflow instance for id: " + workflowInstanceId); + } + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + if (logger.isDebugEnabled()) + logger.debug("Cancelling workflow with id: " + this.getWorkflowInstance().getId()); + + WorkflowInstance instance = this.getWorkflowInstance(); + if(instance.isActive()) { + // cancel the workflow + this.getWorkflowService().cancelWorkflow(this.getWorkflowInstance().getId()); + } + else + { + // delete the workflow + this.getWorkflowService().deleteWorkflow(this.getWorkflowInstance().getId()); + } + + if (logger.isDebugEnabled()) + logger.debug("Cancelled workflow with id: " + this.getWorkflowInstance().getId()); + + return outcome; + } + + @Override + protected String getErrorMessageId() + { + return "error_cancel_workflow"; + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "no"); + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "yes"); + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns the confirmation to display to the user before deleting the content. + * + * @return The formatted message to display + */ + public String getConfirmMessage() + { + String confirmMsg = Application.getMessage(FacesContext.getCurrentInstance(), + "cancel_workflow_confirm"); + + String workflowLabel = this.getWorkflowInstance().getDefinition().getTitle(); + if (this.getWorkflowInstance().getDescription() != null && this.getWorkflowInstance().getDescription().length() > 0) + { + workflowLabel = workflowLabel + " (" + this.getWorkflowInstance().getDescription() + ")"; + } + + return MessageFormat.format(confirmMsg, new Object[] {workflowLabel}); + } + + /** + * Returns the workflow service instance + * + * @return WorkflowService instance + */ + public WorkflowService getWorkflowService() + { + if (workflowService == null) + { + workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); + } + return workflowService; + } + + /** + * Sets the workflow service to use + * + * @param workflowService The WorkflowService instance + */ + public void setWorkflowService(WorkflowService workflowService) + { + this.workflowService = workflowService; + } + + protected WorkflowInstance getWorkflowInstance() + { + if (workflowInstance == null) + { + String workflowInstanceId = this.parameters.get("workflow-instance-id"); + if (workflowInstanceId == null || workflowInstanceId.length() == 0) + { + throw new IllegalArgumentException("Cancel workflow dialog called without workflow instance id"); + } + + this.workflowInstance = getWorkflowService().getWorkflowById(workflowInstanceId); + if (this.workflowInstance == null) + { + throw new IllegalArgumentException("Failed to find workflow instance for id: " + workflowInstanceId); + } + } + return workflowInstance; + } + +} diff --git a/source/java/org/alfresco/web/bean/workflow/ManageTaskDialog.java b/source/java/org/alfresco/web/bean/workflow/ManageTaskDialog.java index 0e5651a2e3..87b85baefa 100644 --- a/source/java/org/alfresco/web/bean/workflow/ManageTaskDialog.java +++ b/source/java/org/alfresco/web/bean/workflow/ManageTaskDialog.java @@ -1,896 +1,896 @@ - -package org.alfresco.web.bean.workflow; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.workflow.WorkflowModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.workflow.WorkflowInstance; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.service.cmr.workflow.WorkflowTaskDefinition; -import org.alfresco.service.cmr.workflow.WorkflowTaskState; -import org.alfresco.service.cmr.workflow.WorkflowTransition; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.AlfrescoNavigationHandler; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.dialog.BaseDialogBean; -import org.alfresco.web.bean.repository.MapNode; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.NodePropertyResolver; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.TransientNode; -import org.alfresco.web.bean.repository.User; -import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.alfresco.web.ui.common.component.data.UIRichList; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation for the "Manage Task" dialog. - * - * @author gavinc - */ -public class ManageTaskDialog extends BaseDialogBean -{ - private static final long serialVersionUID = -3209544870892993135L; - - transient private WorkflowService workflowService; - protected Node taskNode; - transient private WorkflowTask task; - transient private WorkflowInstance workflowInstance; - transient private WorkflowTransition[] transitions; - protected NodeRef workflowPackage; - protected List resources; - protected TaskCompleteResolver completeResolver = new TaskCompleteResolver(); - protected UIRichList packageItemsRichList; - protected List packageItemsToAdd; - protected List packageItemsToRemove; - protected String[] itemsToAdd; - protected boolean isItemBeingAdded = false; - - private final static Log LOGGER = LogFactory.getLog(ManageTaskDialog.class); - - protected static final String ID_PREFIX = "transition_"; - protected static final String CLIENT_ID_PREFIX = AlfrescoNavigationHandler.DIALOG_PREFIX + ID_PREFIX; - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // reset variables - this.task = null; - this.taskNode = null; - this.workflowInstance = null; - this.transitions = null; - this.workflowPackage = null; - this.resources = null; - this.itemsToAdd = null; - this.packageItemsToAdd = null; - this.packageItemsToRemove = null; - this.isItemBeingAdded = false; - if (this.packageItemsRichList != null) - { - this.packageItemsRichList.setValue(null); - this.packageItemsRichList = null; - } - - // get the task details - String taskId = this.parameters.get("id"); - this.task = this.getWorkflowService().getTaskById(taskId); - - if (this.task != null) - { - // setup a transient node to represent the task we're managing - WorkflowTaskDefinition taskDef = this.task.definition; - this.taskNode = new TransientNode(taskDef.metadata.getName(), "task_" + System.currentTimeMillis(), - this.task.properties); - - // get access to the workflow instance for the task - this.workflowInstance = this.task.path.instance; - - // setup the workflow package for the task - this.workflowPackage = (NodeRef) this.task.properties.get(WorkflowModel.ASSOC_PACKAGE); - - if (LOGGER.isDebugEnabled()) - { - LOGGER.debug("Task: " + this.task); - LOGGER.debug("Trasient node: " + this.taskNode); - Boolean isSystemPackage = (Boolean) this.getNodeService().getProperty(this.workflowPackage, - WorkflowModel.PROP_IS_SYSTEM_PACKAGE); - LOGGER.debug("Workflow package: " + this.workflowPackage + " system package: " + isSystemPackage); - } - } - } - - @Override - public void restored() - { - // reset the workflow package rich list so everything gets re-evaluated - if (this.packageItemsRichList != null) - { - this.packageItemsRichList.setValue(null); - this.packageItemsRichList = null; - } - } - - @Override - protected String finishImpl(FacesContext context, String outcome) throws Exception - { - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Saving task: " + this.getWorkflowTask().id); - - // before updating the task still exists and is not completed - WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); - if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) - { - Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); - return outcome; - } - - // prepare the edited parameters for saving - Map params = WorkflowUtil.prepareTaskParams(this.taskNode); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Saving task with parameters: " + params); - - // update the task with the updated parameters and resources - updateResources(); - this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); - - return outcome; - } - - @Override - public List getAdditionalButtons() - { - List buttons = null; - - if (this.getWorkflowTask() != null) - { - // get the transitions available from this task and - // show them in the dialog as additional buttons - this.transitions = this.getWorkflowTask().path.node.transitions; - boolean isPooledTask = isPooledTask(); - - if (isPooledTask || this.transitions != null) - { - buttons = new ArrayList(this.transitions.length + 1); - - if (isPooledTask) - { - if (this.taskNode.getProperties().get(ContentModel.PROP_OWNER) == null) - { - buttons.add(new DialogButtonConfig("button_take_ownership", null, "take_ownership", - "#{DialogManager.bean.takeOwnership}", "false", null)); - } - else - { - buttons.add(new DialogButtonConfig("button_return_to_pool", null, "return_ownership", - "#{DialogManager.bean.returnOwnership}", "false", null)); - } - } - - if (this.transitions != null) - { - Object hiddenTransitions = this.taskNode.getProperties().get(WorkflowModel.PROP_HIDDEN_TRANSITIONS); - for (WorkflowTransition trans : this.transitions) - { - if (hiddenTransitions == null - || (hiddenTransitions instanceof String && ((String) hiddenTransitions).equals("")) - || (hiddenTransitions instanceof String && !((String) hiddenTransitions) - .equals(trans.id)) || (hiddenTransitions instanceof List) - && !((List) hiddenTransitions).contains(trans.id)) - { - if (this.taskNode.getProperties().get(ContentModel.PROP_OWNER) != null) - { - buttons.add(new DialogButtonConfig(ID_PREFIX + trans.title, trans.title, null, - "#{DialogManager.bean.transition}", "false", null)); - } - } - } - } - } - } - - return buttons; - } - - @Override - public String getFinishButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "save_changes"); - } - - @Override - public boolean getFinishButtonDisabled() - { - return false; - } - - @Override - public String getContainerTitle() - { - String titleStart = Application.getMessage(FacesContext.getCurrentInstance(), "manage_task_title"); - - return titleStart + ": " + this.getWorkflowTask().title; - } - - @Override - public String getContainerDescription() - { - return this.getWorkflowTask().description; - } - - // ------------------------------------------------------------------------------ - // Event handlers - - @SuppressWarnings("deprecation") - public String takeOwnership() - { - String outcome = getDefaultFinishOutcome(); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Taking ownership of task: " + this.getWorkflowTask().id); - - FacesContext context = FacesContext.getCurrentInstance(); - - // before taking ownership check the task still exists and is not - // completed - WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); - if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) - { - Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); - return outcome; - } - - UserTransaction tx = null; - - try - { - tx = Repository.getUserTransaction(context); - tx.begin(); - - // prepare the edited parameters for saving - User user = Application.getCurrentUser(context); - String userName = user.getUserName(); - Map params = new HashMap(); - params.put(ContentModel.PROP_OWNER, userName); - - // update the task with the updated parameters and resources - updateResources(); - this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); - - // commit the changes - tx.commit(); - } - catch (Throwable e) - { - // rollback the transaction - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception ex) - { - } - Utils.addErrorMessage(formatErrorMessage(e), e); - outcome = this.getErrorOutcome(e); - } - - return outcome; - } - - @SuppressWarnings("deprecation") - public String returnOwnership() - { - String outcome = getDefaultFinishOutcome(); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Returning ownership of task to pool: " + this.getWorkflowTask().id); - - FacesContext context = FacesContext.getCurrentInstance(); - // before returning ownership check the task still exists and is not - // completed - WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); - if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) - { - Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); - return outcome; - } - - UserTransaction tx = null; - - try - { - tx = Repository.getUserTransaction(context); - tx.begin(); - - // prepare the edited parameters for saving - Map params = new HashMap(); - params.put(ContentModel.PROP_OWNER, null); - - // update the task with the updated parameters and resources - updateResources(); - this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); - - // commit the changes - tx.commit(); - } - catch (Throwable e) - { - // rollback the transaction - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception ex) - { - } - Utils.addErrorMessage(formatErrorMessage(e), e); - outcome = this.getErrorOutcome(e); - } - - return outcome; - } - - @SuppressWarnings("deprecation") - public String transition() - { - String outcome = getDefaultFinishOutcome(); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Transitioning task: " + this.getWorkflowTask().id); - - // before transitioning check the task still exists and is not completed - FacesContext context = FacesContext.getCurrentInstance(); - WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); - if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) - { - Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); - return outcome; - } - - // to find out which transition button was pressed we need - // to look for the button's id in the request parameters, - // the first non-null result is the button that was pressed. - Map reqParams = context.getExternalContext().getRequestParameterMap(); - - String selectedTransition = null; - for (WorkflowTransition trans : this.getWorkflowTransitions()) - { - Object result = reqParams.get(CLIENT_ID_PREFIX + FacesHelper.makeLegalId(trans.title)); - if (result != null) - { - // this was the button that was pressed - selectedTransition = trans.id; - break; - } - } - - UserTransaction tx = null; - - try - { - tx = Repository.getUserTransaction(context); - tx.begin(); - - // prepare the edited parameters for saving - Map params = WorkflowUtil.prepareTaskParams(this.taskNode); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Transitioning task with parameters: " + params); - - // update the task with the updated parameters and resources - updateResources(); - this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); - - // signal the selected transition to the workflow task - this.getWorkflowService().endTask(this.getWorkflowTask().id, selectedTransition); - - // commit the changes - tx.commit(); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Ended task with transition: " + selectedTransition); - } - catch (Throwable e) - { - // rollback the transaction - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception ex) - { - } - Utils.addErrorMessage(formatErrorMessage(e), e); - outcome = this.getErrorOutcome(e); - } - - return outcome; - } - - /** - * Prepares the dialog to allow the user to add an item to the workflow - * package - * - * @param event The event - */ - public void prepareForAdd(ActionEvent event) - { - this.isItemBeingAdded = true; - } - - /** - * Cancels the adding of an item to the workflow package - * - * @param event The event - */ - public void cancelAddPackageItems(ActionEvent event) - { - this.isItemBeingAdded = false; - } - - /** - * Adds an item to the workflow package - * - * @param event The event - */ - public void addPackageItems(ActionEvent event) - { - if (this.itemsToAdd != null) - { - if (this.packageItemsToAdd == null) - { - // create the list of items to add if necessary - this.packageItemsToAdd = new ArrayList(this.itemsToAdd.length); - } - - for (String item : this.itemsToAdd) - { - // if this item is in the remove list it means it was there - // originally - // and has now been re-added, as a result we don't need to do - // anything - // to the original workflow package, therefore remove from the - // remove list - if (this.packageItemsToRemove != null && this.packageItemsToRemove.contains(item)) - { - this.packageItemsToRemove.remove(item); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Removed item from the removed list: " + item); - } - else - { - this.packageItemsToAdd.add(item); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Added item to the added list: " + item); - } - } - - // reset the rich list so it re-renders - this.packageItemsRichList.setValue(null); - } - - this.isItemBeingAdded = false; - this.itemsToAdd = null; - } - - /** - * Removes an item from the workflow package - * - * @param event The event containing a reference to the item to remove - */ - public void removePackageItem(ActionEvent event) - { - UIActionLink link = (UIActionLink) event.getComponent(); - Map params = link.getParameterMap(); - String nodeRef = new NodeRef(Repository.getStoreRef(), params.get("id")).toString(); - - if (this.packageItemsToAdd != null && this.packageItemsToAdd.contains(nodeRef)) - { - // remove the item from the added list if it was added in this - // dialog session - this.packageItemsToAdd.remove(nodeRef); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Removed item from the added list: " + nodeRef); - } - else - { - // add the node to the list of items to remove - if (this.packageItemsToRemove == null) - { - this.packageItemsToRemove = new ArrayList(1); - } - - this.packageItemsToRemove.add(nodeRef); - - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Added item to the removed list: " + nodeRef); - } - - // reset the rich list so it re-renders - this.packageItemsRichList.setValue(null); - } - - /** - * Toggles the complete flag for a workflow package item - * - * @param event The event containing a reference to the item to toggle the - * status for - */ - public void togglePackageItemComplete(ActionEvent event) - { - // TODO: not supported yet - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns a String array of NodeRef's that are being added to the workflow - * package - * - * @return String array of NodeRef's - */ - public String[] getItemsToAdd() - { - return this.itemsToAdd; - } - - /** - * Sets the NodeRef's to add as items to the workflow package - * - * @param itemsToAdd NodeRef's to add to the workflow package - */ - public void setItemsToAdd(String[] itemsToAdd) - { - this.itemsToAdd = itemsToAdd; - } - - /** - * Determines whether an item is currently being added to the workflow - * package - * - * @return true if an item is being added - */ - public boolean isItemBeingAdded() - { - return this.isItemBeingAdded; - } - - /** - * Sets the rich list being used for the workflow package items - * - * @param richList The rich list instance - */ - public void setPackageItemsRichList(UIRichList richList) - { - this.packageItemsRichList = richList; - } - - /** - * Returns the rich list being used for the workflow package items - * - * @return The rich list instance - */ - public UIRichList getPackageItemsRichList() - { - return this.packageItemsRichList; - } - - /** - * Returns the Node representing the task - * - * @return The node - */ - public Node getTaskNode() - { - return this.taskNode; - } - - /** - * Returns whether this is a pooled task - * - * @return true => pooled - */ - public boolean isPooledTask() - { - List pooledActors = (List) taskNode.getAssociations().get(WorkflowModel.ASSOC_POOLED_ACTORS); - return (pooledActors != null && pooledActors.size() > 0); - } - - /** - * Returns the WorkflowInstance that the current task belongs to - * - * @return The workflow instance - */ - public WorkflowInstance getWorkflowInstance() - { - if (workflowInstance == null) - { - workflowInstance = getWorkflowTask().path.instance; - } - return this.workflowInstance; - } - - /** - * Returns the URL to the Workflow Definition Image of the current task - * - * @return the url - */ - public String getWorkflowDefinitionImageUrl() - { - return "/workflowdefinitionimage/" + this.getWorkflowInstance().definition.id; - } - - /** - * Returns the action group the current task uses for the workflow package - * - * @return action group id - */ - public String getPackageActionGroup() - { - return (String) this.getWorkflowTask().properties.get(WorkflowModel.PROP_PACKAGE_ACTION_GROUP); - } - - /** - * Returns the action group the current task uses for each workflow package - * item - * - * @return action group id - */ - public String getPackageItemActionGroup() - { - return (String) this.getWorkflowTask().properties.get(WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP); - } - - /** - * Returns a list of resources associated with this task i.e. the children - * of the workflow package - * - * @return The list of nodes - */ - public List getResources() - { - this.resources = new ArrayList(4); - - if (this.workflowPackage != null) - { - UserTransaction tx = null; - try - { - FacesContext context = FacesContext.getCurrentInstance(); - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - List contents = this.workflowService.getPackageContents(getWorkflowTask().id); - - for (NodeRef nodeRef : contents) - { - if (this.getNodeService().exists(nodeRef)) - { - // find it's type so we can see if it's a node we - // are interested in - QName type = this.getNodeService().getType(nodeRef); - - // make sure the type is defined in the data - // dictionary - if (this.getDictionaryService().getType(type) != null) - { - // look for content nodes or links to content - // NOTE: folders within workflow packages are - // ignored for now - if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_CONTENT) - || ApplicationModel.TYPE_FILELINK.equals(type)) - { - // if the node is not in the removed list - // then add create the - // client side representation and add to the - // list - if (this.packageItemsToRemove == null - || this.packageItemsToRemove.contains(nodeRef.toString()) == false) - { - createAndAddNode(nodeRef); - } - } - } - } - } - - // now iterate through the items to add list and add them to the - // list of resources - if (this.packageItemsToAdd != null) - { - for (String newItem : this.packageItemsToAdd) - { - NodeRef nodeRef = new NodeRef(newItem); - if (this.getNodeService().exists(nodeRef)) - { - // we know the type is correct as this was added as - // a result of a query - // for all content items so just add the item to the - // resources list - createAndAddNode(nodeRef); - } - else - { - if (LOGGER.isDebugEnabled()) - LOGGER.debug("Ignoring " + nodeRef + " as it has been removed from the repository"); - } - } - } - - // commit the transaction - tx.commit(); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), - Repository.ERROR_GENERIC), err.getMessage()), err); - this.resources = Collections. emptyList(); - try - { - if (tx != null) - { - tx.rollback(); - } - } - catch (Exception tex) - { - } - } - } - else if (LOGGER.isDebugEnabled()) - { - LOGGER.debug("Failed to find workflow package for task: " + this.getWorkflowTask().id); - } - - return this.resources; - } - - /** - * Sets the workflow service to use - * - * @param workflowService WorkflowService instance - */ - public void setWorkflowService(WorkflowService workflowService) - { - this.workflowService = workflowService; - } - - protected WorkflowService getWorkflowService() - { - if (workflowService == null) - { - workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); - } - return workflowService; - } - - protected WorkflowTask getWorkflowTask() - { - if (task == null) - { - String taskId = this.parameters.get("id"); - task = this.getWorkflowService().getTaskById(taskId); - } - return task; - } - - protected WorkflowTransition[] getWorkflowTransitions() - { - if (transitions == null) - { - transitions = getWorkflowTask().path.node.transitions; - } - return transitions; - } - - // ------------------------------------------------------------------------------ - // Helper methods - - protected void createAndAddNode(NodeRef nodeRef) - { - // create our Node representation - MapNode node = new MapNode(nodeRef, this.getNodeService(), true); - this.browseBean.setupCommonBindingProperties(node); - - // add property resolvers to show path information - node.addPropertyResolver("path", this.browseBean.resolverPath); - node.addPropertyResolver("displayPath", this.browseBean.resolverDisplayPath); - - // add a property resolver to indicate whether the item has been - // completed or not - // node.addPropertyResolver("completed", this.completeResolver); - - // add the id of the task being managed - node.getProperties().put("taskId", this.getWorkflowTask().id); - - this.resources.add(node); - } - - protected void updateResources() - { - // remove any items the user selected to remove - if (this.workflowPackage != null && this.packageItemsToRemove != null && this.packageItemsToRemove.size() > 0) - { - for (String removedItem : this.packageItemsToRemove) - { - this.getNodeService().removeChild(this.workflowPackage, new NodeRef(removedItem)); - } - } - - // add any items the user selected to add - if (this.workflowPackage != null && this.packageItemsToAdd != null && this.packageItemsToAdd.size() > 0) - { - for (String addedItem : this.packageItemsToAdd) - { - NodeRef addedNodeRef = new NodeRef(addedItem); - this.getNodeService().addChild( - this.workflowPackage, - addedNodeRef, - WorkflowModel.ASSOC_PACKAGE_CONTAINS, - QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, QName - .createValidLocalName((String) this.getNodeService().getProperty(addedNodeRef, - ContentModel.PROP_NAME)))); - } - } - } - - // ------------------------------------------------------------------------------ - // Inner classes - - /** - * Property resolver to determine if the given node has been flagged as - * complete - */ - protected class TaskCompleteResolver implements NodePropertyResolver - { - private static final long serialVersionUID = 5862037943275638314L; - - public Object get(Node node) - { - String result = Application.getMessage(FacesContext.getCurrentInstance(), "no"); - List completedItems = (List) getWorkflowTask().properties.get(WorkflowModel.PROP_COMPLETED_ITEMS); - if (completedItems != null && completedItems.size() > 0 && completedItems.contains(node.getNodeRef())) - { - result = Application.getMessage(FacesContext.getCurrentInstance(), "yes"); - } - return result; - } - } -} + +package org.alfresco.web.bean.workflow; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.workflow.WorkflowModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.workflow.WorkflowInstance; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.service.cmr.workflow.WorkflowTaskDefinition; +import org.alfresco.service.cmr.workflow.WorkflowTaskState; +import org.alfresco.service.cmr.workflow.WorkflowTransition; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.AlfrescoNavigationHandler; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.dialog.BaseDialogBean; +import org.alfresco.web.bean.repository.MapNode; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.NodePropertyResolver; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.TransientNode; +import org.alfresco.web.bean.repository.User; +import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.alfresco.web.ui.common.component.data.UIRichList; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation for the "Manage Task" dialog. + * + * @author gavinc + */ +public class ManageTaskDialog extends BaseDialogBean +{ + private static final long serialVersionUID = -3209544870892993135L; + + transient private WorkflowService workflowService; + protected Node taskNode; + transient private WorkflowTask task; + transient private WorkflowInstance workflowInstance; + transient private WorkflowTransition[] transitions; + protected NodeRef workflowPackage; + protected List resources; + protected TaskCompleteResolver completeResolver = new TaskCompleteResolver(); + protected UIRichList packageItemsRichList; + protected List packageItemsToAdd; + protected List packageItemsToRemove; + protected String[] itemsToAdd; + protected boolean isItemBeingAdded = false; + + private final static Log LOGGER = LogFactory.getLog(ManageTaskDialog.class); + + protected static final String ID_PREFIX = "transition_"; + protected static final String CLIENT_ID_PREFIX = AlfrescoNavigationHandler.DIALOG_PREFIX + ID_PREFIX; + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // reset variables + this.task = null; + this.taskNode = null; + this.workflowInstance = null; + this.transitions = null; + this.workflowPackage = null; + this.resources = null; + this.itemsToAdd = null; + this.packageItemsToAdd = null; + this.packageItemsToRemove = null; + this.isItemBeingAdded = false; + if (this.packageItemsRichList != null) + { + this.packageItemsRichList.setValue(null); + this.packageItemsRichList = null; + } + + // get the task details + String taskId = this.parameters.get("id"); + this.task = this.getWorkflowService().getTaskById(taskId); + + if (this.task != null) + { + // setup a transient node to represent the task we're managing + WorkflowTaskDefinition taskDef = this.task.definition; + this.taskNode = new TransientNode(taskDef.metadata.getName(), "task_" + System.currentTimeMillis(), + this.task.properties); + + // get access to the workflow instance for the task + this.workflowInstance = this.task.path.instance; + + // setup the workflow package for the task + this.workflowPackage = (NodeRef) this.task.properties.get(WorkflowModel.ASSOC_PACKAGE); + + if (LOGGER.isDebugEnabled()) + { + LOGGER.debug("Task: " + this.task); + LOGGER.debug("Trasient node: " + this.taskNode); + Boolean isSystemPackage = (Boolean) this.getNodeService().getProperty(this.workflowPackage, + WorkflowModel.PROP_IS_SYSTEM_PACKAGE); + LOGGER.debug("Workflow package: " + this.workflowPackage + " system package: " + isSystemPackage); + } + } + } + + @Override + public void restored() + { + // reset the workflow package rich list so everything gets re-evaluated + if (this.packageItemsRichList != null) + { + this.packageItemsRichList.setValue(null); + this.packageItemsRichList = null; + } + } + + @Override + protected String finishImpl(FacesContext context, String outcome) throws Exception + { + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Saving task: " + this.getWorkflowTask().id); + + // before updating the task still exists and is not completed + WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); + if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) + { + Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); + return outcome; + } + + // prepare the edited parameters for saving + Map params = WorkflowUtil.prepareTaskParams(this.taskNode); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Saving task with parameters: " + params); + + // update the task with the updated parameters and resources + updateResources(); + this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); + + return outcome; + } + + @Override + public List getAdditionalButtons() + { + List buttons = null; + + if (this.getWorkflowTask() != null) + { + // get the transitions available from this task and + // show them in the dialog as additional buttons + this.transitions = this.getWorkflowTask().path.node.transitions; + boolean isPooledTask = isPooledTask(); + + if (isPooledTask || this.transitions != null) + { + buttons = new ArrayList(this.transitions.length + 1); + + if (isPooledTask) + { + if (this.taskNode.getProperties().get(ContentModel.PROP_OWNER) == null) + { + buttons.add(new DialogButtonConfig("button_take_ownership", null, "take_ownership", + "#{DialogManager.bean.takeOwnership}", "false", null)); + } + else + { + buttons.add(new DialogButtonConfig("button_return_to_pool", null, "return_ownership", + "#{DialogManager.bean.returnOwnership}", "false", null)); + } + } + + if (this.transitions != null) + { + Object hiddenTransitions = this.taskNode.getProperties().get(WorkflowModel.PROP_HIDDEN_TRANSITIONS); + for (WorkflowTransition trans : this.transitions) + { + if (hiddenTransitions == null + || (hiddenTransitions instanceof String && ((String) hiddenTransitions).equals("")) + || (hiddenTransitions instanceof String && !((String) hiddenTransitions) + .equals(trans.id)) || (hiddenTransitions instanceof List) + && !((List) hiddenTransitions).contains(trans.id)) + { + if (this.taskNode.getProperties().get(ContentModel.PROP_OWNER) != null) + { + buttons.add(new DialogButtonConfig(ID_PREFIX + trans.title, trans.title, null, + "#{DialogManager.bean.transition}", "false", null)); + } + } + } + } + } + } + + return buttons; + } + + @Override + public String getFinishButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "save_changes"); + } + + @Override + public boolean getFinishButtonDisabled() + { + return false; + } + + @Override + public String getContainerTitle() + { + String titleStart = Application.getMessage(FacesContext.getCurrentInstance(), "manage_task_title"); + + return titleStart + ": " + this.getWorkflowTask().title; + } + + @Override + public String getContainerDescription() + { + return this.getWorkflowTask().description; + } + + // ------------------------------------------------------------------------------ + // Event handlers + + @SuppressWarnings("deprecation") + public String takeOwnership() + { + String outcome = getDefaultFinishOutcome(); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Taking ownership of task: " + this.getWorkflowTask().id); + + FacesContext context = FacesContext.getCurrentInstance(); + + // before taking ownership check the task still exists and is not + // completed + WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); + if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) + { + Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); + return outcome; + } + + UserTransaction tx = null; + + try + { + tx = Repository.getUserTransaction(context); + tx.begin(); + + // prepare the edited parameters for saving + User user = Application.getCurrentUser(context); + String userName = user.getUserName(); + Map params = new HashMap(); + params.put(ContentModel.PROP_OWNER, userName); + + // update the task with the updated parameters and resources + updateResources(); + this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); + + // commit the changes + tx.commit(); + } + catch (Throwable e) + { + // rollback the transaction + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception ex) + { + } + Utils.addErrorMessage(formatErrorMessage(e), e); + outcome = this.getErrorOutcome(e); + } + + return outcome; + } + + @SuppressWarnings("deprecation") + public String returnOwnership() + { + String outcome = getDefaultFinishOutcome(); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Returning ownership of task to pool: " + this.getWorkflowTask().id); + + FacesContext context = FacesContext.getCurrentInstance(); + // before returning ownership check the task still exists and is not + // completed + WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); + if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) + { + Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); + return outcome; + } + + UserTransaction tx = null; + + try + { + tx = Repository.getUserTransaction(context); + tx.begin(); + + // prepare the edited parameters for saving + Map params = new HashMap(); + params.put(ContentModel.PROP_OWNER, null); + + // update the task with the updated parameters and resources + updateResources(); + this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); + + // commit the changes + tx.commit(); + } + catch (Throwable e) + { + // rollback the transaction + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception ex) + { + } + Utils.addErrorMessage(formatErrorMessage(e), e); + outcome = this.getErrorOutcome(e); + } + + return outcome; + } + + @SuppressWarnings("deprecation") + public String transition() + { + String outcome = getDefaultFinishOutcome(); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Transitioning task: " + this.getWorkflowTask().id); + + // before transitioning check the task still exists and is not completed + FacesContext context = FacesContext.getCurrentInstance(); + WorkflowTask checkTask = this.getWorkflowService().getTaskById(this.getWorkflowTask().id); + if (checkTask == null || checkTask.state == WorkflowTaskState.COMPLETED) + { + Utils.addErrorMessage(Application.getMessage(context, "invalid_task")); + return outcome; + } + + // to find out which transition button was pressed we need + // to look for the button's id in the request parameters, + // the first non-null result is the button that was pressed. + Map reqParams = context.getExternalContext().getRequestParameterMap(); + + String selectedTransition = null; + for (WorkflowTransition trans : this.getWorkflowTransitions()) + { + Object result = reqParams.get(CLIENT_ID_PREFIX + FacesHelper.makeLegalId(trans.title)); + if (result != null) + { + // this was the button that was pressed + selectedTransition = trans.id; + break; + } + } + + UserTransaction tx = null; + + try + { + tx = Repository.getUserTransaction(context); + tx.begin(); + + // prepare the edited parameters for saving + Map params = WorkflowUtil.prepareTaskParams(this.taskNode); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Transitioning task with parameters: " + params); + + // update the task with the updated parameters and resources + updateResources(); + this.getWorkflowService().updateTask(this.getWorkflowTask().id, params, null, null); + + // signal the selected transition to the workflow task + this.getWorkflowService().endTask(this.getWorkflowTask().id, selectedTransition); + + // commit the changes + tx.commit(); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Ended task with transition: " + selectedTransition); + } + catch (Throwable e) + { + // rollback the transaction + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception ex) + { + } + Utils.addErrorMessage(formatErrorMessage(e), e); + outcome = this.getErrorOutcome(e); + } + + return outcome; + } + + /** + * Prepares the dialog to allow the user to add an item to the workflow + * package + * + * @param event The event + */ + public void prepareForAdd(ActionEvent event) + { + this.isItemBeingAdded = true; + } + + /** + * Cancels the adding of an item to the workflow package + * + * @param event The event + */ + public void cancelAddPackageItems(ActionEvent event) + { + this.isItemBeingAdded = false; + } + + /** + * Adds an item to the workflow package + * + * @param event The event + */ + public void addPackageItems(ActionEvent event) + { + if (this.itemsToAdd != null) + { + if (this.packageItemsToAdd == null) + { + // create the list of items to add if necessary + this.packageItemsToAdd = new ArrayList(this.itemsToAdd.length); + } + + for (String item : this.itemsToAdd) + { + // if this item is in the remove list it means it was there + // originally + // and has now been re-added, as a result we don't need to do + // anything + // to the original workflow package, therefore remove from the + // remove list + if (this.packageItemsToRemove != null && this.packageItemsToRemove.contains(item)) + { + this.packageItemsToRemove.remove(item); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Removed item from the removed list: " + item); + } + else + { + this.packageItemsToAdd.add(item); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Added item to the added list: " + item); + } + } + + // reset the rich list so it re-renders + this.packageItemsRichList.setValue(null); + } + + this.isItemBeingAdded = false; + this.itemsToAdd = null; + } + + /** + * Removes an item from the workflow package + * + * @param event The event containing a reference to the item to remove + */ + public void removePackageItem(ActionEvent event) + { + UIActionLink link = (UIActionLink) event.getComponent(); + Map params = link.getParameterMap(); + String nodeRef = new NodeRef(Repository.getStoreRef(), params.get("id")).toString(); + + if (this.packageItemsToAdd != null && this.packageItemsToAdd.contains(nodeRef)) + { + // remove the item from the added list if it was added in this + // dialog session + this.packageItemsToAdd.remove(nodeRef); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Removed item from the added list: " + nodeRef); + } + else + { + // add the node to the list of items to remove + if (this.packageItemsToRemove == null) + { + this.packageItemsToRemove = new ArrayList(1); + } + + this.packageItemsToRemove.add(nodeRef); + + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Added item to the removed list: " + nodeRef); + } + + // reset the rich list so it re-renders + this.packageItemsRichList.setValue(null); + } + + /** + * Toggles the complete flag for a workflow package item + * + * @param event The event containing a reference to the item to toggle the + * status for + */ + public void togglePackageItemComplete(ActionEvent event) + { + // TODO: not supported yet + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns a String array of NodeRef's that are being added to the workflow + * package + * + * @return String array of NodeRef's + */ + public String[] getItemsToAdd() + { + return this.itemsToAdd; + } + + /** + * Sets the NodeRef's to add as items to the workflow package + * + * @param itemsToAdd NodeRef's to add to the workflow package + */ + public void setItemsToAdd(String[] itemsToAdd) + { + this.itemsToAdd = itemsToAdd; + } + + /** + * Determines whether an item is currently being added to the workflow + * package + * + * @return true if an item is being added + */ + public boolean isItemBeingAdded() + { + return this.isItemBeingAdded; + } + + /** + * Sets the rich list being used for the workflow package items + * + * @param richList The rich list instance + */ + public void setPackageItemsRichList(UIRichList richList) + { + this.packageItemsRichList = richList; + } + + /** + * Returns the rich list being used for the workflow package items + * + * @return The rich list instance + */ + public UIRichList getPackageItemsRichList() + { + return this.packageItemsRichList; + } + + /** + * Returns the Node representing the task + * + * @return The node + */ + public Node getTaskNode() + { + return this.taskNode; + } + + /** + * Returns whether this is a pooled task + * + * @return true => pooled + */ + public boolean isPooledTask() + { + List pooledActors = (List) taskNode.getAssociations().get(WorkflowModel.ASSOC_POOLED_ACTORS); + return (pooledActors != null && pooledActors.size() > 0); + } + + /** + * Returns the WorkflowInstance that the current task belongs to + * + * @return The workflow instance + */ + public WorkflowInstance getWorkflowInstance() + { + if (workflowInstance == null) + { + workflowInstance = getWorkflowTask().path.instance; + } + return this.workflowInstance; + } + + /** + * Returns the URL to the Workflow Definition Image of the current task + * + * @return the url + */ + public String getWorkflowDefinitionImageUrl() + { + return "/workflowdefinitionimage/" + this.getWorkflowInstance().definition.id; + } + + /** + * Returns the action group the current task uses for the workflow package + * + * @return action group id + */ + public String getPackageActionGroup() + { + return (String) this.getWorkflowTask().properties.get(WorkflowModel.PROP_PACKAGE_ACTION_GROUP); + } + + /** + * Returns the action group the current task uses for each workflow package + * item + * + * @return action group id + */ + public String getPackageItemActionGroup() + { + return (String) this.getWorkflowTask().properties.get(WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP); + } + + /** + * Returns a list of resources associated with this task i.e. the children + * of the workflow package + * + * @return The list of nodes + */ + public List getResources() + { + this.resources = new ArrayList(4); + + if (this.workflowPackage != null) + { + UserTransaction tx = null; + try + { + FacesContext context = FacesContext.getCurrentInstance(); + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + List contents = this.workflowService.getPackageContents(getWorkflowTask().id); + + for (NodeRef nodeRef : contents) + { + if (this.getNodeService().exists(nodeRef)) + { + // find it's type so we can see if it's a node we + // are interested in + QName type = this.getNodeService().getType(nodeRef); + + // make sure the type is defined in the data + // dictionary + if (this.getDictionaryService().getType(type) != null) + { + // look for content nodes or links to content + // NOTE: folders within workflow packages are + // ignored for now + if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_CONTENT) + || ApplicationModel.TYPE_FILELINK.equals(type)) + { + // if the node is not in the removed list + // then add create the + // client side representation and add to the + // list + if (this.packageItemsToRemove == null + || this.packageItemsToRemove.contains(nodeRef.toString()) == false) + { + createAndAddNode(nodeRef); + } + } + } + } + } + + // now iterate through the items to add list and add them to the + // list of resources + if (this.packageItemsToAdd != null) + { + for (String newItem : this.packageItemsToAdd) + { + NodeRef nodeRef = new NodeRef(newItem); + if (this.getNodeService().exists(nodeRef)) + { + // we know the type is correct as this was added as + // a result of a query + // for all content items so just add the item to the + // resources list + createAndAddNode(nodeRef); + } + else + { + if (LOGGER.isDebugEnabled()) + LOGGER.debug("Ignoring " + nodeRef + " as it has been removed from the repository"); + } + } + } + + // commit the transaction + tx.commit(); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), + Repository.ERROR_GENERIC), err.getMessage()), err); + this.resources = Collections. emptyList(); + try + { + if (tx != null) + { + tx.rollback(); + } + } + catch (Exception tex) + { + } + } + } + else if (LOGGER.isDebugEnabled()) + { + LOGGER.debug("Failed to find workflow package for task: " + this.getWorkflowTask().id); + } + + return this.resources; + } + + /** + * Sets the workflow service to use + * + * @param workflowService WorkflowService instance + */ + public void setWorkflowService(WorkflowService workflowService) + { + this.workflowService = workflowService; + } + + protected WorkflowService getWorkflowService() + { + if (workflowService == null) + { + workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); + } + return workflowService; + } + + protected WorkflowTask getWorkflowTask() + { + if (task == null) + { + String taskId = this.parameters.get("id"); + task = this.getWorkflowService().getTaskById(taskId); + } + return task; + } + + protected WorkflowTransition[] getWorkflowTransitions() + { + if (transitions == null) + { + transitions = getWorkflowTask().path.node.transitions; + } + return transitions; + } + + // ------------------------------------------------------------------------------ + // Helper methods + + protected void createAndAddNode(NodeRef nodeRef) + { + // create our Node representation + MapNode node = new MapNode(nodeRef, this.getNodeService(), true); + this.browseBean.setupCommonBindingProperties(node); + + // add property resolvers to show path information + node.addPropertyResolver("path", this.browseBean.resolverPath); + node.addPropertyResolver("displayPath", this.browseBean.resolverDisplayPath); + + // add a property resolver to indicate whether the item has been + // completed or not + // node.addPropertyResolver("completed", this.completeResolver); + + // add the id of the task being managed + node.getProperties().put("taskId", this.getWorkflowTask().id); + + this.resources.add(node); + } + + protected void updateResources() + { + // remove any items the user selected to remove + if (this.workflowPackage != null && this.packageItemsToRemove != null && this.packageItemsToRemove.size() > 0) + { + for (String removedItem : this.packageItemsToRemove) + { + this.getNodeService().removeChild(this.workflowPackage, new NodeRef(removedItem)); + } + } + + // add any items the user selected to add + if (this.workflowPackage != null && this.packageItemsToAdd != null && this.packageItemsToAdd.size() > 0) + { + for (String addedItem : this.packageItemsToAdd) + { + NodeRef addedNodeRef = new NodeRef(addedItem); + this.getNodeService().addChild( + this.workflowPackage, + addedNodeRef, + WorkflowModel.ASSOC_PACKAGE_CONTAINS, + QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, QName + .createValidLocalName((String) this.getNodeService().getProperty(addedNodeRef, + ContentModel.PROP_NAME)))); + } + } + } + + // ------------------------------------------------------------------------------ + // Inner classes + + /** + * Property resolver to determine if the given node has been flagged as + * complete + */ + protected class TaskCompleteResolver implements NodePropertyResolver + { + private static final long serialVersionUID = 5862037943275638314L; + + public Object get(Node node) + { + String result = Application.getMessage(FacesContext.getCurrentInstance(), "no"); + List completedItems = (List) getWorkflowTask().properties.get(WorkflowModel.PROP_COMPLETED_ITEMS); + if (completedItems != null && completedItems.size() > 0 && completedItems.contains(node.getNodeRef())) + { + result = Application.getMessage(FacesContext.getCurrentInstance(), "yes"); + } + return result; + } + } +} diff --git a/source/java/org/alfresco/web/bean/workflow/ReassignTaskDialog.java b/source/java/org/alfresco/web/bean/workflow/ReassignTaskDialog.java index 58b8e99810..bdf829b05b 100644 --- a/source/java/org/alfresco/web/bean/workflow/ReassignTaskDialog.java +++ b/source/java/org/alfresco/web/bean/workflow/ReassignTaskDialog.java @@ -1,89 +1,89 @@ -package org.alfresco.web.bean.workflow; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.ui.common.component.UIGenericPicker; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation for the "Reassign Task" dialog - * - * @author gavinc - */ -public class ReassignTaskDialog extends BaseReassignDialog -{ - private static final long serialVersionUID = 5804171557325189475L; - - protected String taskId; - - private static final Log logger = LogFactory.getLog(ReassignTaskDialog.class); - - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.taskId = this.parameters.get("id"); - if (this.taskId == null || this.taskId.length() == 0) - { - throw new IllegalArgumentException("Reassign task dialog called without task id"); - } - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - if (logger.isDebugEnabled()) - logger.debug("Reassigning task with id: " + this.taskId); - - UIComponent picker = context.getViewRoot().findComponent("dialog:dialog-body:user-picker"); - - if (picker != null && picker instanceof UIGenericPicker) - { - UIGenericPicker userPicker = (UIGenericPicker)picker; - String[] user = userPicker.getSelectedResults(); - if (user != null && user.length > 0) - { - // create a map to hold the new owner property then update the task - String userName = user[0]; - Map params = new HashMap(1); - params.put(ContentModel.PROP_OWNER, userName); - this.getWorkflowService().updateTask(this.taskId, params, null, null); - } - else - { - if (logger.isWarnEnabled()) - logger.warn("Failed to find selected user, reassign was unsuccessful"); - } - } - else - { - if (logger.isWarnEnabled()) - logger.warn("Failed to find user-picker component, reassign was unsuccessful"); - } - - if (logger.isDebugEnabled()) - logger.debug("Reassigning task with id: " + this.taskId); - - return outcome; - } - - @Override - protected String getErrorMessageId() - { - return "error_reassign_task"; - } -} +package org.alfresco.web.bean.workflow; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.ui.common.component.UIGenericPicker; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation for the "Reassign Task" dialog + * + * @author gavinc + */ +public class ReassignTaskDialog extends BaseReassignDialog +{ + private static final long serialVersionUID = 5804171557325189475L; + + protected String taskId; + + private static final Log logger = LogFactory.getLog(ReassignTaskDialog.class); + + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.taskId = this.parameters.get("id"); + if (this.taskId == null || this.taskId.length() == 0) + { + throw new IllegalArgumentException("Reassign task dialog called without task id"); + } + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + if (logger.isDebugEnabled()) + logger.debug("Reassigning task with id: " + this.taskId); + + UIComponent picker = context.getViewRoot().findComponent("dialog:dialog-body:user-picker"); + + if (picker != null && picker instanceof UIGenericPicker) + { + UIGenericPicker userPicker = (UIGenericPicker)picker; + String[] user = userPicker.getSelectedResults(); + if (user != null && user.length > 0) + { + // create a map to hold the new owner property then update the task + String userName = user[0]; + Map params = new HashMap(1); + params.put(ContentModel.PROP_OWNER, userName); + this.getWorkflowService().updateTask(this.taskId, params, null, null); + } + else + { + if (logger.isWarnEnabled()) + logger.warn("Failed to find selected user, reassign was unsuccessful"); + } + } + else + { + if (logger.isWarnEnabled()) + logger.warn("Failed to find user-picker component, reassign was unsuccessful"); + } + + if (logger.isDebugEnabled()) + logger.debug("Reassigning task with id: " + this.taskId); + + return outcome; + } + + @Override + protected String getErrorMessageId() + { + return "error_reassign_task"; + } +} diff --git a/source/java/org/alfresco/web/bean/workflow/ReassignWorkItemDialog.java b/source/java/org/alfresco/web/bean/workflow/ReassignWorkItemDialog.java index 4bee631f86..08ef202198 100644 --- a/source/java/org/alfresco/web/bean/workflow/ReassignWorkItemDialog.java +++ b/source/java/org/alfresco/web/bean/workflow/ReassignWorkItemDialog.java @@ -1,89 +1,89 @@ -package org.alfresco.web.bean.workflow; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Map; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.ui.common.component.UIGenericPicker; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Bean implementation for the "Reassign Work Item" dialog - * - * @author gavinc - */ -public class ReassignWorkItemDialog extends BaseReassignDialog -{ - private static final long serialVersionUID = 6501900045849920148L; - - protected String workItemId; - - private static final Log logger = LogFactory.getLog(ReassignWorkItemDialog.class); - - - // ------------------------------------------------------------------------------ - // Dialog implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - this.workItemId = this.parameters.get("workitem-id"); - if (this.workItemId == null || this.workItemId.length() == 0) - { - throw new IllegalArgumentException("Reassign workitem dialog called without task id"); - } - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - if (logger.isDebugEnabled()) - logger.debug("Reassigning work item with id: " + this.workItemId); - - UIComponent picker = context.getViewRoot().findComponent("dialog:dialog-body:user-picker"); - - if (picker != null && picker instanceof UIGenericPicker) - { - UIGenericPicker userPicker = (UIGenericPicker)picker; - String[] user = userPicker.getSelectedResults(); - if (user != null && user.length > 0) - { - // create a map to hold the new owner property then update the task - String userName = user[0]; - Map params = new HashMap(1); - params.put(ContentModel.PROP_OWNER, userName); - this.getWorkflowService().updateTask(this.workItemId, params, null, null); - } - else - { - if (logger.isWarnEnabled()) - logger.warn("Failed to find selected user, reassign was unsuccessful"); - } - } - else - { - if (logger.isWarnEnabled()) - logger.warn("Failed to find user-picker component, reassign was unsuccessful"); - } - - if (logger.isDebugEnabled()) - logger.debug("Reassigning work item with id: " + this.workItemId); - - return outcome; - } - - @Override - protected String getErrorMessageId() - { - return "error_reassign_workitem"; - } -} +package org.alfresco.web.bean.workflow; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.ui.common.component.UIGenericPicker; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Bean implementation for the "Reassign Work Item" dialog + * + * @author gavinc + */ +public class ReassignWorkItemDialog extends BaseReassignDialog +{ + private static final long serialVersionUID = 6501900045849920148L; + + protected String workItemId; + + private static final Log logger = LogFactory.getLog(ReassignWorkItemDialog.class); + + + // ------------------------------------------------------------------------------ + // Dialog implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + this.workItemId = this.parameters.get("workitem-id"); + if (this.workItemId == null || this.workItemId.length() == 0) + { + throw new IllegalArgumentException("Reassign workitem dialog called without task id"); + } + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + if (logger.isDebugEnabled()) + logger.debug("Reassigning work item with id: " + this.workItemId); + + UIComponent picker = context.getViewRoot().findComponent("dialog:dialog-body:user-picker"); + + if (picker != null && picker instanceof UIGenericPicker) + { + UIGenericPicker userPicker = (UIGenericPicker)picker; + String[] user = userPicker.getSelectedResults(); + if (user != null && user.length > 0) + { + // create a map to hold the new owner property then update the task + String userName = user[0]; + Map params = new HashMap(1); + params.put(ContentModel.PROP_OWNER, userName); + this.getWorkflowService().updateTask(this.workItemId, params, null, null); + } + else + { + if (logger.isWarnEnabled()) + logger.warn("Failed to find selected user, reassign was unsuccessful"); + } + } + else + { + if (logger.isWarnEnabled()) + logger.warn("Failed to find user-picker component, reassign was unsuccessful"); + } + + if (logger.isDebugEnabled()) + logger.debug("Reassigning work item with id: " + this.workItemId); + + return outcome; + } + + @Override + protected String getErrorMessageId() + { + return "error_reassign_workitem"; + } +} diff --git a/source/java/org/alfresco/web/bean/workflow/StartWorkflowWizard.java b/source/java/org/alfresco/web/bean/workflow/StartWorkflowWizard.java index fa9b91e617..44c2308d34 100644 --- a/source/java/org/alfresco/web/bean/workflow/StartWorkflowWizard.java +++ b/source/java/org/alfresco/web/bean/workflow/StartWorkflowWizard.java @@ -1,814 +1,814 @@ -package org.alfresco.web.bean.workflow; - -import java.io.Serializable; -import java.text.MessageFormat; -import java.util.ArrayList; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.ResourceBundle; -import java.util.StringTokenizer; - -import javax.faces.context.FacesContext; -import javax.faces.event.AbortProcessingException; -import javax.faces.event.ActionEvent; -import javax.faces.model.SelectItem; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.policy.BehaviourFilter; -import org.alfresco.repo.publishing.PublishingEventHelper; -import org.alfresco.repo.workflow.WorkflowModel; -import org.alfresco.repo.workflow.activiti.ActivitiConstants; -import org.alfresco.repo.workflow.jbpm.JBPMEngine; -import org.alfresco.service.cmr.dictionary.PropertyDefinition; -import org.alfresco.service.cmr.invitation.InvitationService; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.workflow.WorkflowDefinition; -import org.alfresco.service.cmr.workflow.WorkflowPath; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.service.cmr.workflow.WorkflowTaskDefinition; -import org.alfresco.service.cmr.workflow.WorkflowTaskState; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.repository.MapNode; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.TransientNode; -import org.alfresco.web.bean.wizard.BaseWizardBean; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.alfresco.web.ui.common.component.data.UIRichList; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.extensions.config.ConfigElement; - -/** - * Bean implementation for the Start Workflow Wizard. - * - * @author gavinc - */ -public class StartWorkflowWizard extends BaseWizardBean -{ - private static final long serialVersionUID = -4370844066621902880L; - - protected String selectedWorkflow; - protected String previouslySelectedWorkflow; - - transient protected List availableWorkflows; - transient private Map workflows; - - protected List excludedWorkflows; - protected List invitationWorkflows; - protected List publishingWorkflows; - - transient private WorkflowService workflowService; - transient private InvitationService invitationService; - transient private BehaviourFilter policyBehaviourFilter; - - protected Node startTaskNode; - protected List resources; - protected List packageItemsToAdd; - protected UIRichList packageItemsRichList; - protected String[] itemsToAdd; - protected boolean isItemBeingAdded = false; - protected boolean nextButtonDisabled = false; - - transient private NodeService unprotectedNodeService; - - private static final Log logger = LogFactory.getLog(StartWorkflowWizard.class); - - public void setUnprotectedNodeService(NodeService unprotectedNodeService) - { - this.unprotectedNodeService = unprotectedNodeService; - } - - protected NodeService getUnprotectedNodeService() - { - if (this.unprotectedNodeService == null) - { - this.unprotectedNodeService = (NodeService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "nodeService"); - } - return this.unprotectedNodeService; - } - - public void setPolicyBehaviourFilter(BehaviourFilter policyBehaviourFilter) - { - this.policyBehaviourFilter = policyBehaviourFilter; - } - - protected BehaviourFilter getBehaviourFilter() - { - if(this.policyBehaviourFilter == null) - { - this.policyBehaviourFilter = (BehaviourFilter) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "policyBehaviourFilter"); - } - return this.policyBehaviourFilter; - } - - protected Map getWorkflows() - { - if (this.workflows == null) - { - initializeWorkflows(); - } - return this.workflows; - } - - // ------------------------------------------------------------------------------ - // Wizard implementation - - @Override - public void init(Map parameters) - { - super.init(parameters); - - // reset the selected workflow - if (this.availableWorkflows != null && this.availableWorkflows.size() > 0) - { - this.selectedWorkflow = (String)this.availableWorkflows.get(0).getValue(); - } - else - { - this.selectedWorkflow = null; - } - - this.previouslySelectedWorkflow = null; - this.startTaskNode = null; - this.resources = null; - this.itemsToAdd = null; - this.packageItemsToAdd = new ArrayList(); - this.isItemBeingAdded = false; - resetRichList(); - - // add the item the workflow wizard was started on to the list of resources - String itemToWorkflowId = this.parameters.get("item-to-workflow"); - try - { - if (itemToWorkflowId != null && itemToWorkflowId.length() > 0) - { - // create the node ref for the item and determine its type - NodeRef itemToWorkflow = new NodeRef(Repository.getStoreRef(), itemToWorkflowId); - QName type = this.getNodeService().getType(itemToWorkflow); - - if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_CONTENT) || this.getDictionaryService().isSubClass(type, ApplicationModel.TYPE_FILELINK)) - { - this.packageItemsToAdd.add(itemToWorkflow.toString()); - } - } - } - catch (InvalidNodeRefException refErr) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] { itemToWorkflowId })); - throw new AbortProcessingException("Invalid node reference"); - } - } - - @Override - public void restored() - { - // reset the workflow package rich list so everything gets re-evaluated - resetRichList(); - } - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - // TODO: Deal with workflows that don't require any data - - if (logger.isDebugEnabled()) - logger.debug("Starting workflow: " + this.selectedWorkflow); - - // prepare the parameters from the current state of the property sheet - Map params = WorkflowUtil.prepareTaskParams(this.startTaskNode); - - if (logger.isDebugEnabled()) - logger.debug("Starting workflow with parameters: " + params); - - // create a workflow package for the attached items and add them - NodeRef workflowPackage = this.getWorkflowService().createPackage(null); - params.put(WorkflowModel.ASSOC_PACKAGE, workflowPackage); - - for (String addedItem : this.packageItemsToAdd) - { - NodeRef addedNodeRef = new NodeRef(addedItem); - //MNT-11522. fix bug. add behavior filter for add items in workflow package. - try - { - this.getBehaviourFilter().disableBehaviour(addedNodeRef, ContentModel.ASPECT_AUDITABLE); - this.getUnprotectedNodeService().addChild(workflowPackage, addedNodeRef, - WorkflowModel.ASSOC_PACKAGE_CONTAINS, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, - QName.createValidLocalName((String)this.getNodeService().getProperty( - addedNodeRef, ContentModel.PROP_NAME)))); - } - finally - { - this.getBehaviourFilter().enableBehaviour(addedNodeRef, ContentModel.ASPECT_AUDITABLE); - } - } - - // setup the context for the workflow (this is the space the workflow was launched from) - Node workflowContext = this.navigator.getCurrentNode(); - if (workflowContext != null) - { - params.put(WorkflowModel.PROP_CONTEXT, (Serializable)workflowContext.getNodeRef()); - } - - // start the workflow to get access to the start task - WorkflowPath path = this.getWorkflowService().startWorkflow(this.selectedWorkflow, params); - if (path != null) - { - // extract the start task - List tasks = this.getWorkflowService().getTasksForWorkflowPath(path.id); - if (tasks.size() == 1) - { - WorkflowTask startTask = tasks.get(0); - - if (logger.isDebugEnabled()) - logger.debug("Found start task:" + startTask); - - if (startTask.state == WorkflowTaskState.IN_PROGRESS) - { - // end the start task to trigger the first 'proper' - // task in the workflow - this.getWorkflowService().endTask(startTask.id, null); - } - } - - if (logger.isDebugEnabled()) - logger.debug("Started workflow: " + this.selectedWorkflow); - } - - return outcome; - } - - @Override - public String next() - { - String stepName = Application.getWizardManager().getCurrentStepName(); - - if ("options".equals(stepName) && - (this.selectedWorkflow.equals(this.previouslySelectedWorkflow) == false)) - { - // retrieve the start task for the selected workflow, get the task - // definition and create a transient node to allow the property - // sheet to collect the required data. - - WorkflowDefinition flowDef = this.getWorkflows().get(this.selectedWorkflow); - - if (logger.isDebugEnabled()) - logger.debug("Selected workflow: "+ flowDef); - - WorkflowTaskDefinition taskDef = flowDef.getStartTaskDefinition(); - if (taskDef != null) - { - if (logger.isDebugEnabled()) - logger.debug("Start task definition: " + taskDef); - - // create an instance of a task from the data dictionary - this.startTaskNode = TransientNode.createNew(getDictionaryService(), taskDef.metadata, - "task_" + System.currentTimeMillis(), null); - } - - // we also need to reset the resources list so that the actions get re-evaluated - resetRichList(); - } - - return null; - } - - @Override - public String back() - { - String stepName = Application.getWizardManager().getCurrentStepName(); - - // if we have come back to the "choose-workflow" step remember - // the current workflow selection - if ("choose-workflow".equals(stepName)) - { - this.previouslySelectedWorkflow = this.selectedWorkflow; - } - - return null; - } - - @Override - public boolean getNextButtonDisabled() - { - return this.nextButtonDisabled; - } - - @Override - public String getContainerTitle() - { - String wizTitle = null; - - ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); - String stepName = Application.getWizardManager().getCurrentStepName(); - - if ("choose-workflow".equals(stepName) == false && this.selectedWorkflow != null) - { - String titlePattern = bundle.getString("start_named_workflow_wizard"); - WorkflowDefinition workflowDef = this.getWorkflows().get(this.selectedWorkflow); - wizTitle = MessageFormat.format(titlePattern, new Object[] {workflowDef.title}); - } - else - { - wizTitle = bundle.getString("start_workflow_wizard"); - } - - return wizTitle; - } - - // ------------------------------------------------------------------------------ - // Event Handlers - - /** - * Prepares the dialog to allow the user to add an item to the workflow package - * - * @param event The event - */ - public void prepareForAdd(ActionEvent event) - { - this.isItemBeingAdded = true; - } - - /** - * Cancels the adding of an item to the workflow package - * - * @param event The event - */ - public void cancelAddPackageItems(ActionEvent event) - { - this.isItemBeingAdded = false; - } - - /** - * Adds items to the workflow package - * - * @param event The event - */ - public void addPackageItems(ActionEvent event) - { - if (this.itemsToAdd != null) - { - for (String item : this.itemsToAdd) - { - this.packageItemsToAdd.add(item); - - if (logger.isDebugEnabled()) - logger.debug("Added item to the added list: " + item); - } - - // reset the rich list so it re-renders - this.packageItemsRichList.setValue(null); - } - - this.isItemBeingAdded = false; - this.itemsToAdd = null; - } - - /** - * Removes an item from the workflow package - * - * @param event The event containing a reference to the item to remove - */ - public void removePackageItem(ActionEvent event) - { - UIActionLink link = (UIActionLink)event.getComponent(); - Map params = link.getParameterMap(); - String nodeRef = new NodeRef(Repository.getStoreRef(), params.get("id")).toString(); - - if (this.packageItemsToAdd.contains(nodeRef)) - { - // remove the item from the added list if it was added in this dialog session - this.packageItemsToAdd.remove(nodeRef); - - if (logger.isDebugEnabled()) - logger.debug("Removed item from the added list: " + nodeRef); - } - - // reset the rich list so it re-renders - this.packageItemsRichList.setValue(null); - } - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns a String array of NodeRef's that are being added to the workflow package - * - * @return String array of NodeRef's - */ - public String[] getItemsToAdd() - { - return this.itemsToAdd; - } - - /** - * Sets the NodeRef's to add as items to the workflow package - * - * @param itemsToAdd NodeRef's to add to the workflow package - */ - public void setItemsToAdd(String[] itemsToAdd) - { - this.itemsToAdd = itemsToAdd; - } - - /** - * Determines whether an item is currently being added to the workflow package - * - * @return true if an item is being added - */ - public boolean isItemBeingAdded() - { - return this.isItemBeingAdded; - } - - /** - * Sets the rich list being used for the workflow package items - * - * @param richList The rich list instance - */ - public void setPackageItemsRichList(UIRichList richList) - { - this.packageItemsRichList = richList; - } - - /** - * Returns the rich list being used for the workflow package items - * - * @return The rich list instance - */ - public UIRichList getPackageItemsRichList() - { - return this.packageItemsRichList; - } - - /** - * Returns the workflow selected by the user - * - * @return The selected workflow - */ - public String getSelectedWorkflow() - { - return selectedWorkflow; - } - - /** - * Sets the selected workflow - * - * @param selectedWorkflow The workflow selected - */ - public void setSelectedWorkflow(String selectedWorkflow) - { - this.selectedWorkflow = selectedWorkflow; - } - - /** - * Returns the Node representing the start task metadata required - * - * @return The Node for the start task - */ - public Node getTaskMetadataNode() - { - return this.startTaskNode; - } - - /** - * Returns the action group the current task uses for the workflow package - * - * @return action group id - */ - public String getPackageActionGroup() - { - String actionGroup = null; - - WorkflowDefinition flowDef = this.getWorkflows().get(this.selectedWorkflow); - WorkflowTaskDefinition taskDef = flowDef.getStartTaskDefinition(); - if (taskDef != null) - { - PropertyDefinition propDef = taskDef.metadata.getProperties().get( - WorkflowModel.PROP_PACKAGE_ACTION_GROUP); - if (propDef != null) - { - actionGroup = propDef.getDefaultValue(); - } - } - - return actionGroup; - } - - /** - * Returns the action group the current task uses for each workflow package item - * - * @return action group id - */ - public String getPackageItemActionGroup() - { - String actionGroup = null; - - WorkflowDefinition flowDef = this.getWorkflows().get(this.selectedWorkflow); - WorkflowTaskDefinition taskDef = flowDef.getStartTaskDefinition(); - if (taskDef != null) - { - PropertyDefinition propDef = taskDef.metadata.getProperties().get( - WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP); - if (propDef != null) - { - actionGroup = propDef.getDefaultValue(); - } - } - - return actionGroup; - } - - /** - * @return Returns the summary data for the wizard. - */ - public String getSummary() - { - ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); - - String workflowName = null; - for (SelectItem item : this.availableWorkflows) - { - if (item.getValue().equals(this.selectedWorkflow)) - { - workflowName = item.getLabel(); - break; - } - } - - return buildSummary( - new String[] {bundle.getString("start_workflow")}, - new String[] {workflowName}); - } - - /** - * Determines whether there are any workflows to start - * - * @return true if there are startable workflows - */ - public boolean getHasStartableWorkflows() - { - // get the list of startable workflow, this will intialise the list if necessary - List workflows = getStartableWorkflows(); - return (workflows.size() > 0); - } - - private void initializeWorkflows() - { - // NOTE: we don't cache the list of startable workflows as they could get - // updated, in which case we need the latest instance id, they could - // theoretically also get removed. - - this.availableWorkflows = new ArrayList(4); - this.workflows = new HashMap(4); - - List configuredInvitationWorkflows = this.getInvitationServiceWorkflowNames(); - List publishingWorkflows = this.getPublishingWorkflowNames(); - List excludedWorkflows = this.getExcludedWorkflows(); - - List workflowDefs = this.getWorkflowService().getDefinitions(); - for (WorkflowDefinition workflowDef : workflowDefs) - { - String name = workflowDef.name; - - if (configuredInvitationWorkflows.contains(name) == false && - publishingWorkflows.contains(name) == false && - excludedWorkflows.contains(name) == false) - { - // add the workflow if it is not a WCM specific workflow - String label = workflowDef.title; - if (workflowDef.description != null && workflowDef.description.length() > 0) - { - label = label + " (" + workflowDef.description + ")"; - } - this.availableWorkflows.add(new SelectItem(workflowDef.id, label)); - this.workflows.put(workflowDef.id, workflowDef); - } - } - - // disable the next button if there are no workflows - if (this.availableWorkflows.size() == 0) - { - this.nextButtonDisabled = true; - } - } - - /** - * Returns a list of workflows that can be started. - * - * @return List of SelectItem objects representing the workflows - */ - public List getStartableWorkflows() - { - if (availableWorkflows == null) - { - initializeWorkflows(); - } - - // Alphabetical list sorting - // Fix bug reported in https://issues.alfresco.com/browse/ETWOTWO-302 - - QuickSort sorter = new QuickSort(availableWorkflows, "label", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - - // select the first workflow in the list - if (this.availableWorkflows.size() > 0 && previouslySelectedWorkflow == null) - { - this.selectedWorkflow = (String)this.availableWorkflows.get(0).getValue(); - } - - return availableWorkflows; - } - - /** - * Returns the URL to the Workflow Definition Image of the current task - * - * @return the url - */ - public String getWorkflowDefinitionImageUrl() - { - String url = null; - if (selectedWorkflow != null) - { - WorkflowDefinition def = getWorkflows().get(selectedWorkflow); - url = "/workflowdefinitionimage/" + def.id; - } - return url; - } - - /** - * Returns a list of resources associated with this task - * i.e. the children of the workflow package - * - * @return The list of nodes - */ - public List getResources() - { - this.resources = new ArrayList(4); - - UserTransaction tx = null; - try - { - FacesContext context = FacesContext.getCurrentInstance(); - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - for (String newItem : this.packageItemsToAdd) - { - NodeRef nodeRef = new NodeRef(newItem); - if (this.getNodeService().exists(nodeRef)) - { - // create our Node representation - MapNode node = new MapNode(nodeRef, this.getNodeService(), true); - this.browseBean.setupCommonBindingProperties(node); - - // add property resolvers to show path information - node.addPropertyResolver("path", this.browseBean.resolverPath); - node.addPropertyResolver("displayPath", this.browseBean.resolverDisplayPath); - - this.resources.add(node); - } - else - { - if (logger.isDebugEnabled()) - logger.debug("Ignoring " + nodeRef + " as it has been removed from the repository"); - } - } - - // commit the transaction - tx.commit(); - } - catch (Throwable err) - { - Utils.addErrorMessage(MessageFormat.format(Application.getMessage( - FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); - this.resources = Collections.emptyList(); - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - - return this.resources; - } - - /** - * Sets the workflow service to use - * - * @param workflowService WorkflowService instance - */ - public void setWorkflowService(WorkflowService workflowService) - { - this.workflowService = workflowService; - } - - - protected WorkflowService getWorkflowService() - { - if (this.workflowService == null) - { - this.workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); - } - return this.workflowService; - } - - // ------------------------------------------------------------------------------ - // Helper methods - - /** - * Resets the rich list - */ - protected void resetRichList() - { - if (this.packageItemsRichList != null) - { - this.packageItemsRichList.setValue(null); - this.packageItemsRichList = null; - } - } - - /** - * Get the Names of globally excluded workflow-names. - * - * @return The names of the workflows to exclude. - */ - protected List getExcludedWorkflows() - { - if ((excludedWorkflows == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) - { - FacesContext fc = FacesContext.getCurrentInstance(); - ConfigElement config = Application.getConfigService(fc).getGlobalConfig().getConfigElement("excluded-workflows"); - if (config != null) - { - StringTokenizer t = new StringTokenizer(config.getValue().trim(), ", "); - excludedWorkflows = new ArrayList(t.countTokens()); - while (t.hasMoreTokens()) - { - String wfName = t.nextToken(); - excludedWorkflows.add(wfName); - } - } - else - { - excludedWorkflows = Collections.emptyList(); - } - } - return excludedWorkflows; - } - - /** - * Get the Names of the Invitation Service Workflows - * - * @return The names of the Invitation Service workflows - */ - protected List getInvitationServiceWorkflowNames() - { - if( invitationWorkflows == null ) - { - if (invitationService != null) - { - invitationWorkflows = invitationService.getInvitationServiceWorkflowNames(); - } - } - return invitationWorkflows; - } - - /** - * Get the names of the publishing workflows - * - * @return The names of the publishing workflows - */ - protected List getPublishingWorkflowNames() - { - if (publishingWorkflows == null) - { - publishingWorkflows = new ArrayList(2); - - publishingWorkflows.add(JBPMEngine.ENGINE_ID + "$" + PublishingEventHelper.WORKFLOW_DEFINITION_NAME); - publishingWorkflows.add(ActivitiConstants.ENGINE_ID + "$" + PublishingEventHelper.WORKFLOW_DEFINITION_NAME); - } - - return publishingWorkflows; - } - - public void setInvitationService(InvitationService invitationService) - { - this.invitationService = invitationService; - } - - public InvitationService getInvitationService() - { - return invitationService; - } -} +package org.alfresco.web.bean.workflow; + +import java.io.Serializable; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.ResourceBundle; +import java.util.StringTokenizer; + +import javax.faces.context.FacesContext; +import javax.faces.event.AbortProcessingException; +import javax.faces.event.ActionEvent; +import javax.faces.model.SelectItem; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.policy.BehaviourFilter; +import org.alfresco.repo.publishing.PublishingEventHelper; +import org.alfresco.repo.workflow.WorkflowModel; +import org.alfresco.repo.workflow.activiti.ActivitiConstants; +import org.alfresco.repo.workflow.jbpm.JBPMEngine; +import org.alfresco.service.cmr.dictionary.PropertyDefinition; +import org.alfresco.service.cmr.invitation.InvitationService; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.workflow.WorkflowDefinition; +import org.alfresco.service.cmr.workflow.WorkflowPath; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.service.cmr.workflow.WorkflowTaskDefinition; +import org.alfresco.service.cmr.workflow.WorkflowTaskState; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.repository.MapNode; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.TransientNode; +import org.alfresco.web.bean.wizard.BaseWizardBean; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.alfresco.web.ui.common.component.data.UIRichList; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.extensions.config.ConfigElement; + +/** + * Bean implementation for the Start Workflow Wizard. + * + * @author gavinc + */ +public class StartWorkflowWizard extends BaseWizardBean +{ + private static final long serialVersionUID = -4370844066621902880L; + + protected String selectedWorkflow; + protected String previouslySelectedWorkflow; + + transient protected List availableWorkflows; + transient private Map workflows; + + protected List excludedWorkflows; + protected List invitationWorkflows; + protected List publishingWorkflows; + + transient private WorkflowService workflowService; + transient private InvitationService invitationService; + transient private BehaviourFilter policyBehaviourFilter; + + protected Node startTaskNode; + protected List resources; + protected List packageItemsToAdd; + protected UIRichList packageItemsRichList; + protected String[] itemsToAdd; + protected boolean isItemBeingAdded = false; + protected boolean nextButtonDisabled = false; + + transient private NodeService unprotectedNodeService; + + private static final Log logger = LogFactory.getLog(StartWorkflowWizard.class); + + public void setUnprotectedNodeService(NodeService unprotectedNodeService) + { + this.unprotectedNodeService = unprotectedNodeService; + } + + protected NodeService getUnprotectedNodeService() + { + if (this.unprotectedNodeService == null) + { + this.unprotectedNodeService = (NodeService) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "nodeService"); + } + return this.unprotectedNodeService; + } + + public void setPolicyBehaviourFilter(BehaviourFilter policyBehaviourFilter) + { + this.policyBehaviourFilter = policyBehaviourFilter; + } + + protected BehaviourFilter getBehaviourFilter() + { + if(this.policyBehaviourFilter == null) + { + this.policyBehaviourFilter = (BehaviourFilter) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "policyBehaviourFilter"); + } + return this.policyBehaviourFilter; + } + + protected Map getWorkflows() + { + if (this.workflows == null) + { + initializeWorkflows(); + } + return this.workflows; + } + + // ------------------------------------------------------------------------------ + // Wizard implementation + + @Override + public void init(Map parameters) + { + super.init(parameters); + + // reset the selected workflow + if (this.availableWorkflows != null && this.availableWorkflows.size() > 0) + { + this.selectedWorkflow = (String)this.availableWorkflows.get(0).getValue(); + } + else + { + this.selectedWorkflow = null; + } + + this.previouslySelectedWorkflow = null; + this.startTaskNode = null; + this.resources = null; + this.itemsToAdd = null; + this.packageItemsToAdd = new ArrayList(); + this.isItemBeingAdded = false; + resetRichList(); + + // add the item the workflow wizard was started on to the list of resources + String itemToWorkflowId = this.parameters.get("item-to-workflow"); + try + { + if (itemToWorkflowId != null && itemToWorkflowId.length() > 0) + { + // create the node ref for the item and determine its type + NodeRef itemToWorkflow = new NodeRef(Repository.getStoreRef(), itemToWorkflowId); + QName type = this.getNodeService().getType(itemToWorkflow); + + if (this.getDictionaryService().isSubClass(type, ContentModel.TYPE_CONTENT) || this.getDictionaryService().isSubClass(type, ApplicationModel.TYPE_FILELINK)) + { + this.packageItemsToAdd.add(itemToWorkflow.toString()); + } + } + } + catch (InvalidNodeRefException refErr) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] { itemToWorkflowId })); + throw new AbortProcessingException("Invalid node reference"); + } + } + + @Override + public void restored() + { + // reset the workflow package rich list so everything gets re-evaluated + resetRichList(); + } + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + // TODO: Deal with workflows that don't require any data + + if (logger.isDebugEnabled()) + logger.debug("Starting workflow: " + this.selectedWorkflow); + + // prepare the parameters from the current state of the property sheet + Map params = WorkflowUtil.prepareTaskParams(this.startTaskNode); + + if (logger.isDebugEnabled()) + logger.debug("Starting workflow with parameters: " + params); + + // create a workflow package for the attached items and add them + NodeRef workflowPackage = this.getWorkflowService().createPackage(null); + params.put(WorkflowModel.ASSOC_PACKAGE, workflowPackage); + + for (String addedItem : this.packageItemsToAdd) + { + NodeRef addedNodeRef = new NodeRef(addedItem); + //MNT-11522. fix bug. add behavior filter for add items in workflow package. + try + { + this.getBehaviourFilter().disableBehaviour(addedNodeRef, ContentModel.ASPECT_AUDITABLE); + this.getUnprotectedNodeService().addChild(workflowPackage, addedNodeRef, + WorkflowModel.ASSOC_PACKAGE_CONTAINS, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, + QName.createValidLocalName((String)this.getNodeService().getProperty( + addedNodeRef, ContentModel.PROP_NAME)))); + } + finally + { + this.getBehaviourFilter().enableBehaviour(addedNodeRef, ContentModel.ASPECT_AUDITABLE); + } + } + + // setup the context for the workflow (this is the space the workflow was launched from) + Node workflowContext = this.navigator.getCurrentNode(); + if (workflowContext != null) + { + params.put(WorkflowModel.PROP_CONTEXT, (Serializable)workflowContext.getNodeRef()); + } + + // start the workflow to get access to the start task + WorkflowPath path = this.getWorkflowService().startWorkflow(this.selectedWorkflow, params); + if (path != null) + { + // extract the start task + List tasks = this.getWorkflowService().getTasksForWorkflowPath(path.id); + if (tasks.size() == 1) + { + WorkflowTask startTask = tasks.get(0); + + if (logger.isDebugEnabled()) + logger.debug("Found start task:" + startTask); + + if (startTask.state == WorkflowTaskState.IN_PROGRESS) + { + // end the start task to trigger the first 'proper' + // task in the workflow + this.getWorkflowService().endTask(startTask.id, null); + } + } + + if (logger.isDebugEnabled()) + logger.debug("Started workflow: " + this.selectedWorkflow); + } + + return outcome; + } + + @Override + public String next() + { + String stepName = Application.getWizardManager().getCurrentStepName(); + + if ("options".equals(stepName) && + (this.selectedWorkflow.equals(this.previouslySelectedWorkflow) == false)) + { + // retrieve the start task for the selected workflow, get the task + // definition and create a transient node to allow the property + // sheet to collect the required data. + + WorkflowDefinition flowDef = this.getWorkflows().get(this.selectedWorkflow); + + if (logger.isDebugEnabled()) + logger.debug("Selected workflow: "+ flowDef); + + WorkflowTaskDefinition taskDef = flowDef.getStartTaskDefinition(); + if (taskDef != null) + { + if (logger.isDebugEnabled()) + logger.debug("Start task definition: " + taskDef); + + // create an instance of a task from the data dictionary + this.startTaskNode = TransientNode.createNew(getDictionaryService(), taskDef.metadata, + "task_" + System.currentTimeMillis(), null); + } + + // we also need to reset the resources list so that the actions get re-evaluated + resetRichList(); + } + + return null; + } + + @Override + public String back() + { + String stepName = Application.getWizardManager().getCurrentStepName(); + + // if we have come back to the "choose-workflow" step remember + // the current workflow selection + if ("choose-workflow".equals(stepName)) + { + this.previouslySelectedWorkflow = this.selectedWorkflow; + } + + return null; + } + + @Override + public boolean getNextButtonDisabled() + { + return this.nextButtonDisabled; + } + + @Override + public String getContainerTitle() + { + String wizTitle = null; + + ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); + String stepName = Application.getWizardManager().getCurrentStepName(); + + if ("choose-workflow".equals(stepName) == false && this.selectedWorkflow != null) + { + String titlePattern = bundle.getString("start_named_workflow_wizard"); + WorkflowDefinition workflowDef = this.getWorkflows().get(this.selectedWorkflow); + wizTitle = MessageFormat.format(titlePattern, new Object[] {workflowDef.title}); + } + else + { + wizTitle = bundle.getString("start_workflow_wizard"); + } + + return wizTitle; + } + + // ------------------------------------------------------------------------------ + // Event Handlers + + /** + * Prepares the dialog to allow the user to add an item to the workflow package + * + * @param event The event + */ + public void prepareForAdd(ActionEvent event) + { + this.isItemBeingAdded = true; + } + + /** + * Cancels the adding of an item to the workflow package + * + * @param event The event + */ + public void cancelAddPackageItems(ActionEvent event) + { + this.isItemBeingAdded = false; + } + + /** + * Adds items to the workflow package + * + * @param event The event + */ + public void addPackageItems(ActionEvent event) + { + if (this.itemsToAdd != null) + { + for (String item : this.itemsToAdd) + { + this.packageItemsToAdd.add(item); + + if (logger.isDebugEnabled()) + logger.debug("Added item to the added list: " + item); + } + + // reset the rich list so it re-renders + this.packageItemsRichList.setValue(null); + } + + this.isItemBeingAdded = false; + this.itemsToAdd = null; + } + + /** + * Removes an item from the workflow package + * + * @param event The event containing a reference to the item to remove + */ + public void removePackageItem(ActionEvent event) + { + UIActionLink link = (UIActionLink)event.getComponent(); + Map params = link.getParameterMap(); + String nodeRef = new NodeRef(Repository.getStoreRef(), params.get("id")).toString(); + + if (this.packageItemsToAdd.contains(nodeRef)) + { + // remove the item from the added list if it was added in this dialog session + this.packageItemsToAdd.remove(nodeRef); + + if (logger.isDebugEnabled()) + logger.debug("Removed item from the added list: " + nodeRef); + } + + // reset the rich list so it re-renders + this.packageItemsRichList.setValue(null); + } + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns a String array of NodeRef's that are being added to the workflow package + * + * @return String array of NodeRef's + */ + public String[] getItemsToAdd() + { + return this.itemsToAdd; + } + + /** + * Sets the NodeRef's to add as items to the workflow package + * + * @param itemsToAdd NodeRef's to add to the workflow package + */ + public void setItemsToAdd(String[] itemsToAdd) + { + this.itemsToAdd = itemsToAdd; + } + + /** + * Determines whether an item is currently being added to the workflow package + * + * @return true if an item is being added + */ + public boolean isItemBeingAdded() + { + return this.isItemBeingAdded; + } + + /** + * Sets the rich list being used for the workflow package items + * + * @param richList The rich list instance + */ + public void setPackageItemsRichList(UIRichList richList) + { + this.packageItemsRichList = richList; + } + + /** + * Returns the rich list being used for the workflow package items + * + * @return The rich list instance + */ + public UIRichList getPackageItemsRichList() + { + return this.packageItemsRichList; + } + + /** + * Returns the workflow selected by the user + * + * @return The selected workflow + */ + public String getSelectedWorkflow() + { + return selectedWorkflow; + } + + /** + * Sets the selected workflow + * + * @param selectedWorkflow The workflow selected + */ + public void setSelectedWorkflow(String selectedWorkflow) + { + this.selectedWorkflow = selectedWorkflow; + } + + /** + * Returns the Node representing the start task metadata required + * + * @return The Node for the start task + */ + public Node getTaskMetadataNode() + { + return this.startTaskNode; + } + + /** + * Returns the action group the current task uses for the workflow package + * + * @return action group id + */ + public String getPackageActionGroup() + { + String actionGroup = null; + + WorkflowDefinition flowDef = this.getWorkflows().get(this.selectedWorkflow); + WorkflowTaskDefinition taskDef = flowDef.getStartTaskDefinition(); + if (taskDef != null) + { + PropertyDefinition propDef = taskDef.metadata.getProperties().get( + WorkflowModel.PROP_PACKAGE_ACTION_GROUP); + if (propDef != null) + { + actionGroup = propDef.getDefaultValue(); + } + } + + return actionGroup; + } + + /** + * Returns the action group the current task uses for each workflow package item + * + * @return action group id + */ + public String getPackageItemActionGroup() + { + String actionGroup = null; + + WorkflowDefinition flowDef = this.getWorkflows().get(this.selectedWorkflow); + WorkflowTaskDefinition taskDef = flowDef.getStartTaskDefinition(); + if (taskDef != null) + { + PropertyDefinition propDef = taskDef.metadata.getProperties().get( + WorkflowModel.PROP_PACKAGE_ITEM_ACTION_GROUP); + if (propDef != null) + { + actionGroup = propDef.getDefaultValue(); + } + } + + return actionGroup; + } + + /** + * @return Returns the summary data for the wizard. + */ + public String getSummary() + { + ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); + + String workflowName = null; + for (SelectItem item : this.availableWorkflows) + { + if (item.getValue().equals(this.selectedWorkflow)) + { + workflowName = item.getLabel(); + break; + } + } + + return buildSummary( + new String[] {bundle.getString("start_workflow")}, + new String[] {workflowName}); + } + + /** + * Determines whether there are any workflows to start + * + * @return true if there are startable workflows + */ + public boolean getHasStartableWorkflows() + { + // get the list of startable workflow, this will intialise the list if necessary + List workflows = getStartableWorkflows(); + return (workflows.size() > 0); + } + + private void initializeWorkflows() + { + // NOTE: we don't cache the list of startable workflows as they could get + // updated, in which case we need the latest instance id, they could + // theoretically also get removed. + + this.availableWorkflows = new ArrayList(4); + this.workflows = new HashMap(4); + + List configuredInvitationWorkflows = this.getInvitationServiceWorkflowNames(); + List publishingWorkflows = this.getPublishingWorkflowNames(); + List excludedWorkflows = this.getExcludedWorkflows(); + + List workflowDefs = this.getWorkflowService().getDefinitions(); + for (WorkflowDefinition workflowDef : workflowDefs) + { + String name = workflowDef.name; + + if (configuredInvitationWorkflows.contains(name) == false && + publishingWorkflows.contains(name) == false && + excludedWorkflows.contains(name) == false) + { + // add the workflow if it is not a WCM specific workflow + String label = workflowDef.title; + if (workflowDef.description != null && workflowDef.description.length() > 0) + { + label = label + " (" + workflowDef.description + ")"; + } + this.availableWorkflows.add(new SelectItem(workflowDef.id, label)); + this.workflows.put(workflowDef.id, workflowDef); + } + } + + // disable the next button if there are no workflows + if (this.availableWorkflows.size() == 0) + { + this.nextButtonDisabled = true; + } + } + + /** + * Returns a list of workflows that can be started. + * + * @return List of SelectItem objects representing the workflows + */ + public List getStartableWorkflows() + { + if (availableWorkflows == null) + { + initializeWorkflows(); + } + + // Alphabetical list sorting + // Fix bug reported in https://issues.alfresco.com/browse/ETWOTWO-302 + + QuickSort sorter = new QuickSort(availableWorkflows, "label", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + + // select the first workflow in the list + if (this.availableWorkflows.size() > 0 && previouslySelectedWorkflow == null) + { + this.selectedWorkflow = (String)this.availableWorkflows.get(0).getValue(); + } + + return availableWorkflows; + } + + /** + * Returns the URL to the Workflow Definition Image of the current task + * + * @return the url + */ + public String getWorkflowDefinitionImageUrl() + { + String url = null; + if (selectedWorkflow != null) + { + WorkflowDefinition def = getWorkflows().get(selectedWorkflow); + url = "/workflowdefinitionimage/" + def.id; + } + return url; + } + + /** + * Returns a list of resources associated with this task + * i.e. the children of the workflow package + * + * @return The list of nodes + */ + public List getResources() + { + this.resources = new ArrayList(4); + + UserTransaction tx = null; + try + { + FacesContext context = FacesContext.getCurrentInstance(); + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + for (String newItem : this.packageItemsToAdd) + { + NodeRef nodeRef = new NodeRef(newItem); + if (this.getNodeService().exists(nodeRef)) + { + // create our Node representation + MapNode node = new MapNode(nodeRef, this.getNodeService(), true); + this.browseBean.setupCommonBindingProperties(node); + + // add property resolvers to show path information + node.addPropertyResolver("path", this.browseBean.resolverPath); + node.addPropertyResolver("displayPath", this.browseBean.resolverDisplayPath); + + this.resources.add(node); + } + else + { + if (logger.isDebugEnabled()) + logger.debug("Ignoring " + nodeRef + " as it has been removed from the repository"); + } + } + + // commit the transaction + tx.commit(); + } + catch (Throwable err) + { + Utils.addErrorMessage(MessageFormat.format(Application.getMessage( + FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err); + this.resources = Collections.emptyList(); + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + + return this.resources; + } + + /** + * Sets the workflow service to use + * + * @param workflowService WorkflowService instance + */ + public void setWorkflowService(WorkflowService workflowService) + { + this.workflowService = workflowService; + } + + + protected WorkflowService getWorkflowService() + { + if (this.workflowService == null) + { + this.workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); + } + return this.workflowService; + } + + // ------------------------------------------------------------------------------ + // Helper methods + + /** + * Resets the rich list + */ + protected void resetRichList() + { + if (this.packageItemsRichList != null) + { + this.packageItemsRichList.setValue(null); + this.packageItemsRichList = null; + } + } + + /** + * Get the Names of globally excluded workflow-names. + * + * @return The names of the workflows to exclude. + */ + protected List getExcludedWorkflows() + { + if ((excludedWorkflows == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance()))) + { + FacesContext fc = FacesContext.getCurrentInstance(); + ConfigElement config = Application.getConfigService(fc).getGlobalConfig().getConfigElement("excluded-workflows"); + if (config != null) + { + StringTokenizer t = new StringTokenizer(config.getValue().trim(), ", "); + excludedWorkflows = new ArrayList(t.countTokens()); + while (t.hasMoreTokens()) + { + String wfName = t.nextToken(); + excludedWorkflows.add(wfName); + } + } + else + { + excludedWorkflows = Collections.emptyList(); + } + } + return excludedWorkflows; + } + + /** + * Get the Names of the Invitation Service Workflows + * + * @return The names of the Invitation Service workflows + */ + protected List getInvitationServiceWorkflowNames() + { + if( invitationWorkflows == null ) + { + if (invitationService != null) + { + invitationWorkflows = invitationService.getInvitationServiceWorkflowNames(); + } + } + return invitationWorkflows; + } + + /** + * Get the names of the publishing workflows + * + * @return The names of the publishing workflows + */ + protected List getPublishingWorkflowNames() + { + if (publishingWorkflows == null) + { + publishingWorkflows = new ArrayList(2); + + publishingWorkflows.add(JBPMEngine.ENGINE_ID + "$" + PublishingEventHelper.WORKFLOW_DEFINITION_NAME); + publishingWorkflows.add(ActivitiConstants.ENGINE_ID + "$" + PublishingEventHelper.WORKFLOW_DEFINITION_NAME); + } + + return publishingWorkflows; + } + + public void setInvitationService(InvitationService invitationService) + { + this.invitationService = invitationService; + } + + public InvitationService getInvitationService() + { + return invitationService; + } +} diff --git a/source/java/org/alfresco/web/bean/workflow/ViewCompletedTaskDialog.java b/source/java/org/alfresco/web/bean/workflow/ViewCompletedTaskDialog.java index 636a474412..25c664b643 100644 --- a/source/java/org/alfresco/web/bean/workflow/ViewCompletedTaskDialog.java +++ b/source/java/org/alfresco/web/bean/workflow/ViewCompletedTaskDialog.java @@ -1,50 +1,50 @@ -package org.alfresco.web.bean.workflow; - -import java.util.List; - -import javax.faces.context.FacesContext; - -import org.alfresco.web.app.Application; -import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; - -/** - * Bean implementation for the "View Completed Task" dialog. - * - * @author gavinc - */ -public class ViewCompletedTaskDialog extends ManageTaskDialog -{ - // ------------------------------------------------------------------------------ - // Dialog implementation - - private static final long serialVersionUID = 1568710712589201055L; - - @Override - protected String finishImpl(FacesContext context, String outcome) - throws Exception - { - // nothing to do as the finish button is not shown and the dialog is read only - - return outcome; - } - - @Override - public String getCancelButtonLabel() - { - return Application.getMessage(FacesContext.getCurrentInstance(), "close"); - } - - @Override - public List getAdditionalButtons() - { - return null; - } - - @Override - public String getContainerTitle() - { - String titleStart = Application.getMessage(FacesContext.getCurrentInstance(), "view_completed_task_title"); - - return titleStart + ": " + this.getWorkflowTask().title; - } -} +package org.alfresco.web.bean.workflow; + +import java.util.List; + +import javax.faces.context.FacesContext; + +import org.alfresco.web.app.Application; +import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; + +/** + * Bean implementation for the "View Completed Task" dialog. + * + * @author gavinc + */ +public class ViewCompletedTaskDialog extends ManageTaskDialog +{ + // ------------------------------------------------------------------------------ + // Dialog implementation + + private static final long serialVersionUID = 1568710712589201055L; + + @Override + protected String finishImpl(FacesContext context, String outcome) + throws Exception + { + // nothing to do as the finish button is not shown and the dialog is read only + + return outcome; + } + + @Override + public String getCancelButtonLabel() + { + return Application.getMessage(FacesContext.getCurrentInstance(), "close"); + } + + @Override + public List getAdditionalButtons() + { + return null; + } + + @Override + public String getContainerTitle() + { + String titleStart = Application.getMessage(FacesContext.getCurrentInstance(), "view_completed_task_title"); + + return titleStart + ": " + this.getWorkflowTask().title; + } +} diff --git a/source/java/org/alfresco/web/bean/workflow/WorkflowBean.java b/source/java/org/alfresco/web/bean/workflow/WorkflowBean.java index a4e03c6fa0..09eb032acd 100644 --- a/source/java/org/alfresco/web/bean/workflow/WorkflowBean.java +++ b/source/java/org/alfresco/web/bean/workflow/WorkflowBean.java @@ -1,363 +1,363 @@ -package org.alfresco.web.bean.workflow; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.event.ActionEvent; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.workflow.WorkflowModel; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.service.cmr.workflow.WorkflowTaskDefinition; -import org.alfresco.service.cmr.workflow.WorkflowTaskQuery; -import org.alfresco.service.cmr.workflow.WorkflowTaskState; -import org.alfresco.service.cmr.workflow.WorkflowTransition; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.config.ClientConfigElement; -import org.springframework.extensions.surf.util.ParameterCheck; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.TransientMapNode; -import org.alfresco.web.bean.repository.TransientNode; -import org.alfresco.web.bean.repository.User; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Managed bean used for providing support for the workflow task dashlets - * - * @author gavinc - */ -public class WorkflowBean implements Serializable -{ - private static final long serialVersionUID = 2950475254440425384L; - - protected NavigationBean navigationBean; - - transient private NodeService nodeService; - transient private WorkflowService workflowService; - - protected List tasks; - protected List activeTasks; - protected List pooledTasks; - protected List completedTasks; - - private static final Log logger = LogFactory.getLog(WorkflowBean.class); - - public static final String BEAN_NAME = "WorkflowBean"; - - - // ------------------------------------------------------------------------------ - // Bean Getters and Setters - - /** - * Returns a list of nodes representing the "all" active tasks. - * - * @return List of all active tasks - */ - public List getAllActiveTasks() - { - if (this.activeTasks == null) - { - // get the current username - FacesContext context = FacesContext.getCurrentInstance(); - User user = Application.getCurrentUser(context); - String userName = user.getUserName(); - - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - // query for all active tasks - WorkflowTaskQuery query = new WorkflowTaskQuery(); - List tasks = this.getWorkflowService().queryTasks(query); - - // create a list of transient nodes to represent - this.activeTasks = new ArrayList(tasks.size()); - for (WorkflowTask task : tasks) - { - Node node = createTask(task); - this.activeTasks.add(node); - - if (logger.isDebugEnabled()) - logger.debug("Added active task: " + node); - } - - // commit the changes - tx.commit(); - } - catch (Throwable e) - { - // rollback the transaction - try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} - Utils.addErrorMessage("Failed to get all active tasks: " + e.toString(), e); - } - } - - return this.activeTasks; - } - - /** - * Returns a list of nodes representing the "pooled" to do tasks the - * current user has. - * - * @return List of to do tasks - */ - public List getPooledTasks() - { - if (this.pooledTasks == null) - { - // get the current username - FacesContext context = FacesContext.getCurrentInstance(); - User user = Application.getCurrentUser(context); - String userName = user.getUserName(); - - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - // get the current pooled tasks for the current user - List tasks = this.getWorkflowService().getPooledTasks(userName, true); - - // create a list of transient nodes to represent - this.pooledTasks = new ArrayList(tasks.size()); - for (WorkflowTask task : tasks) - { - Node node = createTask(task); - this.pooledTasks.add(node); - - if (logger.isDebugEnabled()) - logger.debug("Added pooled task: " + node); - } - - // commit the changes - tx.commit(); - } - catch (Throwable e) - { - // rollback the transaction - try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} - Utils.addErrorMessage("Failed to get pooled tasks: " + e.toString(), e); - } - } - - return this.pooledTasks; - } - - /** - * Returns a list of nodes representing the to do tasks the - * current user has. - * - * @return List of to do tasks - */ - public List getTasksToDo() - { - if (this.tasks == null) - { - // get the current username - FacesContext context = FacesContext.getCurrentInstance(); - User user = Application.getCurrentUser(context); - String userName = user.getUserName(); - - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - // get the current in progress tasks for the current user - List tasks = this.getWorkflowService().getAssignedTasks( - userName, WorkflowTaskState.IN_PROGRESS, true); - - // create a list of transient nodes to represent - this.tasks = new ArrayList(tasks.size()); - for (WorkflowTask task : tasks) - { - Node node = createTask(task); - this.tasks.add(node); - - if (logger.isDebugEnabled()) - logger.debug("Added to do task: " + node); - } - - // commit the changes - tx.commit(); - } - catch (Throwable e) - { - // rollback the transaction - try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} - Utils.addErrorMessage("Failed to get to do tasks: " + e.toString(), e); - } - } - - return this.tasks; - } - - /** - * Returns a list of nodes representing the completed tasks the - * current user has. - * - * @return List of completed tasks - */ - public List getTasksCompleted() - { - if (this.completedTasks == null) - { - // get the current username - FacesContext context = FacesContext.getCurrentInstance(); - User user = Application.getCurrentUser(context); - String userName = user.getUserName(); - - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(context, true); - tx.begin(); - - // get the current in progress tasks for the current user - ClientConfigElement clientConfig = (ClientConfigElement)Application.getConfigService(context).getGlobalConfig().getConfigElement( - ClientConfigElement.CONFIG_ELEMENT_ID); - WorkflowTaskQuery query = new WorkflowTaskQuery(); - query.setActive(null); - query.setActorId(userName); - query.setTaskState(WorkflowTaskState.COMPLETED); - query.setLimit(clientConfig.getTasksCompletedMaxResults()); - List tasks = this.getWorkflowService().queryTasks(query); - - // create a list of transient nodes to represent - this.completedTasks = new ArrayList(tasks.size()); - for (WorkflowTask task : tasks) - { - Node node = createTask(task); - this.completedTasks.add(node); - - if (logger.isDebugEnabled()) - logger.debug("Added completed task: " + node); - } - - // commit the changes - tx.commit(); - } - catch (Throwable e) - { - // rollback the transaction - try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} - Utils.addErrorMessage("Failed to get completed tasks: " + e.toString(), e); - } - } - - return this.completedTasks; - } - - /** - * Sets the navigation bean to use - * - * @param navigationBean The NavigationBean to set. - */ - public void setNavigationBean(NavigationBean navigationBean) - { - this.navigationBean = navigationBean; - } - - /** - * Sets the workflow service to use - * - * @param workflowService WorkflowService instance - */ - public void setWorkflowService(WorkflowService workflowService) - { - this.workflowService = workflowService; - } - - protected WorkflowService getWorkflowService() - { - if (this.workflowService == null) - { - this.workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); - } - return this.workflowService; - } - - /** - * Sets the node service to use - * - * @param nodeService NodeService instance - */ - public void setNodeService(NodeService nodeService) - { - this.nodeService = nodeService; - } - - protected NodeService getNodeService() - { - if (this.nodeService == null) - { - this.nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); - } - return this.nodeService; - } - // ------------------------------------------------------------------------------ - // Navigation handlers - - public void setupTaskDialog(ActionEvent event) - { - UIActionLink link = (UIActionLink)event.getComponent(); - Map params = link.getParameterMap(); - String id = params.get("id"); - String type = params.get("type"); - - // setup the dispatch context with the task we're opening a dialog for - TransientNode node = new TransientNode(QName.createQName(type), id, null); - this.navigationBean.setupDispatchContext(node); - - // pass on parameters for the dialog - Application.getDialogManager().setupParameters(event); - } - - public void setupTaskDialog(String id, String type) - { - ParameterCheck.mandatoryString("Task ID", id); - ParameterCheck.mandatoryString("Task Type", type); - - // setup the dispatch context with the task we're opening a dialog for - TransientNode node = new TransientNode(QName.createQName(type), id, null); - this.navigationBean.setupDispatchContext(node); - - // pass on parameters for the dialog - Map params = new HashMap(2, 1.0f); - params.put("id", id); - params.put("type", type); - Application.getDialogManager().setupParameters(params); - } - - - // ------------------------------------------------------------------------------ - // Helper methods - - /** - * Creates and populates a TransientNode to represent the given - * workflow task from the repository workflow engine - * - * @param task The task to create a representation of - */ - protected TransientMapNode createTask(WorkflowTask task) - { - return new WorkflowTaskNode(task); - } -} +package org.alfresco.web.bean.workflow; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.event.ActionEvent; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.workflow.WorkflowModel; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.service.cmr.workflow.WorkflowTaskDefinition; +import org.alfresco.service.cmr.workflow.WorkflowTaskQuery; +import org.alfresco.service.cmr.workflow.WorkflowTaskState; +import org.alfresco.service.cmr.workflow.WorkflowTransition; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.config.ClientConfigElement; +import org.springframework.extensions.surf.util.ParameterCheck; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.TransientMapNode; +import org.alfresco.web.bean.repository.TransientNode; +import org.alfresco.web.bean.repository.User; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Managed bean used for providing support for the workflow task dashlets + * + * @author gavinc + */ +public class WorkflowBean implements Serializable +{ + private static final long serialVersionUID = 2950475254440425384L; + + protected NavigationBean navigationBean; + + transient private NodeService nodeService; + transient private WorkflowService workflowService; + + protected List tasks; + protected List activeTasks; + protected List pooledTasks; + protected List completedTasks; + + private static final Log logger = LogFactory.getLog(WorkflowBean.class); + + public static final String BEAN_NAME = "WorkflowBean"; + + + // ------------------------------------------------------------------------------ + // Bean Getters and Setters + + /** + * Returns a list of nodes representing the "all" active tasks. + * + * @return List of all active tasks + */ + public List getAllActiveTasks() + { + if (this.activeTasks == null) + { + // get the current username + FacesContext context = FacesContext.getCurrentInstance(); + User user = Application.getCurrentUser(context); + String userName = user.getUserName(); + + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + // query for all active tasks + WorkflowTaskQuery query = new WorkflowTaskQuery(); + List tasks = this.getWorkflowService().queryTasks(query); + + // create a list of transient nodes to represent + this.activeTasks = new ArrayList(tasks.size()); + for (WorkflowTask task : tasks) + { + Node node = createTask(task); + this.activeTasks.add(node); + + if (logger.isDebugEnabled()) + logger.debug("Added active task: " + node); + } + + // commit the changes + tx.commit(); + } + catch (Throwable e) + { + // rollback the transaction + try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} + Utils.addErrorMessage("Failed to get all active tasks: " + e.toString(), e); + } + } + + return this.activeTasks; + } + + /** + * Returns a list of nodes representing the "pooled" to do tasks the + * current user has. + * + * @return List of to do tasks + */ + public List getPooledTasks() + { + if (this.pooledTasks == null) + { + // get the current username + FacesContext context = FacesContext.getCurrentInstance(); + User user = Application.getCurrentUser(context); + String userName = user.getUserName(); + + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + // get the current pooled tasks for the current user + List tasks = this.getWorkflowService().getPooledTasks(userName, true); + + // create a list of transient nodes to represent + this.pooledTasks = new ArrayList(tasks.size()); + for (WorkflowTask task : tasks) + { + Node node = createTask(task); + this.pooledTasks.add(node); + + if (logger.isDebugEnabled()) + logger.debug("Added pooled task: " + node); + } + + // commit the changes + tx.commit(); + } + catch (Throwable e) + { + // rollback the transaction + try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} + Utils.addErrorMessage("Failed to get pooled tasks: " + e.toString(), e); + } + } + + return this.pooledTasks; + } + + /** + * Returns a list of nodes representing the to do tasks the + * current user has. + * + * @return List of to do tasks + */ + public List getTasksToDo() + { + if (this.tasks == null) + { + // get the current username + FacesContext context = FacesContext.getCurrentInstance(); + User user = Application.getCurrentUser(context); + String userName = user.getUserName(); + + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + // get the current in progress tasks for the current user + List tasks = this.getWorkflowService().getAssignedTasks( + userName, WorkflowTaskState.IN_PROGRESS, true); + + // create a list of transient nodes to represent + this.tasks = new ArrayList(tasks.size()); + for (WorkflowTask task : tasks) + { + Node node = createTask(task); + this.tasks.add(node); + + if (logger.isDebugEnabled()) + logger.debug("Added to do task: " + node); + } + + // commit the changes + tx.commit(); + } + catch (Throwable e) + { + // rollback the transaction + try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} + Utils.addErrorMessage("Failed to get to do tasks: " + e.toString(), e); + } + } + + return this.tasks; + } + + /** + * Returns a list of nodes representing the completed tasks the + * current user has. + * + * @return List of completed tasks + */ + public List getTasksCompleted() + { + if (this.completedTasks == null) + { + // get the current username + FacesContext context = FacesContext.getCurrentInstance(); + User user = Application.getCurrentUser(context); + String userName = user.getUserName(); + + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(context, true); + tx.begin(); + + // get the current in progress tasks for the current user + ClientConfigElement clientConfig = (ClientConfigElement)Application.getConfigService(context).getGlobalConfig().getConfigElement( + ClientConfigElement.CONFIG_ELEMENT_ID); + WorkflowTaskQuery query = new WorkflowTaskQuery(); + query.setActive(null); + query.setActorId(userName); + query.setTaskState(WorkflowTaskState.COMPLETED); + query.setLimit(clientConfig.getTasksCompletedMaxResults()); + List tasks = this.getWorkflowService().queryTasks(query); + + // create a list of transient nodes to represent + this.completedTasks = new ArrayList(tasks.size()); + for (WorkflowTask task : tasks) + { + Node node = createTask(task); + this.completedTasks.add(node); + + if (logger.isDebugEnabled()) + logger.debug("Added completed task: " + node); + } + + // commit the changes + tx.commit(); + } + catch (Throwable e) + { + // rollback the transaction + try { if (tx != null) {tx.rollback();} } catch (Exception ex) {} + Utils.addErrorMessage("Failed to get completed tasks: " + e.toString(), e); + } + } + + return this.completedTasks; + } + + /** + * Sets the navigation bean to use + * + * @param navigationBean The NavigationBean to set. + */ + public void setNavigationBean(NavigationBean navigationBean) + { + this.navigationBean = navigationBean; + } + + /** + * Sets the workflow service to use + * + * @param workflowService WorkflowService instance + */ + public void setWorkflowService(WorkflowService workflowService) + { + this.workflowService = workflowService; + } + + protected WorkflowService getWorkflowService() + { + if (this.workflowService == null) + { + this.workflowService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getWorkflowService(); + } + return this.workflowService; + } + + /** + * Sets the node service to use + * + * @param nodeService NodeService instance + */ + public void setNodeService(NodeService nodeService) + { + this.nodeService = nodeService; + } + + protected NodeService getNodeService() + { + if (this.nodeService == null) + { + this.nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService(); + } + return this.nodeService; + } + // ------------------------------------------------------------------------------ + // Navigation handlers + + public void setupTaskDialog(ActionEvent event) + { + UIActionLink link = (UIActionLink)event.getComponent(); + Map params = link.getParameterMap(); + String id = params.get("id"); + String type = params.get("type"); + + // setup the dispatch context with the task we're opening a dialog for + TransientNode node = new TransientNode(QName.createQName(type), id, null); + this.navigationBean.setupDispatchContext(node); + + // pass on parameters for the dialog + Application.getDialogManager().setupParameters(event); + } + + public void setupTaskDialog(String id, String type) + { + ParameterCheck.mandatoryString("Task ID", id); + ParameterCheck.mandatoryString("Task Type", type); + + // setup the dispatch context with the task we're opening a dialog for + TransientNode node = new TransientNode(QName.createQName(type), id, null); + this.navigationBean.setupDispatchContext(node); + + // pass on parameters for the dialog + Map params = new HashMap(2, 1.0f); + params.put("id", id); + params.put("type", type); + Application.getDialogManager().setupParameters(params); + } + + + // ------------------------------------------------------------------------------ + // Helper methods + + /** + * Creates and populates a TransientNode to represent the given + * workflow task from the repository workflow engine + * + * @param task The task to create a representation of + */ + protected TransientMapNode createTask(WorkflowTask task) + { + return new WorkflowTaskNode(task); + } +} diff --git a/source/java/org/alfresco/web/bean/workflow/WorkflowConsoleBean.java b/source/java/org/alfresco/web/bean/workflow/WorkflowConsoleBean.java index 7a651473e5..d6d1277bce 100644 --- a/source/java/org/alfresco/web/bean/workflow/WorkflowConsoleBean.java +++ b/source/java/org/alfresco/web/bean/workflow/WorkflowConsoleBean.java @@ -1,184 +1,184 @@ -package org.alfresco.web.bean.workflow; - -import java.io.Serializable; - -import javax.faces.context.FacesContext; - -import org.alfresco.repo.workflow.WorkflowInterpreter; -import org.alfresco.service.cmr.workflow.WorkflowDefinition; -import org.alfresco.web.app.servlet.FacesHelper; - - -/** - * Backing bean to support the Workflow Console - */ -public class WorkflowConsoleBean implements Serializable -{ - private static final long serialVersionUID = -7531838393180855185L; - - // command - private String command = ""; - private String submittedCommand = "none"; - private long duration = 0L; - private String result = null; - - // supporting repository services - transient private WorkflowInterpreter workflowInterpreter; - - - /** - * @param workflowInterpreter workflow interpreter - */ - public void setWorkflowInterpreter(WorkflowInterpreter workflowInterpreter) - { - this.workflowInterpreter = workflowInterpreter; - } - - private WorkflowInterpreter getWorkflowInterpreter() - { - if (this.workflowInterpreter == null) - { - this.workflowInterpreter = (WorkflowInterpreter) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "workflowInterpreter"); - } - return this.workflowInterpreter; - } - - /** - * Gets the command result - * - * @return result - */ - public String getResult() - { - if (result == null) - { - interpretCommand("help"); - } - return result; - } - - /** - * Sets the command result - * - * @param result - */ - public void setResult(String result) - { - this.result = result; - } - - /** - * Gets the current query - * - * @return query statement - */ - public String getCommand() - { - return command; - } - - /** - * Set the current command - * - * @param command command - */ - public void setCommand(String command) - { - this.command = command; - } - - /** - * Gets the submitted command - * - * @return submitted command - */ - public String getSubmittedCommand() - { - return submittedCommand; - } - - /** - * Set the submitted command - * - * @param submittedCommand The submitted command - */ - public void setSubmittedCommand(String submittedCommand) - { - this.submittedCommand = submittedCommand; - } - - /** - * Gets the last command duration - * - * @return command duration - */ - public long getDuration() - { - return duration; - } - - /** - * Set the duration - * - * @param duration The duration - */ - public void setDuration(long duration) - { - this.duration = duration; - } - - /** - * Action to submit command - * - * @return next action - */ - public String submitCommand() - { - interpretCommand(command); - return "success"; - } - - /** - * Gets the current user name - * - * @return user name - */ - public String getCurrentUserName() - { - return getWorkflowInterpreter().getCurrentUserName(); - } - - /** - * Gets the current workflow definition - * - * @return workflow definition - */ - public String getCurrentWorkflowDef() - { - WorkflowDefinition def = getWorkflowInterpreter().getCurrentWorkflowDef(); - return (def == null) ? "None" : def.title + " v" + def.version; - } - - /** - * Interpret workflow console command - * - * @param command command - */ - private void interpretCommand(String command) - { - try - { - long startms = System.currentTimeMillis(); - String result = getWorkflowInterpreter().interpretCommand(command); - setDuration(System.currentTimeMillis() - startms); - setResult(result); - setCommand(""); - setSubmittedCommand(command); - } - catch (Exception e) - { - setResult(e.toString()); - } - } - -} +package org.alfresco.web.bean.workflow; + +import java.io.Serializable; + +import javax.faces.context.FacesContext; + +import org.alfresco.repo.workflow.WorkflowInterpreter; +import org.alfresco.service.cmr.workflow.WorkflowDefinition; +import org.alfresco.web.app.servlet.FacesHelper; + + +/** + * Backing bean to support the Workflow Console + */ +public class WorkflowConsoleBean implements Serializable +{ + private static final long serialVersionUID = -7531838393180855185L; + + // command + private String command = ""; + private String submittedCommand = "none"; + private long duration = 0L; + private String result = null; + + // supporting repository services + transient private WorkflowInterpreter workflowInterpreter; + + + /** + * @param workflowInterpreter workflow interpreter + */ + public void setWorkflowInterpreter(WorkflowInterpreter workflowInterpreter) + { + this.workflowInterpreter = workflowInterpreter; + } + + private WorkflowInterpreter getWorkflowInterpreter() + { + if (this.workflowInterpreter == null) + { + this.workflowInterpreter = (WorkflowInterpreter) FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "workflowInterpreter"); + } + return this.workflowInterpreter; + } + + /** + * Gets the command result + * + * @return result + */ + public String getResult() + { + if (result == null) + { + interpretCommand("help"); + } + return result; + } + + /** + * Sets the command result + * + * @param result + */ + public void setResult(String result) + { + this.result = result; + } + + /** + * Gets the current query + * + * @return query statement + */ + public String getCommand() + { + return command; + } + + /** + * Set the current command + * + * @param command command + */ + public void setCommand(String command) + { + this.command = command; + } + + /** + * Gets the submitted command + * + * @return submitted command + */ + public String getSubmittedCommand() + { + return submittedCommand; + } + + /** + * Set the submitted command + * + * @param submittedCommand The submitted command + */ + public void setSubmittedCommand(String submittedCommand) + { + this.submittedCommand = submittedCommand; + } + + /** + * Gets the last command duration + * + * @return command duration + */ + public long getDuration() + { + return duration; + } + + /** + * Set the duration + * + * @param duration The duration + */ + public void setDuration(long duration) + { + this.duration = duration; + } + + /** + * Action to submit command + * + * @return next action + */ + public String submitCommand() + { + interpretCommand(command); + return "success"; + } + + /** + * Gets the current user name + * + * @return user name + */ + public String getCurrentUserName() + { + return getWorkflowInterpreter().getCurrentUserName(); + } + + /** + * Gets the current workflow definition + * + * @return workflow definition + */ + public String getCurrentWorkflowDef() + { + WorkflowDefinition def = getWorkflowInterpreter().getCurrentWorkflowDef(); + return (def == null) ? "None" : def.title + " v" + def.version; + } + + /** + * Interpret workflow console command + * + * @param command command + */ + private void interpretCommand(String command) + { + try + { + long startms = System.currentTimeMillis(); + String result = getWorkflowInterpreter().interpretCommand(command); + setDuration(System.currentTimeMillis() - startms); + setResult(result); + setCommand(""); + setSubmittedCommand(command); + } + catch (Exception e) + { + setResult(e.toString()); + } + } + +} diff --git a/source/java/org/alfresco/web/bean/workflow/WorkflowUtil.java b/source/java/org/alfresco/web/bean/workflow/WorkflowUtil.java index fadf562c7e..0cf723714d 100644 --- a/source/java/org/alfresco/web/bean/workflow/WorkflowUtil.java +++ b/source/java/org/alfresco/web/bean/workflow/WorkflowUtil.java @@ -1,277 +1,277 @@ -package org.alfresco.web.bean.workflow; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.servlet.ServletContext; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.repo.security.authentication.AuthenticationUtil; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.AssociationRef; -import org.alfresco.service.cmr.repository.CopyService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Helper class for common Workflow functionality. - *

- * This class should be replaced with calls to a WorkflowService once it is available. - * - * @author Kevin Roast - */ -public class WorkflowUtil -{ - private static Log logger = LogFactory.getLog(WorkflowUtil.class); - - /** - * Execute the Approve step for the Simple Workflow on a node. - * - * @param ref NodeRef to the node with the workflow - * @param nodeService NodeService instance - * @param copyService CopyService instance - * - * @throws AlfrescoRuntimeException - */ - public static void approve(final NodeRef ref, final NodeService nodeService, final CopyService copyService) - throws AlfrescoRuntimeException - { - Node docNode = new Node(ref); - - if (docNode.hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW) == false) - { - throw new AlfrescoRuntimeException("Cannot approve a node that is not part of a workflow."); - } - - // get the simple workflow aspect properties - Map props = docNode.getProperties(); - - Boolean approveMove = (Boolean)props.get(ApplicationModel.PROP_APPROVE_MOVE.toString()); - NodeRef approveFolder = (NodeRef)props.get(ApplicationModel.PROP_APPROVE_FOLDER.toString()); - - if (approveMove.booleanValue()) - { - // first we need to take off the simpleworkflow aspect - nodeService.removeAspect(ref, ApplicationModel.ASPECT_SIMPLE_WORKFLOW); - - // move the node to the specified folder - String qname = QName.createValidLocalName(docNode.getName()); - nodeService.moveNode(ref, approveFolder, ContentModel.ASSOC_CONTAINS, - QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname)); - } - else - { - // first we need to take off the simpleworkflow aspect - // NOTE: run as system to allow Consumers to copy an item - AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork() - { - public String doWork() throws Exception - { - nodeService.removeAspect(ref, ApplicationModel.ASPECT_SIMPLE_WORKFLOW); - return null; - } - }, AuthenticationUtil.getSystemUserName()); - - // copy the node to the specified folder - String name = docNode.getName(); - String qname = QName.createValidLocalName(name); - NodeRef newNode = copyService.copy(ref, approveFolder, ContentModel.ASSOC_CONTAINS, - QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname), true); - - // the copy service does not copy the name of the node so we - // need to update the property on the copied item - nodeService.setProperty(newNode, ContentModel.PROP_NAME, name); - } - - if (logger.isDebugEnabled()) - { - String movedCopied = approveMove ? "moved" : "copied"; - logger.debug("Node has been approved and " + movedCopied + " to folder with id of " + - approveFolder.getId()); - } - } - - /** - * Execute the Reject step for the Simple Workflow on a node. - * - * @param ref NodeRef to the node with the workflow - * @param nodeService NodeService instance - * @param copyService CopyService instance - * - * @throws AlfrescoRuntimeException - */ - public static void reject(NodeRef ref, NodeService nodeService, CopyService copyService) - throws AlfrescoRuntimeException - { - Node docNode = new Node(ref); - - if (docNode.hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW) == false) - { - throw new AlfrescoRuntimeException("Cannot reject a node that is not part of a workflow."); - } - - // get the simple workflow aspect properties - Map props = docNode.getProperties(); - - String rejectStep = (String)props.get(ApplicationModel.PROP_REJECT_STEP.toString()); - Boolean rejectMove = (Boolean)props.get(ApplicationModel.PROP_REJECT_MOVE.toString()); - NodeRef rejectFolder = (NodeRef)props.get(ApplicationModel.PROP_REJECT_FOLDER.toString()); - - if (rejectStep == null && rejectMove == null && rejectFolder == null) - { - throw new AlfrescoRuntimeException("The workflow does not have a reject step defined."); - } - - // first we need to take off the simpleworkflow aspect - nodeService.removeAspect(ref, ApplicationModel.ASPECT_SIMPLE_WORKFLOW); - - if (rejectMove != null && rejectMove.booleanValue()) - { - // move the document to the specified folder - String qname = QName.createValidLocalName(docNode.getName()); - nodeService.moveNode(ref, rejectFolder, ContentModel.ASSOC_CONTAINS, - QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname)); - } - else - { - // copy the document to the specified folder - String name = docNode.getName(); - String qname = QName.createValidLocalName(name); - NodeRef newNode = copyService.copy(ref, rejectFolder, ContentModel.ASSOC_CONTAINS, - QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname), true); - - // the copy service does not copy the name of the node so we - // need to update the property on the copied item - nodeService.setProperty(newNode, ContentModel.PROP_NAME, name); - } - - if (logger.isDebugEnabled()) - { - String movedCopied = rejectMove ? "moved" : "copied"; - logger.debug("Node has been rejected and " + movedCopied + " to folder with id of " + - rejectFolder.getId()); - } - } - - /** - * Prepares the given node for persistence in the workflow engine. - * - * @param node The node to package up for persistence - * @return The map of data representing the node - */ - @SuppressWarnings("unchecked") - public static Map prepareTaskParams(Node node) - { - Map params = new HashMap(); - - // marshal the properties and associations captured by the property sheet - // back into a Map to pass to the workflow service - - // go through all the properties in the transient node and add them to params map - Map props = node.getProperties(); - for (String propName : props.keySet()) - { - QName propQName = Repository.resolveToQName(propName); - params.put(propQName, (Serializable)props.get(propName)); - } - - // go through any associations that have been added to the start task - // and build a list of NodeRefs representing the targets - Map> assocs = node.getAddedAssociations(); - for (String assocName : assocs.keySet()) - { - QName assocQName = Repository.resolveToQName(assocName); - - // get the associations added and create list of targets - Map addedAssocs = assocs.get(assocName); - List originalAssocRefs = (List) node.getAssociations().get(assocName); - List targets = new ArrayList(addedAssocs.size()); - - if (originalAssocRefs != null) - { - for (AssociationRef assoc : originalAssocRefs) - { - targets.add(assoc.getTargetRef()); - } - } - - for (AssociationRef assoc : addedAssocs.values()) - { - targets.add(assoc.getTargetRef()); - } - - params.put(assocQName, (Serializable)targets); - } - - // go through the removed associations and either setup or adjust the - // parameters map accordingly - assocs = node.getRemovedAssociations(); - - for (String assocName : assocs.keySet()) - { - QName assocQName = Repository.resolveToQName(assocName); - - // get the associations removed and create list of targets - Map removedAssocs = assocs.get(assocName); - List targets = (List)params.get(assocQName); - - if (targets == null) - { - // if there weren't any assocs of this type added get the current - // set of assocs from the node - List originalAssocRefs = (List)node.getAssociations().get(assocName); - targets = new ArrayList(originalAssocRefs.size()); - - for (AssociationRef assoc : originalAssocRefs) - { - targets.add(assoc.getTargetRef()); - } - } - - // remove the assocs the user deleted - for (AssociationRef assoc : removedAssocs.values()) - { - targets.remove(assoc.getTargetRef()); - } - - params.put(assocQName, (Serializable)targets); - } - - // TODO: Deal with child associations if and when we need to support - // them for workflow tasks, for now warn that they are being used - Map childAssocs = node.getAddedChildAssociations(); - if (childAssocs.size() > 0) - { - if (logger.isWarnEnabled()) - logger.warn("Child associations are present but are not supported for workflow tasks, ignoring..."); - } - - return params; - } - - public static boolean isTaskEditable(String taskId, ServletContext sc) - { - if(taskId ==null|| taskId.isEmpty()) - { - return false; - } - ServiceRegistry serviceRegistry = Repository.getServiceRegistry(sc); - String username = serviceRegistry.getAuthenticationService().getCurrentUserName(); - WorkflowService workflowService = serviceRegistry.getWorkflowService(); - WorkflowTask task = workflowService.getTaskById(taskId); - return workflowService.isTaskEditable(task, username); - } -} +package org.alfresco.web.bean.workflow; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.servlet.ServletContext; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.repo.security.authentication.AuthenticationUtil; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.AssociationRef; +import org.alfresco.service.cmr.repository.CopyService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Helper class for common Workflow functionality. + *

+ * This class should be replaced with calls to a WorkflowService once it is available. + * + * @author Kevin Roast + */ +public class WorkflowUtil +{ + private static Log logger = LogFactory.getLog(WorkflowUtil.class); + + /** + * Execute the Approve step for the Simple Workflow on a node. + * + * @param ref NodeRef to the node with the workflow + * @param nodeService NodeService instance + * @param copyService CopyService instance + * + * @throws AlfrescoRuntimeException + */ + public static void approve(final NodeRef ref, final NodeService nodeService, final CopyService copyService) + throws AlfrescoRuntimeException + { + Node docNode = new Node(ref); + + if (docNode.hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW) == false) + { + throw new AlfrescoRuntimeException("Cannot approve a node that is not part of a workflow."); + } + + // get the simple workflow aspect properties + Map props = docNode.getProperties(); + + Boolean approveMove = (Boolean)props.get(ApplicationModel.PROP_APPROVE_MOVE.toString()); + NodeRef approveFolder = (NodeRef)props.get(ApplicationModel.PROP_APPROVE_FOLDER.toString()); + + if (approveMove.booleanValue()) + { + // first we need to take off the simpleworkflow aspect + nodeService.removeAspect(ref, ApplicationModel.ASPECT_SIMPLE_WORKFLOW); + + // move the node to the specified folder + String qname = QName.createValidLocalName(docNode.getName()); + nodeService.moveNode(ref, approveFolder, ContentModel.ASSOC_CONTAINS, + QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname)); + } + else + { + // first we need to take off the simpleworkflow aspect + // NOTE: run as system to allow Consumers to copy an item + AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork() + { + public String doWork() throws Exception + { + nodeService.removeAspect(ref, ApplicationModel.ASPECT_SIMPLE_WORKFLOW); + return null; + } + }, AuthenticationUtil.getSystemUserName()); + + // copy the node to the specified folder + String name = docNode.getName(); + String qname = QName.createValidLocalName(name); + NodeRef newNode = copyService.copy(ref, approveFolder, ContentModel.ASSOC_CONTAINS, + QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname), true); + + // the copy service does not copy the name of the node so we + // need to update the property on the copied item + nodeService.setProperty(newNode, ContentModel.PROP_NAME, name); + } + + if (logger.isDebugEnabled()) + { + String movedCopied = approveMove ? "moved" : "copied"; + logger.debug("Node has been approved and " + movedCopied + " to folder with id of " + + approveFolder.getId()); + } + } + + /** + * Execute the Reject step for the Simple Workflow on a node. + * + * @param ref NodeRef to the node with the workflow + * @param nodeService NodeService instance + * @param copyService CopyService instance + * + * @throws AlfrescoRuntimeException + */ + public static void reject(NodeRef ref, NodeService nodeService, CopyService copyService) + throws AlfrescoRuntimeException + { + Node docNode = new Node(ref); + + if (docNode.hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW) == false) + { + throw new AlfrescoRuntimeException("Cannot reject a node that is not part of a workflow."); + } + + // get the simple workflow aspect properties + Map props = docNode.getProperties(); + + String rejectStep = (String)props.get(ApplicationModel.PROP_REJECT_STEP.toString()); + Boolean rejectMove = (Boolean)props.get(ApplicationModel.PROP_REJECT_MOVE.toString()); + NodeRef rejectFolder = (NodeRef)props.get(ApplicationModel.PROP_REJECT_FOLDER.toString()); + + if (rejectStep == null && rejectMove == null && rejectFolder == null) + { + throw new AlfrescoRuntimeException("The workflow does not have a reject step defined."); + } + + // first we need to take off the simpleworkflow aspect + nodeService.removeAspect(ref, ApplicationModel.ASPECT_SIMPLE_WORKFLOW); + + if (rejectMove != null && rejectMove.booleanValue()) + { + // move the document to the specified folder + String qname = QName.createValidLocalName(docNode.getName()); + nodeService.moveNode(ref, rejectFolder, ContentModel.ASSOC_CONTAINS, + QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname)); + } + else + { + // copy the document to the specified folder + String name = docNode.getName(); + String qname = QName.createValidLocalName(name); + NodeRef newNode = copyService.copy(ref, rejectFolder, ContentModel.ASSOC_CONTAINS, + QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, qname), true); + + // the copy service does not copy the name of the node so we + // need to update the property on the copied item + nodeService.setProperty(newNode, ContentModel.PROP_NAME, name); + } + + if (logger.isDebugEnabled()) + { + String movedCopied = rejectMove ? "moved" : "copied"; + logger.debug("Node has been rejected and " + movedCopied + " to folder with id of " + + rejectFolder.getId()); + } + } + + /** + * Prepares the given node for persistence in the workflow engine. + * + * @param node The node to package up for persistence + * @return The map of data representing the node + */ + @SuppressWarnings("unchecked") + public static Map prepareTaskParams(Node node) + { + Map params = new HashMap(); + + // marshal the properties and associations captured by the property sheet + // back into a Map to pass to the workflow service + + // go through all the properties in the transient node and add them to params map + Map props = node.getProperties(); + for (String propName : props.keySet()) + { + QName propQName = Repository.resolveToQName(propName); + params.put(propQName, (Serializable)props.get(propName)); + } + + // go through any associations that have been added to the start task + // and build a list of NodeRefs representing the targets + Map> assocs = node.getAddedAssociations(); + for (String assocName : assocs.keySet()) + { + QName assocQName = Repository.resolveToQName(assocName); + + // get the associations added and create list of targets + Map addedAssocs = assocs.get(assocName); + List originalAssocRefs = (List) node.getAssociations().get(assocName); + List targets = new ArrayList(addedAssocs.size()); + + if (originalAssocRefs != null) + { + for (AssociationRef assoc : originalAssocRefs) + { + targets.add(assoc.getTargetRef()); + } + } + + for (AssociationRef assoc : addedAssocs.values()) + { + targets.add(assoc.getTargetRef()); + } + + params.put(assocQName, (Serializable)targets); + } + + // go through the removed associations and either setup or adjust the + // parameters map accordingly + assocs = node.getRemovedAssociations(); + + for (String assocName : assocs.keySet()) + { + QName assocQName = Repository.resolveToQName(assocName); + + // get the associations removed and create list of targets + Map removedAssocs = assocs.get(assocName); + List targets = (List)params.get(assocQName); + + if (targets == null) + { + // if there weren't any assocs of this type added get the current + // set of assocs from the node + List originalAssocRefs = (List)node.getAssociations().get(assocName); + targets = new ArrayList(originalAssocRefs.size()); + + for (AssociationRef assoc : originalAssocRefs) + { + targets.add(assoc.getTargetRef()); + } + } + + // remove the assocs the user deleted + for (AssociationRef assoc : removedAssocs.values()) + { + targets.remove(assoc.getTargetRef()); + } + + params.put(assocQName, (Serializable)targets); + } + + // TODO: Deal with child associations if and when we need to support + // them for workflow tasks, for now warn that they are being used + Map childAssocs = node.getAddedChildAssociations(); + if (childAssocs.size() > 0) + { + if (logger.isWarnEnabled()) + logger.warn("Child associations are present but are not supported for workflow tasks, ignoring..."); + } + + return params; + } + + public static boolean isTaskEditable(String taskId, ServletContext sc) + { + if(taskId ==null|| taskId.isEmpty()) + { + return false; + } + ServiceRegistry serviceRegistry = Repository.getServiceRegistry(sc); + String username = serviceRegistry.getAuthenticationService().getCurrentUserName(); + WorkflowService workflowService = serviceRegistry.getWorkflowService(); + WorkflowTask task = workflowService.getTaskById(taskId); + return workflowService.isTaskEditable(task, username); + } +} diff --git a/source/java/org/alfresco/web/config/ActionsConfigElement.java b/source/java/org/alfresco/web/config/ActionsConfigElement.java index 0daf28ba0a..6e32bbe7fb 100644 --- a/source/java/org/alfresco/web/config/ActionsConfigElement.java +++ b/source/java/org/alfresco/web/config/ActionsConfigElement.java @@ -1,319 +1,319 @@ -package org.alfresco.web.config; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.HashSet; -import java.util.Iterator; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.web.action.ActionEvaluator; -import org.alfresco.web.bean.repository.Repository; - -/** - * Action config element. - * - * @author Kevin Roast - */ -public class ActionsConfigElement extends ConfigElementAdapter -{ - public static final String CONFIG_ELEMENT_ID = "actions"; - - private Map actionDefs = new HashMap(32, 1.0f); - private Map actionGroups = new HashMap(16, 1.0f); - - /** - * Default constructor - */ - public ActionsConfigElement() - { - super(CONFIG_ELEMENT_ID); - } - - /** - * @param name String - */ - public ActionsConfigElement(String name) - { - super(name); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() - */ - public List getChildren() - { - throw new ConfigException("Reading the Actions config via the generic interfaces is not supported"); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - ActionsConfigElement newElement = (ActionsConfigElement)configElement; - ActionsConfigElement combinedElement = new ActionsConfigElement(); - - // add the existing action definitions - combinedElement.actionDefs.putAll(this.actionDefs); - - // overwrite any existing action definitions i.e. don't combine - combinedElement.actionDefs.putAll(newElement.actionDefs); - - // add the existing action groups - Map combinedActionGroups = new HashMap(this.actionGroups.size()); - try - { - for (ActionGroup group : this.actionGroups.values()) - { - combinedActionGroups.put(group.getId(), (ActionGroup)group.clone()); - } - } - catch (CloneNotSupportedException e) - { - throw new AlfrescoRuntimeException("clone() required on ActionGroup class.", e); - } - combinedElement.actionGroups = combinedActionGroups; - - // any new action groups with the same name must be combined - for (ActionGroup newGroup : newElement.actionGroups.values()) - { - if (combinedElement.actionGroups.containsKey(newGroup.getId())) - { - // there is already a group with this id, combine it with the new one - ActionGroup combinedGroup = combinedElement.actionGroups.get(newGroup.getId()); - if (newGroup.ShowLink != combinedGroup.ShowLink) - { - combinedGroup.ShowLink = newGroup.ShowLink; - } - if (newGroup.Style != null) - { - combinedGroup.Style = newGroup.Style; - } - if (newGroup.StyleClass != null) - { - combinedGroup.StyleClass = newGroup.StyleClass; - } - - // add all the actions from the new group to the combined one - for (String actionRef : newGroup.getAllActions()) - { - combinedGroup.addAction(actionRef); - } - - // add all the hidden actions from the new group to the combined one - for (String actionRef : newGroup.getHiddenActions()) - { - combinedGroup.hideAction(actionRef); - } - } - else - { - // it's a new group so just add it - combinedElement.actionGroups.put(newGroup.getId(), newGroup); - } - } - - return combinedElement; - } - - /*package*/ void addActionDefinition(ActionDefinition actionDef) - { - actionDefs.put(actionDef.getId(), actionDef); - } - - public ActionDefinition getActionDefinition(String id) - { - return actionDefs.get(id); - } - - /*package*/ void addActionGroup(ActionGroup group) - { - actionGroups.put(group.getId(), group); - } - - public ActionGroup getActionGroup(String id) - { - return actionGroups.get(id); - } - - - /** - * Simple class representing the definition of a UI action. - * - * @author Kevin Roast - */ - public static class ActionDefinition - { - public ActionDefinition(String id) - { - if (id == null || id.length() == 0) - { - throw new IllegalArgumentException("ActionDefinition ID is mandatory."); - } - this.id = id; - } - - public String getId() - { - return id; - } - - public void addAllowPermission(String permission) - { - if (permissionAllow == null) - { - permissionAllow = new ArrayList(2); - } - permissionAllow.add(permission); - } - - public void addDenyPermission(String permission) - { - if (permissionDeny == null) - { - permissionDeny = new ArrayList(1); - } - permissionDeny.add(permission); - } - - public List getAllowPermissions() - { - return permissionAllow; - } - - public List getDenyPermissions() - { - return permissionDeny; - } - - public void addParam(String name, String value) - { - if (params == null) - { - params = new HashMap(1, 1.0f); - } - params.put(name, value); - } - - public Map getParams() - { - return params; - } - - String id; - private List permissionAllow = null; - private List permissionDeny = null; - private Map params = null; - - public ActionEvaluator Evaluator = null; - public String Label; - public String LabelMsg; - public String Tooltip; - public String TooltipMsg; - public boolean ShowLink = true; - public String Style; - public String StyleClass; - public String Image; - public String ActionListener; - public String Action; - public String Href; - public String Target; - public String Script; - public String Onclick; - } - - - /** - * Simple class representing a group of UI actions. - * - * @author Kevin Roast - */ - public static class ActionGroup implements Iterable, Cloneable - { - public ActionGroup(String id) - { - if (id == null || id.length() == 0) - { - throw new IllegalArgumentException("ActionGroup ID is mandatory."); - } - this.id = id; - } - - @Override - protected Object clone() throws CloneNotSupportedException - { - ActionGroup clone = new ActionGroup(id); - clone.actions = (Set)((LinkedHashSet)actions).clone(); - clone.hiddenActions = (Set)((HashSet)hiddenActions).clone(); - clone.ShowLink = ShowLink; - clone.Style = Style; - clone.StyleClass = StyleClass; - return clone; - } - - public String getId() - { - return id; - } - - /** - * @return Iterator over the visible ActionDefinition IDs referenced by this group - */ - public Iterator iterator() - { - // create a list of the visible actions and return it's iterator - ArrayList visibleActions = new ArrayList(this.actions.size()); - for (String actionId : this.actions) - { - if (this.hiddenActions.contains(actionId) == false) - { - visibleActions.add(actionId); - } - } - - visibleActions.trimToSize(); - - return visibleActions.iterator(); - } - - /*package*/ void addAction(String actionId) - { - actions.add(actionId); - } - - /*package*/ void hideAction(String actionId) - { - this.hiddenActions.add(actionId); - } - - /*package*/ Set getAllActions() - { - return this.actions; - } - - /*package*/ Set getHiddenActions() - { - return this.hiddenActions; - } - - private String id; - - /** the action definitions, we use a Linked HashSet to ensure we do not have more - than one action with the same Id and that the insertion order is preserved */ - private Set actions = new LinkedHashSet(16, 1.0f); - - /** the actions that have been hidden */ - private Set hiddenActions = new HashSet(4, 1.0f); - - public boolean ShowLink; - public String Style; - public String StyleClass; - } -} +package org.alfresco.web.config; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.action.ActionEvaluator; +import org.alfresco.web.bean.repository.Repository; + +/** + * Action config element. + * + * @author Kevin Roast + */ +public class ActionsConfigElement extends ConfigElementAdapter +{ + public static final String CONFIG_ELEMENT_ID = "actions"; + + private Map actionDefs = new HashMap(32, 1.0f); + private Map actionGroups = new HashMap(16, 1.0f); + + /** + * Default constructor + */ + public ActionsConfigElement() + { + super(CONFIG_ELEMENT_ID); + } + + /** + * @param name String + */ + public ActionsConfigElement(String name) + { + super(name); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() + */ + public List getChildren() + { + throw new ConfigException("Reading the Actions config via the generic interfaces is not supported"); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + ActionsConfigElement newElement = (ActionsConfigElement)configElement; + ActionsConfigElement combinedElement = new ActionsConfigElement(); + + // add the existing action definitions + combinedElement.actionDefs.putAll(this.actionDefs); + + // overwrite any existing action definitions i.e. don't combine + combinedElement.actionDefs.putAll(newElement.actionDefs); + + // add the existing action groups + Map combinedActionGroups = new HashMap(this.actionGroups.size()); + try + { + for (ActionGroup group : this.actionGroups.values()) + { + combinedActionGroups.put(group.getId(), (ActionGroup)group.clone()); + } + } + catch (CloneNotSupportedException e) + { + throw new AlfrescoRuntimeException("clone() required on ActionGroup class.", e); + } + combinedElement.actionGroups = combinedActionGroups; + + // any new action groups with the same name must be combined + for (ActionGroup newGroup : newElement.actionGroups.values()) + { + if (combinedElement.actionGroups.containsKey(newGroup.getId())) + { + // there is already a group with this id, combine it with the new one + ActionGroup combinedGroup = combinedElement.actionGroups.get(newGroup.getId()); + if (newGroup.ShowLink != combinedGroup.ShowLink) + { + combinedGroup.ShowLink = newGroup.ShowLink; + } + if (newGroup.Style != null) + { + combinedGroup.Style = newGroup.Style; + } + if (newGroup.StyleClass != null) + { + combinedGroup.StyleClass = newGroup.StyleClass; + } + + // add all the actions from the new group to the combined one + for (String actionRef : newGroup.getAllActions()) + { + combinedGroup.addAction(actionRef); + } + + // add all the hidden actions from the new group to the combined one + for (String actionRef : newGroup.getHiddenActions()) + { + combinedGroup.hideAction(actionRef); + } + } + else + { + // it's a new group so just add it + combinedElement.actionGroups.put(newGroup.getId(), newGroup); + } + } + + return combinedElement; + } + + /*package*/ void addActionDefinition(ActionDefinition actionDef) + { + actionDefs.put(actionDef.getId(), actionDef); + } + + public ActionDefinition getActionDefinition(String id) + { + return actionDefs.get(id); + } + + /*package*/ void addActionGroup(ActionGroup group) + { + actionGroups.put(group.getId(), group); + } + + public ActionGroup getActionGroup(String id) + { + return actionGroups.get(id); + } + + + /** + * Simple class representing the definition of a UI action. + * + * @author Kevin Roast + */ + public static class ActionDefinition + { + public ActionDefinition(String id) + { + if (id == null || id.length() == 0) + { + throw new IllegalArgumentException("ActionDefinition ID is mandatory."); + } + this.id = id; + } + + public String getId() + { + return id; + } + + public void addAllowPermission(String permission) + { + if (permissionAllow == null) + { + permissionAllow = new ArrayList(2); + } + permissionAllow.add(permission); + } + + public void addDenyPermission(String permission) + { + if (permissionDeny == null) + { + permissionDeny = new ArrayList(1); + } + permissionDeny.add(permission); + } + + public List getAllowPermissions() + { + return permissionAllow; + } + + public List getDenyPermissions() + { + return permissionDeny; + } + + public void addParam(String name, String value) + { + if (params == null) + { + params = new HashMap(1, 1.0f); + } + params.put(name, value); + } + + public Map getParams() + { + return params; + } + + String id; + private List permissionAllow = null; + private List permissionDeny = null; + private Map params = null; + + public ActionEvaluator Evaluator = null; + public String Label; + public String LabelMsg; + public String Tooltip; + public String TooltipMsg; + public boolean ShowLink = true; + public String Style; + public String StyleClass; + public String Image; + public String ActionListener; + public String Action; + public String Href; + public String Target; + public String Script; + public String Onclick; + } + + + /** + * Simple class representing a group of UI actions. + * + * @author Kevin Roast + */ + public static class ActionGroup implements Iterable, Cloneable + { + public ActionGroup(String id) + { + if (id == null || id.length() == 0) + { + throw new IllegalArgumentException("ActionGroup ID is mandatory."); + } + this.id = id; + } + + @Override + protected Object clone() throws CloneNotSupportedException + { + ActionGroup clone = new ActionGroup(id); + clone.actions = (Set)((LinkedHashSet)actions).clone(); + clone.hiddenActions = (Set)((HashSet)hiddenActions).clone(); + clone.ShowLink = ShowLink; + clone.Style = Style; + clone.StyleClass = StyleClass; + return clone; + } + + public String getId() + { + return id; + } + + /** + * @return Iterator over the visible ActionDefinition IDs referenced by this group + */ + public Iterator iterator() + { + // create a list of the visible actions and return it's iterator + ArrayList visibleActions = new ArrayList(this.actions.size()); + for (String actionId : this.actions) + { + if (this.hiddenActions.contains(actionId) == false) + { + visibleActions.add(actionId); + } + } + + visibleActions.trimToSize(); + + return visibleActions.iterator(); + } + + /*package*/ void addAction(String actionId) + { + actions.add(actionId); + } + + /*package*/ void hideAction(String actionId) + { + this.hiddenActions.add(actionId); + } + + /*package*/ Set getAllActions() + { + return this.actions; + } + + /*package*/ Set getHiddenActions() + { + return this.hiddenActions; + } + + private String id; + + /** the action definitions, we use a Linked HashSet to ensure we do not have more + than one action with the same Id and that the insertion order is preserved */ + private Set actions = new LinkedHashSet(16, 1.0f); + + /** the actions that have been hidden */ + private Set hiddenActions = new HashSet(4, 1.0f); + + public boolean ShowLink; + public String Style; + public String StyleClass; + } +} diff --git a/source/java/org/alfresco/web/config/ActionsElementReader.java b/source/java/org/alfresco/web/config/ActionsElementReader.java index 1fe9fe2b1a..f9d430ec7d 100644 --- a/source/java/org/alfresco/web/config/ActionsElementReader.java +++ b/source/java/org/alfresco/web/config/ActionsElementReader.java @@ -1,254 +1,254 @@ -package org.alfresco.web.config; - -import java.util.Iterator; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.alfresco.web.action.ActionEvaluator; -import org.alfresco.web.config.ActionsConfigElement.ActionDefinition; -import org.alfresco.web.config.ActionsConfigElement.ActionGroup; -import org.dom4j.Element; - -/** - * Config Element Reader for the "Action" config blocks. - * - * @author Kevin Roast - */ -public class ActionsElementReader implements ConfigElementReader -{ - public static final String ELEMENT_ACTION = "action"; - public static final String ELEMENT_ACTIONGROUP = "action-group"; - public static final String ELEMENT_PERMISSIONS = "permissions"; - public static final String ELEMENT_PERMISSION = "permission"; - public static final String ELEMENT_EVALUATOR = "evaluator"; - public static final String ELEMENT_LABEL = "label"; - public static final String ELEMENT_LABELMSG = "label-id"; - public static final String ELEMENT_TOOLTIP = "tooltip"; - public static final String ELEMENT_TOOLTIPMSG = "tooltip-id"; - public static final String ELEMENT_SHOWLINK = "show-link"; - public static final String ELEMENT_STYLE = "style"; - public static final String ELEMENT_STYLECLASS = "style-class"; - public static final String ELEMENT_IMAGE = "image"; - public static final String ELEMENT_ACTIONLISTENER = "action-listener"; - public static final String ELEMENT_ONCLICK = "onclick"; - public static final String ELEMENT_HREF = "href"; - public static final String ELEMENT_TARGET = "target"; - public static final String ELEMENT_SCRIPT = "script"; - public static final String ELEMENT_PARAMS = "params"; - public static final String ELEMENT_PARAM = "param"; - public static final String ATTRIBUTE_ID = "id"; - public static final String ATTRIBUTE_IDREF = "idref"; - public static final String ATTRIBUTE_NAME = "name"; - public static final String ATTRIBUTE_ALLOW = "allow"; - public static final String ATTRIBUTE_HIDE = "hide"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - @SuppressWarnings("unchecked") - public ConfigElement parse(Element element) - { - ActionsConfigElement configElement = new ActionsConfigElement(); - - if (element != null) - { - if (ActionsConfigElement.CONFIG_ELEMENT_ID.equals(element.getName()) == false) - { - throw new ConfigException("ActionsElementReader can only parse config elements of type 'Actions'"); - } - - Iterator actionItr = element.elementIterator(ELEMENT_ACTION); - while (actionItr.hasNext()) - { - // work on each 'action' element in turn - Element actionElement = actionItr.next(); - - // parse the action definition for the element - ActionDefinition actionDef = parseActionDefinition(actionElement); - - // add our finished action def to the map of all actions - configElement.addActionDefinition(actionDef); - } - - Iterator actionGroupItr = element.elementIterator(ELEMENT_ACTIONGROUP); - while (actionGroupItr.hasNext()) - { - // work on each 'action-group' element in turn - Element groupElement = actionGroupItr.next(); - String groupId = groupElement.attributeValue(ATTRIBUTE_ID); - if (groupId == null || groupId.length() == 0) - { - throw new ConfigException("'action-group' config element specified without mandatory 'id' attribute."); - } - - // build a structure to represent the action group - ActionGroup actionGroup = new ActionGroup(groupId); - - // loop round each action ref and add them to the list for this action group - Iterator actionRefItr = groupElement.elementIterator(ELEMENT_ACTION); - while (actionRefItr.hasNext()) - { - Element actionRefElement = actionRefItr.next(); - - // look for an action referred to be Id - this is the common use-case - String idRef = actionRefElement.attributeValue(ATTRIBUTE_IDREF); - if (idRef == null || idRef.length() == 0) - { - // look for an action defined directly rather than referenced by Id - String id = actionRefElement.attributeValue(ATTRIBUTE_ID); - if (id != null && id.length() != 0) - { - ActionDefinition def = parseActionDefinition(actionRefElement); - // override action definition ID based on the group name to avoid conflicts - def.id = actionGroup.getId() + '_' + def.getId(); - configElement.addActionDefinition(def); - actionGroup.addAction(def.getId()); - } - } - else - { - // look for the hide attribute - String hide = actionRefElement.attributeValue(ATTRIBUTE_HIDE); - if (hide != null && Boolean.parseBoolean(hide)) - { - actionGroup.hideAction(idRef); - } - else - { - // add the action definition ID to the group - actionGroup.addAction(idRef); - } - } - } - - // get simple string properties for the action group - actionGroup.Style = groupElement.elementTextTrim(ELEMENT_STYLE); - actionGroup.StyleClass = groupElement.elementTextTrim(ELEMENT_STYLECLASS); - if (groupElement.element(ELEMENT_SHOWLINK) != null) - { - actionGroup.ShowLink = Boolean.parseBoolean(groupElement.element(ELEMENT_SHOWLINK).getTextTrim()); - } - - // add the action group to the map of all action groups - configElement.addActionGroup(actionGroup); - } - } - - return configElement; - } - - /** - * Parse an ActionDefinition from the specific config element. - * - * @param actionElement The config element containing the action def - * - * @return The populated ActionDefinition - */ - public ActionDefinition parseActionDefinition(Element actionElement) - { - String actionId = actionElement.attributeValue(ATTRIBUTE_ID); - if (actionId == null || actionId.length() == 0) - { - throw new ConfigException("'action' config element specified without mandatory 'id' attribute."); - } - - // build a structure to represent the action definition - ActionDefinition actionDef = new ActionDefinition(actionId); - - // look for the permissions element - it can contain many permission - Element permissionsElement = actionElement.element(ELEMENT_PERMISSIONS); - if (permissionsElement != null) - { - // read and process each permission element - Iterator permissionItr = permissionsElement.elementIterator(ELEMENT_PERMISSION); - while (permissionItr.hasNext()) - { - Element permissionElement = permissionItr.next(); - boolean allow = true; - if (permissionElement.attributeValue(ATTRIBUTE_ALLOW) != null) - { - allow = Boolean.parseBoolean(permissionElement.attributeValue(ATTRIBUTE_ALLOW)); - } - String permissionValue = permissionElement.getTextTrim(); - if (allow) - { - actionDef.addAllowPermission(permissionValue); - } - else - { - actionDef.addDenyPermission(permissionValue); - } - } - } - - // find and construct the specified evaluator class - Element evaluatorElement = actionElement.element(ELEMENT_EVALUATOR); - if (evaluatorElement != null) - { - Object evaluator; - String className = evaluatorElement.getTextTrim(); - try - { - Class clazz = Class.forName(className); - evaluator = clazz.newInstance(); - } - catch (Throwable err) - { - throw new ConfigException("Unable to construct action '" + - actionId + "' evaluator classname: " +className); - } - if (evaluator instanceof ActionEvaluator == false) - { - throw new ConfigException("Action '" + actionId + "' evaluator class '" + - className + "' does not implement ActionEvaluator interface."); - } - actionDef.Evaluator = (ActionEvaluator)evaluator; - } - - // find any parameter values that the action requires - Element paramsElement = actionElement.element(ELEMENT_PARAMS); - if (paramsElement != null) - { - Iterator paramsItr = paramsElement.elementIterator(ELEMENT_PARAM); - while (paramsItr.hasNext()) - { - Element paramElement = paramsItr.next(); - String name = paramElement.attributeValue(ATTRIBUTE_NAME); - if (name == null || name.length() == 0) - { - throw new ConfigException("Action '" + actionId + - "' param does not have mandatory 'name' attribute."); - } - String value = paramElement.getTextTrim(); - if (value == null || value.length() == 0) - { - throw new ConfigException("Action '" + actionId + "' param '" + name + "'" + - "' does not have a value."); - } - actionDef.addParam(name, value); - } - } - - // get simple string properties for the action - actionDef.Label = actionElement.elementTextTrim(ELEMENT_LABEL); - actionDef.LabelMsg = actionElement.elementTextTrim(ELEMENT_LABELMSG); - actionDef.Tooltip = actionElement.elementTextTrim(ELEMENT_TOOLTIP); - actionDef.TooltipMsg = actionElement.elementTextTrim(ELEMENT_TOOLTIPMSG); - actionDef.Href = actionElement.elementTextTrim(ELEMENT_HREF); - actionDef.Target = actionElement.elementTextTrim(ELEMENT_TARGET); - actionDef.Script = actionElement.elementTextTrim(ELEMENT_SCRIPT); - actionDef.Action = actionElement.elementTextTrim(ELEMENT_ACTION); - actionDef.ActionListener = actionElement.elementTextTrim(ELEMENT_ACTIONLISTENER); - actionDef.Onclick = actionElement.elementTextTrim(ELEMENT_ONCLICK); - actionDef.Image = actionElement.elementTextTrim(ELEMENT_IMAGE); - actionDef.Style = actionElement.elementTextTrim(ELEMENT_STYLE); - actionDef.StyleClass = actionElement.elementTextTrim(ELEMENT_STYLECLASS); - if (actionElement.element(ELEMENT_SHOWLINK) != null) - { - actionDef.ShowLink = Boolean.parseBoolean(actionElement.element(ELEMENT_SHOWLINK).getTextTrim()); - } - - return actionDef; - } -} +package org.alfresco.web.config; + +import java.util.Iterator; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.alfresco.web.action.ActionEvaluator; +import org.alfresco.web.config.ActionsConfigElement.ActionDefinition; +import org.alfresco.web.config.ActionsConfigElement.ActionGroup; +import org.dom4j.Element; + +/** + * Config Element Reader for the "Action" config blocks. + * + * @author Kevin Roast + */ +public class ActionsElementReader implements ConfigElementReader +{ + public static final String ELEMENT_ACTION = "action"; + public static final String ELEMENT_ACTIONGROUP = "action-group"; + public static final String ELEMENT_PERMISSIONS = "permissions"; + public static final String ELEMENT_PERMISSION = "permission"; + public static final String ELEMENT_EVALUATOR = "evaluator"; + public static final String ELEMENT_LABEL = "label"; + public static final String ELEMENT_LABELMSG = "label-id"; + public static final String ELEMENT_TOOLTIP = "tooltip"; + public static final String ELEMENT_TOOLTIPMSG = "tooltip-id"; + public static final String ELEMENT_SHOWLINK = "show-link"; + public static final String ELEMENT_STYLE = "style"; + public static final String ELEMENT_STYLECLASS = "style-class"; + public static final String ELEMENT_IMAGE = "image"; + public static final String ELEMENT_ACTIONLISTENER = "action-listener"; + public static final String ELEMENT_ONCLICK = "onclick"; + public static final String ELEMENT_HREF = "href"; + public static final String ELEMENT_TARGET = "target"; + public static final String ELEMENT_SCRIPT = "script"; + public static final String ELEMENT_PARAMS = "params"; + public static final String ELEMENT_PARAM = "param"; + public static final String ATTRIBUTE_ID = "id"; + public static final String ATTRIBUTE_IDREF = "idref"; + public static final String ATTRIBUTE_NAME = "name"; + public static final String ATTRIBUTE_ALLOW = "allow"; + public static final String ATTRIBUTE_HIDE = "hide"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + @SuppressWarnings("unchecked") + public ConfigElement parse(Element element) + { + ActionsConfigElement configElement = new ActionsConfigElement(); + + if (element != null) + { + if (ActionsConfigElement.CONFIG_ELEMENT_ID.equals(element.getName()) == false) + { + throw new ConfigException("ActionsElementReader can only parse config elements of type 'Actions'"); + } + + Iterator actionItr = element.elementIterator(ELEMENT_ACTION); + while (actionItr.hasNext()) + { + // work on each 'action' element in turn + Element actionElement = actionItr.next(); + + // parse the action definition for the element + ActionDefinition actionDef = parseActionDefinition(actionElement); + + // add our finished action def to the map of all actions + configElement.addActionDefinition(actionDef); + } + + Iterator actionGroupItr = element.elementIterator(ELEMENT_ACTIONGROUP); + while (actionGroupItr.hasNext()) + { + // work on each 'action-group' element in turn + Element groupElement = actionGroupItr.next(); + String groupId = groupElement.attributeValue(ATTRIBUTE_ID); + if (groupId == null || groupId.length() == 0) + { + throw new ConfigException("'action-group' config element specified without mandatory 'id' attribute."); + } + + // build a structure to represent the action group + ActionGroup actionGroup = new ActionGroup(groupId); + + // loop round each action ref and add them to the list for this action group + Iterator actionRefItr = groupElement.elementIterator(ELEMENT_ACTION); + while (actionRefItr.hasNext()) + { + Element actionRefElement = actionRefItr.next(); + + // look for an action referred to be Id - this is the common use-case + String idRef = actionRefElement.attributeValue(ATTRIBUTE_IDREF); + if (idRef == null || idRef.length() == 0) + { + // look for an action defined directly rather than referenced by Id + String id = actionRefElement.attributeValue(ATTRIBUTE_ID); + if (id != null && id.length() != 0) + { + ActionDefinition def = parseActionDefinition(actionRefElement); + // override action definition ID based on the group name to avoid conflicts + def.id = actionGroup.getId() + '_' + def.getId(); + configElement.addActionDefinition(def); + actionGroup.addAction(def.getId()); + } + } + else + { + // look for the hide attribute + String hide = actionRefElement.attributeValue(ATTRIBUTE_HIDE); + if (hide != null && Boolean.parseBoolean(hide)) + { + actionGroup.hideAction(idRef); + } + else + { + // add the action definition ID to the group + actionGroup.addAction(idRef); + } + } + } + + // get simple string properties for the action group + actionGroup.Style = groupElement.elementTextTrim(ELEMENT_STYLE); + actionGroup.StyleClass = groupElement.elementTextTrim(ELEMENT_STYLECLASS); + if (groupElement.element(ELEMENT_SHOWLINK) != null) + { + actionGroup.ShowLink = Boolean.parseBoolean(groupElement.element(ELEMENT_SHOWLINK).getTextTrim()); + } + + // add the action group to the map of all action groups + configElement.addActionGroup(actionGroup); + } + } + + return configElement; + } + + /** + * Parse an ActionDefinition from the specific config element. + * + * @param actionElement The config element containing the action def + * + * @return The populated ActionDefinition + */ + public ActionDefinition parseActionDefinition(Element actionElement) + { + String actionId = actionElement.attributeValue(ATTRIBUTE_ID); + if (actionId == null || actionId.length() == 0) + { + throw new ConfigException("'action' config element specified without mandatory 'id' attribute."); + } + + // build a structure to represent the action definition + ActionDefinition actionDef = new ActionDefinition(actionId); + + // look for the permissions element - it can contain many permission + Element permissionsElement = actionElement.element(ELEMENT_PERMISSIONS); + if (permissionsElement != null) + { + // read and process each permission element + Iterator permissionItr = permissionsElement.elementIterator(ELEMENT_PERMISSION); + while (permissionItr.hasNext()) + { + Element permissionElement = permissionItr.next(); + boolean allow = true; + if (permissionElement.attributeValue(ATTRIBUTE_ALLOW) != null) + { + allow = Boolean.parseBoolean(permissionElement.attributeValue(ATTRIBUTE_ALLOW)); + } + String permissionValue = permissionElement.getTextTrim(); + if (allow) + { + actionDef.addAllowPermission(permissionValue); + } + else + { + actionDef.addDenyPermission(permissionValue); + } + } + } + + // find and construct the specified evaluator class + Element evaluatorElement = actionElement.element(ELEMENT_EVALUATOR); + if (evaluatorElement != null) + { + Object evaluator; + String className = evaluatorElement.getTextTrim(); + try + { + Class clazz = Class.forName(className); + evaluator = clazz.newInstance(); + } + catch (Throwable err) + { + throw new ConfigException("Unable to construct action '" + + actionId + "' evaluator classname: " +className); + } + if (evaluator instanceof ActionEvaluator == false) + { + throw new ConfigException("Action '" + actionId + "' evaluator class '" + + className + "' does not implement ActionEvaluator interface."); + } + actionDef.Evaluator = (ActionEvaluator)evaluator; + } + + // find any parameter values that the action requires + Element paramsElement = actionElement.element(ELEMENT_PARAMS); + if (paramsElement != null) + { + Iterator paramsItr = paramsElement.elementIterator(ELEMENT_PARAM); + while (paramsItr.hasNext()) + { + Element paramElement = paramsItr.next(); + String name = paramElement.attributeValue(ATTRIBUTE_NAME); + if (name == null || name.length() == 0) + { + throw new ConfigException("Action '" + actionId + + "' param does not have mandatory 'name' attribute."); + } + String value = paramElement.getTextTrim(); + if (value == null || value.length() == 0) + { + throw new ConfigException("Action '" + actionId + "' param '" + name + "'" + + "' does not have a value."); + } + actionDef.addParam(name, value); + } + } + + // get simple string properties for the action + actionDef.Label = actionElement.elementTextTrim(ELEMENT_LABEL); + actionDef.LabelMsg = actionElement.elementTextTrim(ELEMENT_LABELMSG); + actionDef.Tooltip = actionElement.elementTextTrim(ELEMENT_TOOLTIP); + actionDef.TooltipMsg = actionElement.elementTextTrim(ELEMENT_TOOLTIPMSG); + actionDef.Href = actionElement.elementTextTrim(ELEMENT_HREF); + actionDef.Target = actionElement.elementTextTrim(ELEMENT_TARGET); + actionDef.Script = actionElement.elementTextTrim(ELEMENT_SCRIPT); + actionDef.Action = actionElement.elementTextTrim(ELEMENT_ACTION); + actionDef.ActionListener = actionElement.elementTextTrim(ELEMENT_ACTIONLISTENER); + actionDef.Onclick = actionElement.elementTextTrim(ELEMENT_ONCLICK); + actionDef.Image = actionElement.elementTextTrim(ELEMENT_IMAGE); + actionDef.Style = actionElement.elementTextTrim(ELEMENT_STYLE); + actionDef.StyleClass = actionElement.elementTextTrim(ELEMENT_STYLECLASS); + if (actionElement.element(ELEMENT_SHOWLINK) != null) + { + actionDef.ShowLink = Boolean.parseBoolean(actionElement.element(ELEMENT_SHOWLINK).getTextTrim()); + } + + return actionDef; + } +} diff --git a/source/java/org/alfresco/web/config/AdvancedSearchConfigElement.java b/source/java/org/alfresco/web/config/AdvancedSearchConfigElement.java index c15dfd0905..6b4fe4f5d8 100644 --- a/source/java/org/alfresco/web/config/AdvancedSearchConfigElement.java +++ b/source/java/org/alfresco/web/config/AdvancedSearchConfigElement.java @@ -1,230 +1,230 @@ -package org.alfresco.web.config; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.List; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; - -/** - * Custom config element that represents config values for advanced search - * - * @author Gavin Cornwell - */ -public class AdvancedSearchConfigElement extends ConfigElementAdapter implements Serializable -{ - private static final long serialVersionUID = -6427054671579839728L; - - public static final String CONFIG_ELEMENT_ID = "advanced-search"; - - private List contentTypes = null; - private List folderTypes = null; - private List customProps = null; - - /** - * Default Constructor - */ - public AdvancedSearchConfigElement() - { - super(CONFIG_ELEMENT_ID); - } - - /** - * Constructor - * - * @param name Name of the element this config element represents - */ - public AdvancedSearchConfigElement(String name) - { - super(name); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() - */ - @Override - public List getChildren() - { - throw new ConfigException("Reading the advanced search config via the generic interfaces is not supported"); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - AdvancedSearchConfigElement newElement = (AdvancedSearchConfigElement)configElement; - AdvancedSearchConfigElement combinedElement = new AdvancedSearchConfigElement(); - - // just copy the list of types and properties from this instance to the new one - if (this.contentTypes != null) - { - for (String type : this.contentTypes) - { - combinedElement.addContentType(type); - } - } - if (this.folderTypes != null) - { - for (String type : this.folderTypes) - { - combinedElement.addFolderType(type); - } - } - - if (this.customProps != null) - { - for (CustomProperty property : this.customProps) - { - combinedElement.addCustomProperty(property); - } - } - - // now add those types and custom properties from the element to be combined - if (newElement.getContentTypes() != null) - { - for (String type : newElement.getContentTypes()) - { - combinedElement.addContentType(type); - } - } - - if (newElement.getFolderTypes() != null) - { - for (String type : newElement.getFolderTypes()) - { - combinedElement.addFolderType(type); - } - } - - if (newElement.getCustomProperties() != null) - { - for (CustomProperty property : newElement.getCustomProperties()) - { - combinedElement.addCustomProperty(property); - } - } - - return combinedElement; - } - - /** - * @return Returns the contentTypes. - */ - public List getContentTypes() - { - return this.contentTypes; - } - - /** - * @param contentTypes The contentTypes to set. - */ - /*package*/ void setContentTypes(List contentTypes) - { - this.contentTypes = contentTypes; - } - - /** - * @param contentType Adds the given content type to the list - */ - /*package*/ void addContentType(String contentType) - { - if (this.contentTypes == null) - { - this.contentTypes = new ArrayList(3); - } - - if (this.contentTypes.contains(contentType) == false) - { - this.contentTypes.add(contentType); - } - } - - /** - * @return Returns the folderTypes. - */ - public List getFolderTypes() - { - return this.folderTypes; - } - - /** - * @param folderTypes The folderTypes to set. - */ - /*package*/ void setFolderTypes(List folderTypes) - { - this.folderTypes = folderTypes; - } - - /** - * @param folderType Adds the given folder type to the list - */ - /*package*/ void addFolderType(String folderType) - { - if (this.folderTypes == null) - { - this.folderTypes = new ArrayList(3); - } - - if (this.folderTypes.contains(folderType) == false) - { - this.folderTypes.add(folderType); - } - } - - /** - * @return Returns the customProps. - */ - public List getCustomProperties() - { - return this.customProps; - } - - /** - * @param customProps The customProps to set. - */ - /*package*/ void setCustomProperties(List customProps) - { - this.customProps = customProps; - } - - /** - * @param property Adds the given custom property to the list - */ - /*package*/ void addCustomProperty(CustomProperty property) - { - if (this.customProps == null) - { - this.customProps = new ArrayList(3); - } - - // TODO: Determine if the CustomProperty being added is already - // in the list - - this.customProps.add(property); - } - - /** - * Simple wrapper class for custom advanced search property - * @author Kevin Roast - */ - public static class CustomProperty implements Serializable - { - private static final long serialVersionUID = 1457092137913897740L; - - CustomProperty(String type, String aspect, String property, String labelId) - { - Type = type; - Aspect = aspect; - Property = property; - LabelId = labelId; - } - - public String Type; - public String Aspect; - public String Property; - public String LabelId; - } -} +package org.alfresco.web.config; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; + +/** + * Custom config element that represents config values for advanced search + * + * @author Gavin Cornwell + */ +public class AdvancedSearchConfigElement extends ConfigElementAdapter implements Serializable +{ + private static final long serialVersionUID = -6427054671579839728L; + + public static final String CONFIG_ELEMENT_ID = "advanced-search"; + + private List contentTypes = null; + private List folderTypes = null; + private List customProps = null; + + /** + * Default Constructor + */ + public AdvancedSearchConfigElement() + { + super(CONFIG_ELEMENT_ID); + } + + /** + * Constructor + * + * @param name Name of the element this config element represents + */ + public AdvancedSearchConfigElement(String name) + { + super(name); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() + */ + @Override + public List getChildren() + { + throw new ConfigException("Reading the advanced search config via the generic interfaces is not supported"); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + AdvancedSearchConfigElement newElement = (AdvancedSearchConfigElement)configElement; + AdvancedSearchConfigElement combinedElement = new AdvancedSearchConfigElement(); + + // just copy the list of types and properties from this instance to the new one + if (this.contentTypes != null) + { + for (String type : this.contentTypes) + { + combinedElement.addContentType(type); + } + } + if (this.folderTypes != null) + { + for (String type : this.folderTypes) + { + combinedElement.addFolderType(type); + } + } + + if (this.customProps != null) + { + for (CustomProperty property : this.customProps) + { + combinedElement.addCustomProperty(property); + } + } + + // now add those types and custom properties from the element to be combined + if (newElement.getContentTypes() != null) + { + for (String type : newElement.getContentTypes()) + { + combinedElement.addContentType(type); + } + } + + if (newElement.getFolderTypes() != null) + { + for (String type : newElement.getFolderTypes()) + { + combinedElement.addFolderType(type); + } + } + + if (newElement.getCustomProperties() != null) + { + for (CustomProperty property : newElement.getCustomProperties()) + { + combinedElement.addCustomProperty(property); + } + } + + return combinedElement; + } + + /** + * @return Returns the contentTypes. + */ + public List getContentTypes() + { + return this.contentTypes; + } + + /** + * @param contentTypes The contentTypes to set. + */ + /*package*/ void setContentTypes(List contentTypes) + { + this.contentTypes = contentTypes; + } + + /** + * @param contentType Adds the given content type to the list + */ + /*package*/ void addContentType(String contentType) + { + if (this.contentTypes == null) + { + this.contentTypes = new ArrayList(3); + } + + if (this.contentTypes.contains(contentType) == false) + { + this.contentTypes.add(contentType); + } + } + + /** + * @return Returns the folderTypes. + */ + public List getFolderTypes() + { + return this.folderTypes; + } + + /** + * @param folderTypes The folderTypes to set. + */ + /*package*/ void setFolderTypes(List folderTypes) + { + this.folderTypes = folderTypes; + } + + /** + * @param folderType Adds the given folder type to the list + */ + /*package*/ void addFolderType(String folderType) + { + if (this.folderTypes == null) + { + this.folderTypes = new ArrayList(3); + } + + if (this.folderTypes.contains(folderType) == false) + { + this.folderTypes.add(folderType); + } + } + + /** + * @return Returns the customProps. + */ + public List getCustomProperties() + { + return this.customProps; + } + + /** + * @param customProps The customProps to set. + */ + /*package*/ void setCustomProperties(List customProps) + { + this.customProps = customProps; + } + + /** + * @param property Adds the given custom property to the list + */ + /*package*/ void addCustomProperty(CustomProperty property) + { + if (this.customProps == null) + { + this.customProps = new ArrayList(3); + } + + // TODO: Determine if the CustomProperty being added is already + // in the list + + this.customProps.add(property); + } + + /** + * Simple wrapper class for custom advanced search property + * @author Kevin Roast + */ + public static class CustomProperty implements Serializable + { + private static final long serialVersionUID = 1457092137913897740L; + + CustomProperty(String type, String aspect, String property, String labelId) + { + Type = type; + Aspect = aspect; + Property = property; + LabelId = labelId; + } + + public String Type; + public String Aspect; + public String Property; + public String LabelId; + } +} diff --git a/source/java/org/alfresco/web/config/AdvancedSearchElementReader.java b/source/java/org/alfresco/web/config/AdvancedSearchElementReader.java index 47bea05d8f..047e77a614 100644 --- a/source/java/org/alfresco/web/config/AdvancedSearchElementReader.java +++ b/source/java/org/alfresco/web/config/AdvancedSearchElementReader.java @@ -1,108 +1,108 @@ -package org.alfresco.web.config; - -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.alfresco.web.config.AdvancedSearchConfigElement.CustomProperty; -import org.dom4j.Element; - -/** - * Custom element reader to parse config for advanced search - * - * @author Gavin Cornwell - */ -public class AdvancedSearchElementReader implements ConfigElementReader -{ - public static final String ELEMENT_CONTENTTYPES = "content-types"; - public static final String ELEMENT_FOLDERTYPES = "folder-types"; - public static final String ELEMENT_TYPE = "type"; - public static final String ELEMENT_CUSTOMPROPS = "custom-properties"; - public static final String ELEMENT_METADATA = "meta-data"; - public static final String ATTRIBUTE_NAME = "name"; - public static final String ATTRIBUTE_TYPE = "type"; - public static final String ATTRIBUTE_PROPERTY = "property"; - public static final String ATTRIBUTE_ASPECT = "aspect"; - public static final String ATTRIBUTE_DISPLAYLABEL = "display-label-id"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - @SuppressWarnings("unchecked") - public ConfigElement parse(Element element) - { - AdvancedSearchConfigElement configElement = null; - - if (element != null) - { - String name = element.getName(); - if (name.equals(AdvancedSearchConfigElement.CONFIG_ELEMENT_ID) == false) - { - throw new ConfigException("AdvancedSearchElementReader can only parse " + - AdvancedSearchConfigElement.CONFIG_ELEMENT_ID + " elements, the element passed was '" + - name + "'"); - } - - configElement = new AdvancedSearchConfigElement(); - - // get the list of content types - Element contentTypes = element.element(ELEMENT_CONTENTTYPES); - if (contentTypes != null) - { - Iterator typesItr = contentTypes.elementIterator(ELEMENT_TYPE); - List types = new ArrayList(5); - while (typesItr.hasNext()) - { - Element contentType = typesItr.next(); - String type = contentType.attributeValue(ATTRIBUTE_NAME); - if (type != null) - { - types.add(type); - } - } - configElement.setContentTypes(types); - } - - // get the list of folder types - Element folderTypes = element.element(ELEMENT_FOLDERTYPES); - if (folderTypes != null) - { - Iterator typesItr = folderTypes.elementIterator(ELEMENT_TYPE); - List types = new ArrayList(5); - while (typesItr.hasNext()) - { - Element folderType = typesItr.next(); - String type = folderType.attributeValue(ATTRIBUTE_NAME); - if (type != null) - { - types.add(type); - } - } - configElement.setFolderTypes(types); - } - - // get the list of custom properties to display - Element customProps = element.element(ELEMENT_CUSTOMPROPS); - if (customProps != null) - { - Iterator propsItr = customProps.elementIterator(ELEMENT_METADATA); - List props = new ArrayList(5); - while (propsItr.hasNext()) - { - Element propElement = propsItr.next(); - String type = propElement.attributeValue(ATTRIBUTE_TYPE); - String aspect = propElement.attributeValue(ATTRIBUTE_ASPECT); - String prop = propElement.attributeValue(ATTRIBUTE_PROPERTY); - String labelId = propElement.attributeValue(ATTRIBUTE_DISPLAYLABEL); - props.add(new AdvancedSearchConfigElement.CustomProperty(type, aspect, prop, labelId)); - } - configElement.setCustomProperties(props); - } - } - - return configElement; - } -} +package org.alfresco.web.config; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.alfresco.web.config.AdvancedSearchConfigElement.CustomProperty; +import org.dom4j.Element; + +/** + * Custom element reader to parse config for advanced search + * + * @author Gavin Cornwell + */ +public class AdvancedSearchElementReader implements ConfigElementReader +{ + public static final String ELEMENT_CONTENTTYPES = "content-types"; + public static final String ELEMENT_FOLDERTYPES = "folder-types"; + public static final String ELEMENT_TYPE = "type"; + public static final String ELEMENT_CUSTOMPROPS = "custom-properties"; + public static final String ELEMENT_METADATA = "meta-data"; + public static final String ATTRIBUTE_NAME = "name"; + public static final String ATTRIBUTE_TYPE = "type"; + public static final String ATTRIBUTE_PROPERTY = "property"; + public static final String ATTRIBUTE_ASPECT = "aspect"; + public static final String ATTRIBUTE_DISPLAYLABEL = "display-label-id"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + @SuppressWarnings("unchecked") + public ConfigElement parse(Element element) + { + AdvancedSearchConfigElement configElement = null; + + if (element != null) + { + String name = element.getName(); + if (name.equals(AdvancedSearchConfigElement.CONFIG_ELEMENT_ID) == false) + { + throw new ConfigException("AdvancedSearchElementReader can only parse " + + AdvancedSearchConfigElement.CONFIG_ELEMENT_ID + " elements, the element passed was '" + + name + "'"); + } + + configElement = new AdvancedSearchConfigElement(); + + // get the list of content types + Element contentTypes = element.element(ELEMENT_CONTENTTYPES); + if (contentTypes != null) + { + Iterator typesItr = contentTypes.elementIterator(ELEMENT_TYPE); + List types = new ArrayList(5); + while (typesItr.hasNext()) + { + Element contentType = typesItr.next(); + String type = contentType.attributeValue(ATTRIBUTE_NAME); + if (type != null) + { + types.add(type); + } + } + configElement.setContentTypes(types); + } + + // get the list of folder types + Element folderTypes = element.element(ELEMENT_FOLDERTYPES); + if (folderTypes != null) + { + Iterator typesItr = folderTypes.elementIterator(ELEMENT_TYPE); + List types = new ArrayList(5); + while (typesItr.hasNext()) + { + Element folderType = typesItr.next(); + String type = folderType.attributeValue(ATTRIBUTE_NAME); + if (type != null) + { + types.add(type); + } + } + configElement.setFolderTypes(types); + } + + // get the list of custom properties to display + Element customProps = element.element(ELEMENT_CUSTOMPROPS); + if (customProps != null) + { + Iterator propsItr = customProps.elementIterator(ELEMENT_METADATA); + List props = new ArrayList(5); + while (propsItr.hasNext()) + { + Element propElement = propsItr.next(); + String type = propElement.attributeValue(ATTRIBUTE_TYPE); + String aspect = propElement.attributeValue(ATTRIBUTE_ASPECT); + String prop = propElement.attributeValue(ATTRIBUTE_PROPERTY); + String labelId = propElement.attributeValue(ATTRIBUTE_DISPLAYLABEL); + props.add(new AdvancedSearchConfigElement.CustomProperty(type, aspect, prop, labelId)); + } + configElement.setCustomProperties(props); + } + } + + return configElement; + } +} diff --git a/source/java/org/alfresco/web/config/CommandServletConfigElement.java b/source/java/org/alfresco/web/config/CommandServletConfigElement.java index 3c89c51453..ce6496cbf5 100644 --- a/source/java/org/alfresco/web/config/CommandServletConfigElement.java +++ b/source/java/org/alfresco/web/config/CommandServletConfigElement.java @@ -1,89 +1,89 @@ -package org.alfresco.web.config; - -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; - -/** - * @author Kevin Roast - */ -public class CommandServletConfigElement extends ConfigElementAdapter -{ - public static final String CONFIG_ELEMENT_ID = "command-servlet"; - - private Map commandProcessors = new HashMap(4, 1.0f); - - /** - * Default constructor - */ - public CommandServletConfigElement() - { - super("command-servlet"); - } - - /** - * Constructor - * - * @param name Name of the element this config element represents - */ - public CommandServletConfigElement(String name) - { - super(name); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() - */ - public List getChildren() - { - throw new ConfigException("Reading the Command Servlet config via the generic interfaces is not supported"); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - CommandServletConfigElement newElement = (CommandServletConfigElement)configElement; - CommandServletConfigElement combinedElement = new CommandServletConfigElement(); - - for (String name : commandProcessors.keySet()) - { - combinedElement.addCommandProcessor(name, commandProcessors.get(name)); - } - for (String name : newElement.commandProcessors.keySet()) - { - combinedElement.addCommandProcessor(name, newElement.commandProcessors.get(name)); - } - - return combinedElement; - } - - /*package*/ void addCommandProcessor(String name, String className) - { - try - { - Class clazz = Class.forName(className); - commandProcessors.put(name, clazz); - } - catch (Throwable err) - { - throw new ConfigException("Unable to load command proccessor class: " + - className + " due to " + err.getMessage()); - } - } - - private void addCommandProcessor(String name, Class clazz) - { - commandProcessors.put(name, clazz); - } - - public Class getCommandProcessor(String name) - { - return commandProcessors.get(name); - } -} +package org.alfresco.web.config; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; + +/** + * @author Kevin Roast + */ +public class CommandServletConfigElement extends ConfigElementAdapter +{ + public static final String CONFIG_ELEMENT_ID = "command-servlet"; + + private Map commandProcessors = new HashMap(4, 1.0f); + + /** + * Default constructor + */ + public CommandServletConfigElement() + { + super("command-servlet"); + } + + /** + * Constructor + * + * @param name Name of the element this config element represents + */ + public CommandServletConfigElement(String name) + { + super(name); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() + */ + public List getChildren() + { + throw new ConfigException("Reading the Command Servlet config via the generic interfaces is not supported"); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + CommandServletConfigElement newElement = (CommandServletConfigElement)configElement; + CommandServletConfigElement combinedElement = new CommandServletConfigElement(); + + for (String name : commandProcessors.keySet()) + { + combinedElement.addCommandProcessor(name, commandProcessors.get(name)); + } + for (String name : newElement.commandProcessors.keySet()) + { + combinedElement.addCommandProcessor(name, newElement.commandProcessors.get(name)); + } + + return combinedElement; + } + + /*package*/ void addCommandProcessor(String name, String className) + { + try + { + Class clazz = Class.forName(className); + commandProcessors.put(name, clazz); + } + catch (Throwable err) + { + throw new ConfigException("Unable to load command proccessor class: " + + className + " due to " + err.getMessage()); + } + } + + private void addCommandProcessor(String name, Class clazz) + { + commandProcessors.put(name, clazz); + } + + public Class getCommandProcessor(String name) + { + return commandProcessors.get(name); + } +} diff --git a/source/java/org/alfresco/web/config/CommandServletElementReader.java b/source/java/org/alfresco/web/config/CommandServletElementReader.java index 0d7a7cbaa0..38894939a3 100644 --- a/source/java/org/alfresco/web/config/CommandServletElementReader.java +++ b/source/java/org/alfresco/web/config/CommandServletElementReader.java @@ -1,57 +1,57 @@ -package org.alfresco.web.config; - -import java.util.Iterator; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.dom4j.Element; - -/** - * @author Kevin Roast - */ -public class CommandServletElementReader implements ConfigElementReader -{ - public static final String ELEMENT_COMMANDPROCESSOR = "command-processor"; - public static final String ATTRIBUTE_NAME = "name"; - public static final String ATTRIBUTE_CLASS = "class"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - @SuppressWarnings("unchecked") - public ConfigElement parse(Element element) - { - CommandServletConfigElement configElement = new CommandServletConfigElement(); - - if (element != null) - { - if (CommandServletConfigElement.CONFIG_ELEMENT_ID.equals(element.getName()) == false) - { - throw new ConfigException("CommandServletElementReader can only parse config elements of type 'command-servlet'"); - } - - Iterator itr = element.elementIterator(ELEMENT_COMMANDPROCESSOR); - while (itr.hasNext()) - { - Element procElement = itr.next(); - - String name = procElement.attributeValue(ATTRIBUTE_NAME); - String className = procElement.attributeValue(ATTRIBUTE_CLASS); - - if (name == null || name.length() == 0) - { - throw new ConfigException("'name' attribute is mandatory for command processor config element."); - } - if (className == null || className.length() == 0) - { - throw new ConfigException("'class' attribute is mandatory for command processor config element."); - } - - configElement.addCommandProcessor(name, className); - } - } - - return configElement; - } -} +package org.alfresco.web.config; + +import java.util.Iterator; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.dom4j.Element; + +/** + * @author Kevin Roast + */ +public class CommandServletElementReader implements ConfigElementReader +{ + public static final String ELEMENT_COMMANDPROCESSOR = "command-processor"; + public static final String ATTRIBUTE_NAME = "name"; + public static final String ATTRIBUTE_CLASS = "class"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + @SuppressWarnings("unchecked") + public ConfigElement parse(Element element) + { + CommandServletConfigElement configElement = new CommandServletConfigElement(); + + if (element != null) + { + if (CommandServletConfigElement.CONFIG_ELEMENT_ID.equals(element.getName()) == false) + { + throw new ConfigException("CommandServletElementReader can only parse config elements of type 'command-servlet'"); + } + + Iterator itr = element.elementIterator(ELEMENT_COMMANDPROCESSOR); + while (itr.hasNext()) + { + Element procElement = itr.next(); + + String name = procElement.attributeValue(ATTRIBUTE_NAME); + String className = procElement.attributeValue(ATTRIBUTE_CLASS); + + if (name == null || name.length() == 0) + { + throw new ConfigException("'name' attribute is mandatory for command processor config element."); + } + if (className == null || className.length() == 0) + { + throw new ConfigException("'class' attribute is mandatory for command processor config element."); + } + + configElement.addCommandProcessor(name, className); + } + } + + return configElement; + } +} diff --git a/source/java/org/alfresco/web/config/DashboardsConfigElement.java b/source/java/org/alfresco/web/config/DashboardsConfigElement.java index a803ee422e..5783ad6fc5 100644 --- a/source/java/org/alfresco/web/config/DashboardsConfigElement.java +++ b/source/java/org/alfresco/web/config/DashboardsConfigElement.java @@ -1,186 +1,186 @@ -package org.alfresco.web.config; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Iterator; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; - -/** - * Dashboard config element. - * - * @author Kevin Roast - */ -public class DashboardsConfigElement extends ConfigElementAdapter -{ - public static final String CONFIG_ELEMENT_ID = "dashboards"; - - private Map layoutDefs = new LinkedHashMap(4, 1.0f); - private Map dashletDefs = new LinkedHashMap(8, 1.0f); - private List defaultDashlets = null; - private boolean allowGuestConfig = false; - - /** - * Default constructor - */ - public DashboardsConfigElement() - { - super(CONFIG_ELEMENT_ID); - } - - /** - * @param name String - */ - public DashboardsConfigElement(String name) - { - super(name); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() - */ - public List getChildren() - { - throw new ConfigException("Reading the Dashboards config via the generic interfaces is not supported"); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - DashboardsConfigElement newElement = (DashboardsConfigElement)configElement; - DashboardsConfigElement combinedElement = new DashboardsConfigElement(); - - // put all into combined from this and then from new to override any already present - combinedElement.dashletDefs.putAll(this.dashletDefs); - combinedElement.dashletDefs.putAll(newElement.dashletDefs); - - combinedElement.layoutDefs.putAll(this.layoutDefs); - combinedElement.layoutDefs.putAll(newElement.layoutDefs); - - if (newElement.allowGuestConfig != combinedElement.allowGuestConfig) - { - combinedElement.allowGuestConfig = newElement.allowGuestConfig; - } - - // the default-dashlets list is completely replaced if config is overriden - if (newElement.defaultDashlets != null) - { - combinedElement.defaultDashlets = - (List)((ArrayList)newElement.defaultDashlets).clone(); - } - else if (this.defaultDashlets != null) - { - combinedElement.defaultDashlets = - (List)((ArrayList)this.defaultDashlets).clone(); - } - - return combinedElement; - } - - /*package*/ void setAllowGuestConfig(boolean allow) - { - this.allowGuestConfig = allow; - } - - public boolean getAllowGuestConfig() - { - return this.allowGuestConfig; - } - - /*package*/ void addLayoutDefinition(LayoutDefinition def) - { - this.layoutDefs.put(def.Id, def); - } - - public LayoutDefinition getLayoutDefinition(String id) - { - return this.layoutDefs.get(id); - } - - /*package*/ void addDashletDefinition(DashletDefinition def) - { - this.dashletDefs.put(def.Id, def); - } - - public DashletDefinition getDashletDefinition(String id) - { - return this.dashletDefs.get(id); - } - - public Collection getLayouts() - { - return this.layoutDefs.values(); - } - - public Collection getDashlets() - { - return this.dashletDefs.values(); - } - - /*package*/ void addDefaultDashlet(String id) - { - if (this.defaultDashlets == null) - { - this.defaultDashlets = new ArrayList(2); - } - this.defaultDashlets.add(id); - } - - public Collection getDefaultDashlets() - { - return this.defaultDashlets; - } - - /** - * Structure class for the definition of a dashboard page layout - */ - public static class LayoutDefinition implements Serializable - { - private static final long serialVersionUID = -3014156293576142077L; - - LayoutDefinition(String id) - { - this.Id = id; - } - - public String Id; - public String Image; - public int Columns; - public int ColumnLength; - public String Label; - public String LabelId; - public String Description; - public String DescriptionId; - public String JSPPage; - } - - /** - * Structure class for the definition of a dashboard dashlet component - */ - public static class DashletDefinition implements Serializable - { - private static final long serialVersionUID = -5755903997700459631L; - - DashletDefinition(String id) - { - this.Id = id; - } - - public String Id; - public boolean AllowNarrow = true; - public String Label; - public String LabelId; - public String Description; - public String DescriptionId; - public String JSPPage; - public String ConfigJSPPage; - } -} +package org.alfresco.web.config; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; + +/** + * Dashboard config element. + * + * @author Kevin Roast + */ +public class DashboardsConfigElement extends ConfigElementAdapter +{ + public static final String CONFIG_ELEMENT_ID = "dashboards"; + + private Map layoutDefs = new LinkedHashMap(4, 1.0f); + private Map dashletDefs = new LinkedHashMap(8, 1.0f); + private List defaultDashlets = null; + private boolean allowGuestConfig = false; + + /** + * Default constructor + */ + public DashboardsConfigElement() + { + super(CONFIG_ELEMENT_ID); + } + + /** + * @param name String + */ + public DashboardsConfigElement(String name) + { + super(name); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() + */ + public List getChildren() + { + throw new ConfigException("Reading the Dashboards config via the generic interfaces is not supported"); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + DashboardsConfigElement newElement = (DashboardsConfigElement)configElement; + DashboardsConfigElement combinedElement = new DashboardsConfigElement(); + + // put all into combined from this and then from new to override any already present + combinedElement.dashletDefs.putAll(this.dashletDefs); + combinedElement.dashletDefs.putAll(newElement.dashletDefs); + + combinedElement.layoutDefs.putAll(this.layoutDefs); + combinedElement.layoutDefs.putAll(newElement.layoutDefs); + + if (newElement.allowGuestConfig != combinedElement.allowGuestConfig) + { + combinedElement.allowGuestConfig = newElement.allowGuestConfig; + } + + // the default-dashlets list is completely replaced if config is overriden + if (newElement.defaultDashlets != null) + { + combinedElement.defaultDashlets = + (List)((ArrayList)newElement.defaultDashlets).clone(); + } + else if (this.defaultDashlets != null) + { + combinedElement.defaultDashlets = + (List)((ArrayList)this.defaultDashlets).clone(); + } + + return combinedElement; + } + + /*package*/ void setAllowGuestConfig(boolean allow) + { + this.allowGuestConfig = allow; + } + + public boolean getAllowGuestConfig() + { + return this.allowGuestConfig; + } + + /*package*/ void addLayoutDefinition(LayoutDefinition def) + { + this.layoutDefs.put(def.Id, def); + } + + public LayoutDefinition getLayoutDefinition(String id) + { + return this.layoutDefs.get(id); + } + + /*package*/ void addDashletDefinition(DashletDefinition def) + { + this.dashletDefs.put(def.Id, def); + } + + public DashletDefinition getDashletDefinition(String id) + { + return this.dashletDefs.get(id); + } + + public Collection getLayouts() + { + return this.layoutDefs.values(); + } + + public Collection getDashlets() + { + return this.dashletDefs.values(); + } + + /*package*/ void addDefaultDashlet(String id) + { + if (this.defaultDashlets == null) + { + this.defaultDashlets = new ArrayList(2); + } + this.defaultDashlets.add(id); + } + + public Collection getDefaultDashlets() + { + return this.defaultDashlets; + } + + /** + * Structure class for the definition of a dashboard page layout + */ + public static class LayoutDefinition implements Serializable + { + private static final long serialVersionUID = -3014156293576142077L; + + LayoutDefinition(String id) + { + this.Id = id; + } + + public String Id; + public String Image; + public int Columns; + public int ColumnLength; + public String Label; + public String LabelId; + public String Description; + public String DescriptionId; + public String JSPPage; + } + + /** + * Structure class for the definition of a dashboard dashlet component + */ + public static class DashletDefinition implements Serializable + { + private static final long serialVersionUID = -5755903997700459631L; + + DashletDefinition(String id) + { + this.Id = id; + } + + public String Id; + public boolean AllowNarrow = true; + public String Label; + public String LabelId; + public String Description; + public String DescriptionId; + public String JSPPage; + public String ConfigJSPPage; + } +} diff --git a/source/java/org/alfresco/web/config/DashboardsElementReader.java b/source/java/org/alfresco/web/config/DashboardsElementReader.java index df2dfd5f68..3451dd0b9f 100644 --- a/source/java/org/alfresco/web/config/DashboardsElementReader.java +++ b/source/java/org/alfresco/web/config/DashboardsElementReader.java @@ -1,211 +1,211 @@ -package org.alfresco.web.config; - -import java.util.Iterator; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.alfresco.web.config.DashboardsConfigElement.DashletDefinition; -import org.alfresco.web.config.DashboardsConfigElement.LayoutDefinition; -import org.dom4j.Element; - -/** - * Reader for the 'dashboards' config element and child elements. - * - * @author Kevin Roast - */ -public class DashboardsElementReader implements ConfigElementReader -{ - public static final String ELEMENT_DASHBOARDS = "dashboards"; - public static final String ELEMENT_LAYOUTS = "layouts"; - public static final String ELEMENT_LAYOUT = "layout"; - public static final String ELEMENT_DASHLETS = "dashlets"; - public static final String ELEMENT_DASHLET = "dashlet"; - public static final String ELEMENT_GUESTCONFIG = "allow-guest-config"; - public static final String ELEMENT_DEFAULTDASHLETS = "default-dashlets"; - public static final String ATTR_ID = "id"; - public static final String ATTR_COLUMNS = "columns"; - public static final String ATTR_COLUMNLENGTH = "column-length"; - public static final String ATTR_IMAGE = "image"; - public static final String ATTR_LABEL = "label"; - public static final String ATTR_DESCRIPTION = "description"; - public static final String ATTR_LABELID = "label-id"; - public static final String ATTR_DESCRIPTIONID = "description-id"; - public static final String ATTR_JSP = "jsp"; - public static final String ATTR_CONFIGJSP = "config-jsp"; - public static final String ATTR_ALLOWNARROW = "allow-narrow"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - @SuppressWarnings("unchecked") - public ConfigElement parse(Element element) - { - DashboardsConfigElement configElement = new DashboardsConfigElement(); - - if (element != null) - { - if (DashboardsConfigElement.CONFIG_ELEMENT_ID.equals(element.getName()) == false) - { - throw new ConfigException("DashboardsElementReader can only process elements of type 'dashboards'"); - } - - Element layoutsElement = element.element(ELEMENT_LAYOUTS); - if (layoutsElement != null) - { - Iterator layoutsItr = layoutsElement.elementIterator(ELEMENT_LAYOUT); - while (layoutsItr.hasNext()) - { - LayoutDefinition layoutDef = parseLayoutDefinition(layoutsItr.next()); - configElement.addLayoutDefinition(layoutDef); - } - } - - Element dashletsElement = element.element(ELEMENT_DASHLETS); - if (dashletsElement != null) - { - Iterator dashletsItr = dashletsElement.elementIterator(ELEMENT_DASHLET); - while (dashletsItr.hasNext()) - { - DashletDefinition dashletDef = parseDashletDefinition(dashletsItr.next()); - configElement.addDashletDefinition(dashletDef); - } - } - - Element defaultDashletsElement = element.element(ELEMENT_DEFAULTDASHLETS); - if (defaultDashletsElement != null) - { - Iterator dashletsItr = defaultDashletsElement.elementIterator(ELEMENT_DASHLET); - while (dashletsItr.hasNext()) - { - String id = getMandatoryDashletAttributeValue(dashletsItr.next(), ATTR_ID); - configElement.addDefaultDashlet(id); - } - } - - Element guestConfigElement = element.element(ELEMENT_GUESTCONFIG); - if (guestConfigElement != null) - { - boolean allow = Boolean.parseBoolean(guestConfigElement.getTextTrim()); - configElement.setAllowGuestConfig(allow); - } - } - - return configElement; - } - - /** - * Parse a single Layout definition from config. - * - * @param config Element - * - * @return LayoutDefinition for the specified config element. - */ - private static LayoutDefinition parseLayoutDefinition(Element config) - { - String id = getMandatoryLayoutAttributeValue(config, ATTR_ID); - - LayoutDefinition def = new LayoutDefinition(id); - - String columns = getMandatoryLayoutAttributeValue(config, ATTR_COLUMNS); - def.Columns = Integer.parseInt(columns); - String columnLength = getMandatoryLayoutAttributeValue(config, ATTR_COLUMNLENGTH); - def.ColumnLength = Integer.parseInt(columnLength); - def.Image = getMandatoryLayoutAttributeValue(config, ATTR_IMAGE); - def.JSPPage = getMandatoryLayoutAttributeValue(config, ATTR_JSP); - String label = config.attributeValue(ATTR_LABEL); - String labelId = config.attributeValue(ATTR_LABELID); - if ((label == null || label.length() == 0) && (labelId == null || labelId.length() == 0)) - { - throw new ConfigException("Either 'label' or 'label-id' attribute must be specified for Dashboard 'layout' configuration element."); - } - def.Label = label; - def.LabelId = labelId; - String description = config.attributeValue(ATTR_DESCRIPTION); - String descriptionId = config.attributeValue(ATTR_DESCRIPTIONID); - if ((description == null || description.length() == 0) && (descriptionId == null || descriptionId.length() == 0)) - { - throw new ConfigException("Either 'description' or 'description-id' attribute must be specified for Dashboard 'layout' configuration element."); - } - def.Description = description; - def.DescriptionId = descriptionId; - - return def; - } - - /** - * Return a mandatory layout attribute layout. Throw an exception if the value is not found. - * - * @param config Element - * @param attr String - * - * @return String value - */ - private static String getMandatoryLayoutAttributeValue(Element config, String attr) - { - String value = config.attributeValue(attr); - if (value == null || value.length() == 0) - { - throw new ConfigException("Missing mandatory '" + attr + "' attribute for Dashboard 'layout' configuration element."); - } - return value; - } - - /** - * Parse a single Dashlet definition from config. - * - * @param config Element - * - * @return DashletDefinition for the specified config element. - */ - private static DashletDefinition parseDashletDefinition(Element config) - { - String id = getMandatoryDashletAttributeValue(config, ATTR_ID); - - DashletDefinition def = new DashletDefinition(id); - - String allowNarrow = config.attributeValue(ATTR_ALLOWNARROW); - if (allowNarrow != null && allowNarrow.length() != 0) - { - def.AllowNarrow = Boolean.parseBoolean(allowNarrow); - } - def.JSPPage = getMandatoryDashletAttributeValue(config, ATTR_JSP); - def.ConfigJSPPage = config.attributeValue(ATTR_CONFIGJSP); - String label = config.attributeValue(ATTR_LABEL); - String labelId = config.attributeValue(ATTR_LABELID); - if ((label == null || label.length() == 0) && (labelId == null || labelId.length() == 0)) - { - throw new ConfigException("Either 'label' or 'label-id' attribute must be specified for Dashboard 'dashlet' configuration element."); - } - def.Label = label; - def.LabelId = labelId; - String description = config.attributeValue(ATTR_DESCRIPTION); - String descriptionId = config.attributeValue(ATTR_DESCRIPTIONID); - if ((description == null || description.length() == 0) && (descriptionId == null || descriptionId.length() == 0)) - { - throw new ConfigException("Either 'description' or 'description-id' attribute must be specified for Dashboard 'dashlet' configuration element."); - } - def.Description = description; - def.DescriptionId = descriptionId; - - return def; - } - - /** - * Return a mandatory dashlet attribute layout. Throw an exception if the value is not found. - * - * @param config Element - * @param attr String - * - * @return String value - */ - private static String getMandatoryDashletAttributeValue(Element config, String attr) - { - String value = config.attributeValue(attr); - if (value == null || value.length() == 0) - { - throw new ConfigException("Missing mandatory '" + attr + "' attribute for Dashboard 'dashlet' configuration element."); - } - return value; - } -} +package org.alfresco.web.config; + +import java.util.Iterator; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.alfresco.web.config.DashboardsConfigElement.DashletDefinition; +import org.alfresco.web.config.DashboardsConfigElement.LayoutDefinition; +import org.dom4j.Element; + +/** + * Reader for the 'dashboards' config element and child elements. + * + * @author Kevin Roast + */ +public class DashboardsElementReader implements ConfigElementReader +{ + public static final String ELEMENT_DASHBOARDS = "dashboards"; + public static final String ELEMENT_LAYOUTS = "layouts"; + public static final String ELEMENT_LAYOUT = "layout"; + public static final String ELEMENT_DASHLETS = "dashlets"; + public static final String ELEMENT_DASHLET = "dashlet"; + public static final String ELEMENT_GUESTCONFIG = "allow-guest-config"; + public static final String ELEMENT_DEFAULTDASHLETS = "default-dashlets"; + public static final String ATTR_ID = "id"; + public static final String ATTR_COLUMNS = "columns"; + public static final String ATTR_COLUMNLENGTH = "column-length"; + public static final String ATTR_IMAGE = "image"; + public static final String ATTR_LABEL = "label"; + public static final String ATTR_DESCRIPTION = "description"; + public static final String ATTR_LABELID = "label-id"; + public static final String ATTR_DESCRIPTIONID = "description-id"; + public static final String ATTR_JSP = "jsp"; + public static final String ATTR_CONFIGJSP = "config-jsp"; + public static final String ATTR_ALLOWNARROW = "allow-narrow"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + @SuppressWarnings("unchecked") + public ConfigElement parse(Element element) + { + DashboardsConfigElement configElement = new DashboardsConfigElement(); + + if (element != null) + { + if (DashboardsConfigElement.CONFIG_ELEMENT_ID.equals(element.getName()) == false) + { + throw new ConfigException("DashboardsElementReader can only process elements of type 'dashboards'"); + } + + Element layoutsElement = element.element(ELEMENT_LAYOUTS); + if (layoutsElement != null) + { + Iterator layoutsItr = layoutsElement.elementIterator(ELEMENT_LAYOUT); + while (layoutsItr.hasNext()) + { + LayoutDefinition layoutDef = parseLayoutDefinition(layoutsItr.next()); + configElement.addLayoutDefinition(layoutDef); + } + } + + Element dashletsElement = element.element(ELEMENT_DASHLETS); + if (dashletsElement != null) + { + Iterator dashletsItr = dashletsElement.elementIterator(ELEMENT_DASHLET); + while (dashletsItr.hasNext()) + { + DashletDefinition dashletDef = parseDashletDefinition(dashletsItr.next()); + configElement.addDashletDefinition(dashletDef); + } + } + + Element defaultDashletsElement = element.element(ELEMENT_DEFAULTDASHLETS); + if (defaultDashletsElement != null) + { + Iterator dashletsItr = defaultDashletsElement.elementIterator(ELEMENT_DASHLET); + while (dashletsItr.hasNext()) + { + String id = getMandatoryDashletAttributeValue(dashletsItr.next(), ATTR_ID); + configElement.addDefaultDashlet(id); + } + } + + Element guestConfigElement = element.element(ELEMENT_GUESTCONFIG); + if (guestConfigElement != null) + { + boolean allow = Boolean.parseBoolean(guestConfigElement.getTextTrim()); + configElement.setAllowGuestConfig(allow); + } + } + + return configElement; + } + + /** + * Parse a single Layout definition from config. + * + * @param config Element + * + * @return LayoutDefinition for the specified config element. + */ + private static LayoutDefinition parseLayoutDefinition(Element config) + { + String id = getMandatoryLayoutAttributeValue(config, ATTR_ID); + + LayoutDefinition def = new LayoutDefinition(id); + + String columns = getMandatoryLayoutAttributeValue(config, ATTR_COLUMNS); + def.Columns = Integer.parseInt(columns); + String columnLength = getMandatoryLayoutAttributeValue(config, ATTR_COLUMNLENGTH); + def.ColumnLength = Integer.parseInt(columnLength); + def.Image = getMandatoryLayoutAttributeValue(config, ATTR_IMAGE); + def.JSPPage = getMandatoryLayoutAttributeValue(config, ATTR_JSP); + String label = config.attributeValue(ATTR_LABEL); + String labelId = config.attributeValue(ATTR_LABELID); + if ((label == null || label.length() == 0) && (labelId == null || labelId.length() == 0)) + { + throw new ConfigException("Either 'label' or 'label-id' attribute must be specified for Dashboard 'layout' configuration element."); + } + def.Label = label; + def.LabelId = labelId; + String description = config.attributeValue(ATTR_DESCRIPTION); + String descriptionId = config.attributeValue(ATTR_DESCRIPTIONID); + if ((description == null || description.length() == 0) && (descriptionId == null || descriptionId.length() == 0)) + { + throw new ConfigException("Either 'description' or 'description-id' attribute must be specified for Dashboard 'layout' configuration element."); + } + def.Description = description; + def.DescriptionId = descriptionId; + + return def; + } + + /** + * Return a mandatory layout attribute layout. Throw an exception if the value is not found. + * + * @param config Element + * @param attr String + * + * @return String value + */ + private static String getMandatoryLayoutAttributeValue(Element config, String attr) + { + String value = config.attributeValue(attr); + if (value == null || value.length() == 0) + { + throw new ConfigException("Missing mandatory '" + attr + "' attribute for Dashboard 'layout' configuration element."); + } + return value; + } + + /** + * Parse a single Dashlet definition from config. + * + * @param config Element + * + * @return DashletDefinition for the specified config element. + */ + private static DashletDefinition parseDashletDefinition(Element config) + { + String id = getMandatoryDashletAttributeValue(config, ATTR_ID); + + DashletDefinition def = new DashletDefinition(id); + + String allowNarrow = config.attributeValue(ATTR_ALLOWNARROW); + if (allowNarrow != null && allowNarrow.length() != 0) + { + def.AllowNarrow = Boolean.parseBoolean(allowNarrow); + } + def.JSPPage = getMandatoryDashletAttributeValue(config, ATTR_JSP); + def.ConfigJSPPage = config.attributeValue(ATTR_CONFIGJSP); + String label = config.attributeValue(ATTR_LABEL); + String labelId = config.attributeValue(ATTR_LABELID); + if ((label == null || label.length() == 0) && (labelId == null || labelId.length() == 0)) + { + throw new ConfigException("Either 'label' or 'label-id' attribute must be specified for Dashboard 'dashlet' configuration element."); + } + def.Label = label; + def.LabelId = labelId; + String description = config.attributeValue(ATTR_DESCRIPTION); + String descriptionId = config.attributeValue(ATTR_DESCRIPTIONID); + if ((description == null || description.length() == 0) && (descriptionId == null || descriptionId.length() == 0)) + { + throw new ConfigException("Either 'description' or 'description-id' attribute must be specified for Dashboard 'dashlet' configuration element."); + } + def.Description = description; + def.DescriptionId = descriptionId; + + return def; + } + + /** + * Return a mandatory dashlet attribute layout. Throw an exception if the value is not found. + * + * @param config Element + * @param attr String + * + * @return String value + */ + private static String getMandatoryDashletAttributeValue(Element config, String attr) + { + String value = config.attributeValue(attr); + if (value == null || value.length() == 0) + { + throw new ConfigException("Missing mandatory '" + attr + "' attribute for Dashboard 'dashlet' configuration element."); + } + return value; + } +} diff --git a/source/java/org/alfresco/web/config/DialogsConfigElement.java b/source/java/org/alfresco/web/config/DialogsConfigElement.java index 3c1adc3d91..cd14a48c47 100644 --- a/source/java/org/alfresco/web/config/DialogsConfigElement.java +++ b/source/java/org/alfresco/web/config/DialogsConfigElement.java @@ -1,595 +1,595 @@ -package org.alfresco.web.config; - -import java.io.Serializable; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; -import org.springframework.extensions.surf.util.ParameterCheck; - -/** - * Custom config element that represents the config data for a property sheet - * - * @author gavinc - */ -public class DialogsConfigElement extends ConfigElementAdapter -{ - private static final long serialVersionUID = 8265738244249506534L; - - public static final String CONFIG_ELEMENT_ID = "dialogs"; - - private Map dialogs = new LinkedHashMap(8, 10f); - - /** - * Default constructor - */ - public DialogsConfigElement() - { - super(CONFIG_ELEMENT_ID); - } - - /** - * Constructor - * - * @param name Name of the element this config element represents - */ - public DialogsConfigElement(String name) - { - super(name); - } - - /** - * @see ConfigElement#getChildren() - */ - public List getChildren() - { - throw new ConfigException("Reading the dialogs config via the generic interfaces is not supported"); - } - - /** - * @see ConfigElement#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - DialogsConfigElement combined = new DialogsConfigElement(); - - // add all the dialogs from this element - for (DialogConfig dialog : this.getDialogs().values()) - { - combined.addDialog(dialog); - } - - // add all the dialogs from the given element - for (DialogConfig dialog : ((DialogsConfigElement)configElement).getDialogs().values()) - { - combined.addDialog(dialog); - } - - return combined; - } - - /** - * Returns the named dialog - * - * @param name The name of the dialog to retrieve - * @return The DialogConfig object for the requested dialog or null if it doesn't exist - */ - public DialogConfig getDialog(String name) - { - return this.dialogs.get(name); - } - - /** - * @return Returns a map of the dialogs. A linked hash map is used internally to - * preserve ordering. - */ - public Map getDialogs() - { - return this.dialogs; - } - - /** - * Adds a dialog - * - * @param dialogConfig A pre-configured dialog config object - */ - /*package*/ void addDialog(DialogConfig dialogConfig) - { - this.dialogs.put(dialogConfig.getName(), dialogConfig); - } - - /** - * Immutable inner class representing the configuration of a single dialog. - * - * @author gavinc - */ - public static class DialogConfig implements Serializable - { - private static final long serialVersionUID = -3163053165721862390L; - - protected DialogAttributes attributes; - - public DialogConfig(DialogAttributes attrs) - { - // check the attributes object has been supplied - ParameterCheck.mandatory("attrs", attrs); - - this.attributes = attrs; - } - - public String getName() - { - return this.attributes.getName(); - } - - public String getPage() - { - return this.attributes.getPage(); - } - - public String getManagedBean() - { - return this.attributes.getManagedBean(); - } - - public String getTitle() - { - return this.attributes.getTitle(); - } - - public String getTitleId() - { - return this.attributes.getTitleId(); - } - - public String getSubTitle() - { - return this.attributes.getSubTitle(); - } - - public String getSubTitleId() - { - return this.attributes.getSubTitleId(); - } - - public String getDescription() - { - return this.attributes.getDescription(); - } - - public String getDescriptionId() - { - return this.attributes.getDescriptionId(); - } - - public String getIcon() - { - return this.attributes.getIcon(); - } - - public String getErrorMessageId() - { - return this.attributes.getErrorMessageId(); - } - - public boolean isOKButtonVisible() - { - return this.attributes.isOKButtonVisible(); - } - - public List getButtons() - { - return this.attributes.getButtons(); - } - - public String getActionsConfigId() - { - return this.attributes.getActionsConfigId(); - } - - public boolean getActionsAsMenu() - { - return this.attributes.getActionsAsMenu(); - } - - public String getActionsMenuLabel() - { - return this.attributes.getActionsMenuLabel(); - } - - public String getActionsMenuLabelId() - { - return this.attributes.getActionsMenuLabelId(); - } - - public String getMoreActionsConfigId() - { - return this.attributes.getMoreActionsConfigId(); - } - - public String getMoreActionsMenuLabel() - { - return this.attributes.getMoreActionsMenuLabel(); - } - - public String getMoreActionsMenuLabelId() - { - return this.attributes.getMoreActionsMenuLabelId(); - } - - /** - * @see java.lang.Object#toString() - */ - @Override - public String toString() - { - StringBuilder buffer = new StringBuilder(super.toString()); - buffer.append(" (").append(this.attributes.toString()).append(")"); - return buffer.toString(); - } - } - - /** - * Immutable inner class representing the configuration for an additional - * dialog button. - * - * @author gavinc - */ - public static class DialogButtonConfig implements Serializable - { - private static final long serialVersionUID = -6897300549206163138L; - - private String id; - private String label; - private String labelId; - private String action; - private String disabled; - private String onclick; - - public DialogButtonConfig(String id, String label, String labelId, - String action, String disabled, String onclick) - { - this.id = id; - this.label = label; - this.labelId = labelId; - this.action = action; - this.disabled = disabled; - this.onclick = onclick; - - if ((this.label == null || this.label.length() == 0) && - (this.labelId == null || this.labelId.length() == 0)) - { - throw new ConfigException("A dialog button needs to have a label or a label-id"); - } - - if (this.action == null || this.action.length() == 0) - { - throw new ConfigException("A dialog button requires an action"); - } - else if (this.action.startsWith("#{") == false) - { - throw new ConfigException("The action for a dialog button must be a method binding expression, '" - + this.action + "' is not!"); - } - } - - public String getAction() - { - return action; - } - - public String getDisabled() - { - return disabled; - } - - public String getId() - { - return id; - } - - public String getLabel() - { - return label; - } - - public String getLabelId() - { - return labelId; - } - - public String getOnclick() - { - return onclick; - } - - /** - * @see java.lang.Object#toString() - */ - @Override - public String toString() - { - StringBuilder buffer = new StringBuilder(super.toString()); - buffer.append(" (id=").append(this.id); - buffer.append(" label=").append(this.label); - buffer.append(" label-id=").append(this.labelId); - buffer.append(" action=").append(this.action); - buffer.append(" disabled=").append(this.disabled); - buffer.append(" onclick=").append(this.onclick).append(")"); - return buffer.toString(); - } - } - - /** - * Object holding all the dialog attributes collected from config. - * - * @author gavinc - */ - public static class DialogAttributes implements Serializable - { - private static final long serialVersionUID = -6897300549207773138L; - - protected String name; - protected String page; - protected String managedBean; - protected String icon; - protected String title; - protected String titleId; - protected String subTitle; - protected String subTitleId; - protected String description; - protected String descriptionId; - protected String errorMsgId = "error_dialog"; - protected boolean isOKButtonVisible = true; - protected List buttons; - protected String actionsConfigId; - protected boolean actionsAsMenu = false; - protected String actionsMenuLabel; - protected String actionsMenuLabelId; - protected String moreActionsConfigId; - protected String moreActionsMenuLabel; - protected String moreActionsMenuLabelId; - - // ---------------------------------------------------- - // Construction - - public DialogAttributes(String name, String page, String bean) - { - // check the mandatory parameters are present - ParameterCheck.mandatoryString("name", name); - ParameterCheck.mandatoryString("page", page); - ParameterCheck.mandatoryString("managedBean", bean); - - this.name = name; - this.page = page; - this.managedBean = bean; - } - - // ---------------------------------------------------- - // Setters - - public void setIcon(String icon) - { - this.icon = icon; - } - - public void setTitle(String title) - { - this.title = title; - } - - public void setTitleId(String titleId) - { - this.titleId = titleId; - } - - public void setSubTitle(String subTitle) - { - this.subTitle = subTitle; - } - - public void setSubTitleId(String subTitleId) - { - this.subTitleId = subTitleId; - } - - public void setDescription(String description) - { - this.description = description; - } - - public void setDescriptionId(String descriptionId) - { - this.descriptionId = descriptionId; - } - - public void setErrorMessageId(String errorMsgId) - { - if (errorMsgId != null && errorMsgId.length() > 0) - { - this.errorMsgId = errorMsgId; - } - } - - public void setOKButtonVisible(boolean isOKButtonVisible) - { - this.isOKButtonVisible = isOKButtonVisible; - } - - public void setButtons(List buttons) - { - this.buttons = buttons; - } - - public void setActionsConfigId(String actionsConfigId) - { - this.actionsConfigId = actionsConfigId; - } - - public void setActionsAsMenu(boolean actionsAsMenu) - { - this.actionsAsMenu = actionsAsMenu; - } - - public void setActionsMenuLabel(String actionsMenuLabel) - { - this.actionsMenuLabel = actionsMenuLabel; - } - - public void setActionsMenuLabelId(String actionsMenuLabelId) - { - this.actionsMenuLabelId = actionsMenuLabelId; - } - - public void setMoreActionsConfigId(String moreActionsConfigId) - { - this.moreActionsConfigId = moreActionsConfigId; - } - - public void setMoreActionsMenuLabel(String moreActionsMenuLabel) - { - this.moreActionsMenuLabel = moreActionsMenuLabel; - } - - public void setMoreActionsMenuLabelId(String moreActionsMenuLabelId) - { - this.moreActionsMenuLabelId = moreActionsMenuLabelId; - } - - // ---------------------------------------------------- - // Getters - - public String getName() - { - return this.name; - } - - public String getPage() - { - return this.page; - } - - public String getManagedBean() - { - return this.managedBean; - } - - public String getDescription() - { - return this.description; - } - - public String getDescriptionId() - { - return this.descriptionId; - } - - public String getIcon() - { - return this.icon; - } - - public String getTitle() - { - return this.title; - } - - public String getTitleId() - { - return this.titleId; - } - - public String getSubTitle() - { - return this.subTitle; - } - - public String getSubTitleId() - { - return this.subTitleId; - } - - public String getErrorMessageId() - { - return this.errorMsgId; - } - - public boolean isOKButtonVisible() - { - return this.isOKButtonVisible; - } - - public List getButtons() - { - return this.buttons; - } - - public String getActionsConfigId() - { - return this.actionsConfigId; - } - - public boolean getActionsAsMenu() - { - return this.actionsAsMenu; - } - - public String getActionsMenuLabel() - { - return this.actionsMenuLabel; - } - - public String getActionsMenuLabelId() - { - return this.actionsMenuLabelId; - } - - public String getMoreActionsConfigId() - { - return this.moreActionsConfigId; - } - - public String getMoreActionsMenuLabel() - { - return this.moreActionsMenuLabel; - } - - public String getMoreActionsMenuLabelId() - { - return this.moreActionsMenuLabelId; - } - - /** - * @see java.lang.Object#toString() - */ - @Override - public String toString() - { - StringBuilder buffer = new StringBuilder(); - buffer.append("name=").append(this.name); - buffer.append(" page=").append(this.page); - buffer.append(" managedBean=").append(this.managedBean); - buffer.append(" icon=").append(this.icon); - buffer.append(" title=").append(this.title); - buffer.append(" titleId=").append(this.titleId); - buffer.append(" subTitle=").append(this.subTitle); - buffer.append(" subTitleId=").append(this.subTitleId); - buffer.append(" description=").append(this.description); - buffer.append(" descriptionId=").append(this.descriptionId); - buffer.append(" errorMsgId=").append(this.errorMsgId); - buffer.append(" isOKButtonVisible=").append(this.isOKButtonVisible); - buffer.append(" actionsConfigId=").append(this.actionsConfigId); - buffer.append(" actionsAsMenu=").append(this.actionsAsMenu); - buffer.append(" actionsMenuLabel=").append(this.actionsMenuLabel); - buffer.append(" actionsMenuLabelId=").append(this.actionsMenuLabelId); - buffer.append(" moreActionsConfigId=").append(this.moreActionsConfigId); - buffer.append(" moreActionsMenuLabel=").append(this.moreActionsMenuLabel); - buffer.append(" moreActionsMenuLabelId=").append(this.moreActionsMenuLabelId); - buffer.append(" buttons=").append(this.buttons); - return buffer.toString(); - } - } -} +package org.alfresco.web.config; + +import java.io.Serializable; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; +import org.springframework.extensions.surf.util.ParameterCheck; + +/** + * Custom config element that represents the config data for a property sheet + * + * @author gavinc + */ +public class DialogsConfigElement extends ConfigElementAdapter +{ + private static final long serialVersionUID = 8265738244249506534L; + + public static final String CONFIG_ELEMENT_ID = "dialogs"; + + private Map dialogs = new LinkedHashMap(8, 10f); + + /** + * Default constructor + */ + public DialogsConfigElement() + { + super(CONFIG_ELEMENT_ID); + } + + /** + * Constructor + * + * @param name Name of the element this config element represents + */ + public DialogsConfigElement(String name) + { + super(name); + } + + /** + * @see ConfigElement#getChildren() + */ + public List getChildren() + { + throw new ConfigException("Reading the dialogs config via the generic interfaces is not supported"); + } + + /** + * @see ConfigElement#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + DialogsConfigElement combined = new DialogsConfigElement(); + + // add all the dialogs from this element + for (DialogConfig dialog : this.getDialogs().values()) + { + combined.addDialog(dialog); + } + + // add all the dialogs from the given element + for (DialogConfig dialog : ((DialogsConfigElement)configElement).getDialogs().values()) + { + combined.addDialog(dialog); + } + + return combined; + } + + /** + * Returns the named dialog + * + * @param name The name of the dialog to retrieve + * @return The DialogConfig object for the requested dialog or null if it doesn't exist + */ + public DialogConfig getDialog(String name) + { + return this.dialogs.get(name); + } + + /** + * @return Returns a map of the dialogs. A linked hash map is used internally to + * preserve ordering. + */ + public Map getDialogs() + { + return this.dialogs; + } + + /** + * Adds a dialog + * + * @param dialogConfig A pre-configured dialog config object + */ + /*package*/ void addDialog(DialogConfig dialogConfig) + { + this.dialogs.put(dialogConfig.getName(), dialogConfig); + } + + /** + * Immutable inner class representing the configuration of a single dialog. + * + * @author gavinc + */ + public static class DialogConfig implements Serializable + { + private static final long serialVersionUID = -3163053165721862390L; + + protected DialogAttributes attributes; + + public DialogConfig(DialogAttributes attrs) + { + // check the attributes object has been supplied + ParameterCheck.mandatory("attrs", attrs); + + this.attributes = attrs; + } + + public String getName() + { + return this.attributes.getName(); + } + + public String getPage() + { + return this.attributes.getPage(); + } + + public String getManagedBean() + { + return this.attributes.getManagedBean(); + } + + public String getTitle() + { + return this.attributes.getTitle(); + } + + public String getTitleId() + { + return this.attributes.getTitleId(); + } + + public String getSubTitle() + { + return this.attributes.getSubTitle(); + } + + public String getSubTitleId() + { + return this.attributes.getSubTitleId(); + } + + public String getDescription() + { + return this.attributes.getDescription(); + } + + public String getDescriptionId() + { + return this.attributes.getDescriptionId(); + } + + public String getIcon() + { + return this.attributes.getIcon(); + } + + public String getErrorMessageId() + { + return this.attributes.getErrorMessageId(); + } + + public boolean isOKButtonVisible() + { + return this.attributes.isOKButtonVisible(); + } + + public List getButtons() + { + return this.attributes.getButtons(); + } + + public String getActionsConfigId() + { + return this.attributes.getActionsConfigId(); + } + + public boolean getActionsAsMenu() + { + return this.attributes.getActionsAsMenu(); + } + + public String getActionsMenuLabel() + { + return this.attributes.getActionsMenuLabel(); + } + + public String getActionsMenuLabelId() + { + return this.attributes.getActionsMenuLabelId(); + } + + public String getMoreActionsConfigId() + { + return this.attributes.getMoreActionsConfigId(); + } + + public String getMoreActionsMenuLabel() + { + return this.attributes.getMoreActionsMenuLabel(); + } + + public String getMoreActionsMenuLabelId() + { + return this.attributes.getMoreActionsMenuLabelId(); + } + + /** + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + StringBuilder buffer = new StringBuilder(super.toString()); + buffer.append(" (").append(this.attributes.toString()).append(")"); + return buffer.toString(); + } + } + + /** + * Immutable inner class representing the configuration for an additional + * dialog button. + * + * @author gavinc + */ + public static class DialogButtonConfig implements Serializable + { + private static final long serialVersionUID = -6897300549206163138L; + + private String id; + private String label; + private String labelId; + private String action; + private String disabled; + private String onclick; + + public DialogButtonConfig(String id, String label, String labelId, + String action, String disabled, String onclick) + { + this.id = id; + this.label = label; + this.labelId = labelId; + this.action = action; + this.disabled = disabled; + this.onclick = onclick; + + if ((this.label == null || this.label.length() == 0) && + (this.labelId == null || this.labelId.length() == 0)) + { + throw new ConfigException("A dialog button needs to have a label or a label-id"); + } + + if (this.action == null || this.action.length() == 0) + { + throw new ConfigException("A dialog button requires an action"); + } + else if (this.action.startsWith("#{") == false) + { + throw new ConfigException("The action for a dialog button must be a method binding expression, '" + + this.action + "' is not!"); + } + } + + public String getAction() + { + return action; + } + + public String getDisabled() + { + return disabled; + } + + public String getId() + { + return id; + } + + public String getLabel() + { + return label; + } + + public String getLabelId() + { + return labelId; + } + + public String getOnclick() + { + return onclick; + } + + /** + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + StringBuilder buffer = new StringBuilder(super.toString()); + buffer.append(" (id=").append(this.id); + buffer.append(" label=").append(this.label); + buffer.append(" label-id=").append(this.labelId); + buffer.append(" action=").append(this.action); + buffer.append(" disabled=").append(this.disabled); + buffer.append(" onclick=").append(this.onclick).append(")"); + return buffer.toString(); + } + } + + /** + * Object holding all the dialog attributes collected from config. + * + * @author gavinc + */ + public static class DialogAttributes implements Serializable + { + private static final long serialVersionUID = -6897300549207773138L; + + protected String name; + protected String page; + protected String managedBean; + protected String icon; + protected String title; + protected String titleId; + protected String subTitle; + protected String subTitleId; + protected String description; + protected String descriptionId; + protected String errorMsgId = "error_dialog"; + protected boolean isOKButtonVisible = true; + protected List buttons; + protected String actionsConfigId; + protected boolean actionsAsMenu = false; + protected String actionsMenuLabel; + protected String actionsMenuLabelId; + protected String moreActionsConfigId; + protected String moreActionsMenuLabel; + protected String moreActionsMenuLabelId; + + // ---------------------------------------------------- + // Construction + + public DialogAttributes(String name, String page, String bean) + { + // check the mandatory parameters are present + ParameterCheck.mandatoryString("name", name); + ParameterCheck.mandatoryString("page", page); + ParameterCheck.mandatoryString("managedBean", bean); + + this.name = name; + this.page = page; + this.managedBean = bean; + } + + // ---------------------------------------------------- + // Setters + + public void setIcon(String icon) + { + this.icon = icon; + } + + public void setTitle(String title) + { + this.title = title; + } + + public void setTitleId(String titleId) + { + this.titleId = titleId; + } + + public void setSubTitle(String subTitle) + { + this.subTitle = subTitle; + } + + public void setSubTitleId(String subTitleId) + { + this.subTitleId = subTitleId; + } + + public void setDescription(String description) + { + this.description = description; + } + + public void setDescriptionId(String descriptionId) + { + this.descriptionId = descriptionId; + } + + public void setErrorMessageId(String errorMsgId) + { + if (errorMsgId != null && errorMsgId.length() > 0) + { + this.errorMsgId = errorMsgId; + } + } + + public void setOKButtonVisible(boolean isOKButtonVisible) + { + this.isOKButtonVisible = isOKButtonVisible; + } + + public void setButtons(List buttons) + { + this.buttons = buttons; + } + + public void setActionsConfigId(String actionsConfigId) + { + this.actionsConfigId = actionsConfigId; + } + + public void setActionsAsMenu(boolean actionsAsMenu) + { + this.actionsAsMenu = actionsAsMenu; + } + + public void setActionsMenuLabel(String actionsMenuLabel) + { + this.actionsMenuLabel = actionsMenuLabel; + } + + public void setActionsMenuLabelId(String actionsMenuLabelId) + { + this.actionsMenuLabelId = actionsMenuLabelId; + } + + public void setMoreActionsConfigId(String moreActionsConfigId) + { + this.moreActionsConfigId = moreActionsConfigId; + } + + public void setMoreActionsMenuLabel(String moreActionsMenuLabel) + { + this.moreActionsMenuLabel = moreActionsMenuLabel; + } + + public void setMoreActionsMenuLabelId(String moreActionsMenuLabelId) + { + this.moreActionsMenuLabelId = moreActionsMenuLabelId; + } + + // ---------------------------------------------------- + // Getters + + public String getName() + { + return this.name; + } + + public String getPage() + { + return this.page; + } + + public String getManagedBean() + { + return this.managedBean; + } + + public String getDescription() + { + return this.description; + } + + public String getDescriptionId() + { + return this.descriptionId; + } + + public String getIcon() + { + return this.icon; + } + + public String getTitle() + { + return this.title; + } + + public String getTitleId() + { + return this.titleId; + } + + public String getSubTitle() + { + return this.subTitle; + } + + public String getSubTitleId() + { + return this.subTitleId; + } + + public String getErrorMessageId() + { + return this.errorMsgId; + } + + public boolean isOKButtonVisible() + { + return this.isOKButtonVisible; + } + + public List getButtons() + { + return this.buttons; + } + + public String getActionsConfigId() + { + return this.actionsConfigId; + } + + public boolean getActionsAsMenu() + { + return this.actionsAsMenu; + } + + public String getActionsMenuLabel() + { + return this.actionsMenuLabel; + } + + public String getActionsMenuLabelId() + { + return this.actionsMenuLabelId; + } + + public String getMoreActionsConfigId() + { + return this.moreActionsConfigId; + } + + public String getMoreActionsMenuLabel() + { + return this.moreActionsMenuLabel; + } + + public String getMoreActionsMenuLabelId() + { + return this.moreActionsMenuLabelId; + } + + /** + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + StringBuilder buffer = new StringBuilder(); + buffer.append("name=").append(this.name); + buffer.append(" page=").append(this.page); + buffer.append(" managedBean=").append(this.managedBean); + buffer.append(" icon=").append(this.icon); + buffer.append(" title=").append(this.title); + buffer.append(" titleId=").append(this.titleId); + buffer.append(" subTitle=").append(this.subTitle); + buffer.append(" subTitleId=").append(this.subTitleId); + buffer.append(" description=").append(this.description); + buffer.append(" descriptionId=").append(this.descriptionId); + buffer.append(" errorMsgId=").append(this.errorMsgId); + buffer.append(" isOKButtonVisible=").append(this.isOKButtonVisible); + buffer.append(" actionsConfigId=").append(this.actionsConfigId); + buffer.append(" actionsAsMenu=").append(this.actionsAsMenu); + buffer.append(" actionsMenuLabel=").append(this.actionsMenuLabel); + buffer.append(" actionsMenuLabelId=").append(this.actionsMenuLabelId); + buffer.append(" moreActionsConfigId=").append(this.moreActionsConfigId); + buffer.append(" moreActionsMenuLabel=").append(this.moreActionsMenuLabel); + buffer.append(" moreActionsMenuLabelId=").append(this.moreActionsMenuLabelId); + buffer.append(" buttons=").append(this.buttons); + return buffer.toString(); + } + } +} diff --git a/source/java/org/alfresco/web/config/DialogsElementReader.java b/source/java/org/alfresco/web/config/DialogsElementReader.java index d1e8581f07..9e584897cd 100644 --- a/source/java/org/alfresco/web/config/DialogsElementReader.java +++ b/source/java/org/alfresco/web/config/DialogsElementReader.java @@ -1,186 +1,186 @@ -package org.alfresco.web.config; - -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; -import org.dom4j.Element; - -/** - * Custom element reader to parse config for dialogs - * - * @author gavinc - */ -public class DialogsElementReader implements ConfigElementReader -{ - public static final String ELEMENT_DIALOGS = "dialogs"; - public static final String ELEMENT_DIALOG = "dialog"; - public static final String ELEMENT_BUTTONS = "buttons"; - public static final String ELEMENT_BUTTON = "button"; - public static final String ATTR_NAME = "name"; - public static final String ATTR_PAGE = "page"; - public static final String ATTR_MANAGED_BEAN = "managed-bean"; - public static final String ATTR_ICON = "icon"; - public static final String ATTR_TITLE = "title"; - public static final String ATTR_TITLE_ID = "title-id"; - public static final String ATTR_SUBTITLE = "subtitle"; - public static final String ATTR_SUBTITLE_ID = "subtitle-id"; - public static final String ATTR_DESCRIPTION = "description"; - public static final String ATTR_DESCRIPTION_ID = "description-id"; - public static final String ATTR_ERROR_MSG_ID = "error-message-id"; - public static final String ATTR_SHOW_OK_BUTTON = "show-ok-button"; - - // action related attributes - public static final String ATTR_ACTIONS_CONFIG_ID = "actions-config-id"; - public static final String ATTR_ACTIONS_AS_MENU = "actions-as-menu"; - public static final String ATTR_ACTIONS_MENU_LABEL = "actions-menu-label"; - public static final String ATTR_ACTIONS_MENU_LABEL_ID = "actions-menu-label-id"; - public static final String ATTR_MORE_ACTIONS_CONFIG_ID = "more-actions-config-id"; - public static final String ATTR_MORE_ACTIONS_MENU_LABEL = "more-actions-menu-label"; - public static final String ATTR_MORE_ACTIONS_MENU_LABEL_ID = "more-actions-menu-label-id"; - - // button related attributes - public static final String ATTR_ID = "id"; - public static final String ATTR_LABEL = "label"; - public static final String ATTR_LABEL_ID = "label-id"; - public static final String ATTR_ACTION = "action"; - public static final String ATTR_DISABLED = "disabled"; - public static final String ATTR_ONCLICK = "onclick"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - @SuppressWarnings("unchecked") - public ConfigElement parse(Element element) - { - DialogsConfigElement configElement = null; - - if (element != null) - { - String elementName = element.getName(); - if (elementName.equals(ELEMENT_DIALOGS) == false) - { - throw new ConfigException("DialogsElementReader can only parse " + - ELEMENT_DIALOGS + "elements, the element passed was '" + - elementName + "'"); - } - - configElement = new DialogsConfigElement(); - - // go through the dialogs - Iterator items = element.elementIterator(ELEMENT_DIALOG); - while (items.hasNext()) - { - Element item = items.next(); - - String name = item.attributeValue(ATTR_NAME); - String page = item.attributeValue(ATTR_PAGE); - String bean = item.attributeValue(ATTR_MANAGED_BEAN); - String icon = item.attributeValue(ATTR_ICON); - String title = item.attributeValue(ATTR_TITLE); - String titleId = item.attributeValue(ATTR_TITLE_ID); - String subTitle = item.attributeValue(ATTR_SUBTITLE); - String subTitleId = item.attributeValue(ATTR_SUBTITLE_ID); - String description = item.attributeValue(ATTR_DESCRIPTION); - String descriptionId = item.attributeValue(ATTR_DESCRIPTION_ID); - String errorMsgId = item.attributeValue(ATTR_ERROR_MSG_ID); - String showOK = item.attributeValue(ATTR_SHOW_OK_BUTTON); - - boolean isOKButtonVisible = true; - if (showOK != null) - { - isOKButtonVisible = Boolean.parseBoolean(showOK); - } - - // action related config - String actionsConfigId = item.attributeValue(ATTR_ACTIONS_CONFIG_ID); - boolean useMenuForActions = false; - String asMenu = item.attributeValue(ATTR_ACTIONS_AS_MENU); - if (asMenu != null) - { - useMenuForActions = Boolean.parseBoolean(asMenu); - } - String actionsMenuLabel = item.attributeValue(ATTR_ACTIONS_MENU_LABEL); - String actionsMenuLabelId = item.attributeValue(ATTR_ACTIONS_MENU_LABEL_ID); - String moreActionsConfigId = item.attributeValue(ATTR_MORE_ACTIONS_CONFIG_ID); - String moreActionsMenuLabel = item.attributeValue(ATTR_MORE_ACTIONS_MENU_LABEL); - String moreActionsMenuLabelId = item.attributeValue(ATTR_MORE_ACTIONS_MENU_LABEL_ID); - - // parse any buttons that may be present - List buttons = parseButtons(item); - - // setup the attrbiutes object - DialogsConfigElement.DialogAttributes attrs = - new DialogsConfigElement.DialogAttributes(name, page, bean); - attrs.setIcon(icon); - attrs.setTitle(title); - attrs.setTitleId(titleId); - attrs.setSubTitle(subTitle); - attrs.setSubTitleId(subTitleId); - attrs.setDescription(description); - attrs.setDescriptionId(descriptionId); - attrs.setErrorMessageId(errorMsgId); - attrs.setOKButtonVisible(isOKButtonVisible); - attrs.setButtons(buttons); - attrs.setActionsConfigId(actionsConfigId); - attrs.setActionsAsMenu(useMenuForActions); - attrs.setActionsMenuLabel(actionsMenuLabel); - attrs.setActionsMenuLabelId(actionsMenuLabelId); - attrs.setMoreActionsConfigId(moreActionsConfigId); - attrs.setMoreActionsMenuLabel(moreActionsMenuLabel); - attrs.setMoreActionsMenuLabelId(moreActionsMenuLabelId); - - // create and add the dialog config object - DialogsConfigElement.DialogConfig cfg = new DialogsConfigElement.DialogConfig(attrs); - configElement.addDialog(cfg); - } - } - - return configElement; - } - - /** - * Retrieve the configuration for additional buttons. - * - * @param dialog The dialog XML element - * @return List of configured buttons - */ - @SuppressWarnings("unchecked") - protected List parseButtons(Element dialog) - { - List buttons = null; - - // iterate over any configured buttons - Element buttonsConfig = dialog.element(ELEMENT_BUTTONS); - if (buttonsConfig != null) - { - buttons = new ArrayList(4); - - Iterator children = buttonsConfig.elementIterator(ELEMENT_BUTTON); - while (children.hasNext()) - { - Element button = children.next(); - - String id = button.attributeValue(ATTR_ID); - String label = button.attributeValue(ATTR_LABEL); - String labelId = button.attributeValue(ATTR_LABEL_ID); - String action = button.attributeValue(ATTR_ACTION); - String disabled = button.attributeValue(ATTR_DISABLED); - String onclick = button.attributeValue(ATTR_ONCLICK); - - // create the button config object - DialogButtonConfig btnCfg = new DialogButtonConfig(id, label, - labelId, action, disabled, onclick); - - // add the button to the list - buttons.add(btnCfg); - } - } - - return buttons; - } -} +package org.alfresco.web.config; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; +import org.dom4j.Element; + +/** + * Custom element reader to parse config for dialogs + * + * @author gavinc + */ +public class DialogsElementReader implements ConfigElementReader +{ + public static final String ELEMENT_DIALOGS = "dialogs"; + public static final String ELEMENT_DIALOG = "dialog"; + public static final String ELEMENT_BUTTONS = "buttons"; + public static final String ELEMENT_BUTTON = "button"; + public static final String ATTR_NAME = "name"; + public static final String ATTR_PAGE = "page"; + public static final String ATTR_MANAGED_BEAN = "managed-bean"; + public static final String ATTR_ICON = "icon"; + public static final String ATTR_TITLE = "title"; + public static final String ATTR_TITLE_ID = "title-id"; + public static final String ATTR_SUBTITLE = "subtitle"; + public static final String ATTR_SUBTITLE_ID = "subtitle-id"; + public static final String ATTR_DESCRIPTION = "description"; + public static final String ATTR_DESCRIPTION_ID = "description-id"; + public static final String ATTR_ERROR_MSG_ID = "error-message-id"; + public static final String ATTR_SHOW_OK_BUTTON = "show-ok-button"; + + // action related attributes + public static final String ATTR_ACTIONS_CONFIG_ID = "actions-config-id"; + public static final String ATTR_ACTIONS_AS_MENU = "actions-as-menu"; + public static final String ATTR_ACTIONS_MENU_LABEL = "actions-menu-label"; + public static final String ATTR_ACTIONS_MENU_LABEL_ID = "actions-menu-label-id"; + public static final String ATTR_MORE_ACTIONS_CONFIG_ID = "more-actions-config-id"; + public static final String ATTR_MORE_ACTIONS_MENU_LABEL = "more-actions-menu-label"; + public static final String ATTR_MORE_ACTIONS_MENU_LABEL_ID = "more-actions-menu-label-id"; + + // button related attributes + public static final String ATTR_ID = "id"; + public static final String ATTR_LABEL = "label"; + public static final String ATTR_LABEL_ID = "label-id"; + public static final String ATTR_ACTION = "action"; + public static final String ATTR_DISABLED = "disabled"; + public static final String ATTR_ONCLICK = "onclick"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + @SuppressWarnings("unchecked") + public ConfigElement parse(Element element) + { + DialogsConfigElement configElement = null; + + if (element != null) + { + String elementName = element.getName(); + if (elementName.equals(ELEMENT_DIALOGS) == false) + { + throw new ConfigException("DialogsElementReader can only parse " + + ELEMENT_DIALOGS + "elements, the element passed was '" + + elementName + "'"); + } + + configElement = new DialogsConfigElement(); + + // go through the dialogs + Iterator items = element.elementIterator(ELEMENT_DIALOG); + while (items.hasNext()) + { + Element item = items.next(); + + String name = item.attributeValue(ATTR_NAME); + String page = item.attributeValue(ATTR_PAGE); + String bean = item.attributeValue(ATTR_MANAGED_BEAN); + String icon = item.attributeValue(ATTR_ICON); + String title = item.attributeValue(ATTR_TITLE); + String titleId = item.attributeValue(ATTR_TITLE_ID); + String subTitle = item.attributeValue(ATTR_SUBTITLE); + String subTitleId = item.attributeValue(ATTR_SUBTITLE_ID); + String description = item.attributeValue(ATTR_DESCRIPTION); + String descriptionId = item.attributeValue(ATTR_DESCRIPTION_ID); + String errorMsgId = item.attributeValue(ATTR_ERROR_MSG_ID); + String showOK = item.attributeValue(ATTR_SHOW_OK_BUTTON); + + boolean isOKButtonVisible = true; + if (showOK != null) + { + isOKButtonVisible = Boolean.parseBoolean(showOK); + } + + // action related config + String actionsConfigId = item.attributeValue(ATTR_ACTIONS_CONFIG_ID); + boolean useMenuForActions = false; + String asMenu = item.attributeValue(ATTR_ACTIONS_AS_MENU); + if (asMenu != null) + { + useMenuForActions = Boolean.parseBoolean(asMenu); + } + String actionsMenuLabel = item.attributeValue(ATTR_ACTIONS_MENU_LABEL); + String actionsMenuLabelId = item.attributeValue(ATTR_ACTIONS_MENU_LABEL_ID); + String moreActionsConfigId = item.attributeValue(ATTR_MORE_ACTIONS_CONFIG_ID); + String moreActionsMenuLabel = item.attributeValue(ATTR_MORE_ACTIONS_MENU_LABEL); + String moreActionsMenuLabelId = item.attributeValue(ATTR_MORE_ACTIONS_MENU_LABEL_ID); + + // parse any buttons that may be present + List buttons = parseButtons(item); + + // setup the attrbiutes object + DialogsConfigElement.DialogAttributes attrs = + new DialogsConfigElement.DialogAttributes(name, page, bean); + attrs.setIcon(icon); + attrs.setTitle(title); + attrs.setTitleId(titleId); + attrs.setSubTitle(subTitle); + attrs.setSubTitleId(subTitleId); + attrs.setDescription(description); + attrs.setDescriptionId(descriptionId); + attrs.setErrorMessageId(errorMsgId); + attrs.setOKButtonVisible(isOKButtonVisible); + attrs.setButtons(buttons); + attrs.setActionsConfigId(actionsConfigId); + attrs.setActionsAsMenu(useMenuForActions); + attrs.setActionsMenuLabel(actionsMenuLabel); + attrs.setActionsMenuLabelId(actionsMenuLabelId); + attrs.setMoreActionsConfigId(moreActionsConfigId); + attrs.setMoreActionsMenuLabel(moreActionsMenuLabel); + attrs.setMoreActionsMenuLabelId(moreActionsMenuLabelId); + + // create and add the dialog config object + DialogsConfigElement.DialogConfig cfg = new DialogsConfigElement.DialogConfig(attrs); + configElement.addDialog(cfg); + } + } + + return configElement; + } + + /** + * Retrieve the configuration for additional buttons. + * + * @param dialog The dialog XML element + * @return List of configured buttons + */ + @SuppressWarnings("unchecked") + protected List parseButtons(Element dialog) + { + List buttons = null; + + // iterate over any configured buttons + Element buttonsConfig = dialog.element(ELEMENT_BUTTONS); + if (buttonsConfig != null) + { + buttons = new ArrayList(4); + + Iterator children = buttonsConfig.elementIterator(ELEMENT_BUTTON); + while (children.hasNext()) + { + Element button = children.next(); + + String id = button.attributeValue(ATTR_ID); + String label = button.attributeValue(ATTR_LABEL); + String labelId = button.attributeValue(ATTR_LABEL_ID); + String action = button.attributeValue(ATTR_ACTION); + String disabled = button.attributeValue(ATTR_DISABLED); + String onclick = button.attributeValue(ATTR_ONCLICK); + + // create the button config object + DialogButtonConfig btnCfg = new DialogButtonConfig(id, label, + labelId, action, disabled, onclick); + + // add the button to the list + buttons.add(btnCfg); + } + } + + return buttons; + } +} diff --git a/source/java/org/alfresco/web/config/LanguagesConfigElement.java b/source/java/org/alfresco/web/config/LanguagesConfigElement.java index 237c9fda7e..0e5dc85ce3 100644 --- a/source/java/org/alfresco/web/config/LanguagesConfigElement.java +++ b/source/java/org/alfresco/web/config/LanguagesConfigElement.java @@ -1,109 +1,109 @@ -package org.alfresco.web.config; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; - -/** - * Custom config element that represents config values for languages - * - * @author Gavin Cornwell - */ -public class LanguagesConfigElement extends ConfigElementAdapter -{ - public static final String CONFIG_ELEMENT_ID = "languages"; - - private Map localeMap = new HashMap(); - private List languages = new ArrayList(8); - - /** - * Default Constructor - */ - public LanguagesConfigElement() - { - super(CONFIG_ELEMENT_ID); - } - - /** - * Constructor - * - * @param name Name of the element this config element represents - */ - public LanguagesConfigElement(String name) - { - super(name); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() - */ - @Override - public List getChildren() - { - throw new ConfigException("Reading the languages config via the generic interfaces is not supported"); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - LanguagesConfigElement newElement = (LanguagesConfigElement)configElement; - LanguagesConfigElement combinedElement = new LanguagesConfigElement(); - - // add the languages from this config element - for (String locale : this.languages) - { - combinedElement.addLanguage(locale, this.localeMap.get(locale)); - } - - // now add the languages from the one to be combined (but - // only if they are not already in the list) - List languages = newElement.getLanguages(); - for (String locale : languages) - { - if (combinedElement.getLabelForLanguage(locale) == null) - { - String label = newElement.getLabelForLanguage(locale); - combinedElement.addLanguage(locale, label); - } - } - - return combinedElement; - } - - /** - * Add a language locale and display label to the list. - * - * @param locale Locale code - * @param label Display label - */ - /*package*/ void addLanguage(String locale, String label) - { - this.localeMap.put(locale, label); - this.languages.add(locale); - } - - /** - * @return List of supported language locale strings in config file order - */ - public List getLanguages() - { - return this.languages; - } - - /** - * @param locale The locale string to lookup language label for - * - * @return the language label for specified locale string, or null if not found - */ - public String getLabelForLanguage(String locale) - { - return this.localeMap.get(locale); - } -} +package org.alfresco.web.config; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; + +/** + * Custom config element that represents config values for languages + * + * @author Gavin Cornwell + */ +public class LanguagesConfigElement extends ConfigElementAdapter +{ + public static final String CONFIG_ELEMENT_ID = "languages"; + + private Map localeMap = new HashMap(); + private List languages = new ArrayList(8); + + /** + * Default Constructor + */ + public LanguagesConfigElement() + { + super(CONFIG_ELEMENT_ID); + } + + /** + * Constructor + * + * @param name Name of the element this config element represents + */ + public LanguagesConfigElement(String name) + { + super(name); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() + */ + @Override + public List getChildren() + { + throw new ConfigException("Reading the languages config via the generic interfaces is not supported"); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + LanguagesConfigElement newElement = (LanguagesConfigElement)configElement; + LanguagesConfigElement combinedElement = new LanguagesConfigElement(); + + // add the languages from this config element + for (String locale : this.languages) + { + combinedElement.addLanguage(locale, this.localeMap.get(locale)); + } + + // now add the languages from the one to be combined (but + // only if they are not already in the list) + List languages = newElement.getLanguages(); + for (String locale : languages) + { + if (combinedElement.getLabelForLanguage(locale) == null) + { + String label = newElement.getLabelForLanguage(locale); + combinedElement.addLanguage(locale, label); + } + } + + return combinedElement; + } + + /** + * Add a language locale and display label to the list. + * + * @param locale Locale code + * @param label Display label + */ + /*package*/ void addLanguage(String locale, String label) + { + this.localeMap.put(locale, label); + this.languages.add(locale); + } + + /** + * @return List of supported language locale strings in config file order + */ + public List getLanguages() + { + return this.languages; + } + + /** + * @param locale The locale string to lookup language label for + * + * @return the language label for specified locale string, or null if not found + */ + public String getLabelForLanguage(String locale) + { + return this.localeMap.get(locale); + } +} diff --git a/source/java/org/alfresco/web/config/LanguagesElementReader.java b/source/java/org/alfresco/web/config/LanguagesElementReader.java index 03c6c2335d..63567fab03 100644 --- a/source/java/org/alfresco/web/config/LanguagesElementReader.java +++ b/source/java/org/alfresco/web/config/LanguagesElementReader.java @@ -1,58 +1,58 @@ -package org.alfresco.web.config; - -import java.util.Iterator; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.dom4j.Element; - -/** - * Custom element reader to parse config for languages - * - * @author Gavin Cornwell - */ -public class LanguagesElementReader implements ConfigElementReader -{ - public static final String ELEMENT_LANGUAGE = "language"; - public static final String ATTRIBUTE_LOCALE = "locale"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - @SuppressWarnings("unchecked") - public ConfigElement parse(Element element) - { - LanguagesConfigElement configElement = null; - - if (element != null) - { - String name = element.getName(); - if (name.equals(LanguagesConfigElement.CONFIG_ELEMENT_ID) == false) - { - throw new ConfigException("LanguagesElementReader can only parse " + - LanguagesConfigElement.CONFIG_ELEMENT_ID + " elements, the element passed was '" + - name + "'"); - } - - configElement = new LanguagesConfigElement(); - - Iterator langsItr = element.elementIterator(ELEMENT_LANGUAGE); - while (langsItr.hasNext()) - { - Element language = langsItr.next(); - String localeCode = language.attributeValue(ATTRIBUTE_LOCALE); - String label = language.getTextTrim(); - - if (localeCode != null && localeCode.length() != 0 && - label != null && label.length() != 0) - { - // store the language code against the display label - configElement.addLanguage(localeCode, label); - } - } - } - - return configElement; - } -} +package org.alfresco.web.config; + +import java.util.Iterator; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.dom4j.Element; + +/** + * Custom element reader to parse config for languages + * + * @author Gavin Cornwell + */ +public class LanguagesElementReader implements ConfigElementReader +{ + public static final String ELEMENT_LANGUAGE = "language"; + public static final String ATTRIBUTE_LOCALE = "locale"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + @SuppressWarnings("unchecked") + public ConfigElement parse(Element element) + { + LanguagesConfigElement configElement = null; + + if (element != null) + { + String name = element.getName(); + if (name.equals(LanguagesConfigElement.CONFIG_ELEMENT_ID) == false) + { + throw new ConfigException("LanguagesElementReader can only parse " + + LanguagesConfigElement.CONFIG_ELEMENT_ID + " elements, the element passed was '" + + name + "'"); + } + + configElement = new LanguagesConfigElement(); + + Iterator langsItr = element.elementIterator(ELEMENT_LANGUAGE); + while (langsItr.hasNext()) + { + Element language = langsItr.next(); + String localeCode = language.attributeValue(ATTRIBUTE_LOCALE); + String label = language.getTextTrim(); + + if (localeCode != null && localeCode.length() != 0 && + label != null && label.length() != 0) + { + // store the language code against the display label + configElement.addLanguage(localeCode, label); + } + } + } + + return configElement; + } +} diff --git a/source/java/org/alfresco/web/config/NavigationConfigElement.java b/source/java/org/alfresco/web/config/NavigationConfigElement.java index 870122952b..f54930d643 100644 --- a/source/java/org/alfresco/web/config/NavigationConfigElement.java +++ b/source/java/org/alfresco/web/config/NavigationConfigElement.java @@ -1,230 +1,230 @@ -package org.alfresco.web.config; - -import java.util.HashMap; -import java.util.List; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.element.ConfigElementAdapter; -import org.springframework.extensions.config.element.GenericConfigElement; - -/** - * Custom config element that represents the config data for navigation - * - * @author gavinc - */ -public class NavigationConfigElement extends ConfigElementAdapter -{ - private HashMap viewIds = new HashMap(); - private HashMap outcomes = new HashMap(); - - private boolean kidsPopulated = false; - - /** - * Default constructor - */ - public NavigationConfigElement() - { - super("navigation"); - } - - /** - * Constructor - * - * @param name Name of the element this config element represents - */ - public NavigationConfigElement(String name) - { - super(name); - } - - /** - * @see ConfigElement#getChildren() - */ - public List getChildren() - { - // lazily build the list of generic config elements representing - // the navigation overrides as the caller may not even call this method - - List kids = null; - - if (this.viewIds.size() > 0 || this.outcomes.size() > 0) - { - if (this.kidsPopulated == false) - { - // create generic config elements for the from-view-id items - for (String fromViewId : this.viewIds.keySet()) - { - GenericConfigElement ce = new GenericConfigElement(NavigationElementReader.ELEMENT_OVERRIDE); - ce.addAttribute(NavigationElementReader.ATTR_FROM_VIEWID, fromViewId); - - NavigationResult navRes = this.viewIds.get(fromViewId); - String result = navRes.getResult(); - if (navRes.isOutcome()) - { - ce.addAttribute(NavigationElementReader.ATTR_TO_OUTCOME, result); - } - else - { - ce.addAttribute(NavigationElementReader.ATTR_TO_VIEWID, result); - } - - // add the element - this.children.add(ce); - } - - // create generic config elements for the from-outcome items - for (String fromOutcome : this.outcomes.keySet()) - { - GenericConfigElement ce = new GenericConfigElement(NavigationElementReader.ELEMENT_OVERRIDE); - ce.addAttribute(NavigationElementReader.ATTR_FROM_OUTCOME, fromOutcome); - - NavigationResult navRes = this.outcomes.get(fromOutcome); - String result = navRes.getResult(); - if (navRes.isOutcome()) - { - ce.addAttribute(NavigationElementReader.ATTR_TO_OUTCOME, result); - } - else - { - ce.addAttribute(NavigationElementReader.ATTR_TO_VIEWID, result); - } - - // add the element - this.children.add(ce); - } - - this.kidsPopulated = true; - } - - kids = super.getChildren(); - } - - return kids; - } - - /** - * @see ConfigElement#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - NavigationConfigElement newElement = (NavigationConfigElement)configElement; - NavigationConfigElement combinedElement = new NavigationConfigElement(); - - // add all the existing from view id overrides - for (String fromViewId : this.viewIds.keySet()) - { - combinedElement.addOverride(fromViewId, null, this.viewIds.get(fromViewId)); - } - - // add all the existing from outcome overrides - for (String fromOutcome : this.outcomes.keySet()) - { - combinedElement.addOverride(null, fromOutcome, this.outcomes.get(fromOutcome)); - } - - // add all the from view id overrides from the given element - HashMap viewIds = newElement.getViewIds(); - for (String fromViewId : viewIds.keySet()) - { - combinedElement.addOverride(fromViewId, null, viewIds.get(fromViewId)); - } - - // add all the from outcome overrides from the given element - HashMap outcomes = newElement.getOutcomes(); - for (String fromOutcome : outcomes.keySet()) - { - combinedElement.addOverride(null, fromOutcome, outcomes.get(fromOutcome)); - } - - return combinedElement; - } - - /** - * Returns the list of view ids that have overrides defined - * - * @return Map of view ids and navigation results - */ - public HashMap getViewIds() - { - return this.viewIds; - } - - /** - * Returns the list of outcomes that have overrides defined - * - * @return Map of outcomes and navigation results - */ - public HashMap getOutcomes() - { - return this.outcomes; - } - - /** - * Adds an override configuration item - * - * @param fromViewId The from-view-id value from the config - * @param fromOutcome The from-outcome value from the config - * @param toViewId The to-view-id value from the config - * @param toOutcome The to-outcome value from the config - */ - public void addOverride(String fromViewId, String fromOutcome, - String toViewId, String toOutcome) - { - // NOTE: the constructor will check the validity of the to* parameters - NavigationResult result = new NavigationResult(toViewId, toOutcome); - addOverride(fromViewId, fromOutcome, result); - } - - /** - * Adds an override configuration item - * - * @param fromViewId The from-view-id value from the config - * @param fromOutcome The from-outcome value from the config - * @param result The navigation result object to add - */ - public void addOverride(String fromViewId, String fromOutcome, - NavigationResult result) - { - if (fromViewId != null && fromOutcome != null) - { - throw new IllegalStateException("You can not have both a from-view-id and from-outcome"); - } - - if (fromViewId != null) - { - this.viewIds.put(fromViewId, result); - } - else if (fromOutcome != null) - { - this.outcomes.put(fromOutcome, result); - } - } - - /** - * Returns the best match navigation override configured for the given - * current view id and/or outcome. - * - * If an outcome is passed it takes precedence, the view id will not be - * used. - * - * @param fromViewId The current view id - * @param fromOutcome The current outcome - * @return The navigation result - */ - public NavigationResult getOverride(String fromViewId, String fromOutcome) - { - NavigationResult result = null; - - // look for a match for the outcome if one was provided - if (fromOutcome != null) - { - result = this.outcomes.get(fromOutcome); - } - else if (fromViewId != null) - { - result = this.viewIds.get(fromViewId); - } - - return result; - } -} +package org.alfresco.web.config; + +import java.util.HashMap; +import java.util.List; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.element.ConfigElementAdapter; +import org.springframework.extensions.config.element.GenericConfigElement; + +/** + * Custom config element that represents the config data for navigation + * + * @author gavinc + */ +public class NavigationConfigElement extends ConfigElementAdapter +{ + private HashMap viewIds = new HashMap(); + private HashMap outcomes = new HashMap(); + + private boolean kidsPopulated = false; + + /** + * Default constructor + */ + public NavigationConfigElement() + { + super("navigation"); + } + + /** + * Constructor + * + * @param name Name of the element this config element represents + */ + public NavigationConfigElement(String name) + { + super(name); + } + + /** + * @see ConfigElement#getChildren() + */ + public List getChildren() + { + // lazily build the list of generic config elements representing + // the navigation overrides as the caller may not even call this method + + List kids = null; + + if (this.viewIds.size() > 0 || this.outcomes.size() > 0) + { + if (this.kidsPopulated == false) + { + // create generic config elements for the from-view-id items + for (String fromViewId : this.viewIds.keySet()) + { + GenericConfigElement ce = new GenericConfigElement(NavigationElementReader.ELEMENT_OVERRIDE); + ce.addAttribute(NavigationElementReader.ATTR_FROM_VIEWID, fromViewId); + + NavigationResult navRes = this.viewIds.get(fromViewId); + String result = navRes.getResult(); + if (navRes.isOutcome()) + { + ce.addAttribute(NavigationElementReader.ATTR_TO_OUTCOME, result); + } + else + { + ce.addAttribute(NavigationElementReader.ATTR_TO_VIEWID, result); + } + + // add the element + this.children.add(ce); + } + + // create generic config elements for the from-outcome items + for (String fromOutcome : this.outcomes.keySet()) + { + GenericConfigElement ce = new GenericConfigElement(NavigationElementReader.ELEMENT_OVERRIDE); + ce.addAttribute(NavigationElementReader.ATTR_FROM_OUTCOME, fromOutcome); + + NavigationResult navRes = this.outcomes.get(fromOutcome); + String result = navRes.getResult(); + if (navRes.isOutcome()) + { + ce.addAttribute(NavigationElementReader.ATTR_TO_OUTCOME, result); + } + else + { + ce.addAttribute(NavigationElementReader.ATTR_TO_VIEWID, result); + } + + // add the element + this.children.add(ce); + } + + this.kidsPopulated = true; + } + + kids = super.getChildren(); + } + + return kids; + } + + /** + * @see ConfigElement#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + NavigationConfigElement newElement = (NavigationConfigElement)configElement; + NavigationConfigElement combinedElement = new NavigationConfigElement(); + + // add all the existing from view id overrides + for (String fromViewId : this.viewIds.keySet()) + { + combinedElement.addOverride(fromViewId, null, this.viewIds.get(fromViewId)); + } + + // add all the existing from outcome overrides + for (String fromOutcome : this.outcomes.keySet()) + { + combinedElement.addOverride(null, fromOutcome, this.outcomes.get(fromOutcome)); + } + + // add all the from view id overrides from the given element + HashMap viewIds = newElement.getViewIds(); + for (String fromViewId : viewIds.keySet()) + { + combinedElement.addOverride(fromViewId, null, viewIds.get(fromViewId)); + } + + // add all the from outcome overrides from the given element + HashMap outcomes = newElement.getOutcomes(); + for (String fromOutcome : outcomes.keySet()) + { + combinedElement.addOverride(null, fromOutcome, outcomes.get(fromOutcome)); + } + + return combinedElement; + } + + /** + * Returns the list of view ids that have overrides defined + * + * @return Map of view ids and navigation results + */ + public HashMap getViewIds() + { + return this.viewIds; + } + + /** + * Returns the list of outcomes that have overrides defined + * + * @return Map of outcomes and navigation results + */ + public HashMap getOutcomes() + { + return this.outcomes; + } + + /** + * Adds an override configuration item + * + * @param fromViewId The from-view-id value from the config + * @param fromOutcome The from-outcome value from the config + * @param toViewId The to-view-id value from the config + * @param toOutcome The to-outcome value from the config + */ + public void addOverride(String fromViewId, String fromOutcome, + String toViewId, String toOutcome) + { + // NOTE: the constructor will check the validity of the to* parameters + NavigationResult result = new NavigationResult(toViewId, toOutcome); + addOverride(fromViewId, fromOutcome, result); + } + + /** + * Adds an override configuration item + * + * @param fromViewId The from-view-id value from the config + * @param fromOutcome The from-outcome value from the config + * @param result The navigation result object to add + */ + public void addOverride(String fromViewId, String fromOutcome, + NavigationResult result) + { + if (fromViewId != null && fromOutcome != null) + { + throw new IllegalStateException("You can not have both a from-view-id and from-outcome"); + } + + if (fromViewId != null) + { + this.viewIds.put(fromViewId, result); + } + else if (fromOutcome != null) + { + this.outcomes.put(fromOutcome, result); + } + } + + /** + * Returns the best match navigation override configured for the given + * current view id and/or outcome. + * + * If an outcome is passed it takes precedence, the view id will not be + * used. + * + * @param fromViewId The current view id + * @param fromOutcome The current outcome + * @return The navigation result + */ + public NavigationResult getOverride(String fromViewId, String fromOutcome) + { + NavigationResult result = null; + + // look for a match for the outcome if one was provided + if (fromOutcome != null) + { + result = this.outcomes.get(fromOutcome); + } + else if (fromViewId != null) + { + result = this.viewIds.get(fromViewId); + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/config/NavigationElementReader.java b/source/java/org/alfresco/web/config/NavigationElementReader.java index 4bc81a18b6..a6d6426ae3 100644 --- a/source/java/org/alfresco/web/config/NavigationElementReader.java +++ b/source/java/org/alfresco/web/config/NavigationElementReader.java @@ -1,64 +1,64 @@ -package org.alfresco.web.config; - -import java.util.Iterator; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.dom4j.Element; - -/** - * Custom element reader to parse config for navigation overrides - * - * @author gavinc - */ -public class NavigationElementReader implements ConfigElementReader -{ - public static final String ELEMENT_NAVIGATION = "navigation"; - public static final String ELEMENT_OVERRIDE = "override"; - public static final String ATTR_FROM_VIEWID = "from-view-id"; - public static final String ATTR_FROM_OUTCOME = "from-outcome"; - public static final String ATTR_TO_VIEWID = "to-view-id"; - public static final String ATTR_TO_OUTCOME = "to-outcome"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - public ConfigElement parse(Element element) - { - NavigationConfigElement configElement = null; - - if (element != null) - { - String name = element.getName(); - if (ELEMENT_NAVIGATION.equals(name) == false) - { - throw new ConfigException("NavigationElementReader can only parse " + - ELEMENT_NAVIGATION + "elements, " + "the element passed was '" + - name + "'"); - } - - configElement = new NavigationConfigElement(); - - // go through the items to show - Iterator items = element.elementIterator(); - while (items.hasNext()) - { - Element item = items.next(); - - // only process the override elements - if (ELEMENT_OVERRIDE.equals(item.getName())) - { - String fromViewId = item.attributeValue(ATTR_FROM_VIEWID); - String fromOutcome = item.attributeValue(ATTR_FROM_OUTCOME); - String toViewId = item.attributeValue(ATTR_TO_VIEWID); - String toOutcome = item.attributeValue(ATTR_TO_OUTCOME); - - configElement.addOverride(fromViewId, fromOutcome, toViewId, toOutcome); - } - } - } - - return configElement; - } -} +package org.alfresco.web.config; + +import java.util.Iterator; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.dom4j.Element; + +/** + * Custom element reader to parse config for navigation overrides + * + * @author gavinc + */ +public class NavigationElementReader implements ConfigElementReader +{ + public static final String ELEMENT_NAVIGATION = "navigation"; + public static final String ELEMENT_OVERRIDE = "override"; + public static final String ATTR_FROM_VIEWID = "from-view-id"; + public static final String ATTR_FROM_OUTCOME = "from-outcome"; + public static final String ATTR_TO_VIEWID = "to-view-id"; + public static final String ATTR_TO_OUTCOME = "to-outcome"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + public ConfigElement parse(Element element) + { + NavigationConfigElement configElement = null; + + if (element != null) + { + String name = element.getName(); + if (ELEMENT_NAVIGATION.equals(name) == false) + { + throw new ConfigException("NavigationElementReader can only parse " + + ELEMENT_NAVIGATION + "elements, " + "the element passed was '" + + name + "'"); + } + + configElement = new NavigationConfigElement(); + + // go through the items to show + Iterator items = element.elementIterator(); + while (items.hasNext()) + { + Element item = items.next(); + + // only process the override elements + if (ELEMENT_OVERRIDE.equals(item.getName())) + { + String fromViewId = item.attributeValue(ATTR_FROM_VIEWID); + String fromOutcome = item.attributeValue(ATTR_FROM_OUTCOME); + String toViewId = item.attributeValue(ATTR_TO_VIEWID); + String toOutcome = item.attributeValue(ATTR_TO_OUTCOME); + + configElement.addOverride(fromViewId, fromOutcome, toViewId, toOutcome); + } + } + } + + return configElement; + } +} diff --git a/source/java/org/alfresco/web/config/NavigationResult.java b/source/java/org/alfresco/web/config/NavigationResult.java index 805834ffe5..046c46f02c 100644 --- a/source/java/org/alfresco/web/config/NavigationResult.java +++ b/source/java/org/alfresco/web/config/NavigationResult.java @@ -1,71 +1,71 @@ -package org.alfresco.web.config; - -/** - * Represents the result of a navigation config result. - * - * This object holds the string result which can either represent an outcome - * or a view id. - * - * @author gavinc - */ -public class NavigationResult -{ - private String result; - private boolean isOutcome = true; - - /** - * Default constructor - * - * @param viewId The to-view-id value - * @param outcome The to-outcome value - */ - public NavigationResult(String viewId, String outcome) - { - if (viewId != null && outcome != null) - { - throw new IllegalStateException("You can not have both a to-view-id and to-outcome"); - } - - if (outcome != null) - { - this.result = outcome; - } - else if (viewId != null) - { - this.result = viewId; - this.isOutcome = false; - } - } - - /** - * Returns the result - * - * @return The result - */ - public String getResult() - { - return this.result; - } - - /** - * Determines whether the result is an outcome - * - * @return true if the result represents an outcome, - * false if it represents a view id - */ - public boolean isOutcome() - { - return this.isOutcome; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() - { - StringBuilder buffer = new StringBuilder(super.toString()); - buffer.append(" (result=").append(this.result); - buffer.append(" isOutcome=").append(this.isOutcome).append(")"); - return buffer.toString(); - } -} +package org.alfresco.web.config; + +/** + * Represents the result of a navigation config result. + * + * This object holds the string result which can either represent an outcome + * or a view id. + * + * @author gavinc + */ +public class NavigationResult +{ + private String result; + private boolean isOutcome = true; + + /** + * Default constructor + * + * @param viewId The to-view-id value + * @param outcome The to-outcome value + */ + public NavigationResult(String viewId, String outcome) + { + if (viewId != null && outcome != null) + { + throw new IllegalStateException("You can not have both a to-view-id and to-outcome"); + } + + if (outcome != null) + { + this.result = outcome; + } + else if (viewId != null) + { + this.result = viewId; + this.isOutcome = false; + } + } + + /** + * Returns the result + * + * @return The result + */ + public String getResult() + { + return this.result; + } + + /** + * Determines whether the result is an outcome + * + * @return true if the result represents an outcome, + * false if it represents a view id + */ + public boolean isOutcome() + { + return this.isOutcome; + } + + /** + * @see java.lang.Object#toString() + */ + public String toString() + { + StringBuilder buffer = new StringBuilder(super.toString()); + buffer.append(" (result=").append(this.result); + buffer.append(" isOutcome=").append(this.isOutcome).append(")"); + return buffer.toString(); + } +} diff --git a/source/java/org/alfresco/web/config/ViewsConfigElement.java b/source/java/org/alfresco/web/config/ViewsConfigElement.java index f7452833fd..029960b9d4 100644 --- a/source/java/org/alfresco/web/config/ViewsConfigElement.java +++ b/source/java/org/alfresco/web/config/ViewsConfigElement.java @@ -1,353 +1,353 @@ -package org.alfresco.web.config; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; - -/** - * Custom config element that represents config values for views in the client - * - * @author Gavin Cornwell - */ -public class ViewsConfigElement extends ConfigElementAdapter implements Serializable -{ - private static final long serialVersionUID = -503735723795178986L; - - public static final String CONFIG_ELEMENT_ID = "views"; - - public static final String VIEW_DETAILS = "details"; - public static final String VIEW_ICONS = "icons"; - public static final String VIEW_LIST = "list"; - public static final String VIEW_BUBBLE = "bubble"; - public static final String SORT_ASCENDING = "ascending"; - public static final String SORT_DESCENDING = "descending"; - - private static final String SEPARATOR = ":"; - - // defaults - private int defaultPageSize = 10; - private String defaultView = "details"; - private String defaultSortColumn = "name"; - - // list to store all the configured views - private List views = new ArrayList(4); - - // map to store all the default views - private Map defaultViews = new HashMap(4); - - // map to store all default page sizes for configured client views - private Map pageSizes = new HashMap(10); - - // map to store default sort columns for configured views - private Map sortColumns = new HashMap(4); - - // list of pages that have been configured to have ascending sorts - private Map sortDirections = new HashMap(1); - - /** - * Default Constructor - */ - public ViewsConfigElement() - { - super(CONFIG_ELEMENT_ID); - - // add the default page sizes to the map - this.pageSizes.put(VIEW_DETAILS, defaultPageSize); - this.pageSizes.put(VIEW_LIST, defaultPageSize); - this.pageSizes.put(VIEW_ICONS, 9); - this.pageSizes.put(VIEW_BUBBLE, 5); - } - - /** - * Constructor - * - * @param name Name of the element this config element represents - */ - public ViewsConfigElement(String name) - { - super(name); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() - */ - @Override - public List getChildren() - { - throw new ConfigException("Reading the views config via the generic interfaces is not supported"); - } - - /** - * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - ViewsConfigElement newElement = (ViewsConfigElement)configElement; - ViewsConfigElement combinedElement = new ViewsConfigElement(); - - // copy all the config from this element into the new one - for (String viewImpl : this.views) - { - combinedElement.addView(viewImpl); - } - - for (String page : this.defaultViews.keySet()) - { - combinedElement.addDefaultView(page, this.defaultViews.get(page)); - } - - for (String pageView : this.pageSizes.keySet()) - { - if (pageView.indexOf(SEPARATOR) != -1) - { - String page = pageView.substring(0, pageView.indexOf(SEPARATOR)); - String view = pageView.substring(pageView.indexOf(SEPARATOR)+1); - combinedElement.addDefaultPageSize(page, view, this.pageSizes.get(pageView).intValue()); - } - } - - for (String page : this.sortColumns.keySet()) - { - combinedElement.addDefaultSortColumn(page, this.sortColumns.get(page)); - } - - for (String page : this.sortDirections.keySet()) - { - combinedElement.addSortDirection(page, this.sortDirections.get(page)); - } - - // copy all the config from the element to be combined into the new one - for (String viewImpl : newElement.getViews()) - { - combinedElement.addView(viewImpl); - } - - Map newDefaultViews = newElement.getDefaultViews(); - for (String page : newDefaultViews.keySet()) - { - combinedElement.addDefaultView(page, newDefaultViews.get(page)); - } - - Map newPageSizes = newElement.getDefaultPageSizes(); - for (String pageView : newPageSizes.keySet()) - { - if (pageView.indexOf(SEPARATOR) != -1) - { - String page = pageView.substring(0, pageView.indexOf(SEPARATOR)); - String view = pageView.substring(pageView.indexOf(SEPARATOR)+1); - combinedElement.addDefaultPageSize(page, view, newPageSizes.get(pageView).intValue()); - } - } - - Map newSortColumns = newElement.getDefaultSortColumns(); - for (String page : newSortColumns.keySet()) - { - combinedElement.addDefaultSortColumn(page, newSortColumns.get(page)); - } - - Map existingSortDirs = newElement.getSortDirections(); - for (String page : existingSortDirs.keySet()) - { - combinedElement.addSortDirection(page, existingSortDirs.get(page)); - } - - return combinedElement; - } - - /** - * Adds a configured view - * - * @param renderer The implementation class of the view (the renderer) - */ - /*package*/ void addView(String renderer) - { - this.views.add(renderer); - } - - /** - * Returns a map of configured views for the client - * - * @return List of the implementation classes for the configured views - */ - public List getViews() - { - return this.views; - } - - /** - * Adds a default view setting - * - * @param page The page to set the default view for - * @param view The view name that will be the default - */ - /*package*/ void addDefaultView(String page, String view) - { - this.defaultViews.put(page, view); - } - - /** - * Returns the default view for the given page - * - * @param page The page to get the default view for - * @return The defualt view, if there isn't a configured default for the - * given page 'details' will be returned - */ - public String getDefaultView(String page) - { - String view = this.defaultViews.get(page); - - if (view == null) - { - view = this.defaultView; - } - - return view; - } - - /** - * Returns a map of default views for each page - * - * @return Map of default views - */ - /*package*/ Map getDefaultViews() - { - return this.defaultViews; - } - - /** - * Adds a configured page size to the internal store - * - * @param page The name of the page i.e. browse, forums etc. - * @param view The name of the view the size is for i.e. details, icons etc. - * @param size The size of the page - */ - /*package*/ void addDefaultPageSize(String page, String view, int size) - { - this.pageSizes.put(page + SEPARATOR + view, new Integer(size)); - } - - /** - * Returns the page size for the given page and view combination - * - * @param page The name of the page i.e. browse, forums etc. - * @param view The name of the view the size is for i.e. details, icons etc. - * @return The size of the requested page, if the combination doesn't exist - * the default for the view will be used, if the view doesn't exist either - * 10 will be returned. - */ - public int getDefaultPageSize(String page, String view) - { - Integer pageSize = this.pageSizes.get(page + SEPARATOR + view); - - // try just the view if the combination isn't present - if (pageSize == null) - { - pageSize = this.pageSizes.get(view); - - // if the view is not present either default to 10 - if (pageSize == null) - { - pageSize = new Integer(10); - } - } - - return pageSize.intValue(); - } - - /** - * Returns a map of page sizes - * - * @return Map of page sizes - */ - /*package*/ Map getDefaultPageSizes() - { - return this.pageSizes; - } - - /** - * Adds a default sorting column for the given page - * - * @param page The name of the page i.e. browse, forums etc. - * @param column The name of the column to initially sort by - */ - /*package*/ void addDefaultSortColumn(String page, String column) - { - this.sortColumns.put(page, column); - } - - /** - * Returns the default sort column for the given page - * - * @param page The name of the page i.e. browse, forums etc. - * @return The name of the column to sort by, name is returned if - * the page is not found - */ - public String getDefaultSortColumn(String page) - { - String column = this.sortColumns.get(page); - - if (column == null) - { - column = this.defaultSortColumn; - } - - return column; - } - - /** - * Returns a map of the sorted columns for each page - * - * @return Map of sort columns - */ - /*package*/ Map getDefaultSortColumns() - { - return this.sortColumns; - } - - /** - * Sets the given page as using the given sort direction - * - * @param page The name of the page i.e. browse, forums etc. - * @param dir The sort direction - */ - /*package*/ void addSortDirection(String page, String dir) - { - this.sortDirections.put(page, dir); - } - - /** - * Determines whether the given page has been - * configured to use descending sorting by default - * - * @param page The name of the page i.e. browse, forums etc. - * @return true if the page should use descending sorts - */ - public boolean hasDescendingSort(String page) - { - boolean usesDescendingSort = false; - - String sortDir = this.sortDirections.get(page); - if (sortDir != null && sortDir.equalsIgnoreCase(SORT_DESCENDING)) - { - usesDescendingSort = true; - } - - return usesDescendingSort; - } - - /** - * Returns a map of the sort directions - * - * @return Map of sort directions - */ - /*package*/ Map getSortDirections() - { - return this.sortDirections; - } -} +package org.alfresco.web.config; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; + +/** + * Custom config element that represents config values for views in the client + * + * @author Gavin Cornwell + */ +public class ViewsConfigElement extends ConfigElementAdapter implements Serializable +{ + private static final long serialVersionUID = -503735723795178986L; + + public static final String CONFIG_ELEMENT_ID = "views"; + + public static final String VIEW_DETAILS = "details"; + public static final String VIEW_ICONS = "icons"; + public static final String VIEW_LIST = "list"; + public static final String VIEW_BUBBLE = "bubble"; + public static final String SORT_ASCENDING = "ascending"; + public static final String SORT_DESCENDING = "descending"; + + private static final String SEPARATOR = ":"; + + // defaults + private int defaultPageSize = 10; + private String defaultView = "details"; + private String defaultSortColumn = "name"; + + // list to store all the configured views + private List views = new ArrayList(4); + + // map to store all the default views + private Map defaultViews = new HashMap(4); + + // map to store all default page sizes for configured client views + private Map pageSizes = new HashMap(10); + + // map to store default sort columns for configured views + private Map sortColumns = new HashMap(4); + + // list of pages that have been configured to have ascending sorts + private Map sortDirections = new HashMap(1); + + /** + * Default Constructor + */ + public ViewsConfigElement() + { + super(CONFIG_ELEMENT_ID); + + // add the default page sizes to the map + this.pageSizes.put(VIEW_DETAILS, defaultPageSize); + this.pageSizes.put(VIEW_LIST, defaultPageSize); + this.pageSizes.put(VIEW_ICONS, 9); + this.pageSizes.put(VIEW_BUBBLE, 5); + } + + /** + * Constructor + * + * @param name Name of the element this config element represents + */ + public ViewsConfigElement(String name) + { + super(name); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#getChildren() + */ + @Override + public List getChildren() + { + throw new ConfigException("Reading the views config via the generic interfaces is not supported"); + } + + /** + * @see org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + ViewsConfigElement newElement = (ViewsConfigElement)configElement; + ViewsConfigElement combinedElement = new ViewsConfigElement(); + + // copy all the config from this element into the new one + for (String viewImpl : this.views) + { + combinedElement.addView(viewImpl); + } + + for (String page : this.defaultViews.keySet()) + { + combinedElement.addDefaultView(page, this.defaultViews.get(page)); + } + + for (String pageView : this.pageSizes.keySet()) + { + if (pageView.indexOf(SEPARATOR) != -1) + { + String page = pageView.substring(0, pageView.indexOf(SEPARATOR)); + String view = pageView.substring(pageView.indexOf(SEPARATOR)+1); + combinedElement.addDefaultPageSize(page, view, this.pageSizes.get(pageView).intValue()); + } + } + + for (String page : this.sortColumns.keySet()) + { + combinedElement.addDefaultSortColumn(page, this.sortColumns.get(page)); + } + + for (String page : this.sortDirections.keySet()) + { + combinedElement.addSortDirection(page, this.sortDirections.get(page)); + } + + // copy all the config from the element to be combined into the new one + for (String viewImpl : newElement.getViews()) + { + combinedElement.addView(viewImpl); + } + + Map newDefaultViews = newElement.getDefaultViews(); + for (String page : newDefaultViews.keySet()) + { + combinedElement.addDefaultView(page, newDefaultViews.get(page)); + } + + Map newPageSizes = newElement.getDefaultPageSizes(); + for (String pageView : newPageSizes.keySet()) + { + if (pageView.indexOf(SEPARATOR) != -1) + { + String page = pageView.substring(0, pageView.indexOf(SEPARATOR)); + String view = pageView.substring(pageView.indexOf(SEPARATOR)+1); + combinedElement.addDefaultPageSize(page, view, newPageSizes.get(pageView).intValue()); + } + } + + Map newSortColumns = newElement.getDefaultSortColumns(); + for (String page : newSortColumns.keySet()) + { + combinedElement.addDefaultSortColumn(page, newSortColumns.get(page)); + } + + Map existingSortDirs = newElement.getSortDirections(); + for (String page : existingSortDirs.keySet()) + { + combinedElement.addSortDirection(page, existingSortDirs.get(page)); + } + + return combinedElement; + } + + /** + * Adds a configured view + * + * @param renderer The implementation class of the view (the renderer) + */ + /*package*/ void addView(String renderer) + { + this.views.add(renderer); + } + + /** + * Returns a map of configured views for the client + * + * @return List of the implementation classes for the configured views + */ + public List getViews() + { + return this.views; + } + + /** + * Adds a default view setting + * + * @param page The page to set the default view for + * @param view The view name that will be the default + */ + /*package*/ void addDefaultView(String page, String view) + { + this.defaultViews.put(page, view); + } + + /** + * Returns the default view for the given page + * + * @param page The page to get the default view for + * @return The defualt view, if there isn't a configured default for the + * given page 'details' will be returned + */ + public String getDefaultView(String page) + { + String view = this.defaultViews.get(page); + + if (view == null) + { + view = this.defaultView; + } + + return view; + } + + /** + * Returns a map of default views for each page + * + * @return Map of default views + */ + /*package*/ Map getDefaultViews() + { + return this.defaultViews; + } + + /** + * Adds a configured page size to the internal store + * + * @param page The name of the page i.e. browse, forums etc. + * @param view The name of the view the size is for i.e. details, icons etc. + * @param size The size of the page + */ + /*package*/ void addDefaultPageSize(String page, String view, int size) + { + this.pageSizes.put(page + SEPARATOR + view, new Integer(size)); + } + + /** + * Returns the page size for the given page and view combination + * + * @param page The name of the page i.e. browse, forums etc. + * @param view The name of the view the size is for i.e. details, icons etc. + * @return The size of the requested page, if the combination doesn't exist + * the default for the view will be used, if the view doesn't exist either + * 10 will be returned. + */ + public int getDefaultPageSize(String page, String view) + { + Integer pageSize = this.pageSizes.get(page + SEPARATOR + view); + + // try just the view if the combination isn't present + if (pageSize == null) + { + pageSize = this.pageSizes.get(view); + + // if the view is not present either default to 10 + if (pageSize == null) + { + pageSize = new Integer(10); + } + } + + return pageSize.intValue(); + } + + /** + * Returns a map of page sizes + * + * @return Map of page sizes + */ + /*package*/ Map getDefaultPageSizes() + { + return this.pageSizes; + } + + /** + * Adds a default sorting column for the given page + * + * @param page The name of the page i.e. browse, forums etc. + * @param column The name of the column to initially sort by + */ + /*package*/ void addDefaultSortColumn(String page, String column) + { + this.sortColumns.put(page, column); + } + + /** + * Returns the default sort column for the given page + * + * @param page The name of the page i.e. browse, forums etc. + * @return The name of the column to sort by, name is returned if + * the page is not found + */ + public String getDefaultSortColumn(String page) + { + String column = this.sortColumns.get(page); + + if (column == null) + { + column = this.defaultSortColumn; + } + + return column; + } + + /** + * Returns a map of the sorted columns for each page + * + * @return Map of sort columns + */ + /*package*/ Map getDefaultSortColumns() + { + return this.sortColumns; + } + + /** + * Sets the given page as using the given sort direction + * + * @param page The name of the page i.e. browse, forums etc. + * @param dir The sort direction + */ + /*package*/ void addSortDirection(String page, String dir) + { + this.sortDirections.put(page, dir); + } + + /** + * Determines whether the given page has been + * configured to use descending sorting by default + * + * @param page The name of the page i.e. browse, forums etc. + * @return true if the page should use descending sorts + */ + public boolean hasDescendingSort(String page) + { + boolean usesDescendingSort = false; + + String sortDir = this.sortDirections.get(page); + if (sortDir != null && sortDir.equalsIgnoreCase(SORT_DESCENDING)) + { + usesDescendingSort = true; + } + + return usesDescendingSort; + } + + /** + * Returns a map of the sort directions + * + * @return Map of sort directions + */ + /*package*/ Map getSortDirections() + { + return this.sortDirections; + } +} diff --git a/source/java/org/alfresco/web/config/ViewsElementReader.java b/source/java/org/alfresco/web/config/ViewsElementReader.java index 3aa3f1bacf..c3fcfb882b 100644 --- a/source/java/org/alfresco/web/config/ViewsElementReader.java +++ b/source/java/org/alfresco/web/config/ViewsElementReader.java @@ -1,134 +1,134 @@ -package org.alfresco.web.config; - -import java.util.Iterator; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.dom4j.Element; - -/** - * Custom element reader to parse config for client views - * - * @author Gavin Cornwell - */ -public class ViewsElementReader implements ConfigElementReader -{ - public static final String ELEMENT_VIEW = "view"; - public static final String ELEMENT_VIEWIMPL = "view-impl"; - public static final String ELEMENT_VIEWDEFAULTS = "view-defaults"; - public static final String ELEMENT_PAGESIZE = "page-size"; - public static final String ELEMENT_SORTCOLUMN = "sort-column"; - public static final String ELEMENT_SORTDIRECTION = "sort-direction"; - - private static Log logger = LogFactory.getLog(ViewsElementReader.class); - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - @SuppressWarnings("unchecked") - public ConfigElement parse(Element element) - { - ViewsConfigElement configElement = null; - - if (element != null) - { - String name = element.getName(); - if (name.equals(ViewsConfigElement.CONFIG_ELEMENT_ID) == false) - { - throw new ConfigException("ViewsElementReader can only parse " + - ViewsConfigElement.CONFIG_ELEMENT_ID + " elements, the element passed was '" + - name + "'"); - } - - configElement = new ViewsConfigElement(); - - // get the configured views - Iterator renderers = element.elementIterator(ELEMENT_VIEWIMPL); - while (renderers.hasNext()) - { - Element renderer = renderers.next(); - configElement.addView(renderer.getTextTrim()); - } - - // get all the view related default settings - Element viewDefaults = element.element(ELEMENT_VIEWDEFAULTS); - if (viewDefaults != null) - { - Iterator pages = viewDefaults.elementIterator(); - while (pages.hasNext()) - { - Element page = pages.next(); - String pageName = page.getName(); - - // get the default view mode for the page - Element defaultView = page.element(ELEMENT_VIEW); - if (defaultView != null) - { - String viewName = defaultView.getTextTrim(); - configElement.addDefaultView(pageName, viewName); - } - - // get the initial sort column - Element sortColumn = page.element(ELEMENT_SORTCOLUMN); - if (sortColumn != null) - { - String column = sortColumn.getTextTrim(); - configElement.addDefaultSortColumn(pageName, column); - } - - // get the sort direction option - Element sortDir = page.element(ELEMENT_SORTDIRECTION); - if (sortDir != null) - { - configElement.addSortDirection(pageName, sortDir.getTextTrim()); - } - - // process the page-size element - processPageSizeElement(page.element(ELEMENT_PAGESIZE), - pageName, configElement); - } - } - } - - return configElement; - } - - /** - * Processes a page-size element - * - * @param pageSizeElement The element to process - * @param page The page the page-size element belongs to - * @param configElement The config element being populated - */ - @SuppressWarnings("unchecked") - private void processPageSizeElement(Element pageSizeElement, String page, - ViewsConfigElement configElement) - { - if (pageSizeElement != null) - { - Iterator views = pageSizeElement.elementIterator(); - while (views.hasNext()) - { - Element view = views.next(); - String viewName = view.getName(); - String pageSize = view.getTextTrim(); - try - { - configElement.addDefaultPageSize(page, viewName, Integer.parseInt(pageSize)); - } - catch (NumberFormatException nfe) - { - if (logger.isWarnEnabled()) - { - logger.warn("Failed to set page size for view '" + viewName + - "' in page '" + page + "' as '" + pageSize + - "' is an invalid number!"); - } - } - } - } - } -} +package org.alfresco.web.config; + +import java.util.Iterator; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.dom4j.Element; + +/** + * Custom element reader to parse config for client views + * + * @author Gavin Cornwell + */ +public class ViewsElementReader implements ConfigElementReader +{ + public static final String ELEMENT_VIEW = "view"; + public static final String ELEMENT_VIEWIMPL = "view-impl"; + public static final String ELEMENT_VIEWDEFAULTS = "view-defaults"; + public static final String ELEMENT_PAGESIZE = "page-size"; + public static final String ELEMENT_SORTCOLUMN = "sort-column"; + public static final String ELEMENT_SORTDIRECTION = "sort-direction"; + + private static Log logger = LogFactory.getLog(ViewsElementReader.class); + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + @SuppressWarnings("unchecked") + public ConfigElement parse(Element element) + { + ViewsConfigElement configElement = null; + + if (element != null) + { + String name = element.getName(); + if (name.equals(ViewsConfigElement.CONFIG_ELEMENT_ID) == false) + { + throw new ConfigException("ViewsElementReader can only parse " + + ViewsConfigElement.CONFIG_ELEMENT_ID + " elements, the element passed was '" + + name + "'"); + } + + configElement = new ViewsConfigElement(); + + // get the configured views + Iterator renderers = element.elementIterator(ELEMENT_VIEWIMPL); + while (renderers.hasNext()) + { + Element renderer = renderers.next(); + configElement.addView(renderer.getTextTrim()); + } + + // get all the view related default settings + Element viewDefaults = element.element(ELEMENT_VIEWDEFAULTS); + if (viewDefaults != null) + { + Iterator pages = viewDefaults.elementIterator(); + while (pages.hasNext()) + { + Element page = pages.next(); + String pageName = page.getName(); + + // get the default view mode for the page + Element defaultView = page.element(ELEMENT_VIEW); + if (defaultView != null) + { + String viewName = defaultView.getTextTrim(); + configElement.addDefaultView(pageName, viewName); + } + + // get the initial sort column + Element sortColumn = page.element(ELEMENT_SORTCOLUMN); + if (sortColumn != null) + { + String column = sortColumn.getTextTrim(); + configElement.addDefaultSortColumn(pageName, column); + } + + // get the sort direction option + Element sortDir = page.element(ELEMENT_SORTDIRECTION); + if (sortDir != null) + { + configElement.addSortDirection(pageName, sortDir.getTextTrim()); + } + + // process the page-size element + processPageSizeElement(page.element(ELEMENT_PAGESIZE), + pageName, configElement); + } + } + } + + return configElement; + } + + /** + * Processes a page-size element + * + * @param pageSizeElement The element to process + * @param page The page the page-size element belongs to + * @param configElement The config element being populated + */ + @SuppressWarnings("unchecked") + private void processPageSizeElement(Element pageSizeElement, String page, + ViewsConfigElement configElement) + { + if (pageSizeElement != null) + { + Iterator views = pageSizeElement.elementIterator(); + while (views.hasNext()) + { + Element view = views.next(); + String viewName = view.getName(); + String pageSize = view.getTextTrim(); + try + { + configElement.addDefaultPageSize(page, viewName, Integer.parseInt(pageSize)); + } + catch (NumberFormatException nfe) + { + if (logger.isWarnEnabled()) + { + logger.warn("Failed to set page size for view '" + viewName + + "' in page '" + page + "' as '" + pageSize + + "' is an invalid number!"); + } + } + } + } + } +} diff --git a/source/java/org/alfresco/web/config/WizardsConfigElement.java b/source/java/org/alfresco/web/config/WizardsConfigElement.java index 77a45c8916..62c9660815 100644 --- a/source/java/org/alfresco/web/config/WizardsConfigElement.java +++ b/source/java/org/alfresco/web/config/WizardsConfigElement.java @@ -1,458 +1,458 @@ -package org.alfresco.web.config; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.element.ConfigElementAdapter; -import org.springframework.extensions.surf.util.ParameterCheck; - -/** - * Custom config element that represents the config data for a property sheet - * - * @author gavinc - */ -public class WizardsConfigElement extends ConfigElementAdapter -{ - public static final String CONFIG_ELEMENT_ID = "wizards"; - - private Map wizards = new LinkedHashMap(8, 10f); - - /** - * Default constructor - */ - public WizardsConfigElement() - { - super(CONFIG_ELEMENT_ID); - } - - /** - * Constructor - * - * @param name Name of the element this config element represents - */ - public WizardsConfigElement(String name) - { - super(name); - } - - /** - * @see ConfigElement#getChildren() - */ - public List getChildren() - { - throw new ConfigException("Reading the wizards config via the generic interfaces is not supported"); - } - - /** - * @see ConfigElement#combine(org.springframework.extensions.config.ConfigElement) - */ - public ConfigElement combine(ConfigElement configElement) - { - WizardsConfigElement combined = new WizardsConfigElement(); - - // add all the wizards from this element - for (WizardConfig wizard : this.getWizards().values()) - { - combined.addWizard(wizard); - } - - // add all the wizards from the given element - for (WizardConfig wizard : ((WizardsConfigElement)configElement).getWizards().values()) - { - combined.addWizard(wizard); - } - - return combined; - } - - /** - * Returns the named wizard - * - * @param name The name of the wizard to retrieve - * @return The WizardConfig object for the requested wizard or null if it doesn't exist - */ - public WizardConfig getWizard(String name) - { - return this.wizards.get(name); - } - - /** - * @return Returns a map of the wizards - */ - public Map getWizards() - { - return this.wizards; - } - - /** - * Adds a wizard - * - * @param wizardConfig A pre-configured wizard config object - */ - /*package*/ void addWizard(WizardConfig wizardConfig) - { - this.wizards.put(wizardConfig.getName(), wizardConfig); - } - - public abstract static class AbstractConfig implements Serializable - { - protected String title; - protected String titleId; - protected String description; - protected String descriptionId; - - - - protected AbstractConfig() - { - super(); - } - - public AbstractConfig(String title, String titleId, - String description, String descriptionId) - { - this.title = title; - this.titleId = titleId; - this.description = description; - this.descriptionId = descriptionId; - } - - public String getDescription() - { - return this.description; - } - - public String getDescriptionId() - { - return this.descriptionId; - } - - public String getTitle() - { - return this.title; - } - - public String getTitleId() - { - return this.titleId; - } - } - - /** - * Represents the configuration of a single wizard i.e. the <wizard> element - */ - public static class WizardConfig extends AbstractConfig implements Serializable - { - private static final long serialVersionUID = -3377339374041580932L; - - protected String subTitle; - protected String subTitleId; - protected String name; - protected String managedBean; - protected String icon; - protected String errorMsgId = "error_wizard"; - - protected Map steps = new LinkedHashMap(4); - - protected WizardConfig() - { - super(); - } - - public WizardConfig(String name, String bean, String icon, - String title, String titleId, - String subTitle, String subTitleId, - String description, String descriptionId, - String errorMsgId) - { - super(title, titleId, description, descriptionId); - - // check we have a name - ParameterCheck.mandatoryString("name", name); - - this.subTitle = subTitle; - this.subTitleId = subTitleId; - this.name = name; - this.managedBean = bean; - this.icon = icon; - - if (errorMsgId != null && errorMsgId.length() > 0) - { - this.errorMsgId = errorMsgId; - } - } - - public String getName() - { - return this.name; - } - - public String getManagedBean() - { - return this.managedBean; - } - - public String getSubTitle() - { - return this.subTitle; - } - - public String getSubTitleId() - { - return this.subTitleId; - } - - public String getIcon() - { - return this.icon; - } - - public String getErrorMessageId() - { - return this.errorMsgId; - } - - public int getNumberSteps() - { - return this.steps.size(); - } - - public Map getSteps() - { - return this.steps; - } - - public List getStepsAsList() - { - List stepList = new ArrayList(this.steps.size()); - - for (StepConfig stepCfg : this.steps.values()) - { - stepList.add(stepCfg); - } - - return stepList; - } - - public StepConfig getStepByName(String name) - { - return this.steps.get(name); - } - - /*package*/ void addStep(StepConfig step) - { - this.steps.put(step.getName(), step); - } - - /** - * @see java.lang.Object#toString() - */ - @Override - public String toString() - { - StringBuilder buffer = new StringBuilder(super.toString()); - buffer.append(" (name=").append(this.name); - buffer.append(" managed-bean=").append(this.managedBean); - buffer.append(" icon=").append(this.icon); - buffer.append(" title=").append(this.title); - buffer.append(" titleId=").append(this.titleId); - buffer.append(" subTitle=").append(this.subTitle); - buffer.append(" subTitleId=").append(this.subTitleId); - buffer.append(" description=").append(this.description); - buffer.append(" descriptionId=").append(this.descriptionId); - buffer.append(" errorMsgId=").append(this.errorMsgId).append(")"); - return buffer.toString(); - } - } - - /** - * Represents the configuration of a page in a wizard i.e. the <page> element - */ - public static class PageConfig extends AbstractConfig implements Serializable - { - private static final long serialVersionUID = 4154515148190230391L; - - protected String path; - protected String instruction; - protected String instructionId; - - public PageConfig(String path, - String title, String titleId, - String description, String descriptionId, - String instruction, String instructionId) - { - super(title, titleId, description, descriptionId); - - // check we have a path - ParameterCheck.mandatoryString("path", path); - - this.path = path; - this.instruction = instruction; - this.instructionId = instructionId; - } - - public String getPath() - { - return this.path; - } - - public String getInstruction() - { - return this.instruction; - } - - public String getInstructionId() - { - return this.instructionId; - } - - /** - * @see java.lang.Object#toString() - */ - @Override - public String toString() - { - StringBuilder buffer = new StringBuilder(super.toString()); - buffer.append(" (path=").append(this.path); - buffer.append(" title=").append(this.title); - buffer.append(" titleId=").append(this.titleId); - buffer.append(" description=").append(this.description); - buffer.append(" descriptionId=").append(this.descriptionId); - buffer.append(" instruction=").append(this.instruction); - buffer.append(" instructionId=").append(this.instructionId).append(")"); - return buffer.toString(); - } - } - - /** - * Represents the configuration of a conditional page in a wizard - * i.e. a <page> element that is placed within a <condition> - * element. - */ - public static class ConditionalPageConfig extends PageConfig - { - private static final long serialVersionUID = -3398913681170199314L; - - protected String condition; - - public ConditionalPageConfig(String path, String condition, - String title, String titleId, - String description, String descriptionId, - String instruction, String instructionId) - { - super(path, title, titleId, description, descriptionId, instruction, instructionId); - - // check we have a path - ParameterCheck.mandatoryString("condition", condition); - - this.condition = condition; - } - - public String getCondition() - { - return this.condition; - } - - /** - * @see java.lang.Object#toString() - */ - @Override - public String toString() - { - StringBuilder buffer = new StringBuilder(super.toString()); - buffer.append(" (path=").append(this.path); - buffer.append(" condition=").append(this.condition); - buffer.append(" title=").append(this.title); - buffer.append(" titleId=").append(this.titleId); - buffer.append(" description=").append(this.description); - buffer.append(" descriptionId=").append(this.descriptionId); - buffer.append(" instruction=").append(this.instruction); - buffer.append(" instructionId=").append(this.instructionId).append(")"); - return buffer.toString(); - } - } - - /** - * Represents the configuration of a step in a wizard - * i.e. the <step> element. - */ - public static class StepConfig extends AbstractConfig implements Serializable - { - private static final long serialVersionUID = -3707570689181455754L; - - protected String name; - protected PageConfig defaultPage; - protected List conditionalPages = - new ArrayList(3); - - public StepConfig(String name, - String title, String titleId, - String description, String descriptionId) - { - super(title, titleId, description, descriptionId); - - // check we have a name - ParameterCheck.mandatoryString("name", name); - - // check we have a title - if (this.title == null && this.titleId == null) - { - throw new IllegalArgumentException("A title or title-id attribute must be supplied for a step"); - } - - this.name = name; - } - - public String getName() - { - return this.name; - } - - public PageConfig getDefaultPage() - { - return this.defaultPage; - } - - public boolean hasConditionalPages() - { - return (this.conditionalPages.size() > 0); - } - - public List getConditionalPages() - { - return this.conditionalPages; - } - - /*package*/ void addConditionalPage(ConditionalPageConfig conditionalPage) - { - this.conditionalPages.add(conditionalPage); - } - - /*package*/ void setDefaultPage(PageConfig page) - { - this.defaultPage = page; - } - - /** - * @see java.lang.Object#toString() - */ - @Override - public String toString() - { - StringBuilder buffer = new StringBuilder(super.toString()); - buffer.append(" (name=").append(this.name); - buffer.append(" title=").append(this.title); - buffer.append(" titleId=").append(this.titleId); - buffer.append(" description=").append(this.description); - buffer.append(" descriptionId=").append(this.descriptionId); - buffer.append(" defaultPage=").append(this.defaultPage); - buffer.append(" conditionalPages=").append(this.conditionalPages).append(")"); - return buffer.toString(); - } - } -} +package org.alfresco.web.config; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.element.ConfigElementAdapter; +import org.springframework.extensions.surf.util.ParameterCheck; + +/** + * Custom config element that represents the config data for a property sheet + * + * @author gavinc + */ +public class WizardsConfigElement extends ConfigElementAdapter +{ + public static final String CONFIG_ELEMENT_ID = "wizards"; + + private Map wizards = new LinkedHashMap(8, 10f); + + /** + * Default constructor + */ + public WizardsConfigElement() + { + super(CONFIG_ELEMENT_ID); + } + + /** + * Constructor + * + * @param name Name of the element this config element represents + */ + public WizardsConfigElement(String name) + { + super(name); + } + + /** + * @see ConfigElement#getChildren() + */ + public List getChildren() + { + throw new ConfigException("Reading the wizards config via the generic interfaces is not supported"); + } + + /** + * @see ConfigElement#combine(org.springframework.extensions.config.ConfigElement) + */ + public ConfigElement combine(ConfigElement configElement) + { + WizardsConfigElement combined = new WizardsConfigElement(); + + // add all the wizards from this element + for (WizardConfig wizard : this.getWizards().values()) + { + combined.addWizard(wizard); + } + + // add all the wizards from the given element + for (WizardConfig wizard : ((WizardsConfigElement)configElement).getWizards().values()) + { + combined.addWizard(wizard); + } + + return combined; + } + + /** + * Returns the named wizard + * + * @param name The name of the wizard to retrieve + * @return The WizardConfig object for the requested wizard or null if it doesn't exist + */ + public WizardConfig getWizard(String name) + { + return this.wizards.get(name); + } + + /** + * @return Returns a map of the wizards + */ + public Map getWizards() + { + return this.wizards; + } + + /** + * Adds a wizard + * + * @param wizardConfig A pre-configured wizard config object + */ + /*package*/ void addWizard(WizardConfig wizardConfig) + { + this.wizards.put(wizardConfig.getName(), wizardConfig); + } + + public abstract static class AbstractConfig implements Serializable + { + protected String title; + protected String titleId; + protected String description; + protected String descriptionId; + + + + protected AbstractConfig() + { + super(); + } + + public AbstractConfig(String title, String titleId, + String description, String descriptionId) + { + this.title = title; + this.titleId = titleId; + this.description = description; + this.descriptionId = descriptionId; + } + + public String getDescription() + { + return this.description; + } + + public String getDescriptionId() + { + return this.descriptionId; + } + + public String getTitle() + { + return this.title; + } + + public String getTitleId() + { + return this.titleId; + } + } + + /** + * Represents the configuration of a single wizard i.e. the <wizard> element + */ + public static class WizardConfig extends AbstractConfig implements Serializable + { + private static final long serialVersionUID = -3377339374041580932L; + + protected String subTitle; + protected String subTitleId; + protected String name; + protected String managedBean; + protected String icon; + protected String errorMsgId = "error_wizard"; + + protected Map steps = new LinkedHashMap(4); + + protected WizardConfig() + { + super(); + } + + public WizardConfig(String name, String bean, String icon, + String title, String titleId, + String subTitle, String subTitleId, + String description, String descriptionId, + String errorMsgId) + { + super(title, titleId, description, descriptionId); + + // check we have a name + ParameterCheck.mandatoryString("name", name); + + this.subTitle = subTitle; + this.subTitleId = subTitleId; + this.name = name; + this.managedBean = bean; + this.icon = icon; + + if (errorMsgId != null && errorMsgId.length() > 0) + { + this.errorMsgId = errorMsgId; + } + } + + public String getName() + { + return this.name; + } + + public String getManagedBean() + { + return this.managedBean; + } + + public String getSubTitle() + { + return this.subTitle; + } + + public String getSubTitleId() + { + return this.subTitleId; + } + + public String getIcon() + { + return this.icon; + } + + public String getErrorMessageId() + { + return this.errorMsgId; + } + + public int getNumberSteps() + { + return this.steps.size(); + } + + public Map getSteps() + { + return this.steps; + } + + public List getStepsAsList() + { + List stepList = new ArrayList(this.steps.size()); + + for (StepConfig stepCfg : this.steps.values()) + { + stepList.add(stepCfg); + } + + return stepList; + } + + public StepConfig getStepByName(String name) + { + return this.steps.get(name); + } + + /*package*/ void addStep(StepConfig step) + { + this.steps.put(step.getName(), step); + } + + /** + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + StringBuilder buffer = new StringBuilder(super.toString()); + buffer.append(" (name=").append(this.name); + buffer.append(" managed-bean=").append(this.managedBean); + buffer.append(" icon=").append(this.icon); + buffer.append(" title=").append(this.title); + buffer.append(" titleId=").append(this.titleId); + buffer.append(" subTitle=").append(this.subTitle); + buffer.append(" subTitleId=").append(this.subTitleId); + buffer.append(" description=").append(this.description); + buffer.append(" descriptionId=").append(this.descriptionId); + buffer.append(" errorMsgId=").append(this.errorMsgId).append(")"); + return buffer.toString(); + } + } + + /** + * Represents the configuration of a page in a wizard i.e. the <page> element + */ + public static class PageConfig extends AbstractConfig implements Serializable + { + private static final long serialVersionUID = 4154515148190230391L; + + protected String path; + protected String instruction; + protected String instructionId; + + public PageConfig(String path, + String title, String titleId, + String description, String descriptionId, + String instruction, String instructionId) + { + super(title, titleId, description, descriptionId); + + // check we have a path + ParameterCheck.mandatoryString("path", path); + + this.path = path; + this.instruction = instruction; + this.instructionId = instructionId; + } + + public String getPath() + { + return this.path; + } + + public String getInstruction() + { + return this.instruction; + } + + public String getInstructionId() + { + return this.instructionId; + } + + /** + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + StringBuilder buffer = new StringBuilder(super.toString()); + buffer.append(" (path=").append(this.path); + buffer.append(" title=").append(this.title); + buffer.append(" titleId=").append(this.titleId); + buffer.append(" description=").append(this.description); + buffer.append(" descriptionId=").append(this.descriptionId); + buffer.append(" instruction=").append(this.instruction); + buffer.append(" instructionId=").append(this.instructionId).append(")"); + return buffer.toString(); + } + } + + /** + * Represents the configuration of a conditional page in a wizard + * i.e. a <page> element that is placed within a <condition> + * element. + */ + public static class ConditionalPageConfig extends PageConfig + { + private static final long serialVersionUID = -3398913681170199314L; + + protected String condition; + + public ConditionalPageConfig(String path, String condition, + String title, String titleId, + String description, String descriptionId, + String instruction, String instructionId) + { + super(path, title, titleId, description, descriptionId, instruction, instructionId); + + // check we have a path + ParameterCheck.mandatoryString("condition", condition); + + this.condition = condition; + } + + public String getCondition() + { + return this.condition; + } + + /** + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + StringBuilder buffer = new StringBuilder(super.toString()); + buffer.append(" (path=").append(this.path); + buffer.append(" condition=").append(this.condition); + buffer.append(" title=").append(this.title); + buffer.append(" titleId=").append(this.titleId); + buffer.append(" description=").append(this.description); + buffer.append(" descriptionId=").append(this.descriptionId); + buffer.append(" instruction=").append(this.instruction); + buffer.append(" instructionId=").append(this.instructionId).append(")"); + return buffer.toString(); + } + } + + /** + * Represents the configuration of a step in a wizard + * i.e. the <step> element. + */ + public static class StepConfig extends AbstractConfig implements Serializable + { + private static final long serialVersionUID = -3707570689181455754L; + + protected String name; + protected PageConfig defaultPage; + protected List conditionalPages = + new ArrayList(3); + + public StepConfig(String name, + String title, String titleId, + String description, String descriptionId) + { + super(title, titleId, description, descriptionId); + + // check we have a name + ParameterCheck.mandatoryString("name", name); + + // check we have a title + if (this.title == null && this.titleId == null) + { + throw new IllegalArgumentException("A title or title-id attribute must be supplied for a step"); + } + + this.name = name; + } + + public String getName() + { + return this.name; + } + + public PageConfig getDefaultPage() + { + return this.defaultPage; + } + + public boolean hasConditionalPages() + { + return (this.conditionalPages.size() > 0); + } + + public List getConditionalPages() + { + return this.conditionalPages; + } + + /*package*/ void addConditionalPage(ConditionalPageConfig conditionalPage) + { + this.conditionalPages.add(conditionalPage); + } + + /*package*/ void setDefaultPage(PageConfig page) + { + this.defaultPage = page; + } + + /** + * @see java.lang.Object#toString() + */ + @Override + public String toString() + { + StringBuilder buffer = new StringBuilder(super.toString()); + buffer.append(" (name=").append(this.name); + buffer.append(" title=").append(this.title); + buffer.append(" titleId=").append(this.titleId); + buffer.append(" description=").append(this.description); + buffer.append(" descriptionId=").append(this.descriptionId); + buffer.append(" defaultPage=").append(this.defaultPage); + buffer.append(" conditionalPages=").append(this.conditionalPages).append(")"); + return buffer.toString(); + } + } +} diff --git a/source/java/org/alfresco/web/config/WizardsElementReader.java b/source/java/org/alfresco/web/config/WizardsElementReader.java index 11da61b471..17df0d9909 100644 --- a/source/java/org/alfresco/web/config/WizardsElementReader.java +++ b/source/java/org/alfresco/web/config/WizardsElementReader.java @@ -1,159 +1,159 @@ -package org.alfresco.web.config; - -import java.util.Iterator; - -import org.springframework.extensions.config.ConfigElement; -import org.springframework.extensions.config.ConfigException; -import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; -import org.alfresco.web.config.WizardsConfigElement.ConditionalPageConfig; -import org.alfresco.web.config.WizardsConfigElement.PageConfig; -import org.alfresco.web.config.WizardsConfigElement.StepConfig; -import org.dom4j.Element; - -/** - * Custom element reader to parse config for wizards - * - * @author gavinc - */ -public class WizardsElementReader implements ConfigElementReader -{ - public static final String ELEMENT_WIZARDS = "wizards"; - public static final String ELEMENT_WIZARD = "wizard"; - public static final String ELEMENT_STEP = "step"; - public static final String ELEMENT_PAGE = "page"; - public static final String ELEMENT_CONDITION = "condition"; - - public static final String ATTR_NAME = "name"; - public static final String ATTR_MANAGED_BEAN = "managed-bean"; - public static final String ATTR_ICON = "icon"; - public static final String ATTR_TITLE = "title"; - public static final String ATTR_TITLE_ID = "title-id"; - public static final String ATTR_SUBTITLE = "subtitle"; - public static final String ATTR_SUBTITLE_ID = "subtitle-id"; - public static final String ATTR_DESCRIPTION = "description"; - public static final String ATTR_DESCRIPTION_ID = "description-id"; - public static final String ATTR_INSTRUCTION = "instruction"; - public static final String ATTR_INSTRUCTION_ID = "instruction-id"; - public static final String ATTR_ERROR_MSG_ID = "error-message-id"; - public static final String ATTR_IF = "if"; - public static final String ATTR_PATH = "path"; - - /** - * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) - */ - public ConfigElement parse(Element element) - { - WizardsConfigElement configElement = null; - - if (element != null) - { - String elementName = element.getName(); - if (elementName.equals(ELEMENT_WIZARDS) == false) - { - throw new ConfigException("WizardsElementReader can only parse " + - ELEMENT_WIZARDS + "elements, the element passed was '" + - elementName + "'"); - } - - configElement = new WizardsConfigElement(); - - // go through the items to show - Iterator items = element.elementIterator(ELEMENT_WIZARD); - while (items.hasNext()) - { - Element wizard = items.next(); - - String name = wizard.attributeValue(ATTR_NAME); - String bean = wizard.attributeValue(ATTR_MANAGED_BEAN); - String icon = wizard.attributeValue(ATTR_ICON); - String title = wizard.attributeValue(ATTR_TITLE); - String titleId = wizard.attributeValue(ATTR_TITLE_ID); - String subTitle = wizard.attributeValue(ATTR_SUBTITLE); - String subTitleId = wizard.attributeValue(ATTR_SUBTITLE_ID); - String description = wizard.attributeValue(ATTR_DESCRIPTION); - String descriptionId = wizard.attributeValue(ATTR_DESCRIPTION_ID); - String errorMsgId = wizard.attributeValue(ATTR_ERROR_MSG_ID); - - // create the wizard config object - WizardsConfigElement.WizardConfig wizardCfg = new WizardsConfigElement.WizardConfig( - name, bean, icon, title, titleId, subTitle, subTitleId, - description, descriptionId, errorMsgId); - - Iterator steps = wizard.elementIterator(ELEMENT_STEP); - while (steps.hasNext()) - { - StepConfig stepCfg = parseStep(steps.next()); - wizardCfg.addStep(stepCfg); - } - - configElement.addWizard(wizardCfg); - } - } - - return configElement; - } - - /** - * Parses the given element which represents a step in a wizard - * - * @param step The Element representing the step - * @return A StepConfig object - */ - protected StepConfig parseStep(Element step) - { - // get the name of the step and create the config object - String stepName = step.attributeValue(ATTR_NAME); - String stepTitle = step.attributeValue(ATTR_TITLE); - String stepTitleId = step.attributeValue(ATTR_TITLE_ID); - String stepDescription = step.attributeValue(ATTR_DESCRIPTION); - String stepDescriptionId = step.attributeValue(ATTR_DESCRIPTION_ID); - StepConfig stepCfg = new StepConfig(stepName, stepTitle, stepTitleId, - stepDescription, stepDescriptionId); - - // find and parse the default page - Element defaultPageElem = step.element(ELEMENT_PAGE); - if (defaultPageElem != null) - { - String path = defaultPageElem.attributeValue(ATTR_PATH); - String title = defaultPageElem.attributeValue(ATTR_TITLE); - String titleId = defaultPageElem.attributeValue(ATTR_TITLE_ID); - String description = defaultPageElem.attributeValue(ATTR_DESCRIPTION); - String descriptionId = defaultPageElem.attributeValue(ATTR_DESCRIPTION_ID); - String instruction = defaultPageElem.attributeValue(ATTR_INSTRUCTION); - String instructionId = defaultPageElem.attributeValue(ATTR_INSTRUCTION_ID); - - // create and set the page config on the step - stepCfg.setDefaultPage(new PageConfig(path, title, titleId, description, - descriptionId, instruction, instructionId)); - } - - // find and parse any conditions that are present - Iterator conditions = step.elementIterator(ELEMENT_CONDITION); - while (conditions.hasNext()) - { - Element conditionElem = conditions.next(); - - String ifAttr = conditionElem.attributeValue(ATTR_IF); - Element conditionalPageElem = conditionElem.element(ELEMENT_PAGE); - if (conditionalPageElem == null) - { - throw new ConfigException("A condition in step '" + stepCfg.getName() + - "' does not have a containing element"); - } - - String path = conditionalPageElem.attributeValue(ATTR_PATH); - String title = conditionalPageElem.attributeValue(ATTR_TITLE); - String titleId = conditionalPageElem.attributeValue(ATTR_TITLE_ID); - String description = conditionalPageElem.attributeValue(ATTR_DESCRIPTION); - String descriptionId = conditionalPageElem.attributeValue(ATTR_DESCRIPTION_ID); - String instruction = conditionalPageElem.attributeValue(ATTR_INSTRUCTION); - String instructionId = conditionalPageElem.attributeValue(ATTR_INSTRUCTION_ID); - - // create and add the page to the step - stepCfg.addConditionalPage(new ConditionalPageConfig(path, ifAttr, title, - titleId, description, descriptionId, instruction, instructionId)); - } - - return stepCfg; - } -} +package org.alfresco.web.config; + +import java.util.Iterator; + +import org.springframework.extensions.config.ConfigElement; +import org.springframework.extensions.config.ConfigException; +import org.springframework.extensions.config.xml.elementreader.ConfigElementReader; +import org.alfresco.web.config.WizardsConfigElement.ConditionalPageConfig; +import org.alfresco.web.config.WizardsConfigElement.PageConfig; +import org.alfresco.web.config.WizardsConfigElement.StepConfig; +import org.dom4j.Element; + +/** + * Custom element reader to parse config for wizards + * + * @author gavinc + */ +public class WizardsElementReader implements ConfigElementReader +{ + public static final String ELEMENT_WIZARDS = "wizards"; + public static final String ELEMENT_WIZARD = "wizard"; + public static final String ELEMENT_STEP = "step"; + public static final String ELEMENT_PAGE = "page"; + public static final String ELEMENT_CONDITION = "condition"; + + public static final String ATTR_NAME = "name"; + public static final String ATTR_MANAGED_BEAN = "managed-bean"; + public static final String ATTR_ICON = "icon"; + public static final String ATTR_TITLE = "title"; + public static final String ATTR_TITLE_ID = "title-id"; + public static final String ATTR_SUBTITLE = "subtitle"; + public static final String ATTR_SUBTITLE_ID = "subtitle-id"; + public static final String ATTR_DESCRIPTION = "description"; + public static final String ATTR_DESCRIPTION_ID = "description-id"; + public static final String ATTR_INSTRUCTION = "instruction"; + public static final String ATTR_INSTRUCTION_ID = "instruction-id"; + public static final String ATTR_ERROR_MSG_ID = "error-message-id"; + public static final String ATTR_IF = "if"; + public static final String ATTR_PATH = "path"; + + /** + * @see org.springframework.extensions.config.xml.elementreader.ConfigElementReader#parse(org.dom4j.Element) + */ + public ConfigElement parse(Element element) + { + WizardsConfigElement configElement = null; + + if (element != null) + { + String elementName = element.getName(); + if (elementName.equals(ELEMENT_WIZARDS) == false) + { + throw new ConfigException("WizardsElementReader can only parse " + + ELEMENT_WIZARDS + "elements, the element passed was '" + + elementName + "'"); + } + + configElement = new WizardsConfigElement(); + + // go through the items to show + Iterator items = element.elementIterator(ELEMENT_WIZARD); + while (items.hasNext()) + { + Element wizard = items.next(); + + String name = wizard.attributeValue(ATTR_NAME); + String bean = wizard.attributeValue(ATTR_MANAGED_BEAN); + String icon = wizard.attributeValue(ATTR_ICON); + String title = wizard.attributeValue(ATTR_TITLE); + String titleId = wizard.attributeValue(ATTR_TITLE_ID); + String subTitle = wizard.attributeValue(ATTR_SUBTITLE); + String subTitleId = wizard.attributeValue(ATTR_SUBTITLE_ID); + String description = wizard.attributeValue(ATTR_DESCRIPTION); + String descriptionId = wizard.attributeValue(ATTR_DESCRIPTION_ID); + String errorMsgId = wizard.attributeValue(ATTR_ERROR_MSG_ID); + + // create the wizard config object + WizardsConfigElement.WizardConfig wizardCfg = new WizardsConfigElement.WizardConfig( + name, bean, icon, title, titleId, subTitle, subTitleId, + description, descriptionId, errorMsgId); + + Iterator steps = wizard.elementIterator(ELEMENT_STEP); + while (steps.hasNext()) + { + StepConfig stepCfg = parseStep(steps.next()); + wizardCfg.addStep(stepCfg); + } + + configElement.addWizard(wizardCfg); + } + } + + return configElement; + } + + /** + * Parses the given element which represents a step in a wizard + * + * @param step The Element representing the step + * @return A StepConfig object + */ + protected StepConfig parseStep(Element step) + { + // get the name of the step and create the config object + String stepName = step.attributeValue(ATTR_NAME); + String stepTitle = step.attributeValue(ATTR_TITLE); + String stepTitleId = step.attributeValue(ATTR_TITLE_ID); + String stepDescription = step.attributeValue(ATTR_DESCRIPTION); + String stepDescriptionId = step.attributeValue(ATTR_DESCRIPTION_ID); + StepConfig stepCfg = new StepConfig(stepName, stepTitle, stepTitleId, + stepDescription, stepDescriptionId); + + // find and parse the default page + Element defaultPageElem = step.element(ELEMENT_PAGE); + if (defaultPageElem != null) + { + String path = defaultPageElem.attributeValue(ATTR_PATH); + String title = defaultPageElem.attributeValue(ATTR_TITLE); + String titleId = defaultPageElem.attributeValue(ATTR_TITLE_ID); + String description = defaultPageElem.attributeValue(ATTR_DESCRIPTION); + String descriptionId = defaultPageElem.attributeValue(ATTR_DESCRIPTION_ID); + String instruction = defaultPageElem.attributeValue(ATTR_INSTRUCTION); + String instructionId = defaultPageElem.attributeValue(ATTR_INSTRUCTION_ID); + + // create and set the page config on the step + stepCfg.setDefaultPage(new PageConfig(path, title, titleId, description, + descriptionId, instruction, instructionId)); + } + + // find and parse any conditions that are present + Iterator conditions = step.elementIterator(ELEMENT_CONDITION); + while (conditions.hasNext()) + { + Element conditionElem = conditions.next(); + + String ifAttr = conditionElem.attributeValue(ATTR_IF); + Element conditionalPageElem = conditionElem.element(ELEMENT_PAGE); + if (conditionalPageElem == null) + { + throw new ConfigException("A condition in step '" + stepCfg.getName() + + "' does not have a containing element"); + } + + String path = conditionalPageElem.attributeValue(ATTR_PATH); + String title = conditionalPageElem.attributeValue(ATTR_TITLE); + String titleId = conditionalPageElem.attributeValue(ATTR_TITLE_ID); + String description = conditionalPageElem.attributeValue(ATTR_DESCRIPTION); + String descriptionId = conditionalPageElem.attributeValue(ATTR_DESCRIPTION_ID); + String instruction = conditionalPageElem.attributeValue(ATTR_INSTRUCTION); + String instructionId = conditionalPageElem.attributeValue(ATTR_INSTRUCTION_ID); + + // create and add the page to the step + stepCfg.addConditionalPage(new ConditionalPageConfig(path, ifAttr, title, + titleId, description, descriptionId, instruction, instructionId)); + } + + return stepCfg; + } +} diff --git a/source/java/org/alfresco/web/ui/common/component/UISelectList.java b/source/java/org/alfresco/web/ui/common/component/UISelectList.java index ac6ce385c6..c4e8ed5b0a 100644 --- a/source/java/org/alfresco/web/ui/common/component/UISelectList.java +++ b/source/java/org/alfresco/web/ui/common/component/UISelectList.java @@ -1,643 +1,643 @@ -package org.alfresco.web.ui.common.component; - -import java.io.IOException; -import java.util.Collection; -import java.util.Iterator; -import java.util.List; -import java.util.Map; - -import javax.faces.component.NamingContainer; -import javax.faces.component.UICommand; -import javax.faces.component.UIComponent; -import javax.faces.component.UIForm; -import javax.faces.component.UIInput; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.ValueBinding; -import javax.faces.event.AbortProcessingException; -import javax.faces.event.FacesEvent; -import javax.faces.event.FacesListener; -import javax.faces.event.PhaseId; - -import org.alfresco.web.ui.common.Utils; - -/** - * The SelectList component displays a graphical list of items, each with a label and icon image. - * The list has three selection modes; single select (radio), multi-select (checkbox) and active - * selection mode (child action components). - * - * The value for the component is collection of UIListItem objects or a UIListItems instance. - * - * For passive single and multi-select modes, the selected value(s) can be retrieved from the component. - * For active selection mode, appropriate child components such as Command buttons or Action Links - * will be rendered for each item in the list, data-binding to the specified 'var' variable should be - * used to bind required params. It is then up to the developer to retrieve the selected item param - * from the actionListener of the appropriate child component. - * - * @author Kevin Roast - */ -public class UISelectList extends UIInput implements NamingContainer -{ - private Boolean multiSelect; - private Boolean activeSelect; - private int rowIndex = -1; - private int itemCount; - private String onchange = null; - private Boolean escapeItemLabel; - private Boolean escapeItemDescription; - - // ------------------------------------------------------------------------------ - // Component Impl - - /** - * Default constructor - */ - public UISelectList() - { - setRendererType(null); - } - - /** - * @see javax.faces.component.UIComponent#getFamily() - */ - public String getFamily() - { - return "org.alfresco.faces.Controls"; - } - - /** - * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) - */ - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.multiSelect = (Boolean)values[1]; - this.activeSelect = (Boolean)values[2]; - this.itemCount = (Integer)values[3]; - this.onchange = (String)values[4]; - this.escapeItemLabel = (Boolean)values[5]; - this.escapeItemDescription = (Boolean)values[6]; - } - - /** - * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) - */ - public Object saveState(FacesContext context) - { - return new Object[] - { - super.saveState(context), - this.multiSelect, - this.activeSelect, - this.itemCount, - this.onchange, - this.escapeItemLabel, - this.escapeItemDescription - }; - } - - /** - * @return the client Id for this naming container component - based on the current row context. - * This allows a single component rendered multiple times in a list to dynamically base - * their ID on the current row - so that the 'correct' component is decoded and event is - * queued with the current row value. - */ - @Override - public String getClientId(FacesContext context) - { - String clientId = super.getClientId(context); - int rowIndex = getRowIndex(); - return (rowIndex == -1 ? clientId : clientId + "_" + rowIndex); - } - - /** - * Override the processing of child component decodes - we set the current row context so any - * events queued by child components wrapped in FacesEventWrapper have current row value. - */ - @Override - public void processDecodes(FacesContext context) - { - if (!isRendered()) - { - return; - } - - setRowIndex(-1); - for (UIComponent child : (List)this.getChildren()) - { - if (child instanceof UIListItem == false && child instanceof UIListItems == false) - { - for (int i=0; i"); - } - - /** - * Render a list item in the appropriate selection mode - * - * @param context FacesContext - * @param out ResponseWriter - * @param item UIListItem representing the item to render - */ - private void renderItem(FacesContext context, ResponseWriter out, UIListItem item) - throws IOException - { - boolean activeSelect = isActiveSelect(); - boolean escapeLabel = getEscapeItemLabel(); - boolean escapeDescription = getEscapeItemDescription(); - - // begin the row, add tooltip if present - String tooltip = item.getTooltip(); - out.write(""); - - if (activeSelect == false) - { - // we are rendering passive select list, so either multi or single selection using - // checkboxes or radio button control respectively - boolean multiSelect = isMultiSelect(); - String id = getClientId(context); - String itemValue = item.getValue().toString(); - out.write(""); - } - - // optional 32x32 pixel icon - String icon = item.getImage(); - if (icon != null) - { - out.write(""); // give pixel space around edges - out.write(Utils.buildImageTag(context, icon, 32, 32, "")); - out.write(""); - } - - // label and description text - String label = item.getLabel(); - String description = item.getDescription(); - out.write("
"); - if (escapeLabel) - { - out.write(Utils.encode(label)); - } - else - { - out.write(label); - } - out.write("
"); - if (description != null) - { - out.write("
"); - if (escapeDescription) - { - out.write(Utils.encode(description)); - } - else - { - out.write(description); - } - out.write("
"); - } - out.write(""); - - if (activeSelect) - { - // we are rendering an active select list with child components next to each item - // get the child components and look for compatible Command objects - out.write("'); - for (Iterator i = getChildren().iterator(); i.hasNext(); /**/) - { - UIComponent child = (UIComponent)i.next(); - if (child instanceof UICommand) - { - out.write(""); - Utils.encodeRecursive(context, child); - out.write(""); - } - } - out.write(""); - } - } - - - // ------------------------------------------------------------------------------ - // Strongly typed property accessors - - /** - * @return current row index - */ - public int getRowIndex() - { - return this.rowIndex; - } - - /** - * Set the transient current row index. Setting this value causes all child components to - * have their ID values reset - so that cached clientID values are regenerated when next requested. - * - * @param rowIndex int - */ - public void setRowIndex(int rowIndex) - { - if (isActiveSelect()) - { - this.rowIndex = rowIndex; - for (UIComponent child : (List)this.getChildren()) - { - if (child instanceof UIListItem == false && child instanceof UIListItems == false) - { - // forces a reset of the clientId for the component - // This is then regenerated - relative to this naming container which itself uses the - // current row index as part of the Id. This is what facilities the correct component - // rendering submit script and then identified during the decode() phase. - child.setId(child.getId()); - } - } - } - } - - /** - * Get the multi-select rendering flag - * - * @return true for multi-select rendering, false otherwise - */ - public boolean isMultiSelect() - { - ValueBinding vb = getValueBinding("multiSelect"); - if (vb != null) - { - this.multiSelect = (Boolean)vb.getValue(getFacesContext()); - } - - return this.multiSelect != null ? this.multiSelect.booleanValue() : false; - } - - /** - * Set true for multi-select rendering, false otherwise - * - * @param multiSelect True for multi-select - */ - public void setMultiSelect(boolean multiSelect) - { - this.multiSelect = multiSelect; - } - - /** - * Get the active selection mode flag - * - * @return true for active selection mode, false otherwise - */ - public boolean isActiveSelect() - { - ValueBinding vb = getValueBinding("activeSelect"); - if (vb != null) - { - this.activeSelect = (Boolean)vb.getValue(getFacesContext()); - } - - return this.activeSelect != null ? this.activeSelect.booleanValue() : false; - } - - /** - * Set true for active selection mode, false otherwise - * - * @param activeSelect True for active selection - */ - public void setActiveSelect(boolean activeSelect) - { - this.activeSelect = activeSelect; - } - - /** - * Get the escape item label flag - * - * @return true if the items label should be escaped, false otherwise - */ - public boolean getEscapeItemLabel() - { - ValueBinding vb = getValueBinding("escapeItemLabel"); - if (vb != null) - { - this.escapeItemLabel = (Boolean)vb.getValue(getFacesContext()); - } - - return this.escapeItemLabel != null ? this.escapeItemLabel.booleanValue() : true; - } - - /** - * Set true to escape the items label, false otherwise - * - * @param escapeItemLabel true to escape the items label - */ - public void setEscapeItemLabel(boolean escapeItemLabel) - { - this.escapeItemLabel = escapeItemLabel; - } - - /** - * Get the escape item description flag - * - * @return true if the items description should be escaped, false otherwise - */ - public boolean getEscapeItemDescription() - { - ValueBinding vb = getValueBinding("escapeItemDescription"); - if (vb != null) - { - this.escapeItemDescription = (Boolean)vb.getValue(getFacesContext()); - } - - return this.escapeItemDescription != null ? this.escapeItemDescription.booleanValue() : true; - } - - /** - * Set true to escape the items description, false otherwise - * - * @param escapeItemDescription true to escape the items description - */ - public void setEscapeItemDescription(boolean escapeItemDescription) - { - this.escapeItemDescription = escapeItemDescription; - } - - /** - * We use a hidden field name based on the parent form component Id and - * the string "selectlist" to give a hidden field name that can be shared by all - * SelectList components within a single UIForm component. - * - * @return hidden field name - */ - private static String getHiddenFieldName(FacesContext context, UIComponent component) - { - UIForm form = Utils.getParentForm(context, component); - return form.getClientId(context) + NamingContainer.SEPARATOR_CHAR + "selectlist"; - } - - - /** - * Wrapper for a FacesEvent to hold current row value when the event was fired - */ - private static class FacesEventWrapper extends FacesEvent - { - private FacesEvent wrappedFacesEvent; - private int rowIndex; - - public FacesEventWrapper(FacesEvent facesEvent, int rowIndex, UISelectList redirectComponent) - { - super(redirectComponent); - wrappedFacesEvent = facesEvent; - this.rowIndex = rowIndex; - } - - public PhaseId getPhaseId() - { - return wrappedFacesEvent.getPhaseId(); - } - - public void setPhaseId(PhaseId phaseId) - { - wrappedFacesEvent.setPhaseId(phaseId); - } - - public void queue() - { - wrappedFacesEvent.queue(); - } - - public String toString() - { - return wrappedFacesEvent.toString(); - } - - public boolean isAppropriateListener(FacesListener faceslistener) - { - return wrappedFacesEvent.isAppropriateListener(faceslistener); - } - - public void processListener(FacesListener faceslistener) - { - wrappedFacesEvent.processListener(faceslistener); - } - - public FacesEvent getWrappedFacesEvent() - { - return wrappedFacesEvent; - } - - public int getRowIndex() - { - return rowIndex; - } - } -} +package org.alfresco.web.ui.common.component; + +import java.io.IOException; +import java.util.Collection; +import java.util.Iterator; +import java.util.List; +import java.util.Map; + +import javax.faces.component.NamingContainer; +import javax.faces.component.UICommand; +import javax.faces.component.UIComponent; +import javax.faces.component.UIForm; +import javax.faces.component.UIInput; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.ValueBinding; +import javax.faces.event.AbortProcessingException; +import javax.faces.event.FacesEvent; +import javax.faces.event.FacesListener; +import javax.faces.event.PhaseId; + +import org.alfresco.web.ui.common.Utils; + +/** + * The SelectList component displays a graphical list of items, each with a label and icon image. + * The list has three selection modes; single select (radio), multi-select (checkbox) and active + * selection mode (child action components). + * + * The value for the component is collection of UIListItem objects or a UIListItems instance. + * + * For passive single and multi-select modes, the selected value(s) can be retrieved from the component. + * For active selection mode, appropriate child components such as Command buttons or Action Links + * will be rendered for each item in the list, data-binding to the specified 'var' variable should be + * used to bind required params. It is then up to the developer to retrieve the selected item param + * from the actionListener of the appropriate child component. + * + * @author Kevin Roast + */ +public class UISelectList extends UIInput implements NamingContainer +{ + private Boolean multiSelect; + private Boolean activeSelect; + private int rowIndex = -1; + private int itemCount; + private String onchange = null; + private Boolean escapeItemLabel; + private Boolean escapeItemDescription; + + // ------------------------------------------------------------------------------ + // Component Impl + + /** + * Default constructor + */ + public UISelectList() + { + setRendererType(null); + } + + /** + * @see javax.faces.component.UIComponent#getFamily() + */ + public String getFamily() + { + return "org.alfresco.faces.Controls"; + } + + /** + * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) + */ + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.multiSelect = (Boolean)values[1]; + this.activeSelect = (Boolean)values[2]; + this.itemCount = (Integer)values[3]; + this.onchange = (String)values[4]; + this.escapeItemLabel = (Boolean)values[5]; + this.escapeItemDescription = (Boolean)values[6]; + } + + /** + * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) + */ + public Object saveState(FacesContext context) + { + return new Object[] + { + super.saveState(context), + this.multiSelect, + this.activeSelect, + this.itemCount, + this.onchange, + this.escapeItemLabel, + this.escapeItemDescription + }; + } + + /** + * @return the client Id for this naming container component - based on the current row context. + * This allows a single component rendered multiple times in a list to dynamically base + * their ID on the current row - so that the 'correct' component is decoded and event is + * queued with the current row value. + */ + @Override + public String getClientId(FacesContext context) + { + String clientId = super.getClientId(context); + int rowIndex = getRowIndex(); + return (rowIndex == -1 ? clientId : clientId + "_" + rowIndex); + } + + /** + * Override the processing of child component decodes - we set the current row context so any + * events queued by child components wrapped in FacesEventWrapper have current row value. + */ + @Override + public void processDecodes(FacesContext context) + { + if (!isRendered()) + { + return; + } + + setRowIndex(-1); + for (UIComponent child : (List)this.getChildren()) + { + if (child instanceof UIListItem == false && child instanceof UIListItems == false) + { + for (int i=0; i"); + } + + /** + * Render a list item in the appropriate selection mode + * + * @param context FacesContext + * @param out ResponseWriter + * @param item UIListItem representing the item to render + */ + private void renderItem(FacesContext context, ResponseWriter out, UIListItem item) + throws IOException + { + boolean activeSelect = isActiveSelect(); + boolean escapeLabel = getEscapeItemLabel(); + boolean escapeDescription = getEscapeItemDescription(); + + // begin the row, add tooltip if present + String tooltip = item.getTooltip(); + out.write(""); + + if (activeSelect == false) + { + // we are rendering passive select list, so either multi or single selection using + // checkboxes or radio button control respectively + boolean multiSelect = isMultiSelect(); + String id = getClientId(context); + String itemValue = item.getValue().toString(); + out.write(""); + } + + // optional 32x32 pixel icon + String icon = item.getImage(); + if (icon != null) + { + out.write(""); // give pixel space around edges + out.write(Utils.buildImageTag(context, icon, 32, 32, "")); + out.write(""); + } + + // label and description text + String label = item.getLabel(); + String description = item.getDescription(); + out.write("
"); + if (escapeLabel) + { + out.write(Utils.encode(label)); + } + else + { + out.write(label); + } + out.write("
"); + if (description != null) + { + out.write("
"); + if (escapeDescription) + { + out.write(Utils.encode(description)); + } + else + { + out.write(description); + } + out.write("
"); + } + out.write(""); + + if (activeSelect) + { + // we are rendering an active select list with child components next to each item + // get the child components and look for compatible Command objects + out.write("'); + for (Iterator i = getChildren().iterator(); i.hasNext(); /**/) + { + UIComponent child = (UIComponent)i.next(); + if (child instanceof UICommand) + { + out.write(""); + Utils.encodeRecursive(context, child); + out.write(""); + } + } + out.write(""); + } + } + + + // ------------------------------------------------------------------------------ + // Strongly typed property accessors + + /** + * @return current row index + */ + public int getRowIndex() + { + return this.rowIndex; + } + + /** + * Set the transient current row index. Setting this value causes all child components to + * have their ID values reset - so that cached clientID values are regenerated when next requested. + * + * @param rowIndex int + */ + public void setRowIndex(int rowIndex) + { + if (isActiveSelect()) + { + this.rowIndex = rowIndex; + for (UIComponent child : (List)this.getChildren()) + { + if (child instanceof UIListItem == false && child instanceof UIListItems == false) + { + // forces a reset of the clientId for the component + // This is then regenerated - relative to this naming container which itself uses the + // current row index as part of the Id. This is what facilities the correct component + // rendering submit script and then identified during the decode() phase. + child.setId(child.getId()); + } + } + } + } + + /** + * Get the multi-select rendering flag + * + * @return true for multi-select rendering, false otherwise + */ + public boolean isMultiSelect() + { + ValueBinding vb = getValueBinding("multiSelect"); + if (vb != null) + { + this.multiSelect = (Boolean)vb.getValue(getFacesContext()); + } + + return this.multiSelect != null ? this.multiSelect.booleanValue() : false; + } + + /** + * Set true for multi-select rendering, false otherwise + * + * @param multiSelect True for multi-select + */ + public void setMultiSelect(boolean multiSelect) + { + this.multiSelect = multiSelect; + } + + /** + * Get the active selection mode flag + * + * @return true for active selection mode, false otherwise + */ + public boolean isActiveSelect() + { + ValueBinding vb = getValueBinding("activeSelect"); + if (vb != null) + { + this.activeSelect = (Boolean)vb.getValue(getFacesContext()); + } + + return this.activeSelect != null ? this.activeSelect.booleanValue() : false; + } + + /** + * Set true for active selection mode, false otherwise + * + * @param activeSelect True for active selection + */ + public void setActiveSelect(boolean activeSelect) + { + this.activeSelect = activeSelect; + } + + /** + * Get the escape item label flag + * + * @return true if the items label should be escaped, false otherwise + */ + public boolean getEscapeItemLabel() + { + ValueBinding vb = getValueBinding("escapeItemLabel"); + if (vb != null) + { + this.escapeItemLabel = (Boolean)vb.getValue(getFacesContext()); + } + + return this.escapeItemLabel != null ? this.escapeItemLabel.booleanValue() : true; + } + + /** + * Set true to escape the items label, false otherwise + * + * @param escapeItemLabel true to escape the items label + */ + public void setEscapeItemLabel(boolean escapeItemLabel) + { + this.escapeItemLabel = escapeItemLabel; + } + + /** + * Get the escape item description flag + * + * @return true if the items description should be escaped, false otherwise + */ + public boolean getEscapeItemDescription() + { + ValueBinding vb = getValueBinding("escapeItemDescription"); + if (vb != null) + { + this.escapeItemDescription = (Boolean)vb.getValue(getFacesContext()); + } + + return this.escapeItemDescription != null ? this.escapeItemDescription.booleanValue() : true; + } + + /** + * Set true to escape the items description, false otherwise + * + * @param escapeItemDescription true to escape the items description + */ + public void setEscapeItemDescription(boolean escapeItemDescription) + { + this.escapeItemDescription = escapeItemDescription; + } + + /** + * We use a hidden field name based on the parent form component Id and + * the string "selectlist" to give a hidden field name that can be shared by all + * SelectList components within a single UIForm component. + * + * @return hidden field name + */ + private static String getHiddenFieldName(FacesContext context, UIComponent component) + { + UIForm form = Utils.getParentForm(context, component); + return form.getClientId(context) + NamingContainer.SEPARATOR_CHAR + "selectlist"; + } + + + /** + * Wrapper for a FacesEvent to hold current row value when the event was fired + */ + private static class FacesEventWrapper extends FacesEvent + { + private FacesEvent wrappedFacesEvent; + private int rowIndex; + + public FacesEventWrapper(FacesEvent facesEvent, int rowIndex, UISelectList redirectComponent) + { + super(redirectComponent); + wrappedFacesEvent = facesEvent; + this.rowIndex = rowIndex; + } + + public PhaseId getPhaseId() + { + return wrappedFacesEvent.getPhaseId(); + } + + public void setPhaseId(PhaseId phaseId) + { + wrappedFacesEvent.setPhaseId(phaseId); + } + + public void queue() + { + wrappedFacesEvent.queue(); + } + + public String toString() + { + return wrappedFacesEvent.toString(); + } + + public boolean isAppropriateListener(FacesListener faceslistener) + { + return wrappedFacesEvent.isAppropriateListener(faceslistener); + } + + public void processListener(FacesListener faceslistener) + { + wrappedFacesEvent.processListener(faceslistener); + } + + public FacesEvent getWrappedFacesEvent() + { + return wrappedFacesEvent; + } + + public int getRowIndex() + { + return rowIndex; + } + } +} diff --git a/source/java/org/alfresco/web/ui/common/component/debug/UIRepositoryProperties.java b/source/java/org/alfresco/web/ui/common/component/debug/UIRepositoryProperties.java index aacf118e47..612aa8dfd2 100644 --- a/source/java/org/alfresco/web/ui/common/component/debug/UIRepositoryProperties.java +++ b/source/java/org/alfresco/web/ui/common/component/debug/UIRepositoryProperties.java @@ -1,73 +1,73 @@ -package org.alfresco.web.ui.common.component.debug; - -import java.util.List; -import java.util.Map; -import java.util.TreeMap; - -import javax.faces.context.FacesContext; - -import org.alfresco.repo.admin.patch.AppliedPatch; -import org.alfresco.repo.admin.patch.PatchService; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.descriptor.Descriptor; -import org.alfresco.service.descriptor.DescriptorService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.springframework.web.context.WebApplicationContext; -import org.springframework.web.jsf.FacesContextUtils; - -/** - * Component which displays the Alfresco Repository properties - * - * @author kevinr - */ -public class UIRepositoryProperties extends BaseDebugComponent -{ - /** - * @see javax.faces.component.UIComponent#getFamily() - */ - public String getFamily() - { - return "org.alfresco.faces.debug.RepositoryProperties"; - } - - /** - * @see org.alfresco.web.ui.common.component.debug.BaseDebugComponent#getDebugData() - */ - @SuppressWarnings("unchecked") - public Map getDebugData() - { - // note: sort properties - Map properties = new TreeMap(); - - FacesContext fc = FacesContext.getCurrentInstance(); - ServiceRegistry services = Repository.getServiceRegistry(fc); - DescriptorService descriptorService = services.getDescriptorService(); - - Descriptor installedRepoDescriptor = descriptorService.getInstalledRepositoryDescriptor(); - properties.put("Installed Version", installedRepoDescriptor.getVersion()); - properties.put("Installed Schema", installedRepoDescriptor.getSchema()); - - Descriptor systemDescriptor = descriptorService.getServerDescriptor(); - properties.put("Server Version", systemDescriptor.getVersion()); - properties.put("Server Schema", systemDescriptor.getSchema()); - - WebApplicationContext cx = FacesContextUtils.getRequiredWebApplicationContext(fc); - PatchService patchService = (PatchService)cx.getBean("PatchService"); - List patches = patchService.getPatches(null, null); - for (AppliedPatch patch : patches) - { - StringBuilder data = new StringBuilder(256); - data.append(patch.getAppliedOnDate()) - .append(" - ") - .append(patch.getDescription()) - .append(" - ") - .append(patch.getSucceeded() == true ? - Application.getMessage(fc, "repository_patch_succeeded") : - Application.getMessage(fc, "repository_patch_failed")); - properties.put(patch.getId(), data); - } - - return properties; - } -} +package org.alfresco.web.ui.common.component.debug; + +import java.util.List; +import java.util.Map; +import java.util.TreeMap; + +import javax.faces.context.FacesContext; + +import org.alfresco.repo.admin.patch.AppliedPatch; +import org.alfresco.repo.admin.patch.PatchService; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.descriptor.Descriptor; +import org.alfresco.service.descriptor.DescriptorService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.springframework.web.context.WebApplicationContext; +import org.springframework.web.jsf.FacesContextUtils; + +/** + * Component which displays the Alfresco Repository properties + * + * @author kevinr + */ +public class UIRepositoryProperties extends BaseDebugComponent +{ + /** + * @see javax.faces.component.UIComponent#getFamily() + */ + public String getFamily() + { + return "org.alfresco.faces.debug.RepositoryProperties"; + } + + /** + * @see org.alfresco.web.ui.common.component.debug.BaseDebugComponent#getDebugData() + */ + @SuppressWarnings("unchecked") + public Map getDebugData() + { + // note: sort properties + Map properties = new TreeMap(); + + FacesContext fc = FacesContext.getCurrentInstance(); + ServiceRegistry services = Repository.getServiceRegistry(fc); + DescriptorService descriptorService = services.getDescriptorService(); + + Descriptor installedRepoDescriptor = descriptorService.getInstalledRepositoryDescriptor(); + properties.put("Installed Version", installedRepoDescriptor.getVersion()); + properties.put("Installed Schema", installedRepoDescriptor.getSchema()); + + Descriptor systemDescriptor = descriptorService.getServerDescriptor(); + properties.put("Server Version", systemDescriptor.getVersion()); + properties.put("Server Schema", systemDescriptor.getSchema()); + + WebApplicationContext cx = FacesContextUtils.getRequiredWebApplicationContext(fc); + PatchService patchService = (PatchService)cx.getBean("PatchService"); + List patches = patchService.getPatches(null, null); + for (AppliedPatch patch : patches) + { + StringBuilder data = new StringBuilder(256); + data.append(patch.getAppliedOnDate()) + .append(" - ") + .append(patch.getDescription()) + .append(" - ") + .append(patch.getSucceeded() == true ? + Application.getMessage(fc, "repository_patch_succeeded") : + Application.getMessage(fc, "repository_patch_failed")); + properties.put(patch.getId(), data); + } + + return properties; + } +} diff --git a/source/java/org/alfresco/web/ui/common/converter/MultiValueConverter.java b/source/java/org/alfresco/web/ui/common/converter/MultiValueConverter.java index 911785ba9d..e0c376c1f8 100644 --- a/source/java/org/alfresco/web/ui/common/converter/MultiValueConverter.java +++ b/source/java/org/alfresco/web/ui/common/converter/MultiValueConverter.java @@ -1,72 +1,72 @@ -package org.alfresco.web.ui.common.converter; - -import java.util.ArrayList; -import java.util.Collection; -import java.util.List; -import java.util.StringTokenizer; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.convert.Converter; -import javax.faces.convert.ConverterException; - -/** - * Converter class to convert a List of multiple values into a comma - * separated list. - * - * @author gavinc - */ -public class MultiValueConverter implements Converter -{ - /** - *

The standard converter id for this converter.

- */ - public static final String CONVERTER_ID = "org.alfresco.faces.MultiValueConverter"; - - /** - * @see javax.faces.convert.Converter#getAsObject(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.String) - */ - public Object getAsObject(FacesContext context, UIComponent component, String value) - throws ConverterException - { - List items = new ArrayList(); - StringTokenizer tokenizer = new StringTokenizer(value, ", "); - while (tokenizer.hasMoreTokens()) - { - items.add(tokenizer.nextToken().trim()); - } - - return items; - } - - /** - * @see javax.faces.convert.Converter#getAsString(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) - */ - public String getAsString(FacesContext context, UIComponent component, Object value) - throws ConverterException - { - String result = null; - - if (value instanceof Collection) - { - StringBuilder buffer = new StringBuilder(); - for (Object obj : (Collection)value) - { - if (buffer.length() != 0) - { - buffer.append(", "); - } - - buffer.append(obj.toString()); - } - - result = buffer.toString(); - } - else if (value != null) - { - result = value.toString(); - } - - return result; - } -} +package org.alfresco.web.ui.common.converter; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.StringTokenizer; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.convert.Converter; +import javax.faces.convert.ConverterException; + +/** + * Converter class to convert a List of multiple values into a comma + * separated list. + * + * @author gavinc + */ +public class MultiValueConverter implements Converter +{ + /** + *

The standard converter id for this converter.

+ */ + public static final String CONVERTER_ID = "org.alfresco.faces.MultiValueConverter"; + + /** + * @see javax.faces.convert.Converter#getAsObject(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.String) + */ + public Object getAsObject(FacesContext context, UIComponent component, String value) + throws ConverterException + { + List items = new ArrayList(); + StringTokenizer tokenizer = new StringTokenizer(value, ", "); + while (tokenizer.hasMoreTokens()) + { + items.add(tokenizer.nextToken().trim()); + } + + return items; + } + + /** + * @see javax.faces.convert.Converter#getAsString(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) + */ + public String getAsString(FacesContext context, UIComponent component, Object value) + throws ConverterException + { + String result = null; + + if (value instanceof Collection) + { + StringBuilder buffer = new StringBuilder(); + for (Object obj : (Collection)value) + { + if (buffer.length() != 0) + { + buffer.append(", "); + } + + buffer.append(obj.toString()); + } + + result = buffer.toString(); + } + else if (value != null) + { + result = value.toString(); + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/ui/common/renderer/ImagePickerRadioPanelRenderer.java b/source/java/org/alfresco/web/ui/common/renderer/ImagePickerRadioPanelRenderer.java index b5905afffc..74d1ac5cf7 100644 --- a/source/java/org/alfresco/web/ui/common/renderer/ImagePickerRadioPanelRenderer.java +++ b/source/java/org/alfresco/web/ui/common/renderer/ImagePickerRadioPanelRenderer.java @@ -1,55 +1,55 @@ -package org.alfresco.web.ui.common.renderer; - -import java.io.IOException; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; - -import org.alfresco.web.ui.common.PanelGenerator; - -/** - * Renderer for the image picker component that outputs the list of images - * as radio buttons within a rounded corner panel - * - * @author gavinc - */ -public class ImagePickerRadioPanelRenderer extends ImagePickerRadioRenderer -{ - /** - * @see javax.faces.render.Renderer#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - public void encodeBegin(FacesContext context, UIComponent component) throws IOException - { - if (component.isRendered() == false) - { - return; - } - - // output the start of the surrounding rounded corner panel - PanelGenerator.generatePanelStart(context.getResponseWriter(), - context.getExternalContext().getRequestContextPath(), - (String)component.getAttributes().get("panelBorder"), - (String)component.getAttributes().get("panelBgcolor")); - - super.encodeBegin(context, component); - } - - /** - * @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - public void encodeEnd(FacesContext context, UIComponent component) throws IOException - { - if (component.isRendered() == false) - { - return; - } - - super.encodeEnd(context, component); - - // output the end of the surrounding rounded corner panel - PanelGenerator.generatePanelEnd(context.getResponseWriter(), - context.getExternalContext().getRequestContextPath(), - (String)component.getAttributes().get("panelBorder")); - } -} +package org.alfresco.web.ui.common.renderer; + +import java.io.IOException; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; + +import org.alfresco.web.ui.common.PanelGenerator; + +/** + * Renderer for the image picker component that outputs the list of images + * as radio buttons within a rounded corner panel + * + * @author gavinc + */ +public class ImagePickerRadioPanelRenderer extends ImagePickerRadioRenderer +{ + /** + * @see javax.faces.render.Renderer#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + public void encodeBegin(FacesContext context, UIComponent component) throws IOException + { + if (component.isRendered() == false) + { + return; + } + + // output the start of the surrounding rounded corner panel + PanelGenerator.generatePanelStart(context.getResponseWriter(), + context.getExternalContext().getRequestContextPath(), + (String)component.getAttributes().get("panelBorder"), + (String)component.getAttributes().get("panelBgcolor")); + + super.encodeBegin(context, component); + } + + /** + * @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + public void encodeEnd(FacesContext context, UIComponent component) throws IOException + { + if (component.isRendered() == false) + { + return; + } + + super.encodeEnd(context, component); + + // output the end of the surrounding rounded corner panel + PanelGenerator.generatePanelEnd(context.getResponseWriter(), + context.getExternalContext().getRequestContextPath(), + (String)component.getAttributes().get("panelBorder")); + } +} \ No newline at end of file diff --git a/source/java/org/alfresco/web/ui/common/tag/ImagePickerRadioPanelTag.java b/source/java/org/alfresco/web/ui/common/tag/ImagePickerRadioPanelTag.java index f2ada93e7a..f23e09e517 100644 --- a/source/java/org/alfresco/web/ui/common/tag/ImagePickerRadioPanelTag.java +++ b/source/java/org/alfresco/web/ui/common/tag/ImagePickerRadioPanelTag.java @@ -1,71 +1,71 @@ -package org.alfresco.web.ui.common.tag; - -import javax.faces.component.UIComponent; - -/** - * Tag to place the image picker component and radio renderer inside - * a rounded corner panel - * - * @author gavinc - */ -public class ImagePickerRadioPanelTag extends ImagePickerRadioTag -{ - private String panelBorder; - private String panelBgcolor; - - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.ImagePicker"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return "org.alfresco.faces.RadioPanel"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - setStringProperty(component, "panelBorder", this.panelBorder); - setStringProperty(component, "panelBgcolor", this.panelBgcolor); - } - - /** - * @see javax.servlet.jsp.tagext.Tag#release() - */ - public void release() - { - super.release(); - this.panelBorder = null; - this.panelBgcolor = null; - } - - public String getPanelBgcolor() - { - return panelBgcolor; - } - - public void setPanelBgcolor(String panelBgcolor) - { - this.panelBgcolor = panelBgcolor; - } - - public String getPanelBorder() - { - return panelBorder; - } - - public void setPanelBorder(String panelBorder) - { - this.panelBorder = panelBorder; - } -} +package org.alfresco.web.ui.common.tag; + +import javax.faces.component.UIComponent; + +/** + * Tag to place the image picker component and radio renderer inside + * a rounded corner panel + * + * @author gavinc + */ +public class ImagePickerRadioPanelTag extends ImagePickerRadioTag +{ + private String panelBorder; + private String panelBgcolor; + + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.ImagePicker"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return "org.alfresco.faces.RadioPanel"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + setStringProperty(component, "panelBorder", this.panelBorder); + setStringProperty(component, "panelBgcolor", this.panelBgcolor); + } + + /** + * @see javax.servlet.jsp.tagext.Tag#release() + */ + public void release() + { + super.release(); + this.panelBorder = null; + this.panelBgcolor = null; + } + + public String getPanelBgcolor() + { + return panelBgcolor; + } + + public void setPanelBgcolor(String panelBgcolor) + { + this.panelBgcolor = panelBgcolor; + } + + public String getPanelBorder() + { + return panelBorder; + } + + public void setPanelBorder(String panelBorder) + { + this.panelBorder = panelBorder; + } +} diff --git a/source/java/org/alfresco/web/ui/common/tag/MultiValueConverterTag.java b/source/java/org/alfresco/web/ui/common/tag/MultiValueConverterTag.java index 9677f1b98e..a0b3d2ab2c 100644 --- a/source/java/org/alfresco/web/ui/common/tag/MultiValueConverterTag.java +++ b/source/java/org/alfresco/web/ui/common/tag/MultiValueConverterTag.java @@ -1,31 +1,31 @@ -package org.alfresco.web.ui.common.tag; - -import javax.faces.convert.Converter; -import javax.faces.webapp.ConverterTag; -import javax.servlet.jsp.JspException; - -import org.alfresco.web.ui.common.converter.MultiValueConverter; - -/** - * Allows the MultiValueConverter component to be used on JSP pages - * - * @author gavinc - */ -public class MultiValueConverterTag extends ConverterTag -{ - /** - * Default Constructor - */ - public MultiValueConverterTag() - { - setConverterId(MultiValueConverter.CONVERTER_ID); - } - - /** - * @see javax.faces.webapp.ConverterTag#createConverter() - */ - protected Converter createConverter() throws JspException - { - return (MultiValueConverter)super.createConverter(); - } -} +package org.alfresco.web.ui.common.tag; + +import javax.faces.convert.Converter; +import javax.faces.webapp.ConverterTag; +import javax.servlet.jsp.JspException; + +import org.alfresco.web.ui.common.converter.MultiValueConverter; + +/** + * Allows the MultiValueConverter component to be used on JSP pages + * + * @author gavinc + */ +public class MultiValueConverterTag extends ConverterTag +{ + /** + * Default Constructor + */ + public MultiValueConverterTag() + { + setConverterId(MultiValueConverter.CONVERTER_ID); + } + + /** + * @see javax.faces.webapp.ConverterTag#createConverter() + */ + protected Converter createConverter() throws JspException + { + return (MultiValueConverter)super.createConverter(); + } +} diff --git a/source/java/org/alfresco/web/ui/common/tag/SelectListTag.java b/source/java/org/alfresco/web/ui/common/tag/SelectListTag.java index d8706a4168..a2dd610370 100644 --- a/source/java/org/alfresco/web/ui/common/tag/SelectListTag.java +++ b/source/java/org/alfresco/web/ui/common/tag/SelectListTag.java @@ -1,176 +1,176 @@ -package org.alfresco.web.ui.common.tag; - -import javax.faces.component.UIComponent; - -/** - * @author Kevin Roast - */ -public class SelectListTag extends HtmlComponentTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.SelectList"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - setBooleanProperty(component, "multiSelect", this.multiSelect); - setBooleanProperty(component, "activeSelect", this.activeSelect); - setStringStaticProperty(component, "var", this.var); - setStringProperty(component, "itemStyle", this.itemStyle); - setStringProperty(component, "itemStyleClass", this.itemStyleClass); - setStringProperty(component, "value", this.value); - setStringProperty(component, "onchange", this.onchange); - setBooleanProperty(component, "escapeItemLabel", this.escapeItemLabel); - setBooleanProperty(component, "escapeItemDescription", this.escapeItemDescription); - } - - /** - * @see javax.servlet.jsp.tagext.Tag#release() - */ - public void release() - { - super.release(); - this.multiSelect = null; - this.activeSelect = null; - this.var = null; - this.itemStyle = null; - this.itemStyleClass = null; - this.value = null; - this.onchange = null; - this.escapeItemLabel = null; - this.escapeItemDescription = null; - } - - /** - * Set the multi-select mode - * - * @param multiSelect the multi-select mode - */ - public void setMultiSelect(String multiSelect) - { - this.multiSelect = multiSelect; - } - - /** - * Set the active selection mode - * - * @param activeSelect the active selection mode - */ - public void setActiveSelect(String activeSelect) - { - this.activeSelect = activeSelect; - } - - /** - * Set the variable name for row item context - * - * @param var the variable name for row item context - */ - public void setVar(String var) - { - this.var = var; - } - - /** - * Set the item Style - * - * @param itemStyle the item Style - */ - public void setItemStyle(String itemStyle) - { - this.itemStyle = itemStyle; - } - - /** - * Set the item Style Class - * - * @param itemStyleClass the item Style Class - */ - public void setItemStyleClass(String itemStyleClass) - { - this.itemStyleClass = itemStyleClass; - } - - /** - * Set the selected value - * - * @param value the selected value - */ - public void setValue(String value) - { - this.value = value; - } - - /** - * Set the onchange handler - * - * @param onchange the onchange handler. - */ - public void setOnchange(final String onchange) - { - this.onchange = onchange; - } - - /** - * Set the escapeItemLabel flag - * - * @param escapeItemLabel true to escape the items labels - */ - public void setEscapeItemLabel(String escapeItemLabel) - { - this.escapeItemLabel = escapeItemLabel; - } - - /** - * Set the escapeItemDescription flag - * - * @param escapeItemDescription true to escape the items descriptions - */ - public void setEscapeItemDescription(String escapeItemDescription) - { - this.escapeItemDescription = escapeItemDescription; - } - - /** the selected value */ - private String value; - - /** the itemStyle */ - private String itemStyle; - - /** the itemStyleClass */ - private String itemStyleClass; - - /** the multi-select mode */ - private String multiSelect; - - /** the active selection mode */ - private String activeSelect; - - /** the variable name for row item context */ - private String var; - - /** the event handler for a change in selection */ - private String onchange; - - /** the escape mode for item's labels */ - private String escapeItemLabel; - - /** the escape mode for item's descriptions */ - private String escapeItemDescription; -} +package org.alfresco.web.ui.common.tag; + +import javax.faces.component.UIComponent; + +/** + * @author Kevin Roast + */ +public class SelectListTag extends HtmlComponentTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.SelectList"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + setBooleanProperty(component, "multiSelect", this.multiSelect); + setBooleanProperty(component, "activeSelect", this.activeSelect); + setStringStaticProperty(component, "var", this.var); + setStringProperty(component, "itemStyle", this.itemStyle); + setStringProperty(component, "itemStyleClass", this.itemStyleClass); + setStringProperty(component, "value", this.value); + setStringProperty(component, "onchange", this.onchange); + setBooleanProperty(component, "escapeItemLabel", this.escapeItemLabel); + setBooleanProperty(component, "escapeItemDescription", this.escapeItemDescription); + } + + /** + * @see javax.servlet.jsp.tagext.Tag#release() + */ + public void release() + { + super.release(); + this.multiSelect = null; + this.activeSelect = null; + this.var = null; + this.itemStyle = null; + this.itemStyleClass = null; + this.value = null; + this.onchange = null; + this.escapeItemLabel = null; + this.escapeItemDescription = null; + } + + /** + * Set the multi-select mode + * + * @param multiSelect the multi-select mode + */ + public void setMultiSelect(String multiSelect) + { + this.multiSelect = multiSelect; + } + + /** + * Set the active selection mode + * + * @param activeSelect the active selection mode + */ + public void setActiveSelect(String activeSelect) + { + this.activeSelect = activeSelect; + } + + /** + * Set the variable name for row item context + * + * @param var the variable name for row item context + */ + public void setVar(String var) + { + this.var = var; + } + + /** + * Set the item Style + * + * @param itemStyle the item Style + */ + public void setItemStyle(String itemStyle) + { + this.itemStyle = itemStyle; + } + + /** + * Set the item Style Class + * + * @param itemStyleClass the item Style Class + */ + public void setItemStyleClass(String itemStyleClass) + { + this.itemStyleClass = itemStyleClass; + } + + /** + * Set the selected value + * + * @param value the selected value + */ + public void setValue(String value) + { + this.value = value; + } + + /** + * Set the onchange handler + * + * @param onchange the onchange handler. + */ + public void setOnchange(final String onchange) + { + this.onchange = onchange; + } + + /** + * Set the escapeItemLabel flag + * + * @param escapeItemLabel true to escape the items labels + */ + public void setEscapeItemLabel(String escapeItemLabel) + { + this.escapeItemLabel = escapeItemLabel; + } + + /** + * Set the escapeItemDescription flag + * + * @param escapeItemDescription true to escape the items descriptions + */ + public void setEscapeItemDescription(String escapeItemDescription) + { + this.escapeItemDescription = escapeItemDescription; + } + + /** the selected value */ + private String value; + + /** the itemStyle */ + private String itemStyle; + + /** the itemStyleClass */ + private String itemStyleClass; + + /** the multi-select mode */ + private String multiSelect; + + /** the active selection mode */ + private String activeSelect; + + /** the variable name for row item context */ + private String var; + + /** the event handler for a change in selection */ + private String onchange; + + /** the escape mode for item's labels */ + private String escapeItemLabel; + + /** the escape mode for item's descriptions */ + private String escapeItemDescription; +} diff --git a/source/java/org/alfresco/web/ui/common/tag/debug/RepositoryPropertiesTag.java b/source/java/org/alfresco/web/ui/common/tag/debug/RepositoryPropertiesTag.java index 5866555159..fcd7568871 100644 --- a/source/java/org/alfresco/web/ui/common/tag/debug/RepositoryPropertiesTag.java +++ b/source/java/org/alfresco/web/ui/common/tag/debug/RepositoryPropertiesTag.java @@ -1,18 +1,18 @@ -package org.alfresco.web.ui.common.tag.debug; - - -/** - * Tag implementation used to place the Repository properties component on a page. - * - * @author kevinr - */ -public class RepositoryPropertiesTag extends BaseDebugTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.debug.RepositoryProperties"; - } -} +package org.alfresco.web.ui.common.tag.debug; + + +/** + * Tag implementation used to place the Repository properties component on a page. + * + * @author kevinr + */ +public class RepositoryPropertiesTag extends BaseDebugTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.debug.RepositoryProperties"; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIActions.java b/source/java/org/alfresco/web/ui/repo/component/UIActions.java index 72c523140a..6a2bbe8133 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIActions.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIActions.java @@ -1,679 +1,679 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.io.UnsupportedEncodingException; -import java.math.BigInteger; -import java.util.HashSet; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.ResourceBundle; -import java.util.Set; - -import javax.faces.component.UIComponent; -import javax.faces.component.UIParameter; -import javax.faces.component.html.HtmlPanelGroup; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.ValueBinding; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.util.GUID; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.config.ActionsConfigElement; -import org.alfresco.web.config.ActionsConfigElement.ActionDefinition; -import org.alfresco.web.config.ActionsConfigElement.ActionGroup; -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.component.UIActionLink; -import org.alfresco.web.ui.repo.component.evaluator.ActionInstanceEvaluator; -import org.alfresco.web.ui.repo.component.evaluator.PermissionEvaluator; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.apache.myfaces.shared_impl.taglib.UIComponentTagUtils; -import org.springframework.extensions.config.Config; -import org.springframework.extensions.surf.util.URLEncoder; -import org.springframework.extensions.webscripts.ui.common.ConstantMethodBinding; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; - -/** - * @author kevinr - */ -public class UIActions extends SelfRenderingComponent -{ - // ------------------------------------------------------------------------------ - // Component implementation - - private static final String ATTR_VALUE = "value"; - - private static Log logger = LogFactory.getLog(UIActions.class); - - private static final String ATTR_SHOWLINK = "showLink"; - private static final String ATTR_STYLECLASS = "styleClass"; - private static final String ATTR_STYLE = "style"; - private static final String ACTION_CONTEXT = "actionContext"; - - public static final String RENDERER_ACTIONLINK = "org.alfresco.faces.ActionLinkRenderer"; - public static final String COMPONENT_ACTIONLINK = "org.alfresco.faces.ActionLink"; - public static final String COMPONENT_PERMISSIONEVAL = "org.alfresco.faces.PermissionEvaluator"; - public static final String COMPONENT_ACTIONEVAL = "org.alfresco.faces.ActionInstanceEvaluator"; - - public final static Class ACTION_CLASS_ARGS[] = {javax.faces.event.ActionEvent.class}; - - private transient Set groups = new HashSet(4); - private final static String CONTEXTID_DEFAULT = "_default"; - - /** - * @see javax.faces.component.UIComponent#getFamily() - */ - public String getFamily() - { - return "org.alfresco.faces.Controls"; - } - - /** - * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) - */ - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.value = (String)values[1]; - this.showLink = (Boolean)values[2]; - this.verticalSpacing = (Integer)values[3]; - this.groups = new HashSet(4); - } - - /** - * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) - */ - public Object saveState(FacesContext context) - { - Object values[] = new Object[] { - super.saveState(context), this.value, this.showLink, this.verticalSpacing}; - return (values); - } - - /** - * @see javax.faces.component.UIComponentBase#encodeBegin(javax.faces.context.FacesContext) - */ - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - if (isRendered() == false) - { - return; - } - - if (logger.isDebugEnabled()) - logger.debug("encodeBegin() for Id: " + getId() + " groupId: " + getValue()); - - // put the context object into the requestMap so it is accessable - // by any child component value binding expressions - Object actionContext = getContext(); - Map requestMap = getFacesContext().getExternalContext().getRequestMap(); - requestMap.put(ACTION_CONTEXT, actionContext); - - String contextId; - if (actionContext instanceof Node) - { - contextId = ((Node)actionContext).getType().toString(); - if (this.groups.contains(contextId)) - { - if (logger.isDebugEnabled()) - logger.debug("---already built component tree for actions contextId: " + contextId); - return; - } - } - else - { - contextId = CONTEXTID_DEFAULT; - if (this.groups.contains(contextId)) - { - if (logger.isDebugEnabled()) - logger.debug("---already built component tree for default actions."); - return; - } - } - - // look to see if we built a component set for that component group on a previous render - // this will need removing from the child component set to ensure that it does not grow endlessly - for (Iterator i=getChildren().iterator(); i.hasNext(); /**/) - { - UIComponent child = (UIComponent)i.next(); - if (contextId.equals(child.getAttributes().get("contextId"))) - { - if (logger.isDebugEnabled()) - logger.debug("***removing old child component set for contextId: " + contextId); - i.remove(); - break; - } - } - - String groupId = getValue(); - if (groupId != null && groupId.length() != 0) - { - Config config; - if (actionContext instanceof Node) - { - config = Application.getConfigService(context).getConfig(actionContext); - } - else - { - config = Application.getConfigService(context).getGlobalConfig(); - } - if (config != null) - { - // find the Actions specific config element - ActionsConfigElement actionConfig = - (ActionsConfigElement)config.getConfigElement(ActionsConfigElement.CONFIG_ELEMENT_ID); - if (actionConfig != null) - { - // and lookup our ActionGroup by Id - ActionGroup actionGroup = actionConfig.getActionGroup(groupId); - if (actionGroup != null) - { - // render the action group component tree - if (logger.isDebugEnabled()) - logger.debug("-constructing ActionGroup: " + groupId + " for ContextId: " + contextId); - buildActionGroup(context, actionConfig, actionGroup, contextId); - } - else - { - logger.warn("Unable to find specified Action Group config ID: " + groupId); - } - } - } - } - } - - /** - * @see javax.faces.component.UIComponentBase#getRendersChildren() - */ - public boolean getRendersChildren() - { - return true; - } - - /** - * @see javax.faces.component.UIComponentBase#encodeChildren(javax.faces.context.FacesContext) - */ - public void encodeChildren(FacesContext context) throws IOException - { - ResponseWriter out = context.getResponseWriter(); - int verticalSpacing = getVerticalSpacing(); - if (verticalSpacing != 0) - { - out.write(""); - } - - // use the current context Id to find the correct component group to render - Map requestMap = getFacesContext().getExternalContext().getRequestMap(); - Object actionContext = requestMap.get(ACTION_CONTEXT); - String contextId = CONTEXTID_DEFAULT; - if (actionContext instanceof Node) - { - contextId = ((Node)actionContext).getType().toString(); - } - - for (Iterator i=getChildren().iterator(); i.hasNext(); /**/) - { - UIComponent child = (UIComponent)i.next(); - if (contextId.equals(child.getAttributes().get("contextId"))) - { - if (logger.isDebugEnabled()) - logger.debug("Rendering actions group for contextId: " + contextId); - Utils.encodeRecursive(context, child); - break; - } - } - - if (verticalSpacing != 0) - { - out.write("
"); - } - } - - /** - * @see javax.faces.component.UIComponentBase#encodeEnd(javax.faces.context.FacesContext) - */ - public void encodeEnd(FacesContext context) throws IOException - { - if (logger.isDebugEnabled()) - logger.debug("encodeEnd() for Id: " + getId()); - - Map requestMap = getFacesContext().getExternalContext().getRequestMap(); - requestMap.remove(ACTION_CONTEXT); - } - - /** - * Build an action group as reusable UIActionLink components. - * - * @param context FacesContext - * @param config ActionsConfigElement - * @param actionGroup ActionGroup - * @param contextId String - * @throws IOException - */ - @SuppressWarnings("unchecked") - private void buildActionGroup( - FacesContext context, ActionsConfigElement config, ActionGroup actionGroup, String contextId) - throws IOException - { - javax.faces.application.Application facesApp = context.getApplication(); - ResourceBundle messages = Application.getBundle(context); - - // get overriding display attributes - String style = (String)getAttributes().get(ATTR_STYLE); - String styleClass = (String)getAttributes().get(ATTR_STYLECLASS); - Boolean showLink = null; - if (getAttributes().get(ATTR_SHOWLINK) != null) - { - showLink = (Boolean)getAttributes().get(ATTR_SHOWLINK); - } - - // build parent wrapper component - HtmlPanelGroup wrapper = (HtmlPanelGroup)facesApp.createComponent(ComponentConstants.JAVAX_FACES_PANELGROUP); - wrapper.setId(createUniqueId()); - wrapper.getAttributes().put("contextId", contextId); - this.getChildren().add(wrapper); - if (logger.isDebugEnabled()) - logger.debug("UIActions id: " + this.getId() + " Children() structure size: " + this.getChildren().size()); - this.groups.add(contextId); - - // process each ActionDefinition in the order they were defined - for (String actionId : actionGroup) - { - if (logger.isDebugEnabled()) - logger.debug("---processing ActionDefinition: " + actionId); - - ActionDefinition actionDef = config.getActionDefinition(actionId); - if (actionDef == null) - { - throw new AlfrescoRuntimeException("Unable to find configured ActionDefinition Id: " + actionId); - } - - UIComponent currentParent = wrapper; - - // build a permissions evaluator component to wrap the actionlink - PermissionEvaluator permEval = null; - List allow = actionDef.getAllowPermissions(); - if (allow != null && allow.size() != 0) - { - // found some permissions to test - permEval = (PermissionEvaluator)facesApp.createComponent(COMPONENT_PERMISSIONEVAL); - String condition = allow.get(0); - if (allow.size() != 1) - { - for (int i=1; i deny = actionDef.getDenyPermissions(); - if (deny != null && deny.size() != 0) - { - if (permEval == null) - { - permEval = (PermissionEvaluator)facesApp.createComponent(COMPONENT_PERMISSIONEVAL); - } - String condition = deny.get(0); - if (deny.size() != 1) - { - for (int i=1; i components that are needed. - Map params = actionDef.getParams(); - if (params != null) - { - for (String name : params.keySet()) - { - UIParameter param = - (UIParameter)facesApp.createComponent(ComponentConstants.JAVAX_FACES_PARAMETER); - param.setId(createUniqueId()); - param.setName(name); - String value = params.get(name); - if (UIComponentTagUtils.isValueReference(value)) - { - param.setValueBinding(ATTR_VALUE, facesApp.createValueBinding(value)); - } - else - { - param.setValue(value); - } - control.getChildren().add(param); - } - } - - if (logger.isDebugEnabled()) - logger.debug("-----adding UIActionLink component for: " + actionId); - currentParent.getChildren().add(control); - } - } - - - // ------------------------------------------------------------------------------ - // Strongly typed component property accessors - - /** - * Get the value (for this component the value is the ID of an Action Group config block) - * - * @return the value - */ - public String getValue() - { - if (this.value == null) - { - ValueBinding vb = getValueBinding(ATTR_VALUE); - if (vb != null) - { - this.value = (String)vb.getValue(getFacesContext()); - } - } - return this.value; - } - - /** - * Set the value (for this component the value is the ID of an Action Group config block) - * - * @param value the value - */ - public void setValue(String value) - { - this.value = value; - } - - /** - * Get the object that forms the context for this group of actions - * - * @return the context - */ - public Object getContext() - { - ValueBinding vb = getValueBinding("context"); - if (vb != null) - { - this.context = vb.getValue(getFacesContext()); - } - - return this.context; - } - - /** - * Set the the object that forms the context for this group of actions - * - * @param context the context - */ - public void setContext(Object context) - { - this.context = context; - } - - /** - * Get whether to show the link as well as the image if specified - * - * @return true to show the link as well as the image if specified - */ - public boolean getShowLink() - { - ValueBinding vb = getValueBinding(ATTR_SHOWLINK); - if (vb != null) - { - this.showLink = (Boolean)vb.getValue(getFacesContext()); - } - - return this.showLink != null ? this.showLink.booleanValue() : true; - } - - /** - * Set whether to show the link as well as the image if specified - * - * @param showLink Whether to show the link as well as the image if specified - */ - public void setShowLink(boolean showLink) - { - this.showLink = Boolean.valueOf(showLink); - } - - /** - * @return Returns the vertical spacing value in pixels or zero if not set. - */ - public int getVerticalSpacing() - { - ValueBinding vb = getValueBinding("verticalSpacing"); - if (vb != null) - { - this.verticalSpacing = (Integer)vb.getValue(getFacesContext()); - } - - return this.verticalSpacing != null ? this.verticalSpacing : 0; - } - - /** - * @param verticalSpacing The verticalSpacing to set. - */ - public void setVerticalSpacing(int verticalSpacing) - { - this.verticalSpacing = verticalSpacing; - } - - // ------------------------------------------------------------------------------ - // Helper methods - - /** - * Resets the component to force a re-initialisation. - */ - public void reset() - { - // clear any child components and reset the list of groups - if (logger.isDebugEnabled()) - logger.debug("UIActions id: " + this.getId() + "reset() - clearing component child list."); - this.getChildren().clear(); - this.groups.clear(); - } - - /** - * @return a unique ID for a JSF component - */ - private static String createUniqueId() - { - try - { - return "id_" + new BigInteger(GUID.generate().getBytes("8859_1")).toString(Character.MAX_RADIX); - } - catch (UnsupportedEncodingException e) - { - throw new RuntimeException(e); - } - } - - // ------------------------------------------------------------------------------ - // Private data - - /** True to show the link as well as the image if specified */ - private Boolean showLink = null; - - /** For this component the value is the ID of an Action Group config block */ - private String value = null; - - /** The context object for the action group */ - private Object context = null; - - /** Vertical layout spacing */ - private Integer verticalSpacing = null; -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.math.BigInteger; +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.ResourceBundle; +import java.util.Set; + +import javax.faces.component.UIComponent; +import javax.faces.component.UIParameter; +import javax.faces.component.html.HtmlPanelGroup; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.ValueBinding; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.util.GUID; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.config.ActionsConfigElement; +import org.alfresco.web.config.ActionsConfigElement.ActionDefinition; +import org.alfresco.web.config.ActionsConfigElement.ActionGroup; +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.component.UIActionLink; +import org.alfresco.web.ui.repo.component.evaluator.ActionInstanceEvaluator; +import org.alfresco.web.ui.repo.component.evaluator.PermissionEvaluator; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.apache.myfaces.shared_impl.taglib.UIComponentTagUtils; +import org.springframework.extensions.config.Config; +import org.springframework.extensions.surf.util.URLEncoder; +import org.springframework.extensions.webscripts.ui.common.ConstantMethodBinding; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; + +/** + * @author kevinr + */ +public class UIActions extends SelfRenderingComponent +{ + // ------------------------------------------------------------------------------ + // Component implementation + + private static final String ATTR_VALUE = "value"; + + private static Log logger = LogFactory.getLog(UIActions.class); + + private static final String ATTR_SHOWLINK = "showLink"; + private static final String ATTR_STYLECLASS = "styleClass"; + private static final String ATTR_STYLE = "style"; + private static final String ACTION_CONTEXT = "actionContext"; + + public static final String RENDERER_ACTIONLINK = "org.alfresco.faces.ActionLinkRenderer"; + public static final String COMPONENT_ACTIONLINK = "org.alfresco.faces.ActionLink"; + public static final String COMPONENT_PERMISSIONEVAL = "org.alfresco.faces.PermissionEvaluator"; + public static final String COMPONENT_ACTIONEVAL = "org.alfresco.faces.ActionInstanceEvaluator"; + + public final static Class ACTION_CLASS_ARGS[] = {javax.faces.event.ActionEvent.class}; + + private transient Set groups = new HashSet(4); + private final static String CONTEXTID_DEFAULT = "_default"; + + /** + * @see javax.faces.component.UIComponent#getFamily() + */ + public String getFamily() + { + return "org.alfresco.faces.Controls"; + } + + /** + * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) + */ + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.value = (String)values[1]; + this.showLink = (Boolean)values[2]; + this.verticalSpacing = (Integer)values[3]; + this.groups = new HashSet(4); + } + + /** + * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) + */ + public Object saveState(FacesContext context) + { + Object values[] = new Object[] { + super.saveState(context), this.value, this.showLink, this.verticalSpacing}; + return (values); + } + + /** + * @see javax.faces.component.UIComponentBase#encodeBegin(javax.faces.context.FacesContext) + */ + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + if (isRendered() == false) + { + return; + } + + if (logger.isDebugEnabled()) + logger.debug("encodeBegin() for Id: " + getId() + " groupId: " + getValue()); + + // put the context object into the requestMap so it is accessable + // by any child component value binding expressions + Object actionContext = getContext(); + Map requestMap = getFacesContext().getExternalContext().getRequestMap(); + requestMap.put(ACTION_CONTEXT, actionContext); + + String contextId; + if (actionContext instanceof Node) + { + contextId = ((Node)actionContext).getType().toString(); + if (this.groups.contains(contextId)) + { + if (logger.isDebugEnabled()) + logger.debug("---already built component tree for actions contextId: " + contextId); + return; + } + } + else + { + contextId = CONTEXTID_DEFAULT; + if (this.groups.contains(contextId)) + { + if (logger.isDebugEnabled()) + logger.debug("---already built component tree for default actions."); + return; + } + } + + // look to see if we built a component set for that component group on a previous render + // this will need removing from the child component set to ensure that it does not grow endlessly + for (Iterator i=getChildren().iterator(); i.hasNext(); /**/) + { + UIComponent child = (UIComponent)i.next(); + if (contextId.equals(child.getAttributes().get("contextId"))) + { + if (logger.isDebugEnabled()) + logger.debug("***removing old child component set for contextId: " + contextId); + i.remove(); + break; + } + } + + String groupId = getValue(); + if (groupId != null && groupId.length() != 0) + { + Config config; + if (actionContext instanceof Node) + { + config = Application.getConfigService(context).getConfig(actionContext); + } + else + { + config = Application.getConfigService(context).getGlobalConfig(); + } + if (config != null) + { + // find the Actions specific config element + ActionsConfigElement actionConfig = + (ActionsConfigElement)config.getConfigElement(ActionsConfigElement.CONFIG_ELEMENT_ID); + if (actionConfig != null) + { + // and lookup our ActionGroup by Id + ActionGroup actionGroup = actionConfig.getActionGroup(groupId); + if (actionGroup != null) + { + // render the action group component tree + if (logger.isDebugEnabled()) + logger.debug("-constructing ActionGroup: " + groupId + " for ContextId: " + contextId); + buildActionGroup(context, actionConfig, actionGroup, contextId); + } + else + { + logger.warn("Unable to find specified Action Group config ID: " + groupId); + } + } + } + } + } + + /** + * @see javax.faces.component.UIComponentBase#getRendersChildren() + */ + public boolean getRendersChildren() + { + return true; + } + + /** + * @see javax.faces.component.UIComponentBase#encodeChildren(javax.faces.context.FacesContext) + */ + public void encodeChildren(FacesContext context) throws IOException + { + ResponseWriter out = context.getResponseWriter(); + int verticalSpacing = getVerticalSpacing(); + if (verticalSpacing != 0) + { + out.write(""); + } + + // use the current context Id to find the correct component group to render + Map requestMap = getFacesContext().getExternalContext().getRequestMap(); + Object actionContext = requestMap.get(ACTION_CONTEXT); + String contextId = CONTEXTID_DEFAULT; + if (actionContext instanceof Node) + { + contextId = ((Node)actionContext).getType().toString(); + } + + for (Iterator i=getChildren().iterator(); i.hasNext(); /**/) + { + UIComponent child = (UIComponent)i.next(); + if (contextId.equals(child.getAttributes().get("contextId"))) + { + if (logger.isDebugEnabled()) + logger.debug("Rendering actions group for contextId: " + contextId); + Utils.encodeRecursive(context, child); + break; + } + } + + if (verticalSpacing != 0) + { + out.write("
"); + } + } + + /** + * @see javax.faces.component.UIComponentBase#encodeEnd(javax.faces.context.FacesContext) + */ + public void encodeEnd(FacesContext context) throws IOException + { + if (logger.isDebugEnabled()) + logger.debug("encodeEnd() for Id: " + getId()); + + Map requestMap = getFacesContext().getExternalContext().getRequestMap(); + requestMap.remove(ACTION_CONTEXT); + } + + /** + * Build an action group as reusable UIActionLink components. + * + * @param context FacesContext + * @param config ActionsConfigElement + * @param actionGroup ActionGroup + * @param contextId String + * @throws IOException + */ + @SuppressWarnings("unchecked") + private void buildActionGroup( + FacesContext context, ActionsConfigElement config, ActionGroup actionGroup, String contextId) + throws IOException + { + javax.faces.application.Application facesApp = context.getApplication(); + ResourceBundle messages = Application.getBundle(context); + + // get overriding display attributes + String style = (String)getAttributes().get(ATTR_STYLE); + String styleClass = (String)getAttributes().get(ATTR_STYLECLASS); + Boolean showLink = null; + if (getAttributes().get(ATTR_SHOWLINK) != null) + { + showLink = (Boolean)getAttributes().get(ATTR_SHOWLINK); + } + + // build parent wrapper component + HtmlPanelGroup wrapper = (HtmlPanelGroup)facesApp.createComponent(ComponentConstants.JAVAX_FACES_PANELGROUP); + wrapper.setId(createUniqueId()); + wrapper.getAttributes().put("contextId", contextId); + this.getChildren().add(wrapper); + if (logger.isDebugEnabled()) + logger.debug("UIActions id: " + this.getId() + " Children() structure size: " + this.getChildren().size()); + this.groups.add(contextId); + + // process each ActionDefinition in the order they were defined + for (String actionId : actionGroup) + { + if (logger.isDebugEnabled()) + logger.debug("---processing ActionDefinition: " + actionId); + + ActionDefinition actionDef = config.getActionDefinition(actionId); + if (actionDef == null) + { + throw new AlfrescoRuntimeException("Unable to find configured ActionDefinition Id: " + actionId); + } + + UIComponent currentParent = wrapper; + + // build a permissions evaluator component to wrap the actionlink + PermissionEvaluator permEval = null; + List allow = actionDef.getAllowPermissions(); + if (allow != null && allow.size() != 0) + { + // found some permissions to test + permEval = (PermissionEvaluator)facesApp.createComponent(COMPONENT_PERMISSIONEVAL); + String condition = allow.get(0); + if (allow.size() != 1) + { + for (int i=1; i deny = actionDef.getDenyPermissions(); + if (deny != null && deny.size() != 0) + { + if (permEval == null) + { + permEval = (PermissionEvaluator)facesApp.createComponent(COMPONENT_PERMISSIONEVAL); + } + String condition = deny.get(0); + if (deny.size() != 1) + { + for (int i=1; i components that are needed. + Map params = actionDef.getParams(); + if (params != null) + { + for (String name : params.keySet()) + { + UIParameter param = + (UIParameter)facesApp.createComponent(ComponentConstants.JAVAX_FACES_PARAMETER); + param.setId(createUniqueId()); + param.setName(name); + String value = params.get(name); + if (UIComponentTagUtils.isValueReference(value)) + { + param.setValueBinding(ATTR_VALUE, facesApp.createValueBinding(value)); + } + else + { + param.setValue(value); + } + control.getChildren().add(param); + } + } + + if (logger.isDebugEnabled()) + logger.debug("-----adding UIActionLink component for: " + actionId); + currentParent.getChildren().add(control); + } + } + + + // ------------------------------------------------------------------------------ + // Strongly typed component property accessors + + /** + * Get the value (for this component the value is the ID of an Action Group config block) + * + * @return the value + */ + public String getValue() + { + if (this.value == null) + { + ValueBinding vb = getValueBinding(ATTR_VALUE); + if (vb != null) + { + this.value = (String)vb.getValue(getFacesContext()); + } + } + return this.value; + } + + /** + * Set the value (for this component the value is the ID of an Action Group config block) + * + * @param value the value + */ + public void setValue(String value) + { + this.value = value; + } + + /** + * Get the object that forms the context for this group of actions + * + * @return the context + */ + public Object getContext() + { + ValueBinding vb = getValueBinding("context"); + if (vb != null) + { + this.context = vb.getValue(getFacesContext()); + } + + return this.context; + } + + /** + * Set the the object that forms the context for this group of actions + * + * @param context the context + */ + public void setContext(Object context) + { + this.context = context; + } + + /** + * Get whether to show the link as well as the image if specified + * + * @return true to show the link as well as the image if specified + */ + public boolean getShowLink() + { + ValueBinding vb = getValueBinding(ATTR_SHOWLINK); + if (vb != null) + { + this.showLink = (Boolean)vb.getValue(getFacesContext()); + } + + return this.showLink != null ? this.showLink.booleanValue() : true; + } + + /** + * Set whether to show the link as well as the image if specified + * + * @param showLink Whether to show the link as well as the image if specified + */ + public void setShowLink(boolean showLink) + { + this.showLink = Boolean.valueOf(showLink); + } + + /** + * @return Returns the vertical spacing value in pixels or zero if not set. + */ + public int getVerticalSpacing() + { + ValueBinding vb = getValueBinding("verticalSpacing"); + if (vb != null) + { + this.verticalSpacing = (Integer)vb.getValue(getFacesContext()); + } + + return this.verticalSpacing != null ? this.verticalSpacing : 0; + } + + /** + * @param verticalSpacing The verticalSpacing to set. + */ + public void setVerticalSpacing(int verticalSpacing) + { + this.verticalSpacing = verticalSpacing; + } + + // ------------------------------------------------------------------------------ + // Helper methods + + /** + * Resets the component to force a re-initialisation. + */ + public void reset() + { + // clear any child components and reset the list of groups + if (logger.isDebugEnabled()) + logger.debug("UIActions id: " + this.getId() + "reset() - clearing component child list."); + this.getChildren().clear(); + this.groups.clear(); + } + + /** + * @return a unique ID for a JSF component + */ + private static String createUniqueId() + { + try + { + return "id_" + new BigInteger(GUID.generate().getBytes("8859_1")).toString(Character.MAX_RADIX); + } + catch (UnsupportedEncodingException e) + { + throw new RuntimeException(e); + } + } + + // ------------------------------------------------------------------------------ + // Private data + + /** True to show the link as well as the image if specified */ + private Boolean showLink = null; + + /** For this component the value is the ID of an Action Group config block */ + private String value = null; + + /** The context object for the action group */ + private Object context = null; + + /** Vertical layout spacing */ + private Integer verticalSpacing = null; +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIAjaxTagPicker.java b/source/java/org/alfresco/web/ui/repo/component/UIAjaxTagPicker.java index 5fdba1ab02..661033eba2 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIAjaxTagPicker.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIAjaxTagPicker.java @@ -1,296 +1,296 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.List; -import java.util.Map; -import java.util.ResourceBundle; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.transaction.UserTransaction; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; -import org.springframework.web.jsf.FacesContextUtils; - -/** - * @author Mike Hatfield - */ -public class UIAjaxTagPicker extends BaseAjaxItemPicker -{ - private static final String MSG_CLICK_TO_SELECT_TAG = "click_to_select_tag"; - private static final String MSG_ADD = "add"; - private static final String MSG_ADD_A_TAG = "add_a_tag"; - private static final String MSG_REMOVE = "remove"; - - @Override - public String getFamily() - { - return "org.alfresco.faces.AjaxTagPicker"; - } - - @Override - protected String getServiceCall() - { - return "PickerBean.getTagNodes"; - } - - @Override - protected String getDefaultIcon() - { - return "/images/icons/category_small.gif"; - } - - @Override - public Boolean getSingleSelect() - { - // Tag component is never in single select mode, but the base class needs to know this - return false; - } - - @Override - public String getLabel() - { - // Tagger label only retrieved from a value binding when null - if (this.label == null) - { - super.getLabel(); - } - return this.label; - } - - @SuppressWarnings("unchecked") - @Override - /** - * @see javax.faces.component.UIComponentBase#encodeBegin(javax.faces.context.FacesContext) - */ - public void encodeBegin(FacesContext fc) throws IOException - { - if (isRendered() == false) - { - return; - } - - ResponseWriter out = fc.getResponseWriter(); - - String formClientId = Utils.getParentForm(fc, this).getClientId(fc); - Map attrs = this.getAttributes(); - ResourceBundle msg = Application.getBundle(fc); - - // get values from submitted value or none selected - String selectedValues = null; - String selectedNames = null; - String selectedItems = null; - List submitted = null; - - submitted = (List)getSubmittedValue(); - if (submitted == null) - { - Object objSubmitted = getValue(); - // special case to submit empty lists on multi-select values - if ((objSubmitted != null) && (objSubmitted.toString().equals("empty"))) - { - submitted = null; - this.setValue(null); - } - else - { - submitted = (List)getValue(); - } - } - - if (submitted != null) - { - UserTransaction tx = null; - try - { - tx = Repository.getUserTransaction(fc, true); - tx.begin(); - - StringBuilder nameBuf = new StringBuilder(128); - StringBuilder valueBuf = new StringBuilder(128); - StringBuilder itemBuf = new StringBuilder(256); - NodeService nodeService = (NodeService)FacesContextUtils.getRequiredWebApplicationContext( - fc).getBean("nodeService"); - for (NodeRef value : submitted) - { - String name = (String)nodeService.getProperty(value, ContentModel.PROP_NAME); - String icon = (String)nodeService.getProperty(value, ApplicationModel.PROP_ICON); - if (nameBuf.length() != 0) - { - nameBuf.append(", "); - valueBuf.append(","); - itemBuf.append(","); - } - nameBuf.append(name); - valueBuf.append(value.toString()); - itemBuf.append(getItemJson(value.toString(), name, icon)); - } - selectedNames = nameBuf.toString(); - selectedValues = valueBuf.toString(); - selectedItems = "[" + itemBuf.toString() + "]"; - - // commit the transaction - tx.commit(); - } - catch (Throwable err) - { - try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} - } - } - - // generate the Ids for our script object and containing DIV element - String divId = getId(); - String objId = divId + "Obj"; - - // generate the script to create and init our script object - String contextPath = fc.getExternalContext().getRequestContextPath(); - out.write(""); - - // generate the DIV structure for our component as expected by the script object - out.write("
") ; - out.write(" "); - // current selection displayed as link and message to launch the selector - out.write("
"); - if (isDisabled()) - { - out.write(" "); - if (selectedNames != null) - { - out.write(selectedNames); - } - out.write(" "); - } - else - { - out.write(" "); - if (selectedNames == null) - { - if ("".equals(getLabel())) - { - setLabel(msg.getString(MSG_CLICK_TO_SELECT_TAG)); - } - out.write(getLabel()); - } - else - { - out.write(selectedNames); - } - out.write(" "); - } - out.write("
"); - // container for item navigation - out.write("
"); - out.write("
"); - out.write("
"); - out.write("
"); - out.write(" "); - out.write(" "); - out.write(msg.getString(MSG_GO_UP)); - out.write(""); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(msg.getString(MSG_ADD_A_TAG)); - out.write(""); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(" "); - out.write(msg.getString(MSG_ADD)); - out.write(""); - out.write(" "); - out.write(msg.getString(MSG_CANCEL)); - out.write(""); - out.write(" "); - out.write(" "); - out.write(" "); - out.write("
"); - out.write("
"); - // container for item selection - out.write("
"); - out.write("
"); - out.write("
"); - out.write("
"); - out.write("
"); - // controls (OK & Cancel buttons etc.) - out.write("
"); - out.write(" "); - out.write("
"); - out.write(msg.getString(MSG_CANCEL)); - out.write("
"); - out.write("
"); - out.write("
"); - // container for the selected items - out.write("
"); - out.write("
"); - } - -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.List; +import java.util.Map; +import java.util.ResourceBundle; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.transaction.UserTransaction; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; +import org.springframework.web.jsf.FacesContextUtils; + +/** + * @author Mike Hatfield + */ +public class UIAjaxTagPicker extends BaseAjaxItemPicker +{ + private static final String MSG_CLICK_TO_SELECT_TAG = "click_to_select_tag"; + private static final String MSG_ADD = "add"; + private static final String MSG_ADD_A_TAG = "add_a_tag"; + private static final String MSG_REMOVE = "remove"; + + @Override + public String getFamily() + { + return "org.alfresco.faces.AjaxTagPicker"; + } + + @Override + protected String getServiceCall() + { + return "PickerBean.getTagNodes"; + } + + @Override + protected String getDefaultIcon() + { + return "/images/icons/category_small.gif"; + } + + @Override + public Boolean getSingleSelect() + { + // Tag component is never in single select mode, but the base class needs to know this + return false; + } + + @Override + public String getLabel() + { + // Tagger label only retrieved from a value binding when null + if (this.label == null) + { + super.getLabel(); + } + return this.label; + } + + @SuppressWarnings("unchecked") + @Override + /** + * @see javax.faces.component.UIComponentBase#encodeBegin(javax.faces.context.FacesContext) + */ + public void encodeBegin(FacesContext fc) throws IOException + { + if (isRendered() == false) + { + return; + } + + ResponseWriter out = fc.getResponseWriter(); + + String formClientId = Utils.getParentForm(fc, this).getClientId(fc); + Map attrs = this.getAttributes(); + ResourceBundle msg = Application.getBundle(fc); + + // get values from submitted value or none selected + String selectedValues = null; + String selectedNames = null; + String selectedItems = null; + List submitted = null; + + submitted = (List)getSubmittedValue(); + if (submitted == null) + { + Object objSubmitted = getValue(); + // special case to submit empty lists on multi-select values + if ((objSubmitted != null) && (objSubmitted.toString().equals("empty"))) + { + submitted = null; + this.setValue(null); + } + else + { + submitted = (List)getValue(); + } + } + + if (submitted != null) + { + UserTransaction tx = null; + try + { + tx = Repository.getUserTransaction(fc, true); + tx.begin(); + + StringBuilder nameBuf = new StringBuilder(128); + StringBuilder valueBuf = new StringBuilder(128); + StringBuilder itemBuf = new StringBuilder(256); + NodeService nodeService = (NodeService)FacesContextUtils.getRequiredWebApplicationContext( + fc).getBean("nodeService"); + for (NodeRef value : submitted) + { + String name = (String)nodeService.getProperty(value, ContentModel.PROP_NAME); + String icon = (String)nodeService.getProperty(value, ApplicationModel.PROP_ICON); + if (nameBuf.length() != 0) + { + nameBuf.append(", "); + valueBuf.append(","); + itemBuf.append(","); + } + nameBuf.append(name); + valueBuf.append(value.toString()); + itemBuf.append(getItemJson(value.toString(), name, icon)); + } + selectedNames = nameBuf.toString(); + selectedValues = valueBuf.toString(); + selectedItems = "[" + itemBuf.toString() + "]"; + + // commit the transaction + tx.commit(); + } + catch (Throwable err) + { + try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} + } + } + + // generate the Ids for our script object and containing DIV element + String divId = getId(); + String objId = divId + "Obj"; + + // generate the script to create and init our script object + String contextPath = fc.getExternalContext().getRequestContextPath(); + out.write(""); + + // generate the DIV structure for our component as expected by the script object + out.write("
") ; + out.write(" "); + // current selection displayed as link and message to launch the selector + out.write("
"); + if (isDisabled()) + { + out.write(" "); + if (selectedNames != null) + { + out.write(selectedNames); + } + out.write(" "); + } + else + { + out.write(" "); + if (selectedNames == null) + { + if ("".equals(getLabel())) + { + setLabel(msg.getString(MSG_CLICK_TO_SELECT_TAG)); + } + out.write(getLabel()); + } + else + { + out.write(selectedNames); + } + out.write(" "); + } + out.write("
"); + // container for item navigation + out.write("
"); + out.write("
"); + out.write("
"); + out.write("
"); + out.write(" "); + out.write(" "); + out.write(msg.getString(MSG_GO_UP)); + out.write(""); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(msg.getString(MSG_ADD_A_TAG)); + out.write(""); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(" "); + out.write(msg.getString(MSG_ADD)); + out.write(""); + out.write(" "); + out.write(msg.getString(MSG_CANCEL)); + out.write(""); + out.write(" "); + out.write(" "); + out.write(" "); + out.write("
"); + out.write("
"); + // container for item selection + out.write("
"); + out.write("
"); + out.write("
"); + out.write("
"); + out.write("
"); + // controls (OK & Cancel buttons etc.) + out.write("
"); + out.write(" "); + out.write("
"); + out.write(msg.getString(MSG_CANCEL)); + out.write("
"); + out.write("
"); + out.write("
"); + // container for the selected items + out.write("
"); + out.write("
"); + } + +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UICategoryBrowser.java b/source/java/org/alfresco/web/ui/repo/component/UICategoryBrowser.java index 4d4f090d8e..56fc7a148b 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UICategoryBrowser.java +++ b/source/java/org/alfresco/web/ui/repo/component/UICategoryBrowser.java @@ -1,229 +1,229 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.Iterator; -import java.util.List; -import java.util.Map; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.event.AbortProcessingException; -import javax.faces.event.ActionEvent; -import javax.faces.event.FacesEvent; - -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.bean.CategoryBrowserBean; -import org.alfresco.web.bean.NavigationBean; -import org.alfresco.web.bean.search.SearchContext; -import org.alfresco.web.bean.ajax.CategoryBrowserPluginBean; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; -import org.alfresco.web.ui.common.Utils; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; -import org.alfresco.web.ui.repo.component.UITree.TreeNode; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -public class UICategoryBrowser extends SelfRenderingComponent -{ - private static final Log logger = LogFactory.getLog(UICategoryBrowser.class); - - public static final String COMPONENT_TYPE = "org.alfresco.faces.CategoryBrowser"; - - private static final String AJAX_URL_START = "/ajax/invoke/" + CategoryBrowserPluginBean.BEAN_NAME; - - private static final String SUBCATEGORIES_PARAM = "include-subcategories-checkbox"; - - @Override - public String getFamily() - { - return COMPONENT_TYPE; - } - - @Override - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[]) state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - } - - @Override - public Object saveState(FacesContext context) - { - Object values[] = new Object[2]; - // standard component attributes are saved by the super class - values[0] = super.saveState(context); - return values; - } - - /** - * @see javax.faces.component.UIComponentBase#decode(javax.faces.context.FacesContext) - */ - public void decode(FacesContext context) - { - Map requestMap = context.getExternalContext().getRequestParameterMap(); - String fieldId = getClientId(context); - String value = (String) requestMap.get(fieldId); - - if (value != null && value.length() != 0) - { - if (logger.isDebugEnabled()) - logger.debug("Received post back: " + value); - - // work out whether a panel or a node was selected - String item = value; - - String subcategoriesStr = (String) requestMap.get(SUBCATEGORIES_PARAM); - boolean includeSubcategories = "1".equals(subcategoriesStr); - logger.debug("Booléen = " + includeSubcategories); - - // queue an event to be handled later - CategoryBrowserEvent event = new CategoryBrowserEvent(this, item, includeSubcategories); - this.queueEvent(event); - } - } - - /* - * (non-Javadoc) - * - * @see org.alfresco.extension.web.ui.repo.component.UINavigator#broadcast(javax.faces.event.FacesEvent) - */ - @Override - public void broadcast(FacesEvent event) throws AbortProcessingException - { - if (event instanceof CategoryBrowserEvent) - { - FacesContext context = FacesContext.getCurrentInstance(); - CategoryBrowserEvent categoryBrowseEvent = (CategoryBrowserEvent) event; - NodeRef nodeClicked = new NodeRef(categoryBrowseEvent.getItem()); - boolean subcategories = categoryBrowseEvent.isIncludeSubcategories(); - if (logger.isDebugEnabled()) - logger.debug("Selected category: " + nodeClicked + " subcategories? " + subcategories); - - CategoryBrowserBean categoryBrowserBean = (CategoryBrowserBean) FacesHelper.getManagedBean(context, - CategoryBrowserBean.BEAN_NAME); - categoryBrowserBean.setCurrentCategory(nodeClicked); - categoryBrowserBean.setIncludeSubcategories(subcategories); - SearchContext categorySearch = categoryBrowserBean.generateCategorySearchContext(); - - NavigationBean nb = (NavigationBean) FacesHelper.getManagedBean(context, NavigationBean.BEAN_NAME); - nb.setSearchContext(categorySearch); - context.getApplication().getNavigationHandler().handleNavigation(context, null, "category-browse"); - } - else - { - super.broadcast(event); - } - } - - /* - * (non-Javadoc) - * - * @see org.alfresco.web.ui.repo.component.UINavigator#encodeBegin(javax.faces.context.FacesContext) - */ - @Override - public void encodeBegin(FacesContext context) throws IOException - { - if (!isRendered()) - return; - - // TODO: pull width and height from user preferences and/or the main config, - // if present override below using the style attribute - - ResponseWriter out = context.getResponseWriter(); - CategoryBrowserPluginBean categoryBrowserPluginBean = (CategoryBrowserPluginBean) FacesHelper.getManagedBean( - context, CategoryBrowserPluginBean.BEAN_NAME); - CategoryBrowserBean categoryBrowserBean = (CategoryBrowserBean) FacesHelper.getManagedBean(context, - CategoryBrowserBean.BEAN_NAME); - - List rootNodes = null; - - rootNodes = categoryBrowserPluginBean.getCategoryRootNodes(); - // order the root nodes by the tree label - if (rootNodes != null && rootNodes.size() > 1) - { - QuickSort sorter = new QuickSort(rootNodes, "name", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - } - - // main container div - out.write("
"); - - // Subcategories parameter - String includeSub = Application.getMessage(context, "category_browser_plugin_include_subcategories"); - out.write(""); - out.write(""); - - // generate the javascript method to capture the tree node click events - out.write(""); - - // generate the active panel containing the tree - out.write("
"); - UITree tree = (UITree) context.getApplication().createComponent(UITree.COMPONENT_TYPE); - tree.setId("tree"); - tree.setRootNodes(rootNodes); - tree.setRetrieveChildrenUrl(AJAX_URL_START + ".retrieveChildren?"); - tree.setNodeCollapsedUrl(AJAX_URL_START + ".nodeCollapsed?"); - tree.setNodeSelectedCallback("treeNodeSelected"); - tree.setNodeCollapsedCallback("informOfCollapse"); - Utils.encodeRecursive(context, tree); - out.write("
"); - - out.write("
"); - } - - @Override - public void encodeChildren(FacesContext context) throws IOException - { - if (!isRendered()) - return; - for (Iterator i = this.getChildren().iterator(); i.hasNext();) - { - UIComponent child = (UIComponent) i.next(); - Utils.encodeRecursive(context, child); - } - } - - @Override - public boolean getRendersChildren() - { - return true; - } - - /** - * Class representing the clicking of a tree node. - */ - @SuppressWarnings("serial") - public static class CategoryBrowserEvent extends ActionEvent - { - private String item; - - private boolean includeSubcategories; - - public CategoryBrowserEvent(UIComponent component, String item, boolean include) - { - super(component); - - this.item = item; - this.includeSubcategories = include; - } - - public String getItem() - { - return item; - } - - public boolean isIncludeSubcategories() - { - return includeSubcategories; - } - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.Iterator; +import java.util.List; +import java.util.Map; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.event.AbortProcessingException; +import javax.faces.event.ActionEvent; +import javax.faces.event.FacesEvent; + +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.bean.CategoryBrowserBean; +import org.alfresco.web.bean.NavigationBean; +import org.alfresco.web.bean.search.SearchContext; +import org.alfresco.web.bean.ajax.CategoryBrowserPluginBean; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; +import org.alfresco.web.ui.common.Utils; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; +import org.alfresco.web.ui.repo.component.UITree.TreeNode; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +public class UICategoryBrowser extends SelfRenderingComponent +{ + private static final Log logger = LogFactory.getLog(UICategoryBrowser.class); + + public static final String COMPONENT_TYPE = "org.alfresco.faces.CategoryBrowser"; + + private static final String AJAX_URL_START = "/ajax/invoke/" + CategoryBrowserPluginBean.BEAN_NAME; + + private static final String SUBCATEGORIES_PARAM = "include-subcategories-checkbox"; + + @Override + public String getFamily() + { + return COMPONENT_TYPE; + } + + @Override + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[]) state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + } + + @Override + public Object saveState(FacesContext context) + { + Object values[] = new Object[2]; + // standard component attributes are saved by the super class + values[0] = super.saveState(context); + return values; + } + + /** + * @see javax.faces.component.UIComponentBase#decode(javax.faces.context.FacesContext) + */ + public void decode(FacesContext context) + { + Map requestMap = context.getExternalContext().getRequestParameterMap(); + String fieldId = getClientId(context); + String value = (String) requestMap.get(fieldId); + + if (value != null && value.length() != 0) + { + if (logger.isDebugEnabled()) + logger.debug("Received post back: " + value); + + // work out whether a panel or a node was selected + String item = value; + + String subcategoriesStr = (String) requestMap.get(SUBCATEGORIES_PARAM); + boolean includeSubcategories = "1".equals(subcategoriesStr); + logger.debug("Booléen = " + includeSubcategories); + + // queue an event to be handled later + CategoryBrowserEvent event = new CategoryBrowserEvent(this, item, includeSubcategories); + this.queueEvent(event); + } + } + + /* + * (non-Javadoc) + * + * @see org.alfresco.extension.web.ui.repo.component.UINavigator#broadcast(javax.faces.event.FacesEvent) + */ + @Override + public void broadcast(FacesEvent event) throws AbortProcessingException + { + if (event instanceof CategoryBrowserEvent) + { + FacesContext context = FacesContext.getCurrentInstance(); + CategoryBrowserEvent categoryBrowseEvent = (CategoryBrowserEvent) event; + NodeRef nodeClicked = new NodeRef(categoryBrowseEvent.getItem()); + boolean subcategories = categoryBrowseEvent.isIncludeSubcategories(); + if (logger.isDebugEnabled()) + logger.debug("Selected category: " + nodeClicked + " subcategories? " + subcategories); + + CategoryBrowserBean categoryBrowserBean = (CategoryBrowserBean) FacesHelper.getManagedBean(context, + CategoryBrowserBean.BEAN_NAME); + categoryBrowserBean.setCurrentCategory(nodeClicked); + categoryBrowserBean.setIncludeSubcategories(subcategories); + SearchContext categorySearch = categoryBrowserBean.generateCategorySearchContext(); + + NavigationBean nb = (NavigationBean) FacesHelper.getManagedBean(context, NavigationBean.BEAN_NAME); + nb.setSearchContext(categorySearch); + context.getApplication().getNavigationHandler().handleNavigation(context, null, "category-browse"); + } + else + { + super.broadcast(event); + } + } + + /* + * (non-Javadoc) + * + * @see org.alfresco.web.ui.repo.component.UINavigator#encodeBegin(javax.faces.context.FacesContext) + */ + @Override + public void encodeBegin(FacesContext context) throws IOException + { + if (!isRendered()) + return; + + // TODO: pull width and height from user preferences and/or the main config, + // if present override below using the style attribute + + ResponseWriter out = context.getResponseWriter(); + CategoryBrowserPluginBean categoryBrowserPluginBean = (CategoryBrowserPluginBean) FacesHelper.getManagedBean( + context, CategoryBrowserPluginBean.BEAN_NAME); + CategoryBrowserBean categoryBrowserBean = (CategoryBrowserBean) FacesHelper.getManagedBean(context, + CategoryBrowserBean.BEAN_NAME); + + List rootNodes = null; + + rootNodes = categoryBrowserPluginBean.getCategoryRootNodes(); + // order the root nodes by the tree label + if (rootNodes != null && rootNodes.size() > 1) + { + QuickSort sorter = new QuickSort(rootNodes, "name", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + } + + // main container div + out.write("
"); + + // Subcategories parameter + String includeSub = Application.getMessage(context, "category_browser_plugin_include_subcategories"); + out.write(""); + out.write(""); + + // generate the javascript method to capture the tree node click events + out.write(""); + + // generate the active panel containing the tree + out.write("
"); + UITree tree = (UITree) context.getApplication().createComponent(UITree.COMPONENT_TYPE); + tree.setId("tree"); + tree.setRootNodes(rootNodes); + tree.setRetrieveChildrenUrl(AJAX_URL_START + ".retrieveChildren?"); + tree.setNodeCollapsedUrl(AJAX_URL_START + ".nodeCollapsed?"); + tree.setNodeSelectedCallback("treeNodeSelected"); + tree.setNodeCollapsedCallback("informOfCollapse"); + Utils.encodeRecursive(context, tree); + out.write("
"); + + out.write("
"); + } + + @Override + public void encodeChildren(FacesContext context) throws IOException + { + if (!isRendered()) + return; + for (Iterator i = this.getChildren().iterator(); i.hasNext();) + { + UIComponent child = (UIComponent) i.next(); + Utils.encodeRecursive(context, child); + } + } + + @Override + public boolean getRendersChildren() + { + return true; + } + + /** + * Class representing the clicking of a tree node. + */ + @SuppressWarnings("serial") + public static class CategoryBrowserEvent extends ActionEvent + { + private String item; + + private boolean includeSubcategories; + + public CategoryBrowserEvent(UIComponent component, String item, boolean include) + { + super(component); + + this.item = item; + this.includeSubcategories = include; + } + + public String getItem() + { + return item; + } + + public boolean isIncludeSubcategories() + { + return includeSubcategories; + } + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIContentSelector.java b/source/java/org/alfresco/web/ui/repo/component/UIContentSelector.java index b33d97c381..09fa2e7d20 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIContentSelector.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIContentSelector.java @@ -1,402 +1,402 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -import javax.faces.component.UIInput; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.ValueBinding; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.search.LimitBy; -import org.alfresco.service.cmr.search.ResultSet; -import org.alfresco.service.cmr.search.SearchParameters; -import org.alfresco.service.cmr.search.SearchService; -import org.alfresco.service.namespace.NamespaceService; -import org.alfresco.service.namespace.QName; -import org.alfresco.util.SearchLanguageConversion; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Component for selecting content from the repository - * - * @author gavinc - */ -public class UIContentSelector extends UIInput -{ - private final static Log logger = LogFactory.getLog(UIContentSelector.class); - -// private final static String ACTION_SEPARATOR = ";"; - private final static String ACTION_SEARCH = "0"; - - private final static String FIELD_CONTAINS = "_contains"; - private final static String FIELD_AVAILABLE = "_available"; - private final static String MSG_SEARCH = "search"; - - protected String availableOptionsSize; - protected Boolean disabled; - private Boolean multiSelect; - - /** List containing the currently available options */ - protected List availableOptions; - - // ------------------------------------------------------------------------------ - // Component implementation - - /** - * @see javax.faces.component.UIComponent#getFamily() - */ - public String getFamily() - { - return "org.alfresco.faces.ContentSelector"; - } - - /** - * Default constructor - */ - public UIContentSelector() - { - setRendererType(null); - } - - /** - * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) - */ - @SuppressWarnings("unchecked") - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.availableOptions = (List)values[1]; - this.availableOptionsSize = (String)values[2]; - this.disabled = (Boolean)values[3]; - this.multiSelect = (Boolean)values[4]; - } - - /** - * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) - */ - public Object saveState(FacesContext context) - { - Object values[] = new Object[10]; - // standard component attributes are saved by the super class - values[0] = super.saveState(context); - values[1] = this.availableOptions; - values[2] = this.availableOptionsSize; - values[3] = this.disabled; - values[4] = this.multiSelect; - - return (values); - } - - /** - * @see javax.faces.component.UIComponent#decode(javax.faces.context.FacesContext) - */ - public void decode(FacesContext context) - { - Map requestMap = context.getExternalContext().getRequestParameterMap(); - Map valuesMap = context.getExternalContext().getRequestParameterValuesMap(); - String fieldId = getHiddenFieldName(); - String value = (String)requestMap.get(fieldId); - - if (value != null && value.equals(ACTION_SEARCH)) - { - // user has issued a search action, fill the list with options - String contains = (String)requestMap.get(fieldId + FIELD_CONTAINS); - this.availableOptions = new ArrayList(); - getAvailableOptions(FacesContext.getCurrentInstance(), contains); - } - else - { - // set the submitted value (if there is one) - String[] addedItems = (String[])valuesMap.get(fieldId + FIELD_AVAILABLE); - this.setSubmittedValue(addedItems); - } - } - - /** - * @see javax.faces.component.UIComponent#encodeBegin(javax.faces.context.FacesContext) - */ - public void encodeBegin(FacesContext context) throws IOException - { - if (isRendered() == false) - { - return; - } - - ResponseWriter out = context.getResponseWriter(); - - // get the child associations currently on the node and any that have been added - NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); - - if (isDisabled()) - { - // TODO: if the component is disabled just show the current value as text - } - else - { - // start outer table - out.write(""); - - // show the search field - out.write(""); - - // show available options i.e. all content in repository - renderAvailableOptions(context, out, nodeService); - - // close table - out.write("
  
"); - } - } - - /** - * Determines whether the component should be rendered in a disabled state - * - * @return Returns whether the component is disabled - */ - public boolean isDisabled() - { - if (this.disabled == null) - { - ValueBinding vb = getValueBinding("disabled"); - if (vb != null) - { - this.disabled = (Boolean)vb.getValue(getFacesContext()); - } - } - - if (this.disabled == null) - { - this.disabled = Boolean.FALSE; - } - - return this.disabled; - } - - /** - * Determines whether the component should be rendered in a disabled state - * - * @param disabled true to disable the component - */ - public void setDisabled(boolean disabled) - { - this.disabled = disabled; - } - - /** - * Returns the size of the select control when multiple items - * can be selected - * - * @return The size of the select control - */ - public String getAvailableOptionsSize() - { - if (this.availableOptionsSize == null) - { - this.availableOptionsSize = "6"; - } - - return this.availableOptionsSize; - } - - /** - * Sets the size of the select control used when multiple items can - * be selected - * - * @param availableOptionsSize The size - */ - public void setAvailableOptionsSize(String availableOptionsSize) - { - this.availableOptionsSize = availableOptionsSize; - } - - /** - * @return true if multi select should be enabled. - */ - public boolean getMultiSelect() - { - ValueBinding vb = getValueBinding("multiSelect"); - if (vb != null) - { - this.multiSelect = (Boolean)vb.getValue(getFacesContext()); - } - - return multiSelect != null ? multiSelect.booleanValue() : true; - } - - /** - * @param multiSelect Flag to determine whether multi select is enabled - */ - public void setMultiSelect(boolean multiSelect) - { - this.multiSelect = Boolean.valueOf(multiSelect); - } - - /** - * Renders the list of available options - * - * @param context FacesContext - * @param out Writer to write output to - * @param nodeService The NodeService - * @throws IOException - */ - protected void renderAvailableOptions(FacesContext context, ResponseWriter out, NodeService nodeService) - throws IOException - { - boolean itemsPresent = (this.availableOptions != null && this.availableOptions.size() > 0); - - out.write(""); - } - - /** - * Retrieves the available options for the current association - * - * @param context Faces Context - * @param contains The contains part of the query - */ - protected void getAvailableOptions(FacesContext context, String contains) - { - // query for all content in the current repository - StringBuilder query = new StringBuilder("+TYPE:\""); - query.append(ContentModel.TYPE_CONTENT); - query.append("\""); - - if (contains != null && contains.length() > 0) - { - String safeContains = SearchLanguageConversion.escapeLuceneQuery(contains.trim()); - query.append(" AND +@"); - - String nameAttr = Repository.escapeQName(QName.createQName( - NamespaceService.CONTENT_MODEL_1_0_URI, "name")); - query.append(nameAttr); - - query.append(":\"*" + safeContains + "*\""); - } - - int maxResults = Application.getClientConfig(context).getSelectorsSearchMaxResults(); - - if (logger.isDebugEnabled()) - { - logger.debug("Query: " + query.toString()); - logger.debug("Max results size: " + maxResults); - } - - // setup search parameters, including limiting the results - SearchParameters searchParams = new SearchParameters(); - searchParams.addStore(Repository.getStoreRef()); - searchParams.setLanguage(SearchService.LANGUAGE_LUCENE); - searchParams.setQuery(query.toString()); - if (maxResults > 0) - { - searchParams.setLimit(maxResults); - searchParams.setLimitBy(LimitBy.FINAL_SIZE); - } - - ResultSet results = null; - try - { - results = Repository.getServiceRegistry(context).getSearchService().query(searchParams); - this.availableOptions = results.getNodeRefs(); - } - finally - { - if (results != null) - { - results.close(); - } - } - - if (logger.isDebugEnabled()) - logger.debug("Found " + this.availableOptions.size() + " available options"); - } - - /** - * We use a hidden field per picker instance on the page. - * - * @return hidden field name - */ - private String getHiddenFieldName() - { - return getClientId(getFacesContext()); - } - - /** - * Generate FORM submit JavaScript for the specified action - * - * @param context FacesContext - * @param action Action string - * - * @return FORM submit JavaScript - */ - private String generateFormSubmit(FacesContext context, String action) - { - return Utils.generateFormSubmit(context, this, getHiddenFieldName(), action); - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import javax.faces.component.UIInput; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.ValueBinding; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.search.LimitBy; +import org.alfresco.service.cmr.search.ResultSet; +import org.alfresco.service.cmr.search.SearchParameters; +import org.alfresco.service.cmr.search.SearchService; +import org.alfresco.service.namespace.NamespaceService; +import org.alfresco.service.namespace.QName; +import org.alfresco.util.SearchLanguageConversion; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Component for selecting content from the repository + * + * @author gavinc + */ +public class UIContentSelector extends UIInput +{ + private final static Log logger = LogFactory.getLog(UIContentSelector.class); + +// private final static String ACTION_SEPARATOR = ";"; + private final static String ACTION_SEARCH = "0"; + + private final static String FIELD_CONTAINS = "_contains"; + private final static String FIELD_AVAILABLE = "_available"; + private final static String MSG_SEARCH = "search"; + + protected String availableOptionsSize; + protected Boolean disabled; + private Boolean multiSelect; + + /** List containing the currently available options */ + protected List availableOptions; + + // ------------------------------------------------------------------------------ + // Component implementation + + /** + * @see javax.faces.component.UIComponent#getFamily() + */ + public String getFamily() + { + return "org.alfresco.faces.ContentSelector"; + } + + /** + * Default constructor + */ + public UIContentSelector() + { + setRendererType(null); + } + + /** + * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) + */ + @SuppressWarnings("unchecked") + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.availableOptions = (List)values[1]; + this.availableOptionsSize = (String)values[2]; + this.disabled = (Boolean)values[3]; + this.multiSelect = (Boolean)values[4]; + } + + /** + * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) + */ + public Object saveState(FacesContext context) + { + Object values[] = new Object[10]; + // standard component attributes are saved by the super class + values[0] = super.saveState(context); + values[1] = this.availableOptions; + values[2] = this.availableOptionsSize; + values[3] = this.disabled; + values[4] = this.multiSelect; + + return (values); + } + + /** + * @see javax.faces.component.UIComponent#decode(javax.faces.context.FacesContext) + */ + public void decode(FacesContext context) + { + Map requestMap = context.getExternalContext().getRequestParameterMap(); + Map valuesMap = context.getExternalContext().getRequestParameterValuesMap(); + String fieldId = getHiddenFieldName(); + String value = (String)requestMap.get(fieldId); + + if (value != null && value.equals(ACTION_SEARCH)) + { + // user has issued a search action, fill the list with options + String contains = (String)requestMap.get(fieldId + FIELD_CONTAINS); + this.availableOptions = new ArrayList(); + getAvailableOptions(FacesContext.getCurrentInstance(), contains); + } + else + { + // set the submitted value (if there is one) + String[] addedItems = (String[])valuesMap.get(fieldId + FIELD_AVAILABLE); + this.setSubmittedValue(addedItems); + } + } + + /** + * @see javax.faces.component.UIComponent#encodeBegin(javax.faces.context.FacesContext) + */ + public void encodeBegin(FacesContext context) throws IOException + { + if (isRendered() == false) + { + return; + } + + ResponseWriter out = context.getResponseWriter(); + + // get the child associations currently on the node and any that have been added + NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); + + if (isDisabled()) + { + // TODO: if the component is disabled just show the current value as text + } + else + { + // start outer table + out.write(""); + + // show the search field + out.write(""); + + // show available options i.e. all content in repository + renderAvailableOptions(context, out, nodeService); + + // close table + out.write("
  
"); + } + } + + /** + * Determines whether the component should be rendered in a disabled state + * + * @return Returns whether the component is disabled + */ + public boolean isDisabled() + { + if (this.disabled == null) + { + ValueBinding vb = getValueBinding("disabled"); + if (vb != null) + { + this.disabled = (Boolean)vb.getValue(getFacesContext()); + } + } + + if (this.disabled == null) + { + this.disabled = Boolean.FALSE; + } + + return this.disabled; + } + + /** + * Determines whether the component should be rendered in a disabled state + * + * @param disabled true to disable the component + */ + public void setDisabled(boolean disabled) + { + this.disabled = disabled; + } + + /** + * Returns the size of the select control when multiple items + * can be selected + * + * @return The size of the select control + */ + public String getAvailableOptionsSize() + { + if (this.availableOptionsSize == null) + { + this.availableOptionsSize = "6"; + } + + return this.availableOptionsSize; + } + + /** + * Sets the size of the select control used when multiple items can + * be selected + * + * @param availableOptionsSize The size + */ + public void setAvailableOptionsSize(String availableOptionsSize) + { + this.availableOptionsSize = availableOptionsSize; + } + + /** + * @return true if multi select should be enabled. + */ + public boolean getMultiSelect() + { + ValueBinding vb = getValueBinding("multiSelect"); + if (vb != null) + { + this.multiSelect = (Boolean)vb.getValue(getFacesContext()); + } + + return multiSelect != null ? multiSelect.booleanValue() : true; + } + + /** + * @param multiSelect Flag to determine whether multi select is enabled + */ + public void setMultiSelect(boolean multiSelect) + { + this.multiSelect = Boolean.valueOf(multiSelect); + } + + /** + * Renders the list of available options + * + * @param context FacesContext + * @param out Writer to write output to + * @param nodeService The NodeService + * @throws IOException + */ + protected void renderAvailableOptions(FacesContext context, ResponseWriter out, NodeService nodeService) + throws IOException + { + boolean itemsPresent = (this.availableOptions != null && this.availableOptions.size() > 0); + + out.write(""); + } + + /** + * Retrieves the available options for the current association + * + * @param context Faces Context + * @param contains The contains part of the query + */ + protected void getAvailableOptions(FacesContext context, String contains) + { + // query for all content in the current repository + StringBuilder query = new StringBuilder("+TYPE:\""); + query.append(ContentModel.TYPE_CONTENT); + query.append("\""); + + if (contains != null && contains.length() > 0) + { + String safeContains = SearchLanguageConversion.escapeLuceneQuery(contains.trim()); + query.append(" AND +@"); + + String nameAttr = Repository.escapeQName(QName.createQName( + NamespaceService.CONTENT_MODEL_1_0_URI, "name")); + query.append(nameAttr); + + query.append(":\"*" + safeContains + "*\""); + } + + int maxResults = Application.getClientConfig(context).getSelectorsSearchMaxResults(); + + if (logger.isDebugEnabled()) + { + logger.debug("Query: " + query.toString()); + logger.debug("Max results size: " + maxResults); + } + + // setup search parameters, including limiting the results + SearchParameters searchParams = new SearchParameters(); + searchParams.addStore(Repository.getStoreRef()); + searchParams.setLanguage(SearchService.LANGUAGE_LUCENE); + searchParams.setQuery(query.toString()); + if (maxResults > 0) + { + searchParams.setLimit(maxResults); + searchParams.setLimitBy(LimitBy.FINAL_SIZE); + } + + ResultSet results = null; + try + { + results = Repository.getServiceRegistry(context).getSearchService().query(searchParams); + this.availableOptions = results.getNodeRefs(); + } + finally + { + if (results != null) + { + results.close(); + } + } + + if (logger.isDebugEnabled()) + logger.debug("Found " + this.availableOptions.size() + " available options"); + } + + /** + * We use a hidden field per picker instance on the page. + * + * @return hidden field name + */ + private String getHiddenFieldName() + { + return getClientId(getFacesContext()); + } + + /** + * Generate FORM submit JavaScript for the specified action + * + * @param context FacesContext + * @param action Action string + * + * @return FORM submit JavaScript + */ + private String generateFormSubmit(FacesContext context, String action) + { + return Utils.generateFormSubmit(context, this, getHiddenFieldName(), action); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIDialogButtons.java b/source/java/org/alfresco/web/ui/repo/component/UIDialogButtons.java index cb0ecc981d..4c5daa6495 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIDialogButtons.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIDialogButtons.java @@ -1,295 +1,295 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.Iterator; -import java.util.List; - -import javax.faces.component.UICommand; -import javax.faces.component.UIComponent; -import javax.faces.component.UIOutput; -import javax.faces.component.html.HtmlCommandButton; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.MethodBinding; -import javax.faces.el.ValueBinding; - -import org.alfresco.web.app.Application; -import org.alfresco.web.app.servlet.FacesHelper; -import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.common.Utils; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * Component that displays the buttons for a dialog. - *

- * The standard OK and Cancel buttons - * are always generated. Any additional buttons, either configured - * or generated dynamically by the dialog, are generated in between - * the standard buttons. - * - * @author gavinc - */ -public class UIDialogButtons extends SelfRenderingComponent -{ - protected static final String BINDING_EXPRESSION_START = "#{"; - - private static final Log logger = LogFactory.getLog(UIDialogButtons.class); - - @Override - public String getFamily() - { - return "org.alfresco.faces.DialogButtons"; - } - - @Override - public void encodeBegin(FacesContext context) throws IOException - { - if (!isRendered()) return; - - if (this.getChildCount() == 0) - { - // generate all the required buttons the first time - generateButtons(context); - } - - ResponseWriter out = context.getResponseWriter(); - out.write(""); - } - - @Override - public void encodeChildren(FacesContext context) throws IOException - { - if (!isRendered()) return; - - ResponseWriter out = context.getResponseWriter(); - - // render the buttons - for (Iterator i = getChildren().iterator(); i.hasNext(); /**/) - { - out.write(""); - } - } - - @Override - public void encodeEnd(FacesContext context) throws IOException - { - if (!isRendered()) return; - - ResponseWriter out = context.getResponseWriter(); - out.write("
"); - - UIComponent child = (UIComponent)i.next(); - Utils.encodeRecursive(context, child); - - out.write("
"); - } - - @Override - public boolean getRendersChildren() - { - return true; - } - - /** - * Generates the buttons for the dialog currently being shown. - * - * @param context Faces context - */ - @SuppressWarnings("unchecked") - protected void generateButtons(FacesContext context) - { - // generate the OK button, if necessary - if (Application.getDialogManager().isOKButtonVisible()) - { - UICommand okButton = (UICommand)context.getApplication(). - createComponent(HtmlCommandButton.COMPONENT_TYPE); - okButton.setRendererType(ComponentConstants.JAVAX_FACES_BUTTON); - FacesHelper.setupComponentId(context, okButton, "finish-button"); - - // create the binding for the finish button label - ValueBinding valueBinding = context.getApplication().createValueBinding( - "#{DialogManager.finishButtonLabel}"); - okButton.setValueBinding("value", valueBinding); - - // create the action binding - MethodBinding methodBinding = context.getApplication().createMethodBinding( - "#{DialogManager.finish}", null); - okButton.setAction(methodBinding); - - // create the binding for whether the button is disabled - valueBinding = context.getApplication().createValueBinding( - "#{DialogManager.finishButtonDisabled}"); - okButton.setValueBinding("disabled", valueBinding); - - // setup CSS class for button - String styleClass = (String)this.getAttributes().get("styleClass"); - if (styleClass != null) - { - okButton.getAttributes().put("styleClass", styleClass); - } - - // add the OK button - this.getChildren().add(okButton); - } - - // generate the additional buttons - generateAdditionalButtons(context); - - // generate the OK button - UICommand cancelButton = (UICommand)context.getApplication(). - createComponent(HtmlCommandButton.COMPONENT_TYPE); - cancelButton.setRendererType(ComponentConstants.JAVAX_FACES_BUTTON); - FacesHelper.setupComponentId(context, cancelButton, "cancel-button"); - - // create the binding for the cancel button label - ValueBinding valueBinding = context.getApplication().createValueBinding( - "#{DialogManager.cancelButtonLabel}"); - cancelButton.setValueBinding("value", valueBinding); - - // create the action binding - MethodBinding methodBinding = context.getApplication().createMethodBinding( - "#{DialogManager.cancel}", null); - cancelButton.setAction(methodBinding); - - // setup CSS class for button - String styleClass = (String)this.getAttributes().get("styleClass"); - if (styleClass != null) - { - cancelButton.getAttributes().put("styleClass", styleClass); - } - - // set the immediate flag to true - cancelButton.getAttributes().put("immediate", Boolean.TRUE); - - // add the Cancel button - this.getChildren().add(cancelButton); - } - - /** - * If there are any additional buttons to add as defined by the dialog - * configuration and the dialog at runtime they are generated in this - * method. - * - * @param context Faces context - */ - @SuppressWarnings("unchecked") - protected void generateAdditionalButtons(FacesContext context) - { - // get potential list of additional buttons - List buttons = Application.getDialogManager().getAdditionalButtons(); - - if (buttons != null && buttons.size() > 0) - { - if (logger.isDebugEnabled()) - logger.debug("Adding " + buttons.size() + " additional buttons: " + buttons); - - // add a spacing row to separate the additional buttons from the OK button - addSpacingRow(context); - - for (DialogButtonConfig buttonCfg : buttons) - { - UICommand button = (UICommand)context.getApplication(). - createComponent(HtmlCommandButton.COMPONENT_TYPE); - button.setRendererType(ComponentConstants.JAVAX_FACES_BUTTON); - FacesHelper.setupComponentId(context, button, buttonCfg.getId()); - - // setup the value of the button (the label) - String label = buttonCfg.getLabel(); - if (label != null) - { - // see if the label represents a value binding - if (label.startsWith(BINDING_EXPRESSION_START)) - { - ValueBinding binding = context.getApplication().createValueBinding(label); - button.setValueBinding("value", binding); - } - else - { - button.setValue(label); - } - } - else - { - // NOTE: the config checks that a label or a label id - // is present so we can assume there is an id - // if there isn't a label - String labelId = buttonCfg.getLabelId(); - label = Application.getMessage(context, labelId); - button.setValue(label); - } - - // setup the action binding, the config checks that an action - // is present so no need to check for NullPointer. It also checks - // it represents a method binding expression. - String action = buttonCfg.getAction(); - MethodBinding methodBinding = context.getApplication(). - createMethodBinding(action, null); - button.setAction(methodBinding); - - // setup the disabled attribute, check for null and - // binding expressions - String disabled = buttonCfg.getDisabled(); - if (disabled != null && disabled.length() > 0) - { - if (disabled.startsWith(BINDING_EXPRESSION_START)) - { - ValueBinding binding = context.getApplication(). - createValueBinding(disabled); - button.setValueBinding("disabled", binding); - } - else - { - button.getAttributes().put("disabled", - Boolean.parseBoolean(disabled)); - } - } - - // setup CSS class for the button - String styleClass = (String)this.getAttributes().get("styleClass"); - if (styleClass != null) - { - button.getAttributes().put("styleClass", styleClass); - } - - // setup the onclick handler for the button - String onclick = buttonCfg.getOnclick(); - if (onclick != null && onclick.length() > 0) - { - button.getAttributes().put("onclick", onclick); - } - - // add the button - this.getChildren().add(button); - - if (logger.isDebugEnabled()) - logger.debug("Added button with id of: " + button.getId()); - } - - // add a spacing row to separate the additional buttons from the Cancel button - addSpacingRow(context); - } - } - - /** - * Creates an output text component to represent a spacing row. - * - * @param context Faces context - */ - @SuppressWarnings("unchecked") - protected void addSpacingRow(FacesContext context) - { - UIOutput spacingRow = (UIOutput)context.getApplication().createComponent( - ComponentConstants.JAVAX_FACES_OUTPUT); - spacingRow.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); - FacesHelper.setupComponentId(context, spacingRow, null); - spacingRow.setValue("

"); - spacingRow.getAttributes().put("escape", Boolean.FALSE); - this.getChildren().add(spacingRow); - } -} - - - +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.Iterator; +import java.util.List; + +import javax.faces.component.UICommand; +import javax.faces.component.UIComponent; +import javax.faces.component.UIOutput; +import javax.faces.component.html.HtmlCommandButton; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.MethodBinding; +import javax.faces.el.ValueBinding; + +import org.alfresco.web.app.Application; +import org.alfresco.web.app.servlet.FacesHelper; +import org.alfresco.web.config.DialogsConfigElement.DialogButtonConfig; +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.common.Utils; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Component that displays the buttons for a dialog. + *

+ * The standard OK and Cancel buttons + * are always generated. Any additional buttons, either configured + * or generated dynamically by the dialog, are generated in between + * the standard buttons. + * + * @author gavinc + */ +public class UIDialogButtons extends SelfRenderingComponent +{ + protected static final String BINDING_EXPRESSION_START = "#{"; + + private static final Log logger = LogFactory.getLog(UIDialogButtons.class); + + @Override + public String getFamily() + { + return "org.alfresco.faces.DialogButtons"; + } + + @Override + public void encodeBegin(FacesContext context) throws IOException + { + if (!isRendered()) return; + + if (this.getChildCount() == 0) + { + // generate all the required buttons the first time + generateButtons(context); + } + + ResponseWriter out = context.getResponseWriter(); + out.write(""); + } + + @Override + public void encodeChildren(FacesContext context) throws IOException + { + if (!isRendered()) return; + + ResponseWriter out = context.getResponseWriter(); + + // render the buttons + for (Iterator i = getChildren().iterator(); i.hasNext(); /**/) + { + out.write(""); + } + } + + @Override + public void encodeEnd(FacesContext context) throws IOException + { + if (!isRendered()) return; + + ResponseWriter out = context.getResponseWriter(); + out.write("
"); + + UIComponent child = (UIComponent)i.next(); + Utils.encodeRecursive(context, child); + + out.write("
"); + } + + @Override + public boolean getRendersChildren() + { + return true; + } + + /** + * Generates the buttons for the dialog currently being shown. + * + * @param context Faces context + */ + @SuppressWarnings("unchecked") + protected void generateButtons(FacesContext context) + { + // generate the OK button, if necessary + if (Application.getDialogManager().isOKButtonVisible()) + { + UICommand okButton = (UICommand)context.getApplication(). + createComponent(HtmlCommandButton.COMPONENT_TYPE); + okButton.setRendererType(ComponentConstants.JAVAX_FACES_BUTTON); + FacesHelper.setupComponentId(context, okButton, "finish-button"); + + // create the binding for the finish button label + ValueBinding valueBinding = context.getApplication().createValueBinding( + "#{DialogManager.finishButtonLabel}"); + okButton.setValueBinding("value", valueBinding); + + // create the action binding + MethodBinding methodBinding = context.getApplication().createMethodBinding( + "#{DialogManager.finish}", null); + okButton.setAction(methodBinding); + + // create the binding for whether the button is disabled + valueBinding = context.getApplication().createValueBinding( + "#{DialogManager.finishButtonDisabled}"); + okButton.setValueBinding("disabled", valueBinding); + + // setup CSS class for button + String styleClass = (String)this.getAttributes().get("styleClass"); + if (styleClass != null) + { + okButton.getAttributes().put("styleClass", styleClass); + } + + // add the OK button + this.getChildren().add(okButton); + } + + // generate the additional buttons + generateAdditionalButtons(context); + + // generate the OK button + UICommand cancelButton = (UICommand)context.getApplication(). + createComponent(HtmlCommandButton.COMPONENT_TYPE); + cancelButton.setRendererType(ComponentConstants.JAVAX_FACES_BUTTON); + FacesHelper.setupComponentId(context, cancelButton, "cancel-button"); + + // create the binding for the cancel button label + ValueBinding valueBinding = context.getApplication().createValueBinding( + "#{DialogManager.cancelButtonLabel}"); + cancelButton.setValueBinding("value", valueBinding); + + // create the action binding + MethodBinding methodBinding = context.getApplication().createMethodBinding( + "#{DialogManager.cancel}", null); + cancelButton.setAction(methodBinding); + + // setup CSS class for button + String styleClass = (String)this.getAttributes().get("styleClass"); + if (styleClass != null) + { + cancelButton.getAttributes().put("styleClass", styleClass); + } + + // set the immediate flag to true + cancelButton.getAttributes().put("immediate", Boolean.TRUE); + + // add the Cancel button + this.getChildren().add(cancelButton); + } + + /** + * If there are any additional buttons to add as defined by the dialog + * configuration and the dialog at runtime they are generated in this + * method. + * + * @param context Faces context + */ + @SuppressWarnings("unchecked") + protected void generateAdditionalButtons(FacesContext context) + { + // get potential list of additional buttons + List buttons = Application.getDialogManager().getAdditionalButtons(); + + if (buttons != null && buttons.size() > 0) + { + if (logger.isDebugEnabled()) + logger.debug("Adding " + buttons.size() + " additional buttons: " + buttons); + + // add a spacing row to separate the additional buttons from the OK button + addSpacingRow(context); + + for (DialogButtonConfig buttonCfg : buttons) + { + UICommand button = (UICommand)context.getApplication(). + createComponent(HtmlCommandButton.COMPONENT_TYPE); + button.setRendererType(ComponentConstants.JAVAX_FACES_BUTTON); + FacesHelper.setupComponentId(context, button, buttonCfg.getId()); + + // setup the value of the button (the label) + String label = buttonCfg.getLabel(); + if (label != null) + { + // see if the label represents a value binding + if (label.startsWith(BINDING_EXPRESSION_START)) + { + ValueBinding binding = context.getApplication().createValueBinding(label); + button.setValueBinding("value", binding); + } + else + { + button.setValue(label); + } + } + else + { + // NOTE: the config checks that a label or a label id + // is present so we can assume there is an id + // if there isn't a label + String labelId = buttonCfg.getLabelId(); + label = Application.getMessage(context, labelId); + button.setValue(label); + } + + // setup the action binding, the config checks that an action + // is present so no need to check for NullPointer. It also checks + // it represents a method binding expression. + String action = buttonCfg.getAction(); + MethodBinding methodBinding = context.getApplication(). + createMethodBinding(action, null); + button.setAction(methodBinding); + + // setup the disabled attribute, check for null and + // binding expressions + String disabled = buttonCfg.getDisabled(); + if (disabled != null && disabled.length() > 0) + { + if (disabled.startsWith(BINDING_EXPRESSION_START)) + { + ValueBinding binding = context.getApplication(). + createValueBinding(disabled); + button.setValueBinding("disabled", binding); + } + else + { + button.getAttributes().put("disabled", + Boolean.parseBoolean(disabled)); + } + } + + // setup CSS class for the button + String styleClass = (String)this.getAttributes().get("styleClass"); + if (styleClass != null) + { + button.getAttributes().put("styleClass", styleClass); + } + + // setup the onclick handler for the button + String onclick = buttonCfg.getOnclick(); + if (onclick != null && onclick.length() > 0) + { + button.getAttributes().put("onclick", onclick); + } + + // add the button + this.getChildren().add(button); + + if (logger.isDebugEnabled()) + logger.debug("Added button with id of: " + button.getId()); + } + + // add a spacing row to separate the additional buttons from the Cancel button + addSpacingRow(context); + } + } + + /** + * Creates an output text component to represent a spacing row. + * + * @param context Faces context + */ + @SuppressWarnings("unchecked") + protected void addSpacingRow(FacesContext context) + { + UIOutput spacingRow = (UIOutput)context.getApplication().createComponent( + ComponentConstants.JAVAX_FACES_OUTPUT); + spacingRow.setRendererType(ComponentConstants.JAVAX_FACES_TEXT); + FacesHelper.setupComponentId(context, spacingRow, null); + spacingRow.setValue("

"); + spacingRow.getAttributes().put("escape", Boolean.FALSE); + this.getChildren().add(spacingRow); + } +} + + + diff --git a/source/java/org/alfresco/web/ui/repo/component/UIMimeTypeSelector.java b/source/java/org/alfresco/web/ui/repo/component/UIMimeTypeSelector.java index 1adeda81e0..640229f0a1 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIMimeTypeSelector.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIMimeTypeSelector.java @@ -1,76 +1,76 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -import javax.faces.component.UISelectItems; -import javax.faces.component.UISelectOne; -import javax.faces.context.FacesContext; -import javax.faces.model.SelectItem; - -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.MimetypeService; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; - -/** - * Component that holds a list of MIME types configured in the repository. - * - * @author gavinc - */ -public class UIMimeTypeSelector extends UISelectOne -{ - public static final String COMPONENT_TYPE = "org.alfresco.faces.MimeTypeSelector"; - public static final String COMPONENT_FAMILY = "javax.faces.SelectOne"; - - @Override - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - // if the component does not have any children yet create the - // list of MIME types the user can choose from as a child - // SelectItems component. - if (getChildren().size() == 0) - { - UISelectItems items = (UISelectItems)context.getApplication(). - createComponent("javax.faces.SelectItems"); - items.setId(this.getId() + "_items"); - items.setValue(createList()); - - // add the child component - getChildren().add(items); - } - - // do the default processing - super.encodeBegin(context); - } - - /** - * Creates the list of SelectItem components to represent the list - * of MIME types the user can select from - * - * @return List of SelectItem components - */ - protected List createList() - { - List items = new ArrayList(80); - ServiceRegistry registry = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); - MimetypeService mimetypeService = registry.getMimetypeService(); - - // get the mime type display names - Map mimeTypes = mimetypeService.getDisplaysByMimetype(); - for (String mimeType : mimeTypes.keySet()) - { - items.add(new SelectItem(mimeType, mimeTypes.get(mimeType))); - } - - // make sure the list is sorted by the values - QuickSort sorter = new QuickSort(items, "label", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - - return items; - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import javax.faces.component.UISelectItems; +import javax.faces.component.UISelectOne; +import javax.faces.context.FacesContext; +import javax.faces.model.SelectItem; + +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.MimetypeService; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; + +/** + * Component that holds a list of MIME types configured in the repository. + * + * @author gavinc + */ +public class UIMimeTypeSelector extends UISelectOne +{ + public static final String COMPONENT_TYPE = "org.alfresco.faces.MimeTypeSelector"; + public static final String COMPONENT_FAMILY = "javax.faces.SelectOne"; + + @Override + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + // if the component does not have any children yet create the + // list of MIME types the user can choose from as a child + // SelectItems component. + if (getChildren().size() == 0) + { + UISelectItems items = (UISelectItems)context.getApplication(). + createComponent("javax.faces.SelectItems"); + items.setId(this.getId() + "_items"); + items.setValue(createList()); + + // add the child component + getChildren().add(items); + } + + // do the default processing + super.encodeBegin(context); + } + + /** + * Creates the list of SelectItem components to represent the list + * of MIME types the user can select from + * + * @return List of SelectItem components + */ + protected List createList() + { + List items = new ArrayList(80); + ServiceRegistry registry = Repository.getServiceRegistry(FacesContext.getCurrentInstance()); + MimetypeService mimetypeService = registry.getMimetypeService(); + + // get the mime type display names + Map mimeTypes = mimetypeService.getDisplaysByMimetype(); + for (String mimeType : mimeTypes.keySet()) + { + items.add(new SelectItem(mimeType, mimeTypes.get(mimeType))); + } + + // make sure the list is sorted by the values + QuickSort sorter = new QuickSort(items, "label", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + + return items; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UINodeInfo.java b/source/java/org/alfresco/web/ui/repo/component/UINodeInfo.java index bf84995f9f..3550673f13 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UINodeInfo.java +++ b/source/java/org/alfresco/web/ui/repo/component/UINodeInfo.java @@ -1,133 +1,133 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.ValueBinding; - -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; - -/** - * JSF component that displays information about a node. - * - * @author gavinc - */ -public class UINodeInfo extends SelfRenderingComponent -{ - protected final static String NODE_INFO_SCRIPTS_WRITTEN = "_alfNodeInfoScripts"; - - protected Object value = null; - - - // ------------------------------------------------------------------------------ - // Component Impl - - @Override - public String getFamily() - { - return "org.alfresco.faces.NodeInfo"; - } - - @Override - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.value = values[1]; - } - - @Override - public Object saveState(FacesContext context) - { - Object values[] = new Object[] { - super.saveState(context), - this.value}; - return values; - } - - @Override - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - if (!isRendered()) return; - - // if AJAX is disabled don't render anything - if (Application.getClientConfig(context).isNodeSummaryEnabled()) - { - ResponseWriter out = context.getResponseWriter(); - - outputNodeInfoScripts(context, out); - - // wrap the child components in a that has the onmouseover - // event which kicks off the request for node information - // we key the node info panel by the noderef string of the current node - String noderef = Repository.getStoreRef().toString() + '/' + (String)this.getValue(); - out.write(""); - } - } - - protected static void outputNodeInfoScripts(FacesContext context, ResponseWriter out) throws IOException - { - // write out the JavaScript specific to the NodeInfo component, ensure it's only done once - Object present = context.getExternalContext().getRequestMap().get(NODE_INFO_SCRIPTS_WRITTEN); - if (present == null) - { - out.write(""); - - context.getExternalContext().getRequestMap().put( - NODE_INFO_SCRIPTS_WRITTEN, Boolean.TRUE); - } - } - - @Override - public void encodeEnd(FacesContext context) throws IOException - { - if (!isRendered()) return; - - // if AJAX is disabled don't render anything - if (Application.getClientConfig(context).isNodeSummaryEnabled()) - { - context.getResponseWriter().write(""); - } - } - - - // ------------------------------------------------------------------------------ - // Strongly typed component property accessors - - /** - * Get the value - the value is used in a equals() match against the current value in the - * parent ModeList component to set the selected item. - * - * @return the value - */ - public Object getValue() - { - ValueBinding vb = getValueBinding("value"); - if (vb != null) - { - this.value = vb.getValue(getFacesContext()); - } - - return this.value; - } - - /** - * Set the value - the value is used in a equals() match against the current value in the - * parent ModeList component to set the selected item. - * - * @param value the value - */ - public void setValue(Object value) - { - this.value = value; - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.ValueBinding; + +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; + +/** + * JSF component that displays information about a node. + * + * @author gavinc + */ +public class UINodeInfo extends SelfRenderingComponent +{ + protected final static String NODE_INFO_SCRIPTS_WRITTEN = "_alfNodeInfoScripts"; + + protected Object value = null; + + + // ------------------------------------------------------------------------------ + // Component Impl + + @Override + public String getFamily() + { + return "org.alfresco.faces.NodeInfo"; + } + + @Override + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.value = values[1]; + } + + @Override + public Object saveState(FacesContext context) + { + Object values[] = new Object[] { + super.saveState(context), + this.value}; + return values; + } + + @Override + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + if (!isRendered()) return; + + // if AJAX is disabled don't render anything + if (Application.getClientConfig(context).isNodeSummaryEnabled()) + { + ResponseWriter out = context.getResponseWriter(); + + outputNodeInfoScripts(context, out); + + // wrap the child components in a that has the onmouseover + // event which kicks off the request for node information + // we key the node info panel by the noderef string of the current node + String noderef = Repository.getStoreRef().toString() + '/' + (String)this.getValue(); + out.write(""); + } + } + + protected static void outputNodeInfoScripts(FacesContext context, ResponseWriter out) throws IOException + { + // write out the JavaScript specific to the NodeInfo component, ensure it's only done once + Object present = context.getExternalContext().getRequestMap().get(NODE_INFO_SCRIPTS_WRITTEN); + if (present == null) + { + out.write(""); + + context.getExternalContext().getRequestMap().put( + NODE_INFO_SCRIPTS_WRITTEN, Boolean.TRUE); + } + } + + @Override + public void encodeEnd(FacesContext context) throws IOException + { + if (!isRendered()) return; + + // if AJAX is disabled don't render anything + if (Application.getClientConfig(context).isNodeSummaryEnabled()) + { + context.getResponseWriter().write(""); + } + } + + + // ------------------------------------------------------------------------------ + // Strongly typed component property accessors + + /** + * Get the value - the value is used in a equals() match against the current value in the + * parent ModeList component to set the selected item. + * + * @return the value + */ + public Object getValue() + { + ValueBinding vb = getValueBinding("value"); + if (vb != null) + { + this.value = vb.getValue(getFacesContext()); + } + + return this.value; + } + + /** + * Set the value - the value is used in a equals() match against the current value in the + * parent ModeList component to set the selected item. + * + * @param value the value + */ + public void setValue(Object value) + { + this.value = value; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UINodeWorkflowInfo.java b/source/java/org/alfresco/web/ui/repo/component/UINodeWorkflowInfo.java index 588be8fbde..e9616957ed 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UINodeWorkflowInfo.java +++ b/source/java/org/alfresco/web/ui/repo/component/UINodeWorkflowInfo.java @@ -1,347 +1,347 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.text.MessageFormat; -import java.util.List; -import java.util.Map; -import java.util.ResourceBundle; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.ValueBinding; - -import org.alfresco.model.ApplicationModel; -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.dictionary.DictionaryService; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.workflow.WorkflowInstance; -import org.alfresco.service.cmr.workflow.WorkflowService; -import org.alfresco.service.namespace.QName; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.User; -import org.alfresco.web.ui.common.Utils; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; - -/** - * JSF component that displays information about the workflows a node is involved in. - *

- * The node to show workflow information on. - * - * @author gavinc - */ -public class UINodeWorkflowInfo extends SelfRenderingComponent -{ - protected Node value = null; - - // ------------------------------------------------------------------------------ - // Component Impl - - @Override - public String getFamily() - { - return "org.alfresco.faces.NodeWorkflowInfo"; - } - - @Override - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.value = (Node)values[1]; - } - - @Override - public Object saveState(FacesContext context) - { - Object values[] = new Object[8]; - // standard component attributes are saved by the super class - values[0] = super.saveState(context); - values[1] = this.value; - return values; - } - - @Override - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - if (!isRendered()) return; - - // get the node to display the information for - Node node = getValue(); - - if (node != null) - { - // get the services we need - NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); - DictionaryService ddService = Repository.getServiceRegistry(context).getDictionaryService(); - WorkflowService workflowService = Repository.getServiceRegistry(context).getWorkflowService(); - ResponseWriter out = context.getResponseWriter(); - ResourceBundle bundle = Application.getBundle(context); - - // render simple workflow info - renderSimpleWorkflowInfo(context, node, nodeService, ddService, out, bundle); - - // render advanced workflow info - renderAdvancedWorkflowInfo(context, node, nodeService, ddService, workflowService, out, bundle); - } - } - - @Override - public void encodeEnd(FacesContext context) throws IOException - { - if (!isRendered()) return; - } - - // ------------------------------------------------------------------------------ - // Strongly typed component property accessors - - /** - * Get the value, this will be a node representing a piece of content or a space - * - * @return the value - */ - public Node getValue() - { - ValueBinding vb = getValueBinding("value"); - if (vb != null) - { - this.value = (Node)vb.getValue(getFacesContext()); - } - - return this.value; - } - - /** - * Set the value, either a space or content node. - * - * @param value the value - */ - public void setValue(Node value) - { - this.value = value; - } - - // ------------------------------------------------------------------------------ - // Helper methods - - /** - * Renders the simple workflow details for the given node. - * - * @param context Faces context - * @param node The node - * @param nodeService The NodeService instance - * @param ddService The Data Dictionary instance - * @param out The response writer - * @param bundle Message bundle to get strings from - */ - protected void renderSimpleWorkflowInfo(FacesContext context, Node node, - NodeService nodeService, DictionaryService ddService, - ResponseWriter out, ResourceBundle bundle) - throws IOException - { - boolean isContent = true; - - QName type = nodeService.getType(node.getNodeRef()); - if (ddService.isSubClass(type, ContentModel.TYPE_FOLDER)) - { - isContent = false; - } - - // Render HTML for simple workflow - if (isContent) - { - // TODO: for now we only support advanced workflow on content so only - // render the simple workflow title if the node is a content node - out.write("

"); - out.write(bundle.getString("simple_workflow")); - out.write("
"); - } - out.write("
"); - - if (node.hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) - { - // get the simple workflow aspect properties - Map props = node.getProperties(); - - String approveStepName = (String)props.get( - ApplicationModel.PROP_APPROVE_STEP.toString()); - String rejectStepName = (String)props.get( - ApplicationModel.PROP_REJECT_STEP.toString()); - - Boolean approveMove = (Boolean)props.get( - ApplicationModel.PROP_APPROVE_MOVE.toString()); - Boolean rejectMove = (Boolean)props.get( - ApplicationModel.PROP_REJECT_MOVE.toString()); - - NodeRef approveFolder = (NodeRef)props.get( - ApplicationModel.PROP_APPROVE_FOLDER.toString()); - NodeRef rejectFolder = (NodeRef)props.get( - ApplicationModel.PROP_REJECT_FOLDER.toString()); - - String approveFolderName = null; - String rejectFolderName = null; - - // get the approve folder name - if (approveFolder != null) - { - Node approveNode = new Node(approveFolder); - approveFolderName = approveNode.getName(); - } - - // get the reject folder name - if (rejectFolder != null) - { - Node rejectNode = new Node(rejectFolder); - rejectFolderName = rejectNode.getName(); - } - - // calculate the approve action string - String action = null; - if (approveMove.booleanValue()) - { - action = Application.getMessage(FacesContext.getCurrentInstance(), "moved"); - } - else - { - action = Application.getMessage(FacesContext.getCurrentInstance(), "copied"); - } - - String actionPattern = null; - if (isContent) - { - actionPattern = Application.getMessage(FacesContext.getCurrentInstance(), "document_action"); - } - else - { - actionPattern = Application.getMessage(FacesContext.getCurrentInstance(), "space_action"); - } - Object[] params = new Object[] {action, approveFolderName, approveStepName}; - out.write(Utils.encode(MessageFormat.format(actionPattern, params))); - - // add details of the reject step if there is one - if (rejectStepName != null && rejectMove != null && rejectFolderName != null) - { - if (rejectMove.booleanValue()) - { - action = Application.getMessage(FacesContext.getCurrentInstance(), "moved"); - } - else - { - action = Application.getMessage(FacesContext.getCurrentInstance(), "copied"); - } - - out.write(" "); - params = new Object[] {action, rejectFolderName, rejectStepName}; - out.write(Utils.encode(MessageFormat.format(actionPattern, params))); - } - } - else - { - // work out which no workflow message to show depending on the node type - if (isContent) - { - out.write(bundle.getString("doc_not_in_simple_workflow")); - } - else - { - out.write(bundle.getString("space_not_in_simple_workflow")); - } - } - out.write("
"); - } - - /** - * Renders the advanced workflow details for the given node. - * - * @param context Faces context - * @param node The node - * @param nodeService The NodeService instance - * @param ddService The Data Dictionary instance - * @param workflowService The WorkflowService instance - * @param out The response writer - * @param bundle Message bundle to get strings from - */ - protected void renderAdvancedWorkflowInfo(FacesContext context, Node node, - NodeService nodeService, DictionaryService ddService, WorkflowService workflowService, - ResponseWriter out, ResourceBundle bundle) - throws IOException - { - boolean isContent = true; - - QName type = nodeService.getType(node.getNodeRef()); - if (ddService.isSubClass(type, ContentModel.TYPE_FOLDER)) - { - isContent = false; - } - - // TODO: for now we only support advanced workflow on content so don't render - // anything for other types - if (isContent) - { - // Render HTML for advanved workflow - out.write("
"); - out.write(bundle.getString("advanced_workflows")); - out.write("
"); - - List workflows = workflowService.getWorkflowsForContent( - node.getNodeRef(), true); - if (workflows != null && workflows.size() > 0) - { - // list out all the workflows the document is part of - if (isContent) - { - out.write(bundle.getString("doc_part_of_advanced_workflows")); - } - else - { - out.write(bundle.getString("space_part_of_advanced_workflows")); - } - out.write(":
    "); - for (WorkflowInstance wi : workflows) - { - out.write("
  • "); - out.write(wi.definition.title); - if (wi.description != null && wi.description.length() > 0) - { - out.write(" ("); - out.write(Utils.encode(wi.description)); - out.write(")"); - } - out.write(" "); - if (wi.startDate != null) - { - out.write(bundle.getString("started_on").toLowerCase()); - out.write(" "); - out.write(Utils.getDateFormat(context).format(wi.startDate)); - out.write(" "); - } - if (wi.initiator != null) - { - out.write(bundle.getString("by")); - out.write(" "); - out.write(Utils.encode(User.getFullName(nodeService, wi.initiator))); - out.write("."); - } - out.write("
    • "); - } - out.write("
"); - } - else - { - if (isContent) - { - out.write(bundle.getString("doc_not_in_advanced_workflow")); - } - else - { - out.write(bundle.getString("space_not_in_advanced_workflow")); - } - } - out.write("
"); - } - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.text.MessageFormat; +import java.util.List; +import java.util.Map; +import java.util.ResourceBundle; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.ValueBinding; + +import org.alfresco.model.ApplicationModel; +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.dictionary.DictionaryService; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.workflow.WorkflowInstance; +import org.alfresco.service.cmr.workflow.WorkflowService; +import org.alfresco.service.namespace.QName; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.User; +import org.alfresco.web.ui.common.Utils; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; + +/** + * JSF component that displays information about the workflows a node is involved in. + *

+ * The node to show workflow information on. + * + * @author gavinc + */ +public class UINodeWorkflowInfo extends SelfRenderingComponent +{ + protected Node value = null; + + // ------------------------------------------------------------------------------ + // Component Impl + + @Override + public String getFamily() + { + return "org.alfresco.faces.NodeWorkflowInfo"; + } + + @Override + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.value = (Node)values[1]; + } + + @Override + public Object saveState(FacesContext context) + { + Object values[] = new Object[8]; + // standard component attributes are saved by the super class + values[0] = super.saveState(context); + values[1] = this.value; + return values; + } + + @Override + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + if (!isRendered()) return; + + // get the node to display the information for + Node node = getValue(); + + if (node != null) + { + // get the services we need + NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); + DictionaryService ddService = Repository.getServiceRegistry(context).getDictionaryService(); + WorkflowService workflowService = Repository.getServiceRegistry(context).getWorkflowService(); + ResponseWriter out = context.getResponseWriter(); + ResourceBundle bundle = Application.getBundle(context); + + // render simple workflow info + renderSimpleWorkflowInfo(context, node, nodeService, ddService, out, bundle); + + // render advanced workflow info + renderAdvancedWorkflowInfo(context, node, nodeService, ddService, workflowService, out, bundle); + } + } + + @Override + public void encodeEnd(FacesContext context) throws IOException + { + if (!isRendered()) return; + } + + // ------------------------------------------------------------------------------ + // Strongly typed component property accessors + + /** + * Get the value, this will be a node representing a piece of content or a space + * + * @return the value + */ + public Node getValue() + { + ValueBinding vb = getValueBinding("value"); + if (vb != null) + { + this.value = (Node)vb.getValue(getFacesContext()); + } + + return this.value; + } + + /** + * Set the value, either a space or content node. + * + * @param value the value + */ + public void setValue(Node value) + { + this.value = value; + } + + // ------------------------------------------------------------------------------ + // Helper methods + + /** + * Renders the simple workflow details for the given node. + * + * @param context Faces context + * @param node The node + * @param nodeService The NodeService instance + * @param ddService The Data Dictionary instance + * @param out The response writer + * @param bundle Message bundle to get strings from + */ + protected void renderSimpleWorkflowInfo(FacesContext context, Node node, + NodeService nodeService, DictionaryService ddService, + ResponseWriter out, ResourceBundle bundle) + throws IOException + { + boolean isContent = true; + + QName type = nodeService.getType(node.getNodeRef()); + if (ddService.isSubClass(type, ContentModel.TYPE_FOLDER)) + { + isContent = false; + } + + // Render HTML for simple workflow + if (isContent) + { + // TODO: for now we only support advanced workflow on content so only + // render the simple workflow title if the node is a content node + out.write("

"); + out.write(bundle.getString("simple_workflow")); + out.write("
"); + } + out.write("
"); + + if (node.hasAspect(ApplicationModel.ASPECT_SIMPLE_WORKFLOW)) + { + // get the simple workflow aspect properties + Map props = node.getProperties(); + + String approveStepName = (String)props.get( + ApplicationModel.PROP_APPROVE_STEP.toString()); + String rejectStepName = (String)props.get( + ApplicationModel.PROP_REJECT_STEP.toString()); + + Boolean approveMove = (Boolean)props.get( + ApplicationModel.PROP_APPROVE_MOVE.toString()); + Boolean rejectMove = (Boolean)props.get( + ApplicationModel.PROP_REJECT_MOVE.toString()); + + NodeRef approveFolder = (NodeRef)props.get( + ApplicationModel.PROP_APPROVE_FOLDER.toString()); + NodeRef rejectFolder = (NodeRef)props.get( + ApplicationModel.PROP_REJECT_FOLDER.toString()); + + String approveFolderName = null; + String rejectFolderName = null; + + // get the approve folder name + if (approveFolder != null) + { + Node approveNode = new Node(approveFolder); + approveFolderName = approveNode.getName(); + } + + // get the reject folder name + if (rejectFolder != null) + { + Node rejectNode = new Node(rejectFolder); + rejectFolderName = rejectNode.getName(); + } + + // calculate the approve action string + String action = null; + if (approveMove.booleanValue()) + { + action = Application.getMessage(FacesContext.getCurrentInstance(), "moved"); + } + else + { + action = Application.getMessage(FacesContext.getCurrentInstance(), "copied"); + } + + String actionPattern = null; + if (isContent) + { + actionPattern = Application.getMessage(FacesContext.getCurrentInstance(), "document_action"); + } + else + { + actionPattern = Application.getMessage(FacesContext.getCurrentInstance(), "space_action"); + } + Object[] params = new Object[] {action, approveFolderName, approveStepName}; + out.write(Utils.encode(MessageFormat.format(actionPattern, params))); + + // add details of the reject step if there is one + if (rejectStepName != null && rejectMove != null && rejectFolderName != null) + { + if (rejectMove.booleanValue()) + { + action = Application.getMessage(FacesContext.getCurrentInstance(), "moved"); + } + else + { + action = Application.getMessage(FacesContext.getCurrentInstance(), "copied"); + } + + out.write(" "); + params = new Object[] {action, rejectFolderName, rejectStepName}; + out.write(Utils.encode(MessageFormat.format(actionPattern, params))); + } + } + else + { + // work out which no workflow message to show depending on the node type + if (isContent) + { + out.write(bundle.getString("doc_not_in_simple_workflow")); + } + else + { + out.write(bundle.getString("space_not_in_simple_workflow")); + } + } + out.write("
"); + } + + /** + * Renders the advanced workflow details for the given node. + * + * @param context Faces context + * @param node The node + * @param nodeService The NodeService instance + * @param ddService The Data Dictionary instance + * @param workflowService The WorkflowService instance + * @param out The response writer + * @param bundle Message bundle to get strings from + */ + protected void renderAdvancedWorkflowInfo(FacesContext context, Node node, + NodeService nodeService, DictionaryService ddService, WorkflowService workflowService, + ResponseWriter out, ResourceBundle bundle) + throws IOException + { + boolean isContent = true; + + QName type = nodeService.getType(node.getNodeRef()); + if (ddService.isSubClass(type, ContentModel.TYPE_FOLDER)) + { + isContent = false; + } + + // TODO: for now we only support advanced workflow on content so don't render + // anything for other types + if (isContent) + { + // Render HTML for advanved workflow + out.write("
"); + out.write(bundle.getString("advanced_workflows")); + out.write("
"); + + List workflows = workflowService.getWorkflowsForContent( + node.getNodeRef(), true); + if (workflows != null && workflows.size() > 0) + { + // list out all the workflows the document is part of + if (isContent) + { + out.write(bundle.getString("doc_part_of_advanced_workflows")); + } + else + { + out.write(bundle.getString("space_part_of_advanced_workflows")); + } + out.write(":
    "); + for (WorkflowInstance wi : workflows) + { + out.write("
  • "); + out.write(wi.definition.title); + if (wi.description != null && wi.description.length() > 0) + { + out.write(" ("); + out.write(Utils.encode(wi.description)); + out.write(")"); + } + out.write(" "); + if (wi.startDate != null) + { + out.write(bundle.getString("started_on").toLowerCase()); + out.write(" "); + out.write(Utils.getDateFormat(context).format(wi.startDate)); + out.write(" "); + } + if (wi.initiator != null) + { + out.write(bundle.getString("by")); + out.write(" "); + out.write(Utils.encode(User.getFullName(nodeService, wi.initiator))); + out.write("."); + } + out.write("
    • "); + } + out.write("
"); + } + else + { + if (isContent) + { + out.write(bundle.getString("doc_not_in_advanced_workflow")); + } + else + { + out.write(bundle.getString("space_not_in_advanced_workflow")); + } + } + out.write("
"); + } + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIOpenSearch.java b/source/java/org/alfresco/web/ui/repo/component/UIOpenSearch.java index dc7c411079..cde1530a97 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIOpenSearch.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIOpenSearch.java @@ -1,340 +1,340 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; -import java.util.Set; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.repo.content.MimetypeMap; -import org.alfresco.repo.web.scripts.bean.SearchProxy; -import org.alfresco.repo.web.scripts.config.OpenSearchConfigElement; -import org.alfresco.repo.web.scripts.config.OpenSearchConfigElement.EngineConfig; -import org.alfresco.web.app.Application; -import org.alfresco.web.ui.common.Utils; -import org.springframework.extensions.config.Config; -import org.springframework.extensions.config.ConfigService; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; -import org.springframework.web.jsf.FacesContextUtils; - -/** - * JSF component that provides an OpenSearch client, the engines - * searched are configured via the web api config. - * - * @author gavinc - */ -public class UIOpenSearch extends SelfRenderingComponent -{ - protected final static String SCRIPTS_WRITTEN = "_alfOpenSearchScripts"; - protected final static String ENGINE_ID_PREFIX = "eng"; - - // ------------------------------------------------------------------------------ - // Component Impl - - @Override - public String getFamily() - { - return "org.alfresco.faces.OpenSearch"; - } - - @Override - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - if (!isRendered()) return; - - ResponseWriter out = context.getResponseWriter(); - - List engines = getRegisteredEngines(context); - if (engines != null && engines.size() == 0) - { - out.write(Application.getMessage(context, "no_engines_registered")); - return; - } - - String clientId = this.getId(); - - // write out the JavaScript specific to the OpenSearch component, - // make sure it's only done once - Object present = context.getExternalContext().getRequestMap().get(SCRIPTS_WRITTEN); - if (present == null) - { - out.write(""); - out.write(""); - - context.getExternalContext().getRequestMap().put(SCRIPTS_WRITTEN, Boolean.TRUE); - } - - // we use summary info panel pop-ups so need scripts for that object - UINodeInfo.outputNodeInfoScripts(context, out); - - // write out the javascript initialisation required - out.write("\n"); - - // write out the HTML - String styleClass = (String)this.getAttributes().get("styleClass"); - String style = (String)this.getAttributes().get("style"); - - if (styleClass != null || style != null) - { - out.write(" 0) - { - out.write(" class='"); - out.write(styleClass); - out.write("'"); - } - - if (style != null && style.length() > 0) - { - out.write(" style='"); - out.write(style); - out.write("'"); - } - - out.write(">\n"); - } - - out.write("
"); - out.write(""); - out.write("
"); - out.write("
\n"); - out.write("
"); - out.write(Application.getMessage(context, "options")); - out.write("
\n"); - - out.write("
"); - out.write(Application.getMessage(context, "show")); - out.write(""); - out.write(Application.getMessage(context, "items_per_page")); - out.write("
"); - out.write(Application.getMessage(context, "search_in")); - out.write(":
"); - for (OpenSearchEngine engine : engines) - { - out.write(""); - } - out.write("
"); - out.write(""); - out.write(Utils.encode(engine.getLabel())); - out.write("
\n"); - - out.write("
\n
\n"); - - if (styleClass != null || style != null) - { - out.write("
\n"); - } - } - - /** - * Returns a list of OpenSearchEngine objects representing the - * registered OpenSearch engines. - * - * @param context Faces context - * @return List of registered engines - */ - private List getRegisteredEngines(FacesContext context) - { - List engines = null; - - // get the web api config service object from spring - ConfigService cfgSvc = (ConfigService)FacesContextUtils. - getRequiredWebApplicationContext(context).getBean("webscripts.config"); - SearchProxy searchProxy = (SearchProxy)FacesContextUtils. - getRequiredWebApplicationContext(context).getBean("webscript.org.alfresco.repository.search.searchproxy.get"); - if (cfgSvc != null) - { - // get the OpenSearch configuration - Config cfg = cfgSvc.getConfig("OpenSearch"); - OpenSearchConfigElement osConfig = (OpenSearchConfigElement)cfg. - getConfigElement(OpenSearchConfigElement.CONFIG_ELEMENT_ID); - if (osConfig != null) - { - // generate the the list of engines with a unique for each - int id = 1; - engines = new ArrayList(); - - Set enginesCfg = osConfig.getEngines(); - for (EngineConfig engineCfg : enginesCfg) - { - // resolve engine label - String label = engineCfg.getLabel(); - String labelId = engineCfg.getLabelId(); - if (labelId != null && labelId.length() > 0) - { - label = Application.getMessage(context, labelId); - } - - // locate search engine template url of most appropriate response type - String url = searchProxy.createUrl(engineCfg, MimetypeMap.MIMETYPE_ATOM); - if (url == null) - { - url = searchProxy.createUrl(engineCfg, MimetypeMap.MIMETYPE_RSS); - } - - if (url != null) - { - if (url.startsWith("/")) - { - url = context.getExternalContext().getRequestContextPath() + "/wcservice" + url; - } - - // add the engine - OpenSearchEngine engine = new OpenSearchEngine(id, label, url); - engines.add(engine); - - // increase the id counter - id++; - } - } - } - } - - return engines; - } - - /** - * Inner class representing a registered OpenSearch engine. - */ - private class OpenSearchEngine - { - private String id; - private String label; - private String url; - - public OpenSearchEngine(int id, String label, String url) - { - this.id = ENGINE_ID_PREFIX + Integer.toString(id); - this.label = label; - this.url = url; - } - - public String getId() - { - return id; - } - - public String getLabel() - { - return label; - } - - public String getUrl() - { - return url; - } - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.Set; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.repo.content.MimetypeMap; +import org.alfresco.repo.web.scripts.bean.SearchProxy; +import org.alfresco.repo.web.scripts.config.OpenSearchConfigElement; +import org.alfresco.repo.web.scripts.config.OpenSearchConfigElement.EngineConfig; +import org.alfresco.web.app.Application; +import org.alfresco.web.ui.common.Utils; +import org.springframework.extensions.config.Config; +import org.springframework.extensions.config.ConfigService; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; +import org.springframework.web.jsf.FacesContextUtils; + +/** + * JSF component that provides an OpenSearch client, the engines + * searched are configured via the web api config. + * + * @author gavinc + */ +public class UIOpenSearch extends SelfRenderingComponent +{ + protected final static String SCRIPTS_WRITTEN = "_alfOpenSearchScripts"; + protected final static String ENGINE_ID_PREFIX = "eng"; + + // ------------------------------------------------------------------------------ + // Component Impl + + @Override + public String getFamily() + { + return "org.alfresco.faces.OpenSearch"; + } + + @Override + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + if (!isRendered()) return; + + ResponseWriter out = context.getResponseWriter(); + + List engines = getRegisteredEngines(context); + if (engines != null && engines.size() == 0) + { + out.write(Application.getMessage(context, "no_engines_registered")); + return; + } + + String clientId = this.getId(); + + // write out the JavaScript specific to the OpenSearch component, + // make sure it's only done once + Object present = context.getExternalContext().getRequestMap().get(SCRIPTS_WRITTEN); + if (present == null) + { + out.write(""); + out.write(""); + + context.getExternalContext().getRequestMap().put(SCRIPTS_WRITTEN, Boolean.TRUE); + } + + // we use summary info panel pop-ups so need scripts for that object + UINodeInfo.outputNodeInfoScripts(context, out); + + // write out the javascript initialisation required + out.write("\n"); + + // write out the HTML + String styleClass = (String)this.getAttributes().get("styleClass"); + String style = (String)this.getAttributes().get("style"); + + if (styleClass != null || style != null) + { + out.write(" 0) + { + out.write(" class='"); + out.write(styleClass); + out.write("'"); + } + + if (style != null && style.length() > 0) + { + out.write(" style='"); + out.write(style); + out.write("'"); + } + + out.write(">\n"); + } + + out.write("
"); + out.write(""); + out.write("
"); + out.write("
\n"); + out.write("
"); + out.write(Application.getMessage(context, "options")); + out.write("
\n"); + + out.write("
"); + out.write(Application.getMessage(context, "show")); + out.write(""); + out.write(Application.getMessage(context, "items_per_page")); + out.write("
"); + out.write(Application.getMessage(context, "search_in")); + out.write(":
"); + for (OpenSearchEngine engine : engines) + { + out.write(""); + } + out.write("
"); + out.write(""); + out.write(Utils.encode(engine.getLabel())); + out.write("
\n"); + + out.write("
\n
\n"); + + if (styleClass != null || style != null) + { + out.write("
\n"); + } + } + + /** + * Returns a list of OpenSearchEngine objects representing the + * registered OpenSearch engines. + * + * @param context Faces context + * @return List of registered engines + */ + private List getRegisteredEngines(FacesContext context) + { + List engines = null; + + // get the web api config service object from spring + ConfigService cfgSvc = (ConfigService)FacesContextUtils. + getRequiredWebApplicationContext(context).getBean("webscripts.config"); + SearchProxy searchProxy = (SearchProxy)FacesContextUtils. + getRequiredWebApplicationContext(context).getBean("webscript.org.alfresco.repository.search.searchproxy.get"); + if (cfgSvc != null) + { + // get the OpenSearch configuration + Config cfg = cfgSvc.getConfig("OpenSearch"); + OpenSearchConfigElement osConfig = (OpenSearchConfigElement)cfg. + getConfigElement(OpenSearchConfigElement.CONFIG_ELEMENT_ID); + if (osConfig != null) + { + // generate the the list of engines with a unique for each + int id = 1; + engines = new ArrayList(); + + Set enginesCfg = osConfig.getEngines(); + for (EngineConfig engineCfg : enginesCfg) + { + // resolve engine label + String label = engineCfg.getLabel(); + String labelId = engineCfg.getLabelId(); + if (labelId != null && labelId.length() > 0) + { + label = Application.getMessage(context, labelId); + } + + // locate search engine template url of most appropriate response type + String url = searchProxy.createUrl(engineCfg, MimetypeMap.MIMETYPE_ATOM); + if (url == null) + { + url = searchProxy.createUrl(engineCfg, MimetypeMap.MIMETYPE_RSS); + } + + if (url != null) + { + if (url.startsWith("/")) + { + url = context.getExternalContext().getRequestContextPath() + "/wcservice" + url; + } + + // add the engine + OpenSearchEngine engine = new OpenSearchEngine(id, label, url); + engines.add(engine); + + // increase the id counter + id++; + } + } + } + } + + return engines; + } + + /** + * Inner class representing a registered OpenSearch engine. + */ + private class OpenSearchEngine + { + private String id; + private String label; + private String url; + + public OpenSearchEngine(int id, String label, String url) + { + this.id = ENGINE_ID_PREFIX + Integer.toString(id); + this.label = label; + this.url = url; + } + + public String getId() + { + return id; + } + + public String getLabel() + { + return label; + } + + public String getUrl() + { + return url; + } + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIStoreSelector.java b/source/java/org/alfresco/web/ui/repo/component/UIStoreSelector.java index f45a6b5c9d..04a9508642 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIStoreSelector.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIStoreSelector.java @@ -1,63 +1,63 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - -import javax.faces.component.UISelectItems; -import javax.faces.component.UISelectOne; -import javax.faces.context.FacesContext; -import javax.faces.model.SelectItem; - -import org.alfresco.repo.dictionary.constraint.ConstraintRegistry; -import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint; -import org.alfresco.service.cmr.dictionary.Constraint; -import org.alfresco.web.data.IDataContainer; -import org.alfresco.web.data.QuickSort; - -/** - * Component that holds a list of content stores configured in the repository. - */ -public class UIStoreSelector extends UISelectOne -{ - public static final String COMPONENT_TYPE = "org.alfresco.faces.StoreSelector"; - public static final String COMPONENT_FAMILY = "javax.faces.SelectOne"; - - @Override - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - if (getChildren().size() == 0) - { - UISelectItems items = (UISelectItems)context.getApplication(). - createComponent("javax.faces.SelectItems"); - items.setId(this.getId() + "_items"); - items.setValue(createList()); - - // add the child component - getChildren().add(items); - } - - // do the default processing - super.encodeBegin(context); - } - - /** - * @return List of SelectItem components - */ - protected List createList() - { - List items = new ArrayList(5); - Constraint storesConstraint = ConstraintRegistry.getInstance().getConstraint("defaultStoreSelector"); - for(String store : ((ListOfValuesConstraint) storesConstraint).getAllowedValues()) - { - items.add(new SelectItem(store, store)); - } - - // make sure the list is sorted by the values - QuickSort sorter = new QuickSort(items, "label", true, IDataContainer.SORT_CASEINSENSITIVE); - sorter.sort(); - - return items; - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import javax.faces.component.UISelectItems; +import javax.faces.component.UISelectOne; +import javax.faces.context.FacesContext; +import javax.faces.model.SelectItem; + +import org.alfresco.repo.dictionary.constraint.ConstraintRegistry; +import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint; +import org.alfresco.service.cmr.dictionary.Constraint; +import org.alfresco.web.data.IDataContainer; +import org.alfresco.web.data.QuickSort; + +/** + * Component that holds a list of content stores configured in the repository. + */ +public class UIStoreSelector extends UISelectOne +{ + public static final String COMPONENT_TYPE = "org.alfresco.faces.StoreSelector"; + public static final String COMPONENT_FAMILY = "javax.faces.SelectOne"; + + @Override + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + if (getChildren().size() == 0) + { + UISelectItems items = (UISelectItems)context.getApplication(). + createComponent("javax.faces.SelectItems"); + items.setId(this.getId() + "_items"); + items.setValue(createList()); + + // add the child component + getChildren().add(items); + } + + // do the default processing + super.encodeBegin(context); + } + + /** + * @return List of SelectItem components + */ + protected List createList() + { + List items = new ArrayList(5); + Constraint storesConstraint = ConstraintRegistry.getInstance().getConstraint("defaultStoreSelector"); + for(String store : ((ListOfValuesConstraint) storesConstraint).getAllowedValues()) + { + items.add(new SelectItem(store, store)); + } + + // make sure the list is sorted by the values + QuickSort sorter = new QuickSort(items, "label", true, IDataContainer.SORT_CASEINSENSITIVE); + sorter.sort(); + + return items; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIUserGroupPicker.java b/source/java/org/alfresco/web/ui/repo/component/UIUserGroupPicker.java index 46bbcc7b50..917b377966 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIUserGroupPicker.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIUserGroupPicker.java @@ -1,223 +1,223 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.List; -import java.util.Map; -import java.util.ResourceBundle; - -import javax.faces.component.NamingContainer; -import javax.faces.component.UICommand; -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.event.ActionEvent; - -import org.alfresco.web.app.Application; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.WebResources; - -/** - * Seld rendering component tied to the EmailSpaceUsersDialog bean. Renders a hierarchy of - * user/group authorities. Each authority can be (de)selected and groups can be expanded/collapsed - * to display and select from the child authorities in the group. Nested groups are supported. - * - * @author Kevin Roast - */ -public class UIUserGroupPicker extends UICommand -{ - /** action ids */ - public final static int ACTION_NONE = -1; - public final static int ACTION_EXPANDCOLLAPSE = 0; - public final static int ACTION_SELECT = 1; - - private static String SELECTED_AUTHORITY = "_check"; - - - // ------------------------------------------------------------------------------ - // Component implementation - - /** - * Default constructor - */ - public UIUserGroupPicker() - { - setRendererType(null); - } - - /** - * @see javax.faces.component.UIComponent#getFamily() - */ - public String getFamily() - { - return "org.alfresco.faces.UserGroupPicker"; - } - - /** - * @see javax.faces.component.UIComponentBase#decode(javax.faces.context.FacesContext) - */ - public void decode(FacesContext context) - { - Map requestMap = context.getExternalContext().getRequestParameterMap(); - String fieldId = getHiddenFieldName(context); - String value = (String)requestMap.get(fieldId); - - if (value != null && value.length() != 0) - { - // decode the values - we are expecting an action identifier and an authority name - int sepIndex = value.indexOf(NamingContainer.SEPARATOR_CHAR); - int action = Integer.parseInt(value.substring(0, sepIndex)); - String authority = value.substring(sepIndex + 1); - - // queue an event - PickerEvent event = new PickerEvent(this, action, authority); - queueEvent(event); - } - } - - /** - * @see javax.faces.component.UIComponentBase#encodeBegin(javax.faces.context.FacesContext) - */ - public void encodeBegin(FacesContext context) throws IOException - { - if (isRendered() == false) - { - return; - } - - ResponseWriter out = context.getResponseWriter(); - - ResourceBundle bundle = Application.getBundle(context); - - String clientId = getClientId(context); - - // start outer table - out.write(""); - - // get the data that represents the users/groups to display - List userGroups = (List)getValue(); - if (userGroups != null) - { - for (Map authority : userGroups) - { - String authorityId = (String)authority.get("id"); - - out.write(""); - } - } - - out.write("
"); - - // walk parent hierarchy to calculate width of this cell - int width = 16; - Map parent = (Map)authority.get("parent"); - while (parent != null) - { - width += 16; - parent = (Map)parent.get("parent"); - } - out.write(""); - - out.write("
"); - - // output expanded/collapsed icon if authority is a group - boolean expanded = false; - boolean isGroup = (Boolean)authority.get("isGroup"); - if (isGroup) - { - // either output the expanded or collapsed selectable widget - expanded = (Boolean)authority.get("expanded"); - String image = expanded ? WebResources.IMAGE_EXPANDED : WebResources.IMAGE_COLLAPSED; - out.write(Utils.buildImageTag(context, image, 11, 11, "", - generateFormSubmit(context, ACTION_EXPANDCOLLAPSE, authorityId))); - } - out.write(""); - - // output selected checkbox if not expanded and not a duplicate - boolean duplicate = (Boolean)authority.get("duplicate"); - if (duplicate == false && (isGroup == false || expanded == false)) - { - boolean selected = (Boolean)authority.get("selected"); - out.write("'); - } - out.write(""); - - // output icon - out.write(Utils.buildImageTag(context, (String)authority.get("icon"), 16, 16, "")); - out.write(""); - - // output textual information - if (duplicate) - { - out.write(""); - } - out.write(Utils.encode((String)authority.get("fullName"))); - out.write(" ("); - out.write((String)authority.get("roles")); - out.write(")"); - if (duplicate) - { - out.write(""); - } - out.write("
"); - } - - - // ------------------------------------------------------------------------------ - // Private helpers - - /** - * We use a hidden field per picker instance on the page. - * - * @return hidden field name - */ - private String getHiddenFieldName(FacesContext context) - { - return getClientId(context); - } - - /** - * Generate FORM submit JavaScript for the specified action - * - * @param context FacesContext - * @param action Action index - * @param authority Authority Id of the action source - * - * @return FORM submit JavaScript - */ - private String generateFormSubmit(FacesContext context, int action, String authority) - { - return Utils.generateFormSubmit(context, this, getHiddenFieldName(context), - Integer.toString(action) + NamingContainer.SEPARATOR_CHAR + authority); - } - - - // ------------------------------------------------------------------------------ - // Inner classes - - /** - * Class representing the an action relevant to the User Group picker component. - */ - public static class PickerEvent extends ActionEvent - { - public PickerEvent(UIComponent component, int action, String authority) - { - super(component); - Action = action; - Authority = authority; - } - - public String Authority; - public int Action; - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.List; +import java.util.Map; +import java.util.ResourceBundle; + +import javax.faces.component.NamingContainer; +import javax.faces.component.UICommand; +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.event.ActionEvent; + +import org.alfresco.web.app.Application; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.WebResources; + +/** + * Seld rendering component tied to the EmailSpaceUsersDialog bean. Renders a hierarchy of + * user/group authorities. Each authority can be (de)selected and groups can be expanded/collapsed + * to display and select from the child authorities in the group. Nested groups are supported. + * + * @author Kevin Roast + */ +public class UIUserGroupPicker extends UICommand +{ + /** action ids */ + public final static int ACTION_NONE = -1; + public final static int ACTION_EXPANDCOLLAPSE = 0; + public final static int ACTION_SELECT = 1; + + private static String SELECTED_AUTHORITY = "_check"; + + + // ------------------------------------------------------------------------------ + // Component implementation + + /** + * Default constructor + */ + public UIUserGroupPicker() + { + setRendererType(null); + } + + /** + * @see javax.faces.component.UIComponent#getFamily() + */ + public String getFamily() + { + return "org.alfresco.faces.UserGroupPicker"; + } + + /** + * @see javax.faces.component.UIComponentBase#decode(javax.faces.context.FacesContext) + */ + public void decode(FacesContext context) + { + Map requestMap = context.getExternalContext().getRequestParameterMap(); + String fieldId = getHiddenFieldName(context); + String value = (String)requestMap.get(fieldId); + + if (value != null && value.length() != 0) + { + // decode the values - we are expecting an action identifier and an authority name + int sepIndex = value.indexOf(NamingContainer.SEPARATOR_CHAR); + int action = Integer.parseInt(value.substring(0, sepIndex)); + String authority = value.substring(sepIndex + 1); + + // queue an event + PickerEvent event = new PickerEvent(this, action, authority); + queueEvent(event); + } + } + + /** + * @see javax.faces.component.UIComponentBase#encodeBegin(javax.faces.context.FacesContext) + */ + public void encodeBegin(FacesContext context) throws IOException + { + if (isRendered() == false) + { + return; + } + + ResponseWriter out = context.getResponseWriter(); + + ResourceBundle bundle = Application.getBundle(context); + + String clientId = getClientId(context); + + // start outer table + out.write(""); + + // get the data that represents the users/groups to display + List userGroups = (List)getValue(); + if (userGroups != null) + { + for (Map authority : userGroups) + { + String authorityId = (String)authority.get("id"); + + out.write(""); + } + } + + out.write("
"); + + // walk parent hierarchy to calculate width of this cell + int width = 16; + Map parent = (Map)authority.get("parent"); + while (parent != null) + { + width += 16; + parent = (Map)parent.get("parent"); + } + out.write(""); + + out.write("
"); + + // output expanded/collapsed icon if authority is a group + boolean expanded = false; + boolean isGroup = (Boolean)authority.get("isGroup"); + if (isGroup) + { + // either output the expanded or collapsed selectable widget + expanded = (Boolean)authority.get("expanded"); + String image = expanded ? WebResources.IMAGE_EXPANDED : WebResources.IMAGE_COLLAPSED; + out.write(Utils.buildImageTag(context, image, 11, 11, "", + generateFormSubmit(context, ACTION_EXPANDCOLLAPSE, authorityId))); + } + out.write(""); + + // output selected checkbox if not expanded and not a duplicate + boolean duplicate = (Boolean)authority.get("duplicate"); + if (duplicate == false && (isGroup == false || expanded == false)) + { + boolean selected = (Boolean)authority.get("selected"); + out.write("'); + } + out.write(""); + + // output icon + out.write(Utils.buildImageTag(context, (String)authority.get("icon"), 16, 16, "")); + out.write(""); + + // output textual information + if (duplicate) + { + out.write(""); + } + out.write(Utils.encode((String)authority.get("fullName"))); + out.write(" ("); + out.write((String)authority.get("roles")); + out.write(")"); + if (duplicate) + { + out.write(""); + } + out.write("
"); + } + + + // ------------------------------------------------------------------------------ + // Private helpers + + /** + * We use a hidden field per picker instance on the page. + * + * @return hidden field name + */ + private String getHiddenFieldName(FacesContext context) + { + return getClientId(context); + } + + /** + * Generate FORM submit JavaScript for the specified action + * + * @param context FacesContext + * @param action Action index + * @param authority Authority Id of the action source + * + * @return FORM submit JavaScript + */ + private String generateFormSubmit(FacesContext context, int action, String authority) + { + return Utils.generateFormSubmit(context, this, getHiddenFieldName(context), + Integer.toString(action) + NamingContainer.SEPARATOR_CHAR + authority); + } + + + // ------------------------------------------------------------------------------ + // Inner classes + + /** + * Class representing the an action relevant to the User Group picker component. + */ + public static class PickerEvent extends ActionEvent + { + public PickerEvent(UIComponent component, int action, String authority) + { + super(component); + Action = action; + Authority = authority; + } + + public String Authority; + public int Action; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIWorkflowHistory.java b/source/java/org/alfresco/web/ui/repo/component/UIWorkflowHistory.java index 8259580e12..20eeadf68d 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIWorkflowHistory.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIWorkflowHistory.java @@ -1,258 +1,258 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.io.Serializable; -import java.util.Date; -import java.util.List; -import java.util.ResourceBundle; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.ValueBinding; - -import org.alfresco.model.ContentModel; -import org.alfresco.repo.workflow.WorkflowModel; -import org.alfresco.service.cmr.workflow.WorkflowInstance; -import org.alfresco.service.cmr.workflow.WorkflowTask; -import org.alfresco.service.cmr.workflow.WorkflowTaskQuery; -import org.alfresco.service.cmr.workflow.WorkflowTaskState; -import org.alfresco.service.cmr.workflow.WorkflowTransition; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; -import org.springframework.extensions.surf.util.I18NUtil; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -/** - * JSF component that displays historic information about a workflow. - * - * @author gavinc - */ -public class UIWorkflowHistory extends SelfRenderingComponent -{ - protected WorkflowInstance value = null; - - private static final Log logger = LogFactory.getLog(UIWorkflowHistory.class); - - private static final String DEFAULT_TRANSITION_TITLE = "bpm_businessprocessmodel.transition.title"; - private static final String MSG_DESCRIPTION = "description"; - private static final String MSG_TASK = "task_type"; - private static final String MSG_ID = "id"; - private static final String MSG_CREATED = "created"; - private static final String MSG_ASSIGNEE = "assignee"; - private static final String MSG_COMMENT = "comment"; - private static final String MSG_DATE_COMPLETED = "completed_on"; - private static final String MSG_OUTCOME = "outcome"; - private static final String MSG_NO_HISTORY = "no_workflow_history"; - - // ------------------------------------------------------------------------------ - // Component Impl - - @Override - public String getFamily() - { - return "org.alfresco.faces.WorkflowHistory"; - } - - @Override - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.value = (WorkflowInstance)values[1]; - } - - @Override - public Object saveState(FacesContext context) - { - Object values[] = new Object[2]; - // standard component attributes are saved by the super class - values[0] = super.saveState(context); - values[1] = this.value; - return values; - } - - @Override - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - if (!isRendered()) return; - - WorkflowInstance wi = getValue(); - - if (wi != null) - { - ResponseWriter out = context.getResponseWriter(); - ResourceBundle bundle = Application.getBundle(context); - - if (logger.isDebugEnabled()) - logger.debug("Retrieving workflow history for workflow instance: " + wi); - - WorkflowTaskQuery query = new WorkflowTaskQuery(); - query.setActive(null); - query.setProcessId(wi.id); - query.setTaskState(WorkflowTaskState.COMPLETED); - query.setOrderBy(new WorkflowTaskQuery.OrderBy[] { - WorkflowTaskQuery.OrderBy.TaskCreated_Desc, - WorkflowTaskQuery.OrderBy.TaskActor_Asc }); - List tasks = Repository.getServiceRegistry(context). - getWorkflowService().queryTasks(query); - - if (tasks.size() == 0) - { - out.write("
"); - out.write(bundle.getString(MSG_NO_HISTORY)); - out.write("
"); - } - else - { - // output surrounding table and style if necessary - out.write(""); - - // output a header row - out.write(""); - - // output a row for each previous completed task - for (WorkflowTask task : tasks) - { - String id = null; - Serializable idObject = task.properties.get(WorkflowModel.PROP_TASK_ID); - if (idObject instanceof Long) - { - id = ((Long)idObject).toString(); - } - else - { - id = idObject.toString(); - } - - String desc = (String)task.properties.get(WorkflowModel.PROP_DESCRIPTION); - Date createdDate = (Date)task.properties.get(ContentModel.PROP_CREATED); - String owner = (String)task.properties.get(ContentModel.PROP_OWNER); - String comment = (String)task.properties.get(WorkflowModel.PROP_COMMENT); - Date completedDate = (Date)task.properties.get(WorkflowModel.PROP_COMPLETION_DATE); - String transition = (String)task.properties.get(WorkflowModel.PROP_OUTCOME); - String outcome = ""; - if (transition != null) - { - WorkflowTransition[] transitions = task.definition.node.transitions; - for (WorkflowTransition trans : transitions) - { - if (trans.id.equals(transition)) - { - outcome = trans.title; - break; - } - } - } - - if ((outcome == null || outcome.equals("")) && transition != null) - { - // it's possible in Activiti to have tasks without an outcome set, - // in this case default to the transition, if there is one. - outcome = transition; - } - //ACE-1154 - if (outcome.equals("")) - { - outcome = I18NUtil.getMessage(DEFAULT_TRANSITION_TITLE); - } - - out.write(""); - } - - // output the end of the table - out.write("
"); - out.write(bundle.getString(MSG_DESCRIPTION)); - out.write(""); - out.write(bundle.getString(MSG_TASK)); - out.write(""); - out.write(bundle.getString(MSG_ID)); - out.write(""); - out.write(bundle.getString(MSG_CREATED)); - out.write(""); - out.write(bundle.getString(MSG_ASSIGNEE)); - out.write(""); - out.write(bundle.getString(MSG_COMMENT)); - out.write(""); - out.write(bundle.getString(MSG_DATE_COMPLETED)); - out.write(""); - out.write(bundle.getString(MSG_OUTCOME)); - out.write("
"); - out.write(desc == null ? "" : Utils.encode(desc)); - out.write(""); - out.write(Utils.encode(task.title)); - out.write(""); - out.write(id); - out.write(""); - out.write(Utils.getDateTimeFormat(context).format(createdDate)); - out.write(""); - out.write(owner == null ? "" : owner); - out.write(""); - out.write(comment == null ? "" : Utils.encode(comment)); - out.write(""); - out.write(Utils.getDateTimeFormat(context).format(completedDate)); - out.write(""); - out.write(outcome); - out.write("
"); - } - } - } - - @Override - public void encodeEnd(FacesContext context) throws IOException - { - if (!isRendered()) return; - } - - @Override - public boolean getRendersChildren() - { - return false; - } - - // ------------------------------------------------------------------------------ - // Strongly typed component property accessors - - /** - * Returns the workflow instance this component is showing information on - * - * @return The workflow instance - */ - public WorkflowInstance getValue() - { - ValueBinding vb = getValueBinding("value"); - if (vb != null) - { - this.value = (WorkflowInstance)vb.getValue(getFacesContext()); - } - - return this.value; - } - - /** - * Sets the workflow instance to show the summary for - * - * @param value The workflow instance - */ - public void setValue(WorkflowInstance value) - { - this.value = value; - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.io.Serializable; +import java.util.Date; +import java.util.List; +import java.util.ResourceBundle; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.ValueBinding; + +import org.alfresco.model.ContentModel; +import org.alfresco.repo.workflow.WorkflowModel; +import org.alfresco.service.cmr.workflow.WorkflowInstance; +import org.alfresco.service.cmr.workflow.WorkflowTask; +import org.alfresco.service.cmr.workflow.WorkflowTaskQuery; +import org.alfresco.service.cmr.workflow.WorkflowTaskState; +import org.alfresco.service.cmr.workflow.WorkflowTransition; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; +import org.springframework.extensions.surf.util.I18NUtil; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * JSF component that displays historic information about a workflow. + * + * @author gavinc + */ +public class UIWorkflowHistory extends SelfRenderingComponent +{ + protected WorkflowInstance value = null; + + private static final Log logger = LogFactory.getLog(UIWorkflowHistory.class); + + private static final String DEFAULT_TRANSITION_TITLE = "bpm_businessprocessmodel.transition.title"; + private static final String MSG_DESCRIPTION = "description"; + private static final String MSG_TASK = "task_type"; + private static final String MSG_ID = "id"; + private static final String MSG_CREATED = "created"; + private static final String MSG_ASSIGNEE = "assignee"; + private static final String MSG_COMMENT = "comment"; + private static final String MSG_DATE_COMPLETED = "completed_on"; + private static final String MSG_OUTCOME = "outcome"; + private static final String MSG_NO_HISTORY = "no_workflow_history"; + + // ------------------------------------------------------------------------------ + // Component Impl + + @Override + public String getFamily() + { + return "org.alfresco.faces.WorkflowHistory"; + } + + @Override + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.value = (WorkflowInstance)values[1]; + } + + @Override + public Object saveState(FacesContext context) + { + Object values[] = new Object[2]; + // standard component attributes are saved by the super class + values[0] = super.saveState(context); + values[1] = this.value; + return values; + } + + @Override + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + if (!isRendered()) return; + + WorkflowInstance wi = getValue(); + + if (wi != null) + { + ResponseWriter out = context.getResponseWriter(); + ResourceBundle bundle = Application.getBundle(context); + + if (logger.isDebugEnabled()) + logger.debug("Retrieving workflow history for workflow instance: " + wi); + + WorkflowTaskQuery query = new WorkflowTaskQuery(); + query.setActive(null); + query.setProcessId(wi.id); + query.setTaskState(WorkflowTaskState.COMPLETED); + query.setOrderBy(new WorkflowTaskQuery.OrderBy[] { + WorkflowTaskQuery.OrderBy.TaskCreated_Desc, + WorkflowTaskQuery.OrderBy.TaskActor_Asc }); + List tasks = Repository.getServiceRegistry(context). + getWorkflowService().queryTasks(query); + + if (tasks.size() == 0) + { + out.write("
"); + out.write(bundle.getString(MSG_NO_HISTORY)); + out.write("
"); + } + else + { + // output surrounding table and style if necessary + out.write(""); + + // output a header row + out.write(""); + + // output a row for each previous completed task + for (WorkflowTask task : tasks) + { + String id = null; + Serializable idObject = task.properties.get(WorkflowModel.PROP_TASK_ID); + if (idObject instanceof Long) + { + id = ((Long)idObject).toString(); + } + else + { + id = idObject.toString(); + } + + String desc = (String)task.properties.get(WorkflowModel.PROP_DESCRIPTION); + Date createdDate = (Date)task.properties.get(ContentModel.PROP_CREATED); + String owner = (String)task.properties.get(ContentModel.PROP_OWNER); + String comment = (String)task.properties.get(WorkflowModel.PROP_COMMENT); + Date completedDate = (Date)task.properties.get(WorkflowModel.PROP_COMPLETION_DATE); + String transition = (String)task.properties.get(WorkflowModel.PROP_OUTCOME); + String outcome = ""; + if (transition != null) + { + WorkflowTransition[] transitions = task.definition.node.transitions; + for (WorkflowTransition trans : transitions) + { + if (trans.id.equals(transition)) + { + outcome = trans.title; + break; + } + } + } + + if ((outcome == null || outcome.equals("")) && transition != null) + { + // it's possible in Activiti to have tasks without an outcome set, + // in this case default to the transition, if there is one. + outcome = transition; + } + //ACE-1154 + if (outcome.equals("")) + { + outcome = I18NUtil.getMessage(DEFAULT_TRANSITION_TITLE); + } + + out.write(""); + } + + // output the end of the table + out.write("
"); + out.write(bundle.getString(MSG_DESCRIPTION)); + out.write(""); + out.write(bundle.getString(MSG_TASK)); + out.write(""); + out.write(bundle.getString(MSG_ID)); + out.write(""); + out.write(bundle.getString(MSG_CREATED)); + out.write(""); + out.write(bundle.getString(MSG_ASSIGNEE)); + out.write(""); + out.write(bundle.getString(MSG_COMMENT)); + out.write(""); + out.write(bundle.getString(MSG_DATE_COMPLETED)); + out.write(""); + out.write(bundle.getString(MSG_OUTCOME)); + out.write("
"); + out.write(desc == null ? "" : Utils.encode(desc)); + out.write(""); + out.write(Utils.encode(task.title)); + out.write(""); + out.write(id); + out.write(""); + out.write(Utils.getDateTimeFormat(context).format(createdDate)); + out.write(""); + out.write(owner == null ? "" : owner); + out.write(""); + out.write(comment == null ? "" : Utils.encode(comment)); + out.write(""); + out.write(Utils.getDateTimeFormat(context).format(completedDate)); + out.write(""); + out.write(outcome); + out.write("
"); + } + } + } + + @Override + public void encodeEnd(FacesContext context) throws IOException + { + if (!isRendered()) return; + } + + @Override + public boolean getRendersChildren() + { + return false; + } + + // ------------------------------------------------------------------------------ + // Strongly typed component property accessors + + /** + * Returns the workflow instance this component is showing information on + * + * @return The workflow instance + */ + public WorkflowInstance getValue() + { + ValueBinding vb = getValueBinding("value"); + if (vb != null) + { + this.value = (WorkflowInstance)vb.getValue(getFacesContext()); + } + + return this.value; + } + + /** + * Sets the workflow instance to show the summary for + * + * @param value The workflow instance + */ + public void setValue(WorkflowInstance value) + { + this.value = value; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/UIWorkflowSummary.java b/source/java/org/alfresco/web/ui/repo/component/UIWorkflowSummary.java index c5cd6ef71a..9420e7e3a0 100644 --- a/source/java/org/alfresco/web/ui/repo/component/UIWorkflowSummary.java +++ b/source/java/org/alfresco/web/ui/repo/component/UIWorkflowSummary.java @@ -1,182 +1,182 @@ -package org.alfresco.web.ui.repo.component; - -import java.io.IOException; -import java.util.ResourceBundle; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.el.ValueBinding; - -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.workflow.WorkflowInstance; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.User; -import org.alfresco.web.ui.common.Utils; -import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; - -/** - * JSF component that displays summary information about a workflow. - * - * @author gavinc - */ -public class UIWorkflowSummary extends SelfRenderingComponent -{ - protected WorkflowInstance value = null; - - // ------------------------------------------------------------------------------ - // Component Impl - - @Override - public String getFamily() - { - return "org.alfresco.faces.WorkflowSummary"; - } - - @Override - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.value = (WorkflowInstance)values[1]; - } - - @Override - public Object saveState(FacesContext context) - { - Object values[] = new Object[8]; - // standard component attributes are saved by the super class - values[0] = super.saveState(context); - values[1] = this.value; - return values; - } - - @Override - @SuppressWarnings("unchecked") - public void encodeBegin(FacesContext context) throws IOException - { - if (!isRendered()) return; - - WorkflowInstance wi = getValue(); - - if (wi != null) - { - ResponseWriter out = context.getResponseWriter(); - ResourceBundle bundle = Application.getBundle(context); - - // output surrounding table and style if necessary - out.write(""); - - // output the title and description - out.write(""); - out.write(bundle.getString("title")); - out.write(":"); - out.write(wi.definition.title); - if (wi.definition.description != null && wi.definition.description.length() > 0) - { - out.write(" ("); - out.write(Utils.encode(wi.definition.description)); - out.write(")"); - } - out.write(""); - out.write(bundle.getString("initiated_by")); - out.write(":"); - NodeService nodeService = getNodeService(context); - if (wi.initiator != null) - { - if (nodeService.exists(wi.initiator)) - { - out.write(Utils.encode(User.getFullName(Repository.getServiceRegistry( - context).getNodeService(), wi.initiator))); - } - else - { - out.write("<"); - out.write(bundle.getString("unknown")); - out.write(">"); - } - } - out.write(""); - out.write(bundle.getString("started_on")); - out.write(":"); - if (wi.startDate != null) - { - out.write(Utils.getDateFormat(context).format(wi.startDate)); - } - out.write(""); - out.write(bundle.getString("completed_on")); - out.write(":"); - if (wi.endDate != null) - { - out.write(Utils.getDateFormat(context).format(wi.endDate)); - } - else - { - out.write("<"); - out.write(bundle.getString("in_progress")); - out.write(">"); - } - out.write(""); - } - } - - @Override - public void encodeEnd(FacesContext context) throws IOException - { - if (!isRendered()) return; - } - - @Override - public boolean getRendersChildren() - { - return false; - } - - // ------------------------------------------------------------------------------ - // Strongly typed component property accessors - - /** - * Returns the workflow instance this component is showing information on - * - * @return The workflow instance - */ - public WorkflowInstance getValue() - { - ValueBinding vb = getValueBinding("value"); - if (vb != null) - { - this.value = (WorkflowInstance)vb.getValue(getFacesContext()); - } - - return this.value; - } - - /** - * Sets the workflow instance to show the summary for - * - * @param value The workflow instance - */ - public void setValue(WorkflowInstance value) - { - this.value = value; - } - - private NodeService getNodeService(FacesContext fc) - { - return Repository.getServiceRegistry(fc).getNodeService(); - } -} +package org.alfresco.web.ui.repo.component; + +import java.io.IOException; +import java.util.ResourceBundle; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.el.ValueBinding; + +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.workflow.WorkflowInstance; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.User; +import org.alfresco.web.ui.common.Utils; +import org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent; + +/** + * JSF component that displays summary information about a workflow. + * + * @author gavinc + */ +public class UIWorkflowSummary extends SelfRenderingComponent +{ + protected WorkflowInstance value = null; + + // ------------------------------------------------------------------------------ + // Component Impl + + @Override + public String getFamily() + { + return "org.alfresco.faces.WorkflowSummary"; + } + + @Override + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.value = (WorkflowInstance)values[1]; + } + + @Override + public Object saveState(FacesContext context) + { + Object values[] = new Object[8]; + // standard component attributes are saved by the super class + values[0] = super.saveState(context); + values[1] = this.value; + return values; + } + + @Override + @SuppressWarnings("unchecked") + public void encodeBegin(FacesContext context) throws IOException + { + if (!isRendered()) return; + + WorkflowInstance wi = getValue(); + + if (wi != null) + { + ResponseWriter out = context.getResponseWriter(); + ResourceBundle bundle = Application.getBundle(context); + + // output surrounding table and style if necessary + out.write(""); + + // output the title and description + out.write(""); + out.write(bundle.getString("title")); + out.write(":"); + out.write(wi.definition.title); + if (wi.definition.description != null && wi.definition.description.length() > 0) + { + out.write(" ("); + out.write(Utils.encode(wi.definition.description)); + out.write(")"); + } + out.write(""); + out.write(bundle.getString("initiated_by")); + out.write(":"); + NodeService nodeService = getNodeService(context); + if (wi.initiator != null) + { + if (nodeService.exists(wi.initiator)) + { + out.write(Utils.encode(User.getFullName(Repository.getServiceRegistry( + context).getNodeService(), wi.initiator))); + } + else + { + out.write("<"); + out.write(bundle.getString("unknown")); + out.write(">"); + } + } + out.write(""); + out.write(bundle.getString("started_on")); + out.write(":"); + if (wi.startDate != null) + { + out.write(Utils.getDateFormat(context).format(wi.startDate)); + } + out.write(""); + out.write(bundle.getString("completed_on")); + out.write(":"); + if (wi.endDate != null) + { + out.write(Utils.getDateFormat(context).format(wi.endDate)); + } + else + { + out.write("<"); + out.write(bundle.getString("in_progress")); + out.write(">"); + } + out.write(""); + } + } + + @Override + public void encodeEnd(FacesContext context) throws IOException + { + if (!isRendered()) return; + } + + @Override + public boolean getRendersChildren() + { + return false; + } + + // ------------------------------------------------------------------------------ + // Strongly typed component property accessors + + /** + * Returns the workflow instance this component is showing information on + * + * @return The workflow instance + */ + public WorkflowInstance getValue() + { + ValueBinding vb = getValueBinding("value"); + if (vb != null) + { + this.value = (WorkflowInstance)vb.getValue(getFacesContext()); + } + + return this.value; + } + + /** + * Sets the workflow instance to show the summary for + * + * @param value The workflow instance + */ + public void setValue(WorkflowInstance value) + { + this.value = value; + } + + private NodeService getNodeService(FacesContext fc) + { + return Repository.getServiceRegistry(fc).getNodeService(); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/component/evaluator/ActionInstanceEvaluator.java b/source/java/org/alfresco/web/ui/repo/component/evaluator/ActionInstanceEvaluator.java index f1e7d7aaa1..7f218b02d3 100644 --- a/source/java/org/alfresco/web/ui/repo/component/evaluator/ActionInstanceEvaluator.java +++ b/source/java/org/alfresco/web/ui/repo/component/evaluator/ActionInstanceEvaluator.java @@ -1,196 +1,196 @@ -package org.alfresco.web.ui.repo.component.evaluator; - -import java.io.PrintWriter; -import java.io.StringWriter; - -import java.util.HashMap; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.el.ValueBinding; - -import org.alfresco.error.AlfrescoRuntimeException; -import org.alfresco.web.action.ActionEvaluator; -import org.alfresco.web.bean.repository.Node; -import org.alfresco.web.ui.common.component.evaluator.BaseEvaluator; - -/** - * Evaluator for executing an ActionEvaluator instance. - * - * @author Kevin Roast - */ -public class ActionInstanceEvaluator extends BaseEvaluator -{ - private static final String EVALUATOR_CACHE = "_alf_evaluator_cache"; - - /** - * Evaluate by executing the specified action instance evaluator. - * - * @return true to allow rendering of child components, false otherwise - */ - public boolean evaluate() - { - boolean result = false; - - try - { - final Object obj = this.getValue(); - if (obj instanceof Node) - { - result = evaluateCachedResult((Node)obj); - } - else - { - result = this.getEvaluator().evaluate(obj); - } - } - catch (Exception err) - { - // return default value on error and report meaningful error - StringBuilder builder = new StringBuilder("Error during ActionInstanceEvaluator evaluation of "); - builder.append(this.getEvaluator()).append(": "); - String msg = err.getMessage(); - if (msg != null) - { - builder.append(msg); - } - else - { - StringWriter strWriter = new StringWriter(); - PrintWriter writer = new PrintWriter(strWriter); - err.printStackTrace(writer); - builder.append(strWriter.toString()); - } - - s_logger.warn(builder.toString()); - } - - return result; - } - - /** - * To reduce invocations of a particular evaluator for a particular node - * save a cache of evaluator result for a node against the current request. - * Since the same evaluator may get reused several times for multiple actions, but - * in effect execute against the same node instance, this can significantly reduce - * the number of invocations required for a particular evaluator. - * - * @param node Node to evaluate against - * - * @return evaluator result - */ - private boolean evaluateCachedResult(Node node) - { - Boolean result; - - ActionEvaluator evaluator = getEvaluator(); - String cacheKey = node.getNodeRef().toString() + '_' + evaluator.getClass().getName(); - Map cache = getEvaluatorResultCache(); - result = cache.get(cacheKey); - if (result == null) - { - result = evaluator.evaluate(node); - cache.put(cacheKey, result); - } - - return result; - } - - /** - * @return the evaluator result cache - tied to the current request - */ - private Map getEvaluatorResultCache() - { - FacesContext fc = FacesContext.getCurrentInstance(); - Map cache = (Map)fc.getExternalContext().getRequestMap().get(EVALUATOR_CACHE); - if (cache == null) - { - cache = new HashMap(64, 1.0f); - fc.getExternalContext().getRequestMap().put(EVALUATOR_CACHE, cache); - } - return cache; - } - - /** - * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) - */ - public void restoreState(FacesContext context, Object state) - { - Object values[] = (Object[])state; - // standard component attributes are restored by the super class - super.restoreState(context, values[0]); - this.evaluator = (ActionEvaluator)values[1]; - this.evaluatorClassName = (String)values[2]; - } - - /** - * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) - */ - public Object saveState(FacesContext context) - { - return new Object[] { - // standard component attributes are saved by the super class - super.saveState(context), - this.evaluator, - this.evaluatorClassName - }; - } - - /** - * @return the ActionEvaluator to execute - */ - public ActionEvaluator getEvaluator() - { - if (this.evaluator == null) - { - Object objEvaluator; - try - { - Class clazz = Class.forName(getEvaluatorClassName()); - objEvaluator = clazz.newInstance(); - } - catch (Throwable err) - { - throw new AlfrescoRuntimeException("Unable to construct action evaluator: " + getEvaluatorClassName()); - } - if (objEvaluator instanceof ActionEvaluator == false) - { - throw new AlfrescoRuntimeException("Must implement ActionEvaluator interface: " + getEvaluatorClassName()); - } - this.evaluator = (ActionEvaluator)objEvaluator; - } - return this.evaluator; - } - - /** - * @param evaluator The ActionEvaluator to execute - */ - public void setEvaluator(ActionEvaluator evaluator) - { - this.evaluator = evaluator; - } - - /** - * @return the evaluatorClassName - */ - public String getEvaluatorClassName() - { - ValueBinding vb = getValueBinding("evaluatorClassName"); - if (vb != null) - { - this.evaluatorClassName = (String)vb.getValue(getFacesContext()); - } - return this.evaluatorClassName; - } - - /** - * @param evaluatorClassName the evaluatorClassName to set - */ - public void setEvaluatorClassName(String evaluatorClassName) - { - this.evaluatorClassName = evaluatorClassName; - } - - private ActionEvaluator evaluator; - private String evaluatorClassName; -} +package org.alfresco.web.ui.repo.component.evaluator; + +import java.io.PrintWriter; +import java.io.StringWriter; + +import java.util.HashMap; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.el.ValueBinding; + +import org.alfresco.error.AlfrescoRuntimeException; +import org.alfresco.web.action.ActionEvaluator; +import org.alfresco.web.bean.repository.Node; +import org.alfresco.web.ui.common.component.evaluator.BaseEvaluator; + +/** + * Evaluator for executing an ActionEvaluator instance. + * + * @author Kevin Roast + */ +public class ActionInstanceEvaluator extends BaseEvaluator +{ + private static final String EVALUATOR_CACHE = "_alf_evaluator_cache"; + + /** + * Evaluate by executing the specified action instance evaluator. + * + * @return true to allow rendering of child components, false otherwise + */ + public boolean evaluate() + { + boolean result = false; + + try + { + final Object obj = this.getValue(); + if (obj instanceof Node) + { + result = evaluateCachedResult((Node)obj); + } + else + { + result = this.getEvaluator().evaluate(obj); + } + } + catch (Exception err) + { + // return default value on error and report meaningful error + StringBuilder builder = new StringBuilder("Error during ActionInstanceEvaluator evaluation of "); + builder.append(this.getEvaluator()).append(": "); + String msg = err.getMessage(); + if (msg != null) + { + builder.append(msg); + } + else + { + StringWriter strWriter = new StringWriter(); + PrintWriter writer = new PrintWriter(strWriter); + err.printStackTrace(writer); + builder.append(strWriter.toString()); + } + + s_logger.warn(builder.toString()); + } + + return result; + } + + /** + * To reduce invocations of a particular evaluator for a particular node + * save a cache of evaluator result for a node against the current request. + * Since the same evaluator may get reused several times for multiple actions, but + * in effect execute against the same node instance, this can significantly reduce + * the number of invocations required for a particular evaluator. + * + * @param node Node to evaluate against + * + * @return evaluator result + */ + private boolean evaluateCachedResult(Node node) + { + Boolean result; + + ActionEvaluator evaluator = getEvaluator(); + String cacheKey = node.getNodeRef().toString() + '_' + evaluator.getClass().getName(); + Map cache = getEvaluatorResultCache(); + result = cache.get(cacheKey); + if (result == null) + { + result = evaluator.evaluate(node); + cache.put(cacheKey, result); + } + + return result; + } + + /** + * @return the evaluator result cache - tied to the current request + */ + private Map getEvaluatorResultCache() + { + FacesContext fc = FacesContext.getCurrentInstance(); + Map cache = (Map)fc.getExternalContext().getRequestMap().get(EVALUATOR_CACHE); + if (cache == null) + { + cache = new HashMap(64, 1.0f); + fc.getExternalContext().getRequestMap().put(EVALUATOR_CACHE, cache); + } + return cache; + } + + /** + * @see javax.faces.component.StateHolder#restoreState(javax.faces.context.FacesContext, java.lang.Object) + */ + public void restoreState(FacesContext context, Object state) + { + Object values[] = (Object[])state; + // standard component attributes are restored by the super class + super.restoreState(context, values[0]); + this.evaluator = (ActionEvaluator)values[1]; + this.evaluatorClassName = (String)values[2]; + } + + /** + * @see javax.faces.component.StateHolder#saveState(javax.faces.context.FacesContext) + */ + public Object saveState(FacesContext context) + { + return new Object[] { + // standard component attributes are saved by the super class + super.saveState(context), + this.evaluator, + this.evaluatorClassName + }; + } + + /** + * @return the ActionEvaluator to execute + */ + public ActionEvaluator getEvaluator() + { + if (this.evaluator == null) + { + Object objEvaluator; + try + { + Class clazz = Class.forName(getEvaluatorClassName()); + objEvaluator = clazz.newInstance(); + } + catch (Throwable err) + { + throw new AlfrescoRuntimeException("Unable to construct action evaluator: " + getEvaluatorClassName()); + } + if (objEvaluator instanceof ActionEvaluator == false) + { + throw new AlfrescoRuntimeException("Must implement ActionEvaluator interface: " + getEvaluatorClassName()); + } + this.evaluator = (ActionEvaluator)objEvaluator; + } + return this.evaluator; + } + + /** + * @param evaluator The ActionEvaluator to execute + */ + public void setEvaluator(ActionEvaluator evaluator) + { + this.evaluator = evaluator; + } + + /** + * @return the evaluatorClassName + */ + public String getEvaluatorClassName() + { + ValueBinding vb = getValueBinding("evaluatorClassName"); + if (vb != null) + { + this.evaluatorClassName = (String)vb.getValue(getFacesContext()); + } + return this.evaluatorClassName; + } + + /** + * @param evaluatorClassName the evaluatorClassName to set + */ + public void setEvaluatorClassName(String evaluatorClassName) + { + this.evaluatorClassName = evaluatorClassName; + } + + private ActionEvaluator evaluator; + private String evaluatorClassName; +} diff --git a/source/java/org/alfresco/web/ui/repo/component/template/DefaultModelHelper.java b/source/java/org/alfresco/web/ui/repo/component/template/DefaultModelHelper.java index 536a3bbc33..fec9ac5d8c 100644 --- a/source/java/org/alfresco/web/ui/repo/component/template/DefaultModelHelper.java +++ b/source/java/org/alfresco/web/ui/repo/component/template/DefaultModelHelper.java @@ -1,88 +1,88 @@ -package org.alfresco.web.ui.repo.component.template; - -import java.util.Map; - -import javax.faces.context.FacesContext; - -import org.alfresco.repo.web.scripts.FileTypeImageUtils; -import org.alfresco.service.ServiceRegistry; -import org.alfresco.service.cmr.repository.FileTypeImageSize; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.TemplateImageResolver; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.bean.repository.User; - -/** - * Helper class to generate the default template model. - *

- * See http://www.alfresco.org/mediawiki/index.php/Template_Guide for details - * - * @author Kevin Roast - */ -public class DefaultModelHelper -{ - /** - * Private Constructor - */ - private DefaultModelHelper() - { - } - - /** - * Construct the default FreeMarker template model. - *

- * Other root level objects such as the current Space or Document are generally - * added by the appropriate bean responsible for provided access to those nodes. - *

- * Uses the default TemplateImageResolver instance to resolve icons - assumes that the client - * has a valid FacesContext. - *

- * See http://www.alfresco.org/mediawiki/index.php/Template_Guide for details - * - * @return Map containing the default model. - */ - public static Map buildDefaultModel( - ServiceRegistry services, User user, NodeRef template) - { - return buildDefaultModel(services, user, template, imageResolver); - } - - /** - * Construct the default FreeMarker template model. - *

- * Other root level objects such as the current Space or Document are generally - * added by the appropriate bean responsible for provided access to those nodes. - *

- * See http://www.alfresco.org/mediawiki/index.php/Template_Guide for details - * - * @return Map containing the default model. - */ - public static Map buildDefaultModel( - ServiceRegistry services, User user, NodeRef template, TemplateImageResolver resolver) - { - if (services == null) - { - throw new IllegalArgumentException("ServiceRegistry is mandatory."); - } - if (user == null) - { - throw new IllegalArgumentException("Current User is mandatory."); - } - - NodeRef companyRootRef = new NodeRef(Repository.getStoreRef(), Application.getCompanyRootId()); - NodeRef userRootRef = new NodeRef(Repository.getStoreRef(), user.getHomeSpaceId()); - - return services.getTemplateService().buildDefaultModel( - user.getPerson(), companyRootRef, userRootRef, template, resolver); - } - - /** Template Image resolver helper */ - public static final TemplateImageResolver imageResolver = new TemplateImageResolver() - { - public String resolveImagePathForName(String filename, FileTypeImageSize size) - { - return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); - } - }; -} +package org.alfresco.web.ui.repo.component.template; + +import java.util.Map; + +import javax.faces.context.FacesContext; + +import org.alfresco.repo.web.scripts.FileTypeImageUtils; +import org.alfresco.service.ServiceRegistry; +import org.alfresco.service.cmr.repository.FileTypeImageSize; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.TemplateImageResolver; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.bean.repository.User; + +/** + * Helper class to generate the default template model. + *

+ * See http://www.alfresco.org/mediawiki/index.php/Template_Guide for details + * + * @author Kevin Roast + */ +public class DefaultModelHelper +{ + /** + * Private Constructor + */ + private DefaultModelHelper() + { + } + + /** + * Construct the default FreeMarker template model. + *

+ * Other root level objects such as the current Space or Document are generally + * added by the appropriate bean responsible for provided access to those nodes. + *

+ * Uses the default TemplateImageResolver instance to resolve icons - assumes that the client + * has a valid FacesContext. + *

+ * See http://www.alfresco.org/mediawiki/index.php/Template_Guide for details + * + * @return Map containing the default model. + */ + public static Map buildDefaultModel( + ServiceRegistry services, User user, NodeRef template) + { + return buildDefaultModel(services, user, template, imageResolver); + } + + /** + * Construct the default FreeMarker template model. + *

+ * Other root level objects such as the current Space or Document are generally + * added by the appropriate bean responsible for provided access to those nodes. + *

+ * See http://www.alfresco.org/mediawiki/index.php/Template_Guide for details + * + * @return Map containing the default model. + */ + public static Map buildDefaultModel( + ServiceRegistry services, User user, NodeRef template, TemplateImageResolver resolver) + { + if (services == null) + { + throw new IllegalArgumentException("ServiceRegistry is mandatory."); + } + if (user == null) + { + throw new IllegalArgumentException("Current User is mandatory."); + } + + NodeRef companyRootRef = new NodeRef(Repository.getStoreRef(), Application.getCompanyRootId()); + NodeRef userRootRef = new NodeRef(Repository.getStoreRef(), user.getHomeSpaceId()); + + return services.getTemplateService().buildDefaultModel( + user.getPerson(), companyRootRef, userRootRef, template, resolver); + } + + /** Template Image resolver helper */ + public static final TemplateImageResolver imageResolver = new TemplateImageResolver() + { + public String resolveImagePathForName(String filename, FileTypeImageSize size) + { + return FileTypeImageUtils.getFileTypeImage(FacesContext.getCurrentInstance(), filename, size); + } + }; +} diff --git a/source/java/org/alfresco/web/ui/repo/converter/DisplayPathConverter.java b/source/java/org/alfresco/web/ui/repo/converter/DisplayPathConverter.java index 67fa885b10..1abf313fc4 100644 --- a/source/java/org/alfresco/web/ui/repo/converter/DisplayPathConverter.java +++ b/source/java/org/alfresco/web/ui/repo/converter/DisplayPathConverter.java @@ -1,75 +1,75 @@ -package org.alfresco.web.ui.repo.converter; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.convert.Converter; -import javax.faces.convert.ConverterException; - -import org.alfresco.repo.security.permissions.AccessDeniedException; -import org.alfresco.service.cmr.repository.InvalidNodeRefException; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.repository.Path; -import org.alfresco.web.bean.repository.Repository; - -/** - * Converter class to convert a Path or NodeRef reference value (including null) into a human readable form. - * - * @author Kevin Roast - */ -public class DisplayPathConverter implements Converter -{ - /** - *

The standard converter id for this converter.

- */ - public static final String CONVERTER_ID = "org.alfresco.faces.DisplayPathConverter"; - - /** - * @see javax.faces.convert.Converter#getAsObject(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.String) - */ - public Object getAsObject(FacesContext context, UIComponent component, String value) - throws ConverterException - { - return null; - } - - /** - * @see javax.faces.convert.Converter#getAsString(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) - */ - public String getAsString(FacesContext context, UIComponent component, Object value) - throws ConverterException - { - String result = ""; - - if (value != null) - { - try - { - NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); - Path path = null; - if (value instanceof NodeRef) - { - path = nodeService.getPath((NodeRef)value); - } - else if (value instanceof Path) - { - path = (Path)value; - } - if (path != null) - { - result = Repository.getNamePath(nodeService, path, null, "/", null); - } - } - catch (AccessDeniedException accessErr) - { - // use default if this occurs - } - catch (InvalidNodeRefException nodeErr) - { - // use default if this occurs - } - } - - return result; - } -} +package org.alfresco.web.ui.repo.converter; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.convert.Converter; +import javax.faces.convert.ConverterException; + +import org.alfresco.repo.security.permissions.AccessDeniedException; +import org.alfresco.service.cmr.repository.InvalidNodeRefException; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.service.cmr.repository.Path; +import org.alfresco.web.bean.repository.Repository; + +/** + * Converter class to convert a Path or NodeRef reference value (including null) into a human readable form. + * + * @author Kevin Roast + */ +public class DisplayPathConverter implements Converter +{ + /** + *

The standard converter id for this converter.

+ */ + public static final String CONVERTER_ID = "org.alfresco.faces.DisplayPathConverter"; + + /** + * @see javax.faces.convert.Converter#getAsObject(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.String) + */ + public Object getAsObject(FacesContext context, UIComponent component, String value) + throws ConverterException + { + return null; + } + + /** + * @see javax.faces.convert.Converter#getAsString(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) + */ + public String getAsString(FacesContext context, UIComponent component, Object value) + throws ConverterException + { + String result = ""; + + if (value != null) + { + try + { + NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); + Path path = null; + if (value instanceof NodeRef) + { + path = nodeService.getPath((NodeRef)value); + } + else if (value instanceof Path) + { + path = (Path)value; + } + if (path != null) + { + result = Repository.getNamePath(nodeService, path, null, "/", null); + } + } + catch (AccessDeniedException accessErr) + { + // use default if this occurs + } + catch (InvalidNodeRefException nodeErr) + { + // use default if this occurs + } + } + + return result; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/renderer/BaseMultiValueRenderer.java b/source/java/org/alfresco/web/ui/repo/renderer/BaseMultiValueRenderer.java index c0c5efc097..caa6618300 100644 --- a/source/java/org/alfresco/web/ui/repo/renderer/BaseMultiValueRenderer.java +++ b/source/java/org/alfresco/web/ui/repo/renderer/BaseMultiValueRenderer.java @@ -1,326 +1,326 @@ -package org.alfresco.web.ui.repo.renderer; - -import java.io.IOException; -import java.util.Date; -import java.util.List; -import java.util.Map; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; -import javax.faces.convert.Converter; - -import org.alfresco.model.ContentModel; -import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.web.app.Application; -import org.alfresco.web.bean.repository.Repository; -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.converter.XMLDateConverter; -import org.alfresco.web.ui.common.renderer.BaseRenderer; -import org.alfresco.web.ui.repo.RepoConstants; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor.MultiValueEditorEvent; - -/** - * Base class for renderers of the MultiValueEditor component. - * The current items are displayed as a list of options that can be - * removed using a Remove button. - * - * @author gavinc - */ -public abstract class BaseMultiValueRenderer extends BaseRenderer -{ - /** I18N message strings */ - protected final static String MSG_REMOVE = "remove"; - protected final static String MSG_SELECT_BUTTON = "select_button"; - protected final static String MSG_ADD_TO_LIST_BUTTON = "add_to_list_button"; - - protected boolean highlightedRow; - - // ------------------------------------------------------------------------------ - // Renderer implemenation - - /** - * @see javax.faces.render.Renderer#decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - public void decode(FacesContext context, UIComponent component) - { - Map requestMap = context.getExternalContext().getRequestParameterMap(); - String fieldId = getHiddenFieldName(component); - String value = (String)requestMap.get(fieldId); - - int action = UIMultiValueEditor.ACTION_NONE; - int removeIndex = -1; - if (value != null && value.length() != 0) - { - // break up the action into it's parts - int sepIdx = value.indexOf(UIMultiValueEditor.ACTION_SEPARATOR); - if (sepIdx != -1) - { - action = Integer.parseInt(value.substring(0, sepIdx)); - removeIndex = Integer.parseInt(value.substring(sepIdx+1)); - } - else - { - action = Integer.parseInt(value); - } - } - - if (action != UIMultiValueEditor.ACTION_NONE) - { - MultiValueEditorEvent event = new MultiValueEditorEvent(component, action, removeIndex); - component.queueEvent(event); - } - - super.decode(context, component); - } - - /** - * @see javax.faces.render.Renderer#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - @SuppressWarnings("static-access") - public void encodeBegin(FacesContext context, UIComponent component) throws IOException - { - if (component.isRendered() == false) - { - return; - } - - // reset the highlighted row flag - this.highlightedRow = false; - - if (component instanceof UIMultiValueEditor) - { - ResponseWriter out = context.getResponseWriter(); - Map attrs = component.getAttributes(); - UIMultiValueEditor editor = (UIMultiValueEditor)component; - - // start outer table - out.write(""); - - // render the area before the wrapped component - renderPreWrappedComponent(context, out, editor); - } - } - - /** - * @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - public void encodeEnd(FacesContext context, UIComponent component) throws IOException - { - if (component.isRendered() == false) - { - return; - } - - if (component instanceof UIMultiValueEditor) - { - ResponseWriter out = context.getResponseWriter(); - UIMultiValueEditor editor = (UIMultiValueEditor)component; - - // get hold of the node service - NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); - - // render the area between the component and current items list - renderPostWrappedComponent(context, out, editor); - - // show the currently selected items - out.write(""); - - out.write("
"); - out.write(editor.getSelectedItemsMsg()); - out.write("
"); - out.write(""); - - List currentItems = (List)editor.getValue();; - if (currentItems != null && currentItems.size() > 0) - { - for (int x = 0; x < currentItems.size(); x++) - { - Object obj = currentItems.get(x); - if (obj != null) - { - if (obj instanceof NodeRef) - { - if (nodeService.exists((NodeRef)obj)) - { - renderExistingItem(context, component, out, nodeService, x, obj); - } - else - { - // remove invalid NodeRefs from the list - currentItems.remove(x); - } - } - else - { - renderExistingItem(context, component, out, nodeService, x, obj); - } - } - } - } - else - { - out.write(""); - } - - // close tables - out.write("
"); - out.write(Application.getMessage(context, "name")); - out.write("
"); - out.write(editor.getNoSelectedItemsMsg()); - out.write("
\n"); - - // output a hidden field containing the current value - out.write(""); - } - } - - /** - * Renders the area of the component before the wrapped component appears. - * - * @param context FacesContext - * @param out The ResponseWriter to write to - * @param editor The multi value editor component - */ - protected abstract void renderPreWrappedComponent(FacesContext context, - ResponseWriter out, UIMultiValueEditor editor) throws IOException; - - /** - * Renders the area of the component after the wrapped component but before the list - * of currently selected values. - * - * @param context FacesContext - * @param out The ResponseWriter to write to - * @param editor The multi value editor component - */ - protected abstract void renderPostWrappedComponent(FacesContext context, - ResponseWriter out, UIMultiValueEditor editor) throws IOException; - - /** - * Renders an existing item with a remove button - * - * @param context FacesContext - * @param component The UIComponent - * @param out Writer to write output to - * @param nodeService The NodeService - * @param index The index of the item - * @param value The item's value - * @throws IOException - */ - protected void renderExistingItem(FacesContext context, UIComponent component, ResponseWriter out, - NodeService nodeService, int index, Object value) throws IOException - { - out.write(""); - - if (value instanceof NodeRef) - { - String name; - if (ContentModel.TYPE_CATEGORY.equals(nodeService.getType((NodeRef)value))) - { - name = Repository.getNameForCategoryNode(nodeService, (NodeRef)value); - } - else - { - name = Repository.getNameForNode(nodeService, (NodeRef)value); - } - out.write(Utils.encode(name)); - } - else if (value instanceof Date) - { - XMLDateConverter converter = (XMLDateConverter)context.getApplication(). - createConverter(RepoConstants.ALFRESCO_FACES_XMLDATE_CONVERTER); - UIComponent childComponent = (UIComponent)component.getChildren().get(0); - Boolean showTime = (Boolean)childComponent.getAttributes().get("showTime"); - if (showTime != null && showTime.booleanValue()) - { - converter.setPattern(Application.getMessage(context, "date_time_pattern")); - } - else - { - converter.setPattern(Application.getMessage(context, "date_pattern")); - } - - out.write(converter.getAsString(context, childComponent, value)); - } - else if (value instanceof Boolean) - { - Converter converter = context.getApplication().createConverter( - RepoConstants.ALFRESCO_FACES_BOOLEAN_CONVERTER); - out.write(converter.getAsString(context, - (UIComponent)component.getChildren().get(0), value)); - } - else - { - out.write(Utils.encode(value.toString())); - } - - out.write("  "); - out.write(""); - - this.highlightedRow = !this.highlightedRow; - } - - /** - * We use a hidden field per picker instance on the page. - * - * @return hidden field name - */ - protected String getHiddenFieldName(UIComponent component) - { - return component.getClientId(FacesContext.getCurrentInstance()); - } - - /** - * Generate FORM submit JavaScript for the specified action - * - * @param context FacesContext - * @param component The UIComponent - * @param action Action string - * - * @return FORM submit JavaScript - */ - protected String generateFormSubmit(FacesContext context, UIComponent component, String action) - { - return Utils.generateFormSubmit(context, component, getHiddenFieldName(component), action); - } -} +package org.alfresco.web.ui.repo.renderer; + +import java.io.IOException; +import java.util.Date; +import java.util.List; +import java.util.Map; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; +import javax.faces.convert.Converter; + +import org.alfresco.model.ContentModel; +import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.cmr.repository.NodeService; +import org.alfresco.web.app.Application; +import org.alfresco.web.bean.repository.Repository; +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.converter.XMLDateConverter; +import org.alfresco.web.ui.common.renderer.BaseRenderer; +import org.alfresco.web.ui.repo.RepoConstants; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor.MultiValueEditorEvent; + +/** + * Base class for renderers of the MultiValueEditor component. + * The current items are displayed as a list of options that can be + * removed using a Remove button. + * + * @author gavinc + */ +public abstract class BaseMultiValueRenderer extends BaseRenderer +{ + /** I18N message strings */ + protected final static String MSG_REMOVE = "remove"; + protected final static String MSG_SELECT_BUTTON = "select_button"; + protected final static String MSG_ADD_TO_LIST_BUTTON = "add_to_list_button"; + + protected boolean highlightedRow; + + // ------------------------------------------------------------------------------ + // Renderer implemenation + + /** + * @see javax.faces.render.Renderer#decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + public void decode(FacesContext context, UIComponent component) + { + Map requestMap = context.getExternalContext().getRequestParameterMap(); + String fieldId = getHiddenFieldName(component); + String value = (String)requestMap.get(fieldId); + + int action = UIMultiValueEditor.ACTION_NONE; + int removeIndex = -1; + if (value != null && value.length() != 0) + { + // break up the action into it's parts + int sepIdx = value.indexOf(UIMultiValueEditor.ACTION_SEPARATOR); + if (sepIdx != -1) + { + action = Integer.parseInt(value.substring(0, sepIdx)); + removeIndex = Integer.parseInt(value.substring(sepIdx+1)); + } + else + { + action = Integer.parseInt(value); + } + } + + if (action != UIMultiValueEditor.ACTION_NONE) + { + MultiValueEditorEvent event = new MultiValueEditorEvent(component, action, removeIndex); + component.queueEvent(event); + } + + super.decode(context, component); + } + + /** + * @see javax.faces.render.Renderer#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + @SuppressWarnings("static-access") + public void encodeBegin(FacesContext context, UIComponent component) throws IOException + { + if (component.isRendered() == false) + { + return; + } + + // reset the highlighted row flag + this.highlightedRow = false; + + if (component instanceof UIMultiValueEditor) + { + ResponseWriter out = context.getResponseWriter(); + Map attrs = component.getAttributes(); + UIMultiValueEditor editor = (UIMultiValueEditor)component; + + // start outer table + out.write(""); + + // render the area before the wrapped component + renderPreWrappedComponent(context, out, editor); + } + } + + /** + * @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + public void encodeEnd(FacesContext context, UIComponent component) throws IOException + { + if (component.isRendered() == false) + { + return; + } + + if (component instanceof UIMultiValueEditor) + { + ResponseWriter out = context.getResponseWriter(); + UIMultiValueEditor editor = (UIMultiValueEditor)component; + + // get hold of the node service + NodeService nodeService = Repository.getServiceRegistry(context).getNodeService(); + + // render the area between the component and current items list + renderPostWrappedComponent(context, out, editor); + + // show the currently selected items + out.write(""); + + out.write("
"); + out.write(editor.getSelectedItemsMsg()); + out.write("
"); + out.write(""); + + List currentItems = (List)editor.getValue();; + if (currentItems != null && currentItems.size() > 0) + { + for (int x = 0; x < currentItems.size(); x++) + { + Object obj = currentItems.get(x); + if (obj != null) + { + if (obj instanceof NodeRef) + { + if (nodeService.exists((NodeRef)obj)) + { + renderExistingItem(context, component, out, nodeService, x, obj); + } + else + { + // remove invalid NodeRefs from the list + currentItems.remove(x); + } + } + else + { + renderExistingItem(context, component, out, nodeService, x, obj); + } + } + } + } + else + { + out.write(""); + } + + // close tables + out.write("
"); + out.write(Application.getMessage(context, "name")); + out.write("
"); + out.write(editor.getNoSelectedItemsMsg()); + out.write("
\n"); + + // output a hidden field containing the current value + out.write(""); + } + } + + /** + * Renders the area of the component before the wrapped component appears. + * + * @param context FacesContext + * @param out The ResponseWriter to write to + * @param editor The multi value editor component + */ + protected abstract void renderPreWrappedComponent(FacesContext context, + ResponseWriter out, UIMultiValueEditor editor) throws IOException; + + /** + * Renders the area of the component after the wrapped component but before the list + * of currently selected values. + * + * @param context FacesContext + * @param out The ResponseWriter to write to + * @param editor The multi value editor component + */ + protected abstract void renderPostWrappedComponent(FacesContext context, + ResponseWriter out, UIMultiValueEditor editor) throws IOException; + + /** + * Renders an existing item with a remove button + * + * @param context FacesContext + * @param component The UIComponent + * @param out Writer to write output to + * @param nodeService The NodeService + * @param index The index of the item + * @param value The item's value + * @throws IOException + */ + protected void renderExistingItem(FacesContext context, UIComponent component, ResponseWriter out, + NodeService nodeService, int index, Object value) throws IOException + { + out.write(""); + + if (value instanceof NodeRef) + { + String name; + if (ContentModel.TYPE_CATEGORY.equals(nodeService.getType((NodeRef)value))) + { + name = Repository.getNameForCategoryNode(nodeService, (NodeRef)value); + } + else + { + name = Repository.getNameForNode(nodeService, (NodeRef)value); + } + out.write(Utils.encode(name)); + } + else if (value instanceof Date) + { + XMLDateConverter converter = (XMLDateConverter)context.getApplication(). + createConverter(RepoConstants.ALFRESCO_FACES_XMLDATE_CONVERTER); + UIComponent childComponent = (UIComponent)component.getChildren().get(0); + Boolean showTime = (Boolean)childComponent.getAttributes().get("showTime"); + if (showTime != null && showTime.booleanValue()) + { + converter.setPattern(Application.getMessage(context, "date_time_pattern")); + } + else + { + converter.setPattern(Application.getMessage(context, "date_pattern")); + } + + out.write(converter.getAsString(context, childComponent, value)); + } + else if (value instanceof Boolean) + { + Converter converter = context.getApplication().createConverter( + RepoConstants.ALFRESCO_FACES_BOOLEAN_CONVERTER); + out.write(converter.getAsString(context, + (UIComponent)component.getChildren().get(0), value)); + } + else + { + out.write(Utils.encode(value.toString())); + } + + out.write("  "); + out.write(""); + + this.highlightedRow = !this.highlightedRow; + } + + /** + * We use a hidden field per picker instance on the page. + * + * @return hidden field name + */ + protected String getHiddenFieldName(UIComponent component) + { + return component.getClientId(FacesContext.getCurrentInstance()); + } + + /** + * Generate FORM submit JavaScript for the specified action + * + * @param context FacesContext + * @param component The UIComponent + * @param action Action string + * + * @return FORM submit JavaScript + */ + protected String generateFormSubmit(FacesContext context, UIComponent component, String action) + { + return Utils.generateFormSubmit(context, component, getHiddenFieldName(component), action); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/renderer/MultiValueFieldRenderer.java b/source/java/org/alfresco/web/ui/repo/renderer/MultiValueFieldRenderer.java index 7211940f8b..6b512c7fcb 100644 --- a/source/java/org/alfresco/web/ui/repo/renderer/MultiValueFieldRenderer.java +++ b/source/java/org/alfresco/web/ui/repo/renderer/MultiValueFieldRenderer.java @@ -1,55 +1,55 @@ -package org.alfresco.web.ui.repo.renderer; - -import java.io.IOException; -import java.util.Map; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.web.app.Application; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; - -/** - * Renders the MultiValueEditor component for use with field components - * i.e. text, checkboxes, lists etc. - * - * This renderer does not show a "select item" message or a select button, - * the wrapped component is shown immediately with an add to list button - * after it. - * - * @author gavinc - */ -public class MultiValueFieldRenderer extends BaseMultiValueRenderer -{ - @Override - protected void renderPreWrappedComponent(FacesContext context, ResponseWriter out, - UIMultiValueEditor editor) throws IOException - { - out.write(""); - } - - @SuppressWarnings("unchecked") - @Override - protected void renderPostWrappedComponent(FacesContext context, ResponseWriter out, - UIMultiValueEditor editor) throws IOException - { - out.write(" "); - - // if the wrapped component is an mltext field add the icon - if (editor.getAttributes().get("mltext") != null) - { - String tooltip = Application.getMessage(context, "marker_tooltip"); - out.write(""); - } - - out.write(""); - } -} +package org.alfresco.web.ui.repo.renderer; + +import java.io.IOException; +import java.util.Map; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.web.app.Application; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; + +/** + * Renders the MultiValueEditor component for use with field components + * i.e. text, checkboxes, lists etc. + * + * This renderer does not show a "select item" message or a select button, + * the wrapped component is shown immediately with an add to list button + * after it. + * + * @author gavinc + */ +public class MultiValueFieldRenderer extends BaseMultiValueRenderer +{ + @Override + protected void renderPreWrappedComponent(FacesContext context, ResponseWriter out, + UIMultiValueEditor editor) throws IOException + { + out.write(""); + } + + @SuppressWarnings("unchecked") + @Override + protected void renderPostWrappedComponent(FacesContext context, ResponseWriter out, + UIMultiValueEditor editor) throws IOException + { + out.write(" "); + + // if the wrapped component is an mltext field add the icon + if (editor.getAttributes().get("mltext") != null) + { + String tooltip = Application.getMessage(context, "marker_tooltip"); + out.write(""); + } + + out.write(""); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/renderer/MultiValueSelectorRenderer.java b/source/java/org/alfresco/web/ui/repo/renderer/MultiValueSelectorRenderer.java index 426cf0aee9..58b5d8603c 100644 --- a/source/java/org/alfresco/web/ui/repo/renderer/MultiValueSelectorRenderer.java +++ b/source/java/org/alfresco/web/ui/repo/renderer/MultiValueSelectorRenderer.java @@ -1,68 +1,68 @@ -package org.alfresco.web.ui.repo.renderer; - -import java.io.IOException; - -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.web.app.Application; -import org.alfresco.web.ui.repo.component.UIMultiValueEditor; - -/** - * Renders the MultiValueEditor component for use with picker components. - * - * This renderer shows a "select items" message and a select button. When - * the select button is pressed the wrapped component will appear and the - * add to list button will be enabled. - * - * @author gavinc - */ -public class MultiValueSelectorRenderer extends BaseMultiValueRenderer -{ - @Override - protected void renderPreWrappedComponent(FacesContext context, ResponseWriter out, - UIMultiValueEditor editor) throws IOException - { - // show the select an item message - out.write(""); - out.write("1. "); - out.write(editor.getSelectItemMsg()); - out.write(""); - - if (editor.getAddingNewItem()) - { - out.write(""); - } - else - { - out.write(""); - } - } - - @Override - protected void renderPostWrappedComponent(FacesContext context, ResponseWriter out, - UIMultiValueEditor editor) throws IOException - { - if (editor.getAddingNewItem()) - { - out.write(""); - } - - // show the add to list button but only if something has been selected - out.write("2. "); - } -} +package org.alfresco.web.ui.repo.renderer; + +import java.io.IOException; + +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.web.app.Application; +import org.alfresco.web.ui.repo.component.UIMultiValueEditor; + +/** + * Renders the MultiValueEditor component for use with picker components. + * + * This renderer shows a "select items" message and a select button. When + * the select button is pressed the wrapped component will appear and the + * add to list button will be enabled. + * + * @author gavinc + */ +public class MultiValueSelectorRenderer extends BaseMultiValueRenderer +{ + @Override + protected void renderPreWrappedComponent(FacesContext context, ResponseWriter out, + UIMultiValueEditor editor) throws IOException + { + // show the select an item message + out.write(""); + out.write("1. "); + out.write(editor.getSelectItemMsg()); + out.write(""); + + if (editor.getAddingNewItem()) + { + out.write(""); + } + else + { + out.write(""); + } + } + + @Override + protected void renderPostWrappedComponent(FacesContext context, ResponseWriter out, + UIMultiValueEditor editor) throws IOException + { + if (editor.getAddingNewItem()) + { + out.write(""); + } + + // show the add to list button but only if something has been selected + out.write("2. "); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextAreaRenderer.java b/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextAreaRenderer.java index 938194610e..62ee7964e7 100644 --- a/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextAreaRenderer.java +++ b/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextAreaRenderer.java @@ -1,52 +1,52 @@ -package org.alfresco.web.ui.repo.renderer; - -import java.io.IOException; - -import javax.faces.component.UIComponent; -import javax.faces.component.ValueHolder; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.web.app.Application; -import org.apache.myfaces.renderkit.html.HtmlTextareaRenderer; - -/** - * Renders a multilingual text area. - *

- * Renders the default output followed by an icon - * to represent multilingual properties. - *

- * - * @author gavinc - */ -public class MultilingualTextAreaRenderer extends HtmlTextareaRenderer -{ - @Override - protected void encodeTextArea(FacesContext facesContext, UIComponent uiComponent) throws IOException - { - // to workaround a bug in MyFaces where it appears a new line gets removed - // in the process view/edit process add it back (ETWOONE-91) - Object value = ((ValueHolder) uiComponent).getValue(); - String valueStr = null; - if (value != null) - { - valueStr = "\r\n" + (String)value; - } - ((ValueHolder) uiComponent).setValue(valueStr); - super.encodeTextArea(facesContext, uiComponent); -} - - @Override - public void encodeEnd(FacesContext facesContext, UIComponent component) throws IOException - { - super.encodeEnd(facesContext, component); - - String tooltip = Application.getMessage(facesContext, "marker_tooltip"); - ResponseWriter out = facesContext.getResponseWriter(); - out.write(""); - } -} +package org.alfresco.web.ui.repo.renderer; + +import java.io.IOException; + +import javax.faces.component.UIComponent; +import javax.faces.component.ValueHolder; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.web.app.Application; +import org.apache.myfaces.renderkit.html.HtmlTextareaRenderer; + +/** + * Renders a multilingual text area. + *

+ * Renders the default output followed by an icon + * to represent multilingual properties. + *

+ * + * @author gavinc + */ +public class MultilingualTextAreaRenderer extends HtmlTextareaRenderer +{ + @Override + protected void encodeTextArea(FacesContext facesContext, UIComponent uiComponent) throws IOException + { + // to workaround a bug in MyFaces where it appears a new line gets removed + // in the process view/edit process add it back (ETWOONE-91) + Object value = ((ValueHolder) uiComponent).getValue(); + String valueStr = null; + if (value != null) + { + valueStr = "\r\n" + (String)value; + } + ((ValueHolder) uiComponent).setValue(valueStr); + super.encodeTextArea(facesContext, uiComponent); +} + + @Override + public void encodeEnd(FacesContext facesContext, UIComponent component) throws IOException + { + super.encodeEnd(facesContext, component); + + String tooltip = Application.getMessage(facesContext, "marker_tooltip"); + ResponseWriter out = facesContext.getResponseWriter(); + out.write(""); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextRenderer.java b/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextRenderer.java index e9cc8b02af..bdc83bc1dc 100644 --- a/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextRenderer.java +++ b/source/java/org/alfresco/web/ui/repo/renderer/MultilingualTextRenderer.java @@ -1,36 +1,36 @@ -package org.alfresco.web.ui.repo.renderer; - -import java.io.IOException; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.web.app.Application; -import org.apache.myfaces.renderkit.html.HtmlTextRenderer; - -/** - * Renders a multilingual text field. - *

- * Renders the default output followed by an icon - * to represent multilingual properties. - *

- * - * @author gavinc - */ -public class MultilingualTextRenderer extends HtmlTextRenderer -{ - @Override - public void encodeEnd(FacesContext facesContext, UIComponent component) throws IOException - { - super.encodeEnd(facesContext, component); - - String tooltip = Application.getMessage(facesContext, "marker_tooltip"); - ResponseWriter out = facesContext.getResponseWriter(); - out.write(""); - } -} +package org.alfresco.web.ui.repo.renderer; + +import java.io.IOException; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.web.app.Application; +import org.apache.myfaces.renderkit.html.HtmlTextRenderer; + +/** + * Renders a multilingual text field. + *

+ * Renders the default output followed by an icon + * to represent multilingual properties. + *

+ * + * @author gavinc + */ +public class MultilingualTextRenderer extends HtmlTextRenderer +{ + @Override + public void encodeEnd(FacesContext facesContext, UIComponent component) throws IOException + { + super.encodeEnd(facesContext, component); + + String tooltip = Application.getMessage(facesContext, "marker_tooltip"); + ResponseWriter out = facesContext.getResponseWriter(); + out.write(""); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/renderer/property/PropertySheetItemRenderer.java b/source/java/org/alfresco/web/ui/repo/renderer/property/PropertySheetItemRenderer.java index c2c3087a87..f1cdb6582b 100644 --- a/source/java/org/alfresco/web/ui/repo/renderer/property/PropertySheetItemRenderer.java +++ b/source/java/org/alfresco/web/ui/repo/renderer/property/PropertySheetItemRenderer.java @@ -1,106 +1,106 @@ -package org.alfresco.web.ui.repo.renderer.property; - -import java.io.IOException; -import java.util.List; - -import javax.faces.component.UIComponent; -import javax.faces.context.FacesContext; -import javax.faces.context.ResponseWriter; - -import org.alfresco.web.ui.common.Utils; -import org.alfresco.web.ui.common.renderer.BaseRenderer; - -/** - * Renderer for a PropertySheetItem component - * - * @author gavinc - */ -public class PropertySheetItemRenderer extends BaseRenderer -{ - /** - * @see javax.faces.render.Renderer#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - public void encodeBegin(FacesContext context, UIComponent component) throws IOException - { - if (component.isRendered() == false) - { - return; - } - - // NOTE: we close off the first generated by the property sheet's grid renderer - context.getResponseWriter().write(""); - } - - /** - * @see javax.faces.render.Renderer#encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - @SuppressWarnings("unchecked") - public void encodeChildren(FacesContext context, UIComponent component) throws IOException - { - if (component.isRendered() == false) - { - return; - } - - ResponseWriter out = context.getResponseWriter(); - - // make sure there are 2 or 3 child components - int count = component.getChildCount(); - - if (count == 2 || count == 3) - { - // get the label and the control - List children = component.getChildren(); - UIComponent label = children.get(0); - UIComponent control = children.get(1); - - // encode the mandatory marker component if present - if (count == 3) - { - out.write(""); - UIComponent mandatoryMarker = children.get(2); - Utils.encodeRecursive(context, mandatoryMarker); - out.write(""); - } - else - { - // output an empty column - out.write(" "); - } - - // place a style class on the label column if necessary - String labelStylceClass = (String)component.getParent().getAttributes().get("labelStyleClass"); - out.write(" - out.write(">"); - // encode the label - Utils.encodeRecursive(context, label); - // encode the control - out.write(""); - Utils.encodeRecursive(context, control); - - // NOTE: we'll allow the property sheet's grid renderer close off the last - } - } - - /** - * @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent) - */ - public void encodeEnd(FacesContext context, UIComponent component) throws IOException - { - // we don't need to do anything in here - } - - /** - * @see javax.faces.render.Renderer#getRendersChildren() - */ - public boolean getRendersChildren() - { - return true; - } -} +package org.alfresco.web.ui.repo.renderer.property; + +import java.io.IOException; +import java.util.List; + +import javax.faces.component.UIComponent; +import javax.faces.context.FacesContext; +import javax.faces.context.ResponseWriter; + +import org.alfresco.web.ui.common.Utils; +import org.alfresco.web.ui.common.renderer.BaseRenderer; + +/** + * Renderer for a PropertySheetItem component + * + * @author gavinc + */ +public class PropertySheetItemRenderer extends BaseRenderer +{ + /** + * @see javax.faces.render.Renderer#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + public void encodeBegin(FacesContext context, UIComponent component) throws IOException + { + if (component.isRendered() == false) + { + return; + } + + // NOTE: we close off the first generated by the property sheet's grid renderer + context.getResponseWriter().write(""); + } + + /** + * @see javax.faces.render.Renderer#encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + @SuppressWarnings("unchecked") + public void encodeChildren(FacesContext context, UIComponent component) throws IOException + { + if (component.isRendered() == false) + { + return; + } + + ResponseWriter out = context.getResponseWriter(); + + // make sure there are 2 or 3 child components + int count = component.getChildCount(); + + if (count == 2 || count == 3) + { + // get the label and the control + List children = component.getChildren(); + UIComponent label = children.get(0); + UIComponent control = children.get(1); + + // encode the mandatory marker component if present + if (count == 3) + { + out.write(""); + UIComponent mandatoryMarker = children.get(2); + Utils.encodeRecursive(context, mandatoryMarker); + out.write(""); + } + else + { + // output an empty column + out.write(" "); + } + + // place a style class on the label column if necessary + String labelStylceClass = (String)component.getParent().getAttributes().get("labelStyleClass"); + out.write(" + out.write(">"); + // encode the label + Utils.encodeRecursive(context, label); + // encode the control + out.write(""); + Utils.encodeRecursive(context, control); + + // NOTE: we'll allow the property sheet's grid renderer close off the last + } + } + + /** + * @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent) + */ + public void encodeEnd(FacesContext context, UIComponent component) throws IOException + { + // we don't need to do anything in here + } + + /** + * @see javax.faces.render.Renderer#getRendersChildren() + */ + public boolean getRendersChildren() + { + return true; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/ActionsTag.java b/source/java/org/alfresco/web/ui/repo/tag/ActionsTag.java index 331aad0aa1..ef8f429da3 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/ActionsTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/ActionsTag.java @@ -1,105 +1,105 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * @author kevinr - */ -public class ActionsTag extends HtmlComponentTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.Actions"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setBooleanProperty(component, "showLink", this.showLink); - setStringProperty(component, "value", this.value); - setStringBindingProperty(component, "context", this.context); - setIntProperty(component, "verticalSpacing", this.verticalSpacing); - } - - /** - * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() - */ - public void release() - { - super.release(); - this.value = null; - this.showLink = null; - this.context = null; - this.verticalSpacing = null; - } - - /** - * Set the value (id of the action group config to use) - * - * @param value the value (id of the action group config to use) - */ - public void setValue(String value) - { - this.value = value; - } - - /** - * Set the showLink - * - * @param showLink the showLink - */ - public void setShowLink(String showLink) - { - this.showLink = showLink; - } - - /** - * Set the context object - * - * @param context the context object - */ - public void setContext(String context) - { - this.context = context; - } - - /** - * Set the verticalSpacing - * - * @param verticalSpacing the verticalSpacing - */ - public void setVerticalSpacing(String verticalSpacing) - { - this.verticalSpacing = verticalSpacing; - } - - - /** the verticalSpacing */ - private String verticalSpacing; - - /** the context object */ - private String context; - - /** the value (id of the action group config to use) */ - private String value; - - /** the showLink boolean */ - private String showLink; -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * @author kevinr + */ +public class ActionsTag extends HtmlComponentTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.Actions"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setBooleanProperty(component, "showLink", this.showLink); + setStringProperty(component, "value", this.value); + setStringBindingProperty(component, "context", this.context); + setIntProperty(component, "verticalSpacing", this.verticalSpacing); + } + + /** + * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() + */ + public void release() + { + super.release(); + this.value = null; + this.showLink = null; + this.context = null; + this.verticalSpacing = null; + } + + /** + * Set the value (id of the action group config to use) + * + * @param value the value (id of the action group config to use) + */ + public void setValue(String value) + { + this.value = value; + } + + /** + * Set the showLink + * + * @param showLink the showLink + */ + public void setShowLink(String showLink) + { + this.showLink = showLink; + } + + /** + * Set the context object + * + * @param context the context object + */ + public void setContext(String context) + { + this.context = context; + } + + /** + * Set the verticalSpacing + * + * @param verticalSpacing the verticalSpacing + */ + public void setVerticalSpacing(String verticalSpacing) + { + this.verticalSpacing = verticalSpacing; + } + + + /** the verticalSpacing */ + private String verticalSpacing; + + /** the context object */ + private String context; + + /** the value (id of the action group config to use) */ + private String value; + + /** the showLink boolean */ + private String showLink; +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/AjaxTagSelectorTag.java b/source/java/org/alfresco/web/ui/repo/tag/AjaxTagSelectorTag.java index e3b00c2b09..6eb9e72bea 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/AjaxTagSelectorTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/AjaxTagSelectorTag.java @@ -1,19 +1,19 @@ -/* - * Created on 25-May-2005 - */ -package org.alfresco.web.ui.repo.tag; - - -/** - * @author Mike Hatfield - */ -public class AjaxTagSelectorTag extends AjaxItemSelectorTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.AjaxTagPicker"; - } -} +/* + * Created on 25-May-2005 + */ +package org.alfresco.web.ui.repo.tag; + + +/** + * @author Mike Hatfield + */ +public class AjaxTagSelectorTag extends AjaxItemSelectorTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.AjaxTagPicker"; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/BaseMultiValueTag.java b/source/java/org/alfresco/web/ui/repo/tag/BaseMultiValueTag.java index 8bed8b1411..302eece94e 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/BaseMultiValueTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/BaseMultiValueTag.java @@ -1,117 +1,117 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; -import org.alfresco.web.ui.repo.RepoConstants; - -/** - * Base class for all tags that combine the multi value component - * and renderers - * - * @author gavinc - */ -public abstract class BaseMultiValueTag extends HtmlComponentTag -{ - private String value; - private String lastItemAdded; - private String readOnly; - private String selectItemMsg; - private String selectedItemsMsg; - private String noSelectedItemsMsg; - - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return RepoConstants.ALFRESCO_FACES_MULTIVALUE_EDITOR; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - setStringBindingProperty(component, "value", this.value); - setStringBindingProperty(component, "lastItemAdded", this.lastItemAdded); - setStringProperty(component, "selectItemMsg", this.selectItemMsg); - setStringProperty(component, "selectedItemsMsg", this.selectedItemsMsg); - setStringProperty(component, "noSelectedItemsMsg", this.noSelectedItemsMsg); - setBooleanProperty(component, "readOnly", this.readOnly); - } - - /** - * @see javax.servlet.jsp.tagext.Tag#release() - */ - public void release() - { - this.value = null; - this.lastItemAdded = null; - this.readOnly = null; - this.selectedItemsMsg = null; - this.selectItemMsg = null; - this.noSelectedItemsMsg = null; - - super.release(); - } - - /** - * @param value The value to set. - */ - public void setValue(String value) - { - this.value = value; - } - - /** - * Sets the lastItemAdded value expression binding - * - * @param lastItemAdded lastItemAdded binding - */ - public void setLastItemAdded(String lastItemAdded) - { - this.lastItemAdded = lastItemAdded; - } - - /** - * Sets the readOnly flag for the component - * - * @param readOnly true if the component will be read only - */ - public void setReadOnly(String readOnly) - { - this.readOnly = readOnly; - } - - /** - * Sets the message to display for the no selected items - * - * @param noSelectedItemsMsg The message - */ - public void setNoSelectedItemsMsg(String noSelectedItemsMsg) - { - this.noSelectedItemsMsg = noSelectedItemsMsg; - } - - /** - * Sets the message to display for the selected items - * - * @param selectedItemsMsg The message - */ - public void setSelectedItemsMsg(String selectedItemsMsg) - { - this.selectedItemsMsg = selectedItemsMsg; - } - - /** - * Sets the message to display for inviting the user to select an item - * - * @param selectItemMsg The message - */ - public void setSelectItemMsg(String selectItemMsg) - { - this.selectItemMsg = selectItemMsg; - } -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; +import org.alfresco.web.ui.repo.RepoConstants; + +/** + * Base class for all tags that combine the multi value component + * and renderers + * + * @author gavinc + */ +public abstract class BaseMultiValueTag extends HtmlComponentTag +{ + private String value; + private String lastItemAdded; + private String readOnly; + private String selectItemMsg; + private String selectedItemsMsg; + private String noSelectedItemsMsg; + + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return RepoConstants.ALFRESCO_FACES_MULTIVALUE_EDITOR; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + setStringBindingProperty(component, "value", this.value); + setStringBindingProperty(component, "lastItemAdded", this.lastItemAdded); + setStringProperty(component, "selectItemMsg", this.selectItemMsg); + setStringProperty(component, "selectedItemsMsg", this.selectedItemsMsg); + setStringProperty(component, "noSelectedItemsMsg", this.noSelectedItemsMsg); + setBooleanProperty(component, "readOnly", this.readOnly); + } + + /** + * @see javax.servlet.jsp.tagext.Tag#release() + */ + public void release() + { + this.value = null; + this.lastItemAdded = null; + this.readOnly = null; + this.selectedItemsMsg = null; + this.selectItemMsg = null; + this.noSelectedItemsMsg = null; + + super.release(); + } + + /** + * @param value The value to set. + */ + public void setValue(String value) + { + this.value = value; + } + + /** + * Sets the lastItemAdded value expression binding + * + * @param lastItemAdded lastItemAdded binding + */ + public void setLastItemAdded(String lastItemAdded) + { + this.lastItemAdded = lastItemAdded; + } + + /** + * Sets the readOnly flag for the component + * + * @param readOnly true if the component will be read only + */ + public void setReadOnly(String readOnly) + { + this.readOnly = readOnly; + } + + /** + * Sets the message to display for the no selected items + * + * @param noSelectedItemsMsg The message + */ + public void setNoSelectedItemsMsg(String noSelectedItemsMsg) + { + this.noSelectedItemsMsg = noSelectedItemsMsg; + } + + /** + * Sets the message to display for the selected items + * + * @param selectedItemsMsg The message + */ + public void setSelectedItemsMsg(String selectedItemsMsg) + { + this.selectedItemsMsg = selectedItemsMsg; + } + + /** + * Sets the message to display for inviting the user to select an item + * + * @param selectItemMsg The message + */ + public void setSelectItemMsg(String selectItemMsg) + { + this.selectItemMsg = selectItemMsg; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/CategoryBrowserTag.java b/source/java/org/alfresco/web/ui/repo/tag/CategoryBrowserTag.java index 8722e7e070..155c8db6f3 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/CategoryBrowserTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/CategoryBrowserTag.java @@ -1,38 +1,38 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -public class CategoryBrowserTag extends HtmlComponentTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - } - - /** - * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() - */ - public void release() - { - super.release(); - } - - @Override - public String getComponentType() - { - return "org.alfresco.faces.CategoryBrowser"; - } -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +public class CategoryBrowserTag extends HtmlComponentTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + } + + /** + * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() + */ + public void release() + { + super.release(); + } + + @Override + public String getComponentType() + { + return "org.alfresco.faces.CategoryBrowser"; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/ContentSelectorTag.java b/source/java/org/alfresco/web/ui/repo/tag/ContentSelectorTag.java index f7046e48fc..87adc3b9bc 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/ContentSelectorTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/ContentSelectorTag.java @@ -1,97 +1,97 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * Tag class to allow the content selector component to be added to a JSP page - * - * @author gavinc - */ -public class ContentSelectorTag extends HtmlComponentTag -{ - private String availableOptionsSize; - private String disabled; - private String value; - private String multiSelect; - - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.ContentSelector"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setStringStaticProperty(component, "availableOptionsSize", this.availableOptionsSize); - setStringProperty(component, "value", this.value); - setBooleanProperty(component, "disabled", this.disabled); - setBooleanProperty(component, "multiSelect", this.multiSelect); - } - - /** - * @param value The value to set. - */ - public void setValue(String value) - { - this.value = value; - } - - /** - * @param availableOptionsSize Sets the size of the available options size when - * multiple items can be selected - */ - public void setAvailableOptionsSize(String availableOptionsSize) - { - this.availableOptionsSize = availableOptionsSize; - } - - /** - * Set the multiSelect - * - * @param multiSelect the multiSelect - */ - public void setMultiSelect(String multiSelect) - { - this.multiSelect = multiSelect; - } - - /** - * Sets whether the component should be rendered in a disabled state - * - * @param disabled true to render the component in a disabled state - */ - public void setDisabled(String disabled) - { - this.disabled = disabled; - } - - /** - * @see javax.faces.webapp.UIComponentTag#release() - */ - public void release() - { - this.availableOptionsSize = null; - this.disabled = null; - this.value = null; - this.multiSelect = null; - - super.release(); - } -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * Tag class to allow the content selector component to be added to a JSP page + * + * @author gavinc + */ +public class ContentSelectorTag extends HtmlComponentTag +{ + private String availableOptionsSize; + private String disabled; + private String value; + private String multiSelect; + + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.ContentSelector"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setStringStaticProperty(component, "availableOptionsSize", this.availableOptionsSize); + setStringProperty(component, "value", this.value); + setBooleanProperty(component, "disabled", this.disabled); + setBooleanProperty(component, "multiSelect", this.multiSelect); + } + + /** + * @param value The value to set. + */ + public void setValue(String value) + { + this.value = value; + } + + /** + * @param availableOptionsSize Sets the size of the available options size when + * multiple items can be selected + */ + public void setAvailableOptionsSize(String availableOptionsSize) + { + this.availableOptionsSize = availableOptionsSize; + } + + /** + * Set the multiSelect + * + * @param multiSelect the multiSelect + */ + public void setMultiSelect(String multiSelect) + { + this.multiSelect = multiSelect; + } + + /** + * Sets whether the component should be rendered in a disabled state + * + * @param disabled true to render the component in a disabled state + */ + public void setDisabled(String disabled) + { + this.disabled = disabled; + } + + /** + * @see javax.faces.webapp.UIComponentTag#release() + */ + public void release() + { + this.availableOptionsSize = null; + this.disabled = null; + this.value = null; + this.multiSelect = null; + + super.release(); + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/DialogButtonsTag.java b/source/java/org/alfresco/web/ui/repo/tag/DialogButtonsTag.java index ba6da8ce20..26ee2ccd03 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/DialogButtonsTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/DialogButtonsTag.java @@ -1,27 +1,27 @@ -package org.alfresco.web.ui.repo.tag; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * Tag class that allows the UIDialogButtons component to be placed on a JSP. - * - * @author gavinc - */ -public class DialogButtonsTag extends HtmlComponentTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.DialogButtons"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } -} +package org.alfresco.web.ui.repo.tag; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * Tag class that allows the UIDialogButtons component to be placed on a JSP. + * + * @author gavinc + */ +public class DialogButtonsTag extends HtmlComponentTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.DialogButtons"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/MimeTypeSelectorTag.java b/source/java/org/alfresco/web/ui/repo/tag/MimeTypeSelectorTag.java index 136788e5ad..bacfb7733d 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/MimeTypeSelectorTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/MimeTypeSelectorTag.java @@ -1,71 +1,71 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.ComponentConstants; -import org.alfresco.web.ui.common.tag.HtmlComponentTag; -import org.alfresco.web.ui.repo.component.UIMimeTypeSelector; - -/** - * Tag class for the MIME type selector component - * - * @author gavinc - */ -public class MimeTypeSelectorTag extends HtmlComponentTag -{ - /** The value */ - private String value; - - /** Whether the component is disabled */ - private String disabled; - - @Override - public String getComponentType() - { - return UIMimeTypeSelector.COMPONENT_TYPE; - } - - @Override - public String getRendererType() - { - return ComponentConstants.JAVAX_FACES_MENU; - } - - @Override - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setStringBindingProperty(component, "value", this.value); - setBooleanProperty(component, "disabled", this.disabled); - } - - @Override - public void release() - { - super.release(); - - this.value = null; - this.disabled = null; - } - - /** - * Set the value - * - * @param value the value - */ - public void setValue(String value) - { - this.value = value; - } - - /** - * Sets whether the component should be rendered in a disabled state - * - * @param disabled true to render the component in a disabled state - */ - public void setDisabled(String disabled) - { - this.disabled = disabled; - } -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.ComponentConstants; +import org.alfresco.web.ui.common.tag.HtmlComponentTag; +import org.alfresco.web.ui.repo.component.UIMimeTypeSelector; + +/** + * Tag class for the MIME type selector component + * + * @author gavinc + */ +public class MimeTypeSelectorTag extends HtmlComponentTag +{ + /** The value */ + private String value; + + /** Whether the component is disabled */ + private String disabled; + + @Override + public String getComponentType() + { + return UIMimeTypeSelector.COMPONENT_TYPE; + } + + @Override + public String getRendererType() + { + return ComponentConstants.JAVAX_FACES_MENU; + } + + @Override + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setStringBindingProperty(component, "value", this.value); + setBooleanProperty(component, "disabled", this.disabled); + } + + @Override + public void release() + { + super.release(); + + this.value = null; + this.disabled = null; + } + + /** + * Set the value + * + * @param value the value + */ + public void setValue(String value) + { + this.value = value; + } + + /** + * Sets whether the component should be rendered in a disabled state + * + * @param disabled true to render the component in a disabled state + */ + public void setDisabled(String disabled) + { + this.disabled = disabled; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/MultiValueFieldTag.java b/source/java/org/alfresco/web/ui/repo/tag/MultiValueFieldTag.java index 0a75922469..f0a67b9aee 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/MultiValueFieldTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/MultiValueFieldTag.java @@ -1,21 +1,21 @@ -package org.alfresco.web.ui.repo.tag; - -import org.alfresco.web.ui.repo.RepoConstants; - -/** - * Tag that combines the multi value editor component and - * the field renderer. - * - * @author gavinc - * - */ -public class MultiValueFieldTag extends BaseMultiValueTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return RepoConstants.ALFRESCO_FACES_FIELD_RENDERER; - } -} +package org.alfresco.web.ui.repo.tag; + +import org.alfresco.web.ui.repo.RepoConstants; + +/** + * Tag that combines the multi value editor component and + * the field renderer. + * + * @author gavinc + * + */ +public class MultiValueFieldTag extends BaseMultiValueTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return RepoConstants.ALFRESCO_FACES_FIELD_RENDERER; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/MultiValueSelectorTag.java b/source/java/org/alfresco/web/ui/repo/tag/MultiValueSelectorTag.java index 878f268221..dccaba7624 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/MultiValueSelectorTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/MultiValueSelectorTag.java @@ -1,20 +1,20 @@ -package org.alfresco.web.ui.repo.tag; - -import org.alfresco.web.ui.repo.RepoConstants; - -/** - * Tag that combines the multi value editor component and - * the selector renderer. - * - * @author gavinc - */ -public class MultiValueSelectorTag extends BaseMultiValueTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return RepoConstants.ALFRESCO_FACES_SELECTOR_RENDERER; - } -} +package org.alfresco.web.ui.repo.tag; + +import org.alfresco.web.ui.repo.RepoConstants; + +/** + * Tag that combines the multi value editor component and + * the selector renderer. + * + * @author gavinc + */ +public class MultiValueSelectorTag extends BaseMultiValueTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return RepoConstants.ALFRESCO_FACES_SELECTOR_RENDERER; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/NodeInfoTag.java b/source/java/org/alfresco/web/ui/repo/tag/NodeInfoTag.java index ae1b8a38b9..97abff8df0 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/NodeInfoTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/NodeInfoTag.java @@ -1,61 +1,61 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * Tag class for the UINodeInfo component - * - * @author gavinc - */ -public class NodeInfoTag extends HtmlComponentTag -{ - private String value; - - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.NodeInfo"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setStringBindingProperty(component, "value", this.value); - } - - /** - * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() - */ - public void release() - { - super.release(); - - this.value = null; - } - - /** - * Set the value - * - * @param value the value - */ - public void setValue(String value) - { - this.value = value; - } -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * Tag class for the UINodeInfo component + * + * @author gavinc + */ +public class NodeInfoTag extends HtmlComponentTag +{ + private String value; + + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.NodeInfo"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setStringBindingProperty(component, "value", this.value); + } + + /** + * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() + */ + public void release() + { + super.release(); + + this.value = null; + } + + /** + * Set the value + * + * @param value the value + */ + public void setValue(String value) + { + this.value = value; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/NodeWorkflowInfoTag.java b/source/java/org/alfresco/web/ui/repo/tag/NodeWorkflowInfoTag.java index 4421c48922..361a85f20f 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/NodeWorkflowInfoTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/NodeWorkflowInfoTag.java @@ -1,61 +1,61 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * Tag class for the UINodeWorkflowInfo component - * - * @author gavinc - */ -public class NodeWorkflowInfoTag extends HtmlComponentTag -{ - private String value; - - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.NodeWorkflowInfo"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setStringBindingProperty(component, "value", this.value); - } - - /** - * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() - */ - public void release() - { - super.release(); - - this.value = null; - } - - /** - * Set the value - * - * @param value the value - */ - public void setValue(String value) - { - this.value = value; - } -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * Tag class for the UINodeWorkflowInfo component + * + * @author gavinc + */ +public class NodeWorkflowInfoTag extends HtmlComponentTag +{ + private String value; + + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.NodeWorkflowInfo"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setStringBindingProperty(component, "value", this.value); + } + + /** + * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() + */ + public void release() + { + super.release(); + + this.value = null; + } + + /** + * Set the value + * + * @param value the value + */ + public void setValue(String value) + { + this.value = value; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/OpenSearchTag.java b/source/java/org/alfresco/web/ui/repo/tag/OpenSearchTag.java index a7819ca7eb..f6efa3f8ae 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/OpenSearchTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/OpenSearchTag.java @@ -1,27 +1,27 @@ -package org.alfresco.web.ui.repo.tag; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * Tag class for the OpenSearch component - * - * @author gavinc - */ -public class OpenSearchTag extends HtmlComponentTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.OpenSearch"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } -} +package org.alfresco.web.ui.repo.tag; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * Tag class for the OpenSearch component + * + * @author gavinc + */ +public class OpenSearchTag extends HtmlComponentTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.OpenSearch"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/UserGroupPickerTag.java b/source/java/org/alfresco/web/ui/repo/tag/UserGroupPickerTag.java index 9f11cc774a..780d070359 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/UserGroupPickerTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/UserGroupPickerTag.java @@ -1,74 +1,74 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UICommand; -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * @author Kevin Roast - */ -public class UserGroupPickerTag extends HtmlComponentTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.UserGroupPicker"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setStringProperty(component, "value", this.value); - setActionListenerProperty((UICommand)component, this.actionListener); - } - - /** - * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() - */ - public void release() - { - super.release(); - this.value = null; - } - - /** - * Set the value (binding to the list of user/group data) - * - * @param value the value - */ - public void setValue(String value) - { - this.value = value; - } - - /** - * Set the actionListener - * - * @param actionListener the actionListener - */ - public void setActionListener(String actionListener) - { - this.actionListener = actionListener; - } - - /** the value (binding to the list of user/group data) */ - private String value; - - /** the actionListener */ - private String actionListener; -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UICommand; +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * @author Kevin Roast + */ +public class UserGroupPickerTag extends HtmlComponentTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.UserGroupPicker"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setStringProperty(component, "value", this.value); + setActionListenerProperty((UICommand)component, this.actionListener); + } + + /** + * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() + */ + public void release() + { + super.release(); + this.value = null; + } + + /** + * Set the value (binding to the list of user/group data) + * + * @param value the value + */ + public void setValue(String value) + { + this.value = value; + } + + /** + * Set the actionListener + * + * @param actionListener the actionListener + */ + public void setActionListener(String actionListener) + { + this.actionListener = actionListener; + } + + /** the value (binding to the list of user/group data) */ + private String value; + + /** the actionListener */ + private String actionListener; +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/WebProjectFolderSelectorTag.java b/source/java/org/alfresco/web/ui/repo/tag/WebProjectFolderSelectorTag.java index c9b8ef9fb3..1fd8939057 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/WebProjectFolderSelectorTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/WebProjectFolderSelectorTag.java @@ -1,18 +1,18 @@ - -package org.alfresco.web.ui.repo.tag; - -/** - * Tag class to allow the web project folder selector to be used on a JSP - * - * @author gavinc - */ -public class WebProjectFolderSelectorTag extends ItemSelectorTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.WebProjectFolderSelector"; - } -} + +package org.alfresco.web.ui.repo.tag; + +/** + * Tag class to allow the web project folder selector to be used on a JSP + * + * @author gavinc + */ +public class WebProjectFolderSelectorTag extends ItemSelectorTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.WebProjectFolderSelector"; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/WorkflowHistoryTag.java b/source/java/org/alfresco/web/ui/repo/tag/WorkflowHistoryTag.java index 8ba359b7bb..1857b46341 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/WorkflowHistoryTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/WorkflowHistoryTag.java @@ -1,60 +1,60 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * Tag that allows the workflow history component to be placed on a JSP page - * - * @author gavinc - */ -public class WorkflowHistoryTag extends HtmlComponentTag -{ - private String value; - - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.WorkflowHistory"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setStringProperty(component, "value", this.value); - } - - /** - * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() - */ - public void release() - { - super.release(); - this.value = null; - } - - /** - * Set the value (binding to the list of user/group data) - * - * @param value the value - */ - public void setValue(String value) - { - this.value = value; - } -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * Tag that allows the workflow history component to be placed on a JSP page + * + * @author gavinc + */ +public class WorkflowHistoryTag extends HtmlComponentTag +{ + private String value; + + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.WorkflowHistory"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setStringProperty(component, "value", this.value); + } + + /** + * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() + */ + public void release() + { + super.release(); + this.value = null; + } + + /** + * Set the value (binding to the list of user/group data) + * + * @param value the value + */ + public void setValue(String value) + { + this.value = value; + } +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/WorkflowSummaryTag.java b/source/java/org/alfresco/web/ui/repo/tag/WorkflowSummaryTag.java index beb4832f90..2fd718d25e 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/WorkflowSummaryTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/WorkflowSummaryTag.java @@ -1,61 +1,61 @@ -package org.alfresco.web.ui.repo.tag; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.HtmlComponentTag; - -/** - * Tag that allows the workflow summary component to be placed on a JSP page - * - * @author gavinc - */ -public class WorkflowSummaryTag extends HtmlComponentTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.WorkflowSummary"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#getRendererType() - */ - public String getRendererType() - { - return null; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - - setStringProperty(component, "value", this.value); - } - - /** - * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() - */ - public void release() - { - super.release(); - this.value = null; - } - - /** - * Set the value (binding to the list of user/group data) - * - * @param value the value - */ - public void setValue(String value) - { - this.value = value; - } - - /** the value (binding to the workflow instance) */ - private String value; -} +package org.alfresco.web.ui.repo.tag; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.HtmlComponentTag; + +/** + * Tag that allows the workflow summary component to be placed on a JSP page + * + * @author gavinc + */ +public class WorkflowSummaryTag extends HtmlComponentTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.WorkflowSummary"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#getRendererType() + */ + public String getRendererType() + { + return null; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + + setStringProperty(component, "value", this.value); + } + + /** + * @see org.alfresco.web.ui.common.tag.HtmlComponentTag#release() + */ + public void release() + { + super.release(); + this.value = null; + } + + /** + * Set the value (binding to the list of user/group data) + * + * @param value the value + */ + public void setValue(String value) + { + this.value = value; + } + + /** the value (binding to the workflow instance) */ + private String value; +} diff --git a/source/java/org/alfresco/web/ui/repo/tag/evaluator/ActionInstanceEvaluatorTag.java b/source/java/org/alfresco/web/ui/repo/tag/evaluator/ActionInstanceEvaluatorTag.java index ce8c3eb1b8..1386b33880 100644 --- a/source/java/org/alfresco/web/ui/repo/tag/evaluator/ActionInstanceEvaluatorTag.java +++ b/source/java/org/alfresco/web/ui/repo/tag/evaluator/ActionInstanceEvaluatorTag.java @@ -1,51 +1,51 @@ -package org.alfresco.web.ui.repo.tag.evaluator; - -import javax.faces.component.UIComponent; - -import org.alfresco.web.ui.common.tag.evaluator.GenericEvaluatorTag; - -/** - * @author Kevin Roast - */ -public class ActionInstanceEvaluatorTag extends GenericEvaluatorTag -{ - /** - * @see javax.faces.webapp.UIComponentTag#getComponentType() - */ - public String getComponentType() - { - return "org.alfresco.faces.ActionInstanceEvaluator"; - } - - /** - * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) - */ - protected void setProperties(UIComponent component) - { - super.setProperties(component); - setStringProperty(component, "evaluatorClassName", this.evaluatorClassName); - } - - /** - * @see javax.servlet.jsp.tagext.Tag#release() - */ - public void release() - { - super.release(); - this.evaluatorClassName = null; - } - - /** - * Set the evaluatorClassName - * - * @param evaluatorClassName the evaluatorClassName - */ - public void setEvaluatorClassName(String evaluatorClassName) - { - this.evaluatorClassName = evaluatorClassName; - } - - - /** the evaluatorClassName */ - private String evaluatorClassName; -} +package org.alfresco.web.ui.repo.tag.evaluator; + +import javax.faces.component.UIComponent; + +import org.alfresco.web.ui.common.tag.evaluator.GenericEvaluatorTag; + +/** + * @author Kevin Roast + */ +public class ActionInstanceEvaluatorTag extends GenericEvaluatorTag +{ + /** + * @see javax.faces.webapp.UIComponentTag#getComponentType() + */ + public String getComponentType() + { + return "org.alfresco.faces.ActionInstanceEvaluator"; + } + + /** + * @see javax.faces.webapp.UIComponentTag#setProperties(javax.faces.component.UIComponent) + */ + protected void setProperties(UIComponent component) + { + super.setProperties(component); + setStringProperty(component, "evaluatorClassName", this.evaluatorClassName); + } + + /** + * @see javax.servlet.jsp.tagext.Tag#release() + */ + public void release() + { + super.release(); + this.evaluatorClassName = null; + } + + /** + * Set the evaluatorClassName + * + * @param evaluatorClassName the evaluatorClassName + */ + public void setEvaluatorClassName(String evaluatorClassName) + { + this.evaluatorClassName = evaluatorClassName; + } + + + /** the evaluatorClassName */ + private String evaluatorClassName; +}