mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-16 17:55:15 +00:00
32054c773c
and what the baseline & latest versions were, as well as the number of files and links checked in staging. Made LinkValidationAction use the new apis, and annotated the source code so that it's obvious what should be done to use the base & latest snapshot version info (see "Gav TODO" within LinkValidationAction.java). git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@6219 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
290 lines
12 KiB
Java
290 lines
12 KiB
Java
/*
|
|
* 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.linkvalidation;
|
|
|
|
import java.util.List;
|
|
|
|
import org.alfresco.config.JNDIConstants;
|
|
import org.alfresco.repo.action.ParameterDefinitionImpl;
|
|
import org.alfresco.repo.action.executer.ActionExecuterAbstractBase;
|
|
import org.alfresco.repo.avm.AVMNodeConverter;
|
|
import org.alfresco.repo.domain.PropertyValue;
|
|
import org.alfresco.sandbox.SandboxConstants;
|
|
import org.alfresco.service.cmr.action.Action;
|
|
import org.alfresco.service.cmr.action.ParameterDefinition;
|
|
import org.alfresco.service.cmr.avm.AVMService;
|
|
import org.alfresco.service.cmr.avmsync.AVMSyncException;
|
|
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.util.Pair;
|
|
import org.apache.commons.logging.Log;
|
|
import org.apache.commons.logging.LogFactory;
|
|
|
|
/**
|
|
* Performs a link validation check.
|
|
*
|
|
* @author gavinc
|
|
*/
|
|
public class LinkValidationAction extends ActionExecuterAbstractBase
|
|
{
|
|
public static final String NAME = "avm-link-validation";
|
|
|
|
public static final String PARAM_COMPARE_TO_STAGING = "compare-to-staging";
|
|
public static final String PARAM_MONITOR = "monitor";
|
|
|
|
private LinkValidationService linkValidationService;
|
|
private AVMService avmService;
|
|
|
|
private static Log logger = LogFactory.getLog(LinkValidationAction.class);
|
|
|
|
/**
|
|
* Sets the LinkValidationService instance to use
|
|
*
|
|
* @param service The LinkValidationService instance
|
|
*/
|
|
public void setLinkValidationService(LinkValidationService service)
|
|
{
|
|
this.linkValidationService = service;
|
|
}
|
|
|
|
/**
|
|
* Sets the AVMService instance to use
|
|
*
|
|
* @param service The AVMService instance
|
|
*/
|
|
public void setAvmService(AVMService service)
|
|
{
|
|
this.avmService = service;
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
protected void addParameterDefinitions(List<ParameterDefinition> paramList)
|
|
{
|
|
paramList.add(new ParameterDefinitionImpl(PARAM_COMPARE_TO_STAGING, DataTypeDefinition.BOOLEAN,
|
|
false, getParamDisplayLabel(PARAM_COMPARE_TO_STAGING)));
|
|
paramList.add(new ParameterDefinitionImpl(PARAM_MONITOR, DataTypeDefinition.ANY, false,
|
|
getParamDisplayLabel(PARAM_MONITOR)));
|
|
}
|
|
|
|
@Override
|
|
protected void executeImpl(Action action, NodeRef actionedUponNodeRef)
|
|
{
|
|
// get the webapp path to check the links for (is represented by the actioned upon node)
|
|
Pair<Integer, String> avmVersionPath = AVMNodeConverter.ToAVMVersionPath(actionedUponNodeRef);
|
|
String webappPath = avmVersionPath.getSecond();
|
|
|
|
// get store name and path parts.
|
|
String [] webappParts = webappPath.split(":");
|
|
if (webappParts.length != 2)
|
|
{
|
|
throw new AVMSyncException("Malformed source path: " + webappPath);
|
|
}
|
|
|
|
// extract the store name
|
|
String storeName = actionedUponNodeRef.getStoreRef().getIdentifier();
|
|
|
|
// extract the webapp name
|
|
String webappName = webappPath.substring(webappPath.lastIndexOf("/")+1);
|
|
|
|
// get the compare to staging flag
|
|
String destWebappPath = null;
|
|
Boolean compareToStaging = (Boolean)action.getParameterValue(PARAM_COMPARE_TO_STAGING);
|
|
if (compareToStaging != null)
|
|
{
|
|
if (compareToStaging.booleanValue())
|
|
{
|
|
// get the corresponding path in the staging area for the given source
|
|
PropertyValue val = this.avmService.getStoreProperty(storeName, SandboxConstants.PROP_WEBSITE_NAME);
|
|
if (val != null)
|
|
{
|
|
String stagingStoreName = val.getStringValue();
|
|
destWebappPath = stagingStoreName + ":/" + JNDIConstants.DIR_DEFAULT_WWW + "/" +
|
|
JNDIConstants.DIR_DEFAULT_APPBASE + "/" + webappName;
|
|
}
|
|
}
|
|
}
|
|
|
|
// get the monitor object
|
|
HrefValidationProgress monitor = (HrefValidationProgress)action.getParameterValue(PARAM_MONITOR);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
if (destWebappPath == null)
|
|
{
|
|
logger.debug("Performing link validation check for webapp '" + webappPath + "'");
|
|
}
|
|
else
|
|
{
|
|
logger.debug("Performing link validation check for webapp '" + webappPath + "', comparing against '" +
|
|
destWebappPath + "'");
|
|
}
|
|
}
|
|
|
|
LinkValidationReport report = null;
|
|
try
|
|
{
|
|
// determine which API to call depending on whether there is a destination webapp present
|
|
if (destWebappPath != null)
|
|
{
|
|
// get the object to represent the broken files
|
|
HrefDifference hdiff =
|
|
this.linkValidationService.getHrefDifference(
|
|
webappPath, destWebappPath, monitor);
|
|
|
|
// get the broken files created due to deletions and new/modified files
|
|
|
|
// Gav TODO:
|
|
// Instead of calling
|
|
// getHrefManifestBrokenByDelete(hdiff)
|
|
// and getHrefManifestBrokenByNewOrMod(hdiff)
|
|
//
|
|
// You can now call:
|
|
// HrefManifest manifest =
|
|
// this.linkValidationService.getBrokenHrefManifest(hdiff);
|
|
//
|
|
// This will give you a pre-merged manifest of all the broken items
|
|
//
|
|
// This means you can also clean up the broken link report calling
|
|
// signature, and remove your merge logic from the implementation.
|
|
//
|
|
//
|
|
// HrefManifest brokenByDelete = this.linkValidationService.getHrefManifestBrokenByDelete(hdiff);
|
|
// HrefManifest brokenByNewOrMod = this.linkValidationService.getHrefManifestBrokenByNewOrMod(hdiff);
|
|
//
|
|
//
|
|
HrefManifest manifest = this.linkValidationService.getBrokenHrefManifest( hdiff );
|
|
|
|
int baseVersion = manifest.getBaseSnapshotVersion(); // Gav TODO: make use of this
|
|
int latestVersion = manifest.getLatestSnapshotVersion(); // Gav TODO: make use of this
|
|
int fileCount = manifest.getBaseFileCount(); // Gav TODO: make use of this
|
|
int linkCount = manifest.getBaseLinkCount(); // Gav TODO: make use of this
|
|
|
|
HrefManifest bogus = new HrefManifest(); // Gav TODO: make this go away
|
|
|
|
|
|
// create the report object using the 2 sets of results
|
|
report = new LinkValidationReport(
|
|
storeName,
|
|
webappName,
|
|
monitor,
|
|
|
|
// Gav TODO:
|
|
// Here's where you can enhance the report:
|
|
//
|
|
// Pass the following extra parameters
|
|
// to the report generator so it can
|
|
// put up some sort of indication when
|
|
// we're "behind" (and by how much):
|
|
//
|
|
// baseVersion,
|
|
// latestVersion,
|
|
|
|
|
|
// Gav TODO: You can replace brokenByDelete
|
|
// and brokenByNewOrMod with the
|
|
// new pre-merged manifest.
|
|
//
|
|
// brokenByDelete,
|
|
// brokenByNewOrMod
|
|
|
|
manifest,
|
|
bogus); // Gav TODO:
|
|
// Remove this last 'bogus' arg when you re-work the report
|
|
// It's just here to satisfy your merge logic
|
|
// (which should also probably go away)
|
|
}
|
|
else
|
|
{
|
|
// Not updating href info explicitly anymore,
|
|
// so tell the system that's already done.
|
|
// Note that the monitor won't have valid update counts
|
|
|
|
monitor.setDone( true );
|
|
|
|
// retrieve the manifest of all the broken links and files for the webapp
|
|
//
|
|
// Note that latestVersion >= baseVersion
|
|
// Whenever latestVersion > baseVersion,
|
|
// link validation is "behind".
|
|
|
|
HrefManifest manifest =
|
|
this.linkValidationService.getBrokenHrefManifest(webappPath);
|
|
|
|
List<HrefManifestEntry> manifests =
|
|
manifest.getManifestEntries();
|
|
int baseVersion = manifest.getBaseSnapshotVersion(); // Gav TODO: make use of this
|
|
int latestVersion = manifest.getLatestSnapshotVersion(); // Gav TODO: make use of this
|
|
|
|
int fileCount = manifest.getBaseFileCount(); // Gav TODO: make use of this
|
|
int linkCount = manifest.getBaseLinkCount(); // Gav TODO: make use of this
|
|
|
|
|
|
// Create the report object using the link check results
|
|
|
|
report = new LinkValidationReport(
|
|
storeName,
|
|
webappName,
|
|
monitor,
|
|
|
|
//
|
|
// Gav TODO:
|
|
// Here's where you can enhance the report:
|
|
//
|
|
// Pass the following extra parameters
|
|
// to the report generator so it can
|
|
// put up some sort of indication when
|
|
// we're "behind" (and by how much):
|
|
//
|
|
// baseVersion,
|
|
// latestVersion,
|
|
|
|
manifests
|
|
);
|
|
}
|
|
}
|
|
catch (Throwable err)
|
|
{
|
|
if (report != null)
|
|
{
|
|
report.setError(err);
|
|
}
|
|
else
|
|
{
|
|
report = new LinkValidationReport(storeName, webappName, err);
|
|
}
|
|
|
|
logger.error("Link Validation Error: ", err);
|
|
}
|
|
|
|
// store the report as a store property on the store we ran the link check on
|
|
this.avmService.deleteStoreProperty(storeName, SandboxConstants.PROP_LINK_VALIDATION_REPORT);
|
|
this.avmService.setStoreProperty(storeName, SandboxConstants.PROP_LINK_VALIDATION_REPORT,
|
|
new PropertyValue(DataTypeDefinition.ANY, report));
|
|
}
|
|
}
|