- Partial first cut of initial version of links management UI

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5917 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2007-06-11 20:54:23 +00:00
parent a6440c5ac2
commit 4c6a93a5a9
6 changed files with 323 additions and 1 deletions
--- a/source/java/org/alfresco/linkvalidation/LinkValidationAction.java
+++ b/source/java/org/alfresco/linkvalidation/LinkValidationAction.java
@@ -0,0 +1,143 @@
+/*
+ * 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.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_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_MONITOR, DataTypeDefinition.ANY, false, 
+                 getParamDisplayLabel(PARAM_MONITOR)));
+    }
+   
+    @Override
+    protected void executeImpl(Action action, NodeRef actionedUponNodeRef)
+    {
+        // get the store to check the links for (is represented by the actioned upon node)
+        Pair<Integer, String> avmVersionPath = AVMNodeConverter.ToAVMVersionPath(actionedUponNodeRef);
+        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);
+        }
+        
+        // extract the store name
+        String store = storePath[0];
+       
+        // get the monitor object
+        HrefValidationProgress monitor = (HrefValidationProgress)action.getParameterValue(PARAM_MONITOR);
+        
+        if (logger.isDebugEnabled())
+            logger.debug("Performing link validation check for store '" + store + "'");
+        
+        LinkValidationReport report = null;
+        try
+        {
+            // firstly call updateHrefInfo to scan the whole store for broken links
+            // NOTE: currently this is NOT done incrementally
+            this.linkValidationService.updateHrefInfo(store, false, 10000, 30000, 5, monitor);
+            
+            // retrieve the manifest of all the broken links and files
+            List<HrefManifest> manifests = this.linkValidationService.getBrokenHrefManifests(store);
+            
+            // create the report object using the link check results
+            report = new LinkValidationReport(monitor, manifests);
+        }
+        catch (Throwable err)
+        {
+            if (report != null)
+            {
+                report.setError(err);
+            }
+            else
+            {
+               report = new LinkValidationReport(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(store, SandboxConstants.PROP_LINK_VALIDATION_REPORT);
+        this.avmService.setStoreProperty(store, SandboxConstants.PROP_LINK_VALIDATION_REPORT, 
+                 new PropertyValue(DataTypeDefinition.ANY, report));
+   }
+}