Added links management to the submit process

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5989 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Gavin Cornwell 2007-06-15 19:33:02 +00:00
parent 236033e28e
commit 0d95c702cb
5 changed files with 397 additions and 223 deletions

View File

@ -6,6 +6,10 @@
wcmwf_submit.workflow.title=Web Site Submission
wcmwf_submit.workflow.description=Submit changes for approval
wcmwf_submit.node.verifybrokenlinks.transition.abort.title=Abort Submisson
wcmwf_submit.node.verifybrokenlinks.transition.abort.description=Abort Submisson
wcmwf_submit.node.verifybrokenlinks.transition.continue.title=Continue Submission
wcmwf_submit.node.verifybrokenlinks.transition.continue.description=Continue Submisson
wcmwf_submit.node.serialreview.transition.reject.title=Reject
wcmwf_submit.node.serialreview.transition.reject.description=Reject
wcmwf_submit.node.serialreview.transition.approve.title=Approve
@ -28,6 +32,8 @@ wcmwf_submit.node.submitpending.transition.launch.description=Submit Now
wcmwf_workflowmodel.type.wcmwf_submitReviewTask.title=Web Site Submission
wcmwf_workflowmodel.type.wcmwf_submitReviewTask.description=Submit changes for approval
wcmwf_workflowmodel.type.wcmwf_verifyBrokenLinksTask.title=Verify Broken Links
wcmwf_workflowmodel.type.wcmwf_verifyBrokenLinksTask.description=Verify links that do not point to a live resource
wcmwf_workflowmodel.type.wcmwf_reviewTask.title=Review
wcmwf_workflowmodel.type.wcmwf_reviewTask.description=Review Documents to approve or reject them
wcmwf_workflowmodel.type.wcmwf_rejectedTask.title=Rejected
@ -49,6 +55,10 @@ wcmwf_workflowmodel.property.wcmwf_fromPath.title=Source Folder Path
wcmwf_workflowmodel.property.wcmwf_fromPath.description=Folder Path where items have been submitted from
wcmwf_workflowmodel.property.wcmwf_label.title=Submission Label
wcmwf_workflowmodel.property.wcmwf_label.description=Label associated with the submission
wcmwf_workflowmodel.property.wcmwf_launchDate.title=Launch Date
wcmwf_workflowmodel.property.wcmwf_launchDate.description=Date the content in the submission should be committed
wcmwf_workflowmodel.property.wcmwf_validateLinks.title=Validate Links
wcmwf_workflowmodel.property.wcmwf_validateLinks.description=Whether links should be verified before entering the review cycle
wcmwf_workflowmodel.property.wcmwf_reviewerCnt.title=Total Reviewed
wcmwf_workflowmodel.property.wcmwf_reviewerCnt.description=Count of people who reviewed
wcmwf_workflowmodel.property.wcmwf_approveCnt.title=Total Approved

View File

