Merged V2.2 to HEAD

7462: Renamed ManageLinkValidationTaskDialog to ManageReviewTaskDialog as it is now more generic
         Enabled deployment and link validation in parallel review tasks
         Created separate JSP page for manage change request task dialog
         When a server is edited it is now scrolled to
         Some minor UI tidyup
   7467: Added ability to define excludes for a deployment via a regular expression
   7475: Incorporated new icons from Linton
   7492: Allows multiple callbacks for deployment. Adds new FAILED deployment event.
   7493: Added ability to view previous deployment attempts


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@8380 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
2008-02-26 14:19:37 +00:00
parent 27f525c54e
commit ff15cf4079
6 changed files with 299 additions and 167 deletions

View File

@@ -15,11 +15,11 @@
* 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:
* 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
*/
@@ -29,6 +29,7 @@ import java.io.PrintWriter;
import java.io.Serializable;
import java.io.StringWriter;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
@@ -54,12 +55,13 @@ import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.Pair;
import org.alfresco.util.RegexNameMatcher;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Deploys a website to a remote server.
*
*
* @author gavinc
*/
public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
@@ -84,26 +86,26 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
private static Log logger = LogFactory.getLog(AVMDeployWebsiteAction.class);
private static Log delayDeploymentLogger = LogFactory.getLog("alfresco.deployment.delay");
/**
* Calculate the URI representation of a server from the given set of properties
*
* @param props Set of properties to calculate URI from
*
* @param props Set of properties to calculate URI from
*/
public static String calculateServerUri(Map<QName, Serializable> props)
{
StringBuilder uri = new StringBuilder();
// prefix the uri if necessary
String type = (String)props.get(WCMAppModel.PROP_DEPLOYTYPE);
if (WCMAppModel.CONSTRAINT_FILEDEPLOY.equals(type))
{
uri.append(FILE_SERVER_PREFIX);
}
// append server name
uri.append((String)props.get(WCMAppModel.PROP_DEPLOYSERVERHOST));
// append port (if present)
Integer port = (Integer)props.get(WCMAppModel.PROP_DEPLOYSERVERPORT);
if (port != null)
@@ -111,23 +113,23 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
uri.append(":");
uri.append(port.toString());
}
return uri.toString();
}
/**
* Sets the delay to use before starting the deployment
*
*
* @param delay The delay in seconds
*/
public void setDelay(int delay)
{
this.delay = delay;
}
/**
* Sets the default RMI port for Alfresco server deployments
*
*
* @param defaultAlfrescoRmiPort port number
*/
public void setDefaultAlfrescoRmiPort(int defaultAlfrescoRmiPort)
@@ -137,7 +139,7 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
/**
* Sets the default RMI port for File system deployments
*
*
* @param defaultReceiverRmiPort port number
*/
public void setDefaultReceiverRmiPort(int defaultReceiverRmiPort)
@@ -147,7 +149,7 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
/**
* Sets the default remote username to use for deployments
*
*
* @param defaultRemoteUsername Default remote username
*/
public void setDefaultRemoteUsername(String defaultRemoteUsername)
@@ -157,7 +159,7 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
/**
* Sets the default remote password to use for deployments
*
*
* @param defaultRemotePassword Default remote password
*/
public void setDefaultRemotePassword(String defaultRemotePassword)
@@ -167,7 +169,7 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
/**
* Sets the default target name to use on file system receivers
*
*
* @param defaultTargetName Default target name
*/
public void setDefaultTargetName(String defaultTargetName)
@@ -182,7 +184,7 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
{
this.nodeService = service;
}
/**
* @param contentService The ContentService instance
*/
@@ -211,7 +213,7 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
paramList.add(new ParameterDefinitionImpl(PARAM_CALLBACK, DataTypeDefinition.ANY, false,
getParamDisplayLabel(PARAM_CALLBACK)));
}
@Override
protected void executeImpl(Action action, NodeRef actionedUponNodeRef)
{
@@ -219,43 +221,43 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
Pair<Integer, String> avmVersionPath = AVMNodeConverter.ToAVMVersionPath(actionedUponNodeRef);
int version = avmVersionPath.getFirst();
String path = avmVersionPath.getSecond();
// get store name and path parts.
String [] storePath = path.split(":");
if (storePath.length != 2)
{
throw new AVMSyncException("Malformed source path: " + path);
}
// get the NodeRef representing the website being deployed
NodeRef websiteRef = (NodeRef)action.getParameterValue(PARAM_WEBPROJECT);
if (this.nodeService.exists(websiteRef) == false)
{
throw new IllegalStateException("The website NodeRef (" + websiteRef +
throw new IllegalStateException("The website NodeRef (" + websiteRef +
") provided does not exist!");
}
// get the NodeRef representing the server to deploy to
NodeRef serverRef = (NodeRef)action.getParameterValue(PARAM_SERVER);
if (this.nodeService.exists(serverRef) == false)
{
throw new IllegalStateException("The server NodeRef (" + serverRef +
throw new IllegalStateException("The server NodeRef (" + serverRef +
") provided does not exist!");
}
// get the NodeRef representing the deployment attempt this one is part of
NodeRef attemptRef = (NodeRef)action.getParameterValue(PARAM_ATTEMPT);
// TODO: if attempt reference is null create one now for this deployment, for now throw error
if (this.nodeService.exists(attemptRef) == false)
{
throw new IllegalStateException("The attempt NodeRef (" + serverRef +
throw new IllegalStateException("The attempt NodeRef (" + serverRef +
") provided does not exist!");
}
// get the callback object
DeploymentCallback callback = (DeploymentCallback)action.getParameterValue(PARAM_CALLBACK);
// get the other data from the deploymentserver object
Map<QName, Serializable> serverProps = nodeService.getProperties(serverRef);
String serverUri = calculateServerUri(serverProps);
@@ -266,14 +268,15 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
boolean fileServerDeployment = WCMAppModel.CONSTRAINT_FILEDEPLOY.equals(
serverProps.get(WCMAppModel.PROP_DEPLOYTYPE));
String sourcePath = (String)serverProps.get(WCMAppModel.PROP_DEPLOYSOURCEPATH);
String excludes = (String)serverProps.get(WCMAppModel.PROP_DEPLOYEXCLUDES);
String targetName = (String)serverProps.get(WCMAppModel.PROP_DEPLOYSERVERTARGET);
String targetPath = path;
if (fileServerDeployment == false)
{
// if "localhost" is passed as the target server add "live" to the end of the
// if "localhost" is passed as the target server add "live" to the end of the
// store name, this store will then get created automatically.
// TODO: Check that the actual host name of the machine hasn't been passed
if (port == null && (host.equalsIgnoreCase("localhost") || host.equalsIgnoreCase("127.0.0.1")))
@@ -281,7 +284,7 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
targetPath = storePath[0] + "live:" + storePath[1];
}
}
// get defaults for data not provided in server node
if (port == null)
{
@@ -294,22 +297,22 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
port = this.defaultAlfRmiPort;
}
}
if (remoteUsername == null || remoteUsername.length() == 0)
{
remoteUsername = this.defaultRemoteUsername;
}
if (remotePassword == null || remotePassword.length() == 0)
{
remotePassword = this.defaultRemotePassword;
}
if (targetName == null || targetName.length() == 0)
{
targetName = this.defaultTargetName;
}
// determine the actual source path
if (sourcePath != null && sourcePath.length() > 0)
{
@@ -318,26 +321,35 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
{
sourcePath = "/" + sourcePath;
}
// append to the root path
path = path + sourcePath;
}
// determine if a NameMatcher is required (if an exclude is present)
RegexNameMatcher regexMatcher = null;
if (excludes != null && excludes.length() > 0)
{
regexMatcher = new RegexNameMatcher();
List<String> patterns = new ArrayList<String>(1);
patterns.add(excludes);
regexMatcher.setPatterns(patterns);
}
// take a note of the current date/time
Date startDate = new Date();
if (logger.isDebugEnabled())
logger.debug("Starting deployment of " + actionedUponNodeRef.toString() +
logger.debug("Starting deployment of " + actionedUponNodeRef.toString() +
" to " + serverUri + " at " + startDate);
if (delayDeploymentLogger.isDebugEnabled() && delay > 0)
{
delayDeploymentLogger.debug("Delaying deployment by " + delay + "s...");
// add a delay for testing purposes if the delay logger level is debug
// add a delay for testing purposes if the delay logger level is debug
try { Thread.sleep(1000*delay); } catch (Throwable e) {}
}
// make the deploy call passing in the DeploymentCallback, if present
Throwable deployError = null;
DeploymentReport report = null;
@@ -347,31 +359,41 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
if (fileServerDeployment)
{
if (logger.isDebugEnabled())
logger.debug("Performing file server deployment to " + host + ":" + port +
logger.debug("Performing file server deployment to " + host + ":" + port +
" using deploymentserver: " + serverProps);
// TODO: Added new NameMatcher parameter to deploy methods. It acts as a filter.
// Any matching path names are ignored for deployment purposes.
report = this.deployService.deployDifferenceFS(version, path, host, port,
remoteUsername, remotePassword, targetName, null, true, false, false, callback);
List<DeploymentCallback> callbacks = new ArrayList<DeploymentCallback>();
if (callback != null)
{
callbacks.add(callback);
}
report = this.deployService.deployDifferenceFS(version, path, host, port,
remoteUsername, remotePassword, targetName, regexMatcher, true, false, false, callbacks);
}
else
{
if (logger.isDebugEnabled())
logger.debug("Performing Alfresco deployment to " + host + ":" + port +
logger.debug("Performing Alfresco deployment to " + host + ":" + port +
" using deploymentserver: " + serverProps);
// TODO: Added new NameMatcher parameter to deploy methods. It acts as a filter.
// Any matching path names are ignored for deployment purposes.
report = this.deployService.deployDifference(version, path, host, port,
remoteUsername, remotePassword, targetPath, null, true, false, false, callback);
List<DeploymentCallback> callbacks = new ArrayList<DeploymentCallback>();
if (callback != null)
{
callbacks.add(callback);
}
report = this.deployService.deployDifference(version, path, host, port,
remoteUsername, remotePassword, targetPath, regexMatcher, true, false, false, callbacks);
}
}
catch (Throwable err)
{
deployError = err;
logger.error(deployError);
// report the error to the callback object
// TODO: See if this can be incorporated into the DeploymentCallback I/F
if (callback != null)
@@ -402,62 +424,64 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
if (logger.isDebugEnabled())
logger.debug("Failed to apply differences to " + serverUri);
}
// create the deployment report node
createDeploymentReportNode(report, attemptRef, serverProps, version,
createDeploymentReportNode(report, attemptRef, serverProps, version,
websiteRef, startDate, deployError);
}
/**
* Creates a deployment report node as a child of the given website.
*
* @param report The DeploymentReport result from the deploy,
*
* @param report The DeploymentReport result from the deploy,
* will be null if the deploy failed
* @param attempt NodeRef of the attempt the deploy was part of
* @param serverProps The properties of the server the deploy was going to
* @param version The version of the site bebing deployed (the snapshot)
* @param websiteRef The NodeRef of the folder representing the website
* @param startDate The date/time the deployment started
* @param error The error that caused the deployment to fail, null if the
* @param error The error that caused the deployment to fail, null if the
* deployment was successful
* @return The created deployment report NodeRef
*/
private NodeRef createDeploymentReportNode(DeploymentReport report, NodeRef attempt,
Map<QName, Serializable> serverProps, int version, NodeRef websiteRef,
Map<QName, Serializable> serverProps, int version, NodeRef websiteRef,
Date startDate, Throwable error)
{
NodeRef reportRef = null;
String serverUri = calculateServerUri(serverProps);
Map<QName, Serializable> reportProps = new HashMap<QName, Serializable>(4, 1.0f);
reportProps.put(WCMAppModel.PROP_DEPLOYSERVER, serverUri);
reportProps.put(WCMAppModel.PROP_DEPLOYVERSION, version);
reportProps.put(WCMAppModel.PROP_DEPLOYSTARTTIME, startDate);
reportProps.put(WCMAppModel.PROP_DEPLOYENDTIME, new Date());
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERNAMEUSED,
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERNAMEUSED,
serverProps.get(WCMAppModel.PROP_DEPLOYSERVERNAME));
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERUSERNAMEUSED,
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERUSERNAMEUSED,
serverProps.get(WCMAppModel.PROP_DEPLOYSERVERUSERNAME));
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERTARGETUSED,
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERTARGETUSED,
serverProps.get(WCMAppModel.PROP_DEPLOYSERVERTARGET));
reportProps.put(WCMAppModel.PROP_DEPLOYSOURCEPATHUSED,
reportProps.put(WCMAppModel.PROP_DEPLOYSOURCEPATHUSED,
serverProps.get(WCMAppModel.PROP_DEPLOYSOURCEPATH));
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERURLUSED,
reportProps.put(WCMAppModel.PROP_DEPLOYEXCLUDESUSED,
serverProps.get(WCMAppModel.PROP_DEPLOYEXCLUDES));
reportProps.put(WCMAppModel.PROP_DEPLOYSERVERURLUSED,
serverProps.get(WCMAppModel.PROP_DEPLOYSERVERURL));
reportProps.put(WCMAppModel.PROP_DEPLOYSUCCESSFUL, (report != null));
if (report == null && error != null)
{
// add error message as fail reason if appropriate
reportProps.put(WCMAppModel.PROP_DEPLOYFAILEDREASON, error.getMessage());
}
reportRef = this.nodeService.createNode(attempt,
WCMAppModel.ASSOC_DEPLOYMENTREPORTS, WCMAppModel.ASSOC_DEPLOYMENTREPORTS,
reportRef = this.nodeService.createNode(attempt,
WCMAppModel.ASSOC_DEPLOYMENTREPORTS, WCMAppModel.ASSOC_DEPLOYMENTREPORTS,
WCMAppModel.TYPE_DEPLOYMENTREPORT, reportProps).getChildRef();
ContentWriter writer = contentService.getWriter(reportRef, ContentModel.PROP_CONTENT, true);
writer.setMimetype(MimetypeMap.MIMETYPE_TEXT_PLAIN);
writer.setEncoding("UTF-8");
if (report == null)
{
if (error == null)
@@ -484,14 +508,14 @@ public class AVMDeployWebsiteAction extends ActionExecuterAbstractBase
builder.append(event.getDestination());
builder.append("\r\n");
}
writer.putContent(builder.toString());
}
if (logger.isDebugEnabled())
logger.debug("Created deplyoment report node (" + reportRef + ") for server " +
logger.debug("Created deplyoment report node (" + reportRef + ") for server " +
serverUri);
return reportRef;
}
}