@ -1,70 +1,70 @@
<?xml version="1.0" encoding="UTF-8"?>
<model name="wcmwf:workflowmodel" xmlns="http://www.alfresco.org/model/dictionary/1.0">
<imports>
<import uri="http://www.alfresco.org/model/dictionary/1.0" prefix="d"/>
<?xml version="1.0" encoding="UTF-8"?>
<model name="wcmwf:workflowmodel" xmlns="http://www.alfresco.org/model/dictionary/1.0">
<imports>
<import uri="http://www.alfresco.org/model/dictionary/1.0" prefix="d"/>
<import uri="http://www.alfresco.org/model/bpm/1.0" prefix="bpm"/>
<import uri="http://www.alfresco.org/model/wcmappmodel/1.0" prefix="wca"/>
</imports>
<namespaces>
<namespace uri="http://www.alfresco.org/model/wcmworkflow/1.0" prefix="wcmwf"/>
</namespaces>
<constraints>
<constraint name="wcmwf:reviewType" type="LIST">
<parameter name="allowedValues">
<!-- TODO: Determine if priority values can be mapped to human-readable strings -->
<list>
<value>Serial</value>
<value>Parallel</value>
</list>
</parameter>
</constraint>
</constraints>
<types>
<!-- -->
<!-- Base WCM "start" task & workflow task definitions -->
<!-- -->
<!-- Note: Useful for dispatching WCM specific -->
<!-- behaviour -->
<!-- -->
<type name="wcmwf:startTask">
<parent>bpm:startTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>edit_and_remove_wcm_package_item_actions</default>
</property>
</overrides>
</type>
<type name="wcmwf:workflowTask">
<parent>bpm:workflowTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>read_wcm_package_item_actions</default>
</property>
</overrides>
</type>
<type name="wcmwf:submitReviewTask">
<parent>wcmwf:startTask</parent>
<properties>
<property name="wcmwf:submitReviewType">
<title>Serial or Parallel Review</title>
<type>d:text</type>
<mandatory>true</mandatory>
<default>Serial</default>
<constraints>
<constraint ref="wcmwf:reviewType" />
</constraints>
</property>
<import uri="http://www.alfresco.org/model/wcmappmodel/1.0" prefix="wca"/>
</imports>
<namespaces>
<namespace uri="http://www.alfresco.org/model/wcmworkflow/1.0" prefix="wcmwf"/>
</namespaces>
<constraints>
<constraint name="wcmwf:reviewType" type="LIST">
<parameter name="allowedValues">
<!-- TODO: Determine if priority values can be mapped to human-readable strings -->
<list>
<value>Serial</value>
<value>Parallel</value>
</list>
</parameter>
</constraint>
</constraints>
<types>
<!-- -->
<!-- Base WCM "start" task & workflow task definitions -->
<!-- -->
<!-- Note: Useful for dispatching WCM specific -->
<!-- behaviour -->
<!-- -->
<type name="wcmwf:startTask">
<parent>bpm:startTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>edit_and_remove_wcm_package_item_actions</default>
</property>
</overrides>
</type>
<type name="wcmwf:workflowTask">
<parent>bpm:workflowTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>read_wcm_package_item_actions</default>
</property>
</overrides>
</type>
<type name="wcmwf:submitReviewTask">
<parent>wcmwf:startTask</parent>
<properties>
<property name="wcmwf:submitReviewType">
<title>Serial or Parallel Review</title>
<type>d:text</type>
<mandatory>true</mandatory>
<default>Serial</default>
<constraints>
<constraint ref="wcmwf:reviewType" />
</constraints>
</property>
</properties>
<associations>
<association name="wcmwf:webproject">
@ -78,93 +78,101 @@
<many>false</many>
</target>
</association>
</associations>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:reviewTask">
<parent>wcmwf:workflowTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>edit_wcm_package_item_actions</default>
</property>
</overrides>
<mandatory-aspects>
<!-- One or more reviewers - this is here to allow view of all reviewers -->
<!-- in the review task -->
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:submission</aspect>
<aspect>wcmwf:reviewType</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:rejectedTask">
<parent>wcmwf:workflowTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>edit_and_remove_wcm_package_item_actions</default>
</property>
</overrides>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submitpendingTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submitcancelledTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submittedTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<!-- NOTE: kept for backwards compatibility only - for v2.0 wcm submit process definition -->
<type name="wcmwf:approvedTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submitWebContentTask">
<parent>wcmwf:startTask</parent>
<properties>
<property name="wcmwf:from">
<type>d:text</type>
</property>
</properties>
<mandatory-aspects>
<aspect>bpm:assignee</aspect>
</mandatory-aspects>
</associations>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:verifyBrokenLinksTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:reviewTask">
<parent>wcmwf:workflowTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>edit_wcm_package_item_actions</default>
</property>
</overrides>
<mandatory-aspects>
<!-- One or more reviewers - this is here to allow view of all reviewers -->
<!-- in the review task -->
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:submission</aspect>
<aspect>wcmwf:reviewType</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:rejectedTask">
<parent>wcmwf:workflowTask</parent>
<overrides>
<property name="bpm:packageItemActionGroup">
<default>edit_and_remove_wcm_package_item_actions</default>
</property>
</overrides>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submitpendingTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submitcancelledTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submittedTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
<aspect>wcmwf:submission</aspect>
</mandatory-aspects>
</type>
<!-- NOTE: kept for backwards compatibility only - for v2.0 wcm submit process definition -->
<type name="wcmwf:approvedTask">
<parent>wcmwf:workflowTask</parent>
<mandatory-aspects>
<aspect>bpm:assignees</aspect>
<aspect>wcmwf:reviewType</aspect>
<aspect>wcmwf:reviewInfo</aspect>
</mandatory-aspects>
</type>
<type name="wcmwf:submitWebContentTask">
<parent>wcmwf:startTask</parent>
<properties>
<property name="wcmwf:from">
<type>d:text</type>
</property>
</properties>
<mandatory-aspects>
<aspect>bpm:assignee</aspect>
</mandatory-aspects>
</type>
<!-- -->
@ -191,76 +199,81 @@
<mandatory-aspects>
<aspect>bpm:assignee</aspect>
</mandatory-aspects>
</type>
</types>
<aspects>
<aspect name="wcmwf:submission">
<properties>
<property name="wcmwf:fromPath">
<title>Source Folder Path</title>
<description>Folder where items have been submitted from</description>
<type>d:text</type>
<mandatory>true</mandatory>
</property>
<property name="wcmwf:label">
<title>Snapshot Label</title>
<type>d:text</type>
<mandatory>true</mandatory>
</type>
</types>
<aspects>
<aspect name="wcmwf:submission">
<properties>
<property name="wcmwf:fromPath">
<title>Source Folder Path</title>
<description>Folder where items have been submitted from</description>
<type>d:text</type>
<mandatory>true</mandatory>
</property>
<property name="wcmwf:label">
<title>Snapshot Label</title>
<type>d:text</type>
<mandatory>true</mandatory>
</property>
<property name="wcmwf:launchDate">
<title>Launch Date</title>
<description>Date the content in the submission should be committed</description>
<type>d:datetime</type>
</property>
</properties>
</aspect>
<aspect name="wcmwf:reviewType">
<properties>
<property name="wcmwf:reviewType">
<title>Review Type</title>
<type>d:text</type>
<mandatory>true</mandatory>
<constraints>
<constraint ref="wcmwf:reviewType" />
</constraints>
</property>
</properties>
</aspect>
<aspect name="wcmwf:reviewInfo">
<properties>
<property name="wcmwf:reviewerCnt">
<title>Reviewer Count</title>
<type>d:int</type>
<mandatory>true</mandatory>
</property>
<property name="wcmwf:approveCnt">
<title>Approver Count</title>
<type>d:int</type>
<mandatory>true</mandatory>
</property>
<property name="wcmwf:reviewCycle">
<title>Reviewer Cycle</title>
<type>d:int</type>
<mandatory>false</mandatory>
</property>
</properties>
</aspect>
<aspect name="wcmwf:submitted">
<properties>
<property name="wcmwf:workflowInstanceId">
<title>Workflow Instance Id</title>
<type>d:text</type>
<mandatory>true</mandatory>
</property>
</properties>
</aspect>
</aspects>
</property>
<property name="wcmwf:validateLinks">
<title>Validate Links</title>
<description>Determines whether links should be verified before entering the review cycle</description>
<type>d:boolean</type>
</property>
</properties>
</aspect>
<aspect name="wcmwf:reviewType">
<properties>
<property name="wcmwf:reviewType">
<title>Review Type</title>
<type>d:text</type>
<mandatory>true</mandatory>
<constraints>
<constraint ref="wcmwf:reviewType" />
</constraints>
</property>
</properties>
</aspect>
<aspect name="wcmwf:reviewInfo">
<properties>
<property name="wcmwf:reviewerCnt">
<title>Reviewer Count</title>
<type>d:int</type>
<mandatory>true</mandatory>
</property>
<property name="wcmwf:approveCnt">
<title>Approver Count</title>
<type>d:int</type>
<mandatory>true</mandatory>
</property>
<property name="wcmwf:reviewCycle">
<title>Reviewer Cycle</title>
<type>d:int</type>
<mandatory>false</mandatory>
</property>
</properties>
</aspect>
<aspect name="wcmwf:submitted">
<properties>
<property name="wcmwf:workflowInstanceId">
<title>Workflow Instance Id</title>
<type>d:text</type>
<mandatory>true</mandatory>
</property>
</properties>
</aspect>
</aspects>
</model>

View File

@ -44,9 +44,9 @@ import java.util.Map;
*/
public class LinkValidationReport implements Serializable
{
private int numberFilesChecked = 0;
private int numberLinksChecked = 0;
private int numberBrokenLinks = 0;
private int numberFilesChecked = -1;
private int numberLinksChecked = -1;
private int numberBrokenLinks = -1;
private boolean successful = true;
private Throwable error;

View File

@ -36,5 +36,6 @@ public interface WCMWorkflowModel
static final QName PROP_FROM_PATH = QName.createQName(NamespaceService.WCMWF_MODEL_1_0_URI, "fromPath");
static final QName PROP_LABEL = QName.createQName(NamespaceService.WCMWF_MODEL_1_0_URI, "label");
static final QName PROP_LAUNCH_DATE = QName.createQName(NamespaceService.WCMWF_MODEL_1_0_URI, "launchDate");
static final QName PROP_VALIDATE_LINKS = QName.createQName(NamespaceService.WCMWF_MODEL_1_0_URI, "validateLinks");
static final QName ASSOC_WEBPROJECT = QName.createQName(NamespaceService.WCMWF_MODEL_1_0_URI, "webproject");
}

View File

@ -0,0 +1,150 @@
/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing" */
package org.alfresco.repo.avm.wf;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.config.JNDIConstants;
import org.alfresco.linkvalidation.HrefValidationProgress;
import org.alfresco.linkvalidation.LinkValidationAction;
import org.alfresco.linkvalidation.LinkValidationReport;
import org.alfresco.linkvalidation.LinkValidationService;
import org.alfresco.repo.avm.AVMNodeConverter;
import org.alfresco.repo.domain.PropertyValue;
import org.alfresco.repo.workflow.jbpm.JBPMNode;
import org.alfresco.repo.workflow.jbpm.JBPMSpringActionHandler;
import org.alfresco.sandbox.SandboxConstants;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ActionService;
import org.alfresco.service.cmr.avm.AVMService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.util.Pair;
import org.apache.log4j.Logger;
import org.jbpm.graph.exe.ExecutionContext;
import org.springframework.beans.factory.BeanFactory;
/**
* Performs a link validaton check for the workflow sandbox being used
* for a submisson process.
*
* @author gavinc
*/
public class AVMSubmitLinkChecker extends JBPMSpringActionHandler
{
private static final long serialVersionUID = 1442635948148675461L;
private static Logger logger = Logger.getLogger(AVMSubmitLinkChecker.class);
/**
* The AVMService.
*/
private AVMService fAVMService;
/**
* The ActionService.
*/
private ActionService fActionService;
/**
* Set any bean references necessary.
* @param factory The BeanFactory from which to get beans.
*/
@Override
protected void initialiseHandler(BeanFactory factory)
{
this.fActionService = (ActionService)factory.getBean("ActionService");
this.fAVMService = (AVMService)factory.getBean("AVMService");
}
/**
* Do the actual link validation check.
*
* @param executionContext The jBPM context.
*/
public void execute(ExecutionContext executionContext) throws Exception
{
// retrieve the workflow sandbox (the workflow package)
NodeRef pkg = ((JBPMNode)executionContext.getContextInstance().getVariable("bpm_package")).getNodeRef();
Pair<Integer, String> pkgPath = AVMNodeConverter.ToAVMVersionPath(pkg);
// remove the trailing www from the path
String path = pkgPath.getSecond();
path = path.substring(0, (path.length()-JNDIConstants.DIR_DEFAULT_WWW.length()));
NodeRef storePath = AVMNodeConverter.ToNodeRef(-1, path);
// get the store name
String storeName = pkg.getStoreRef().getIdentifier();
if (logger.isDebugEnabled())
logger.info("Found workflow store to check links for: " + path);
// create and execute the action in the background
Throwable cause = null;
int brokenLinks = -1;
try
{
HrefValidationProgress monitor = new HrefValidationProgress();
Map<String, Serializable> args = new HashMap<String, Serializable>(1, 1.0f);
args.put(LinkValidationAction.PARAM_MONITOR, monitor);
Action action = this.fActionService.createAction(LinkValidationAction.NAME, args);
this.fActionService.executeAction(action, storePath, false, false);
// retrieve the deployment report from the store property
PropertyValue val = this.fAVMService.getStoreProperty(storeName,
SandboxConstants.PROP_LINK_VALIDATION_REPORT);
if (val != null)
{
LinkValidationReport report = (LinkValidationReport)val.getSerializableValue();
if (report != null && report.wasSuccessful())
{
brokenLinks = report.getNumberBrokenLinks();
}
else
{
cause = report.getError();
}
}
if (logger.isDebugEnabled())
logger.debug("Link validation check found " + brokenLinks + " broken links");
}
catch (Throwable err)
{
cause = err;
}
// set the number of broken links in a variable
if (brokenLinks == -1)
{
// TODO: Decide how to handle errors,
// for now just return -1 and the workflow can decide
}
executionContext.setVariable("wcmwf_brokenLinks", brokenLinks);
}
}