cmsxmldocumentlinkvalidator.java

一个cms内容管理平台

/*
 * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/validation/CmsXmlDocumentLinkValidator.java,v $
 * Date   : $Date: 2006/10/04 07:35:21 $
 * Version: $Revision: 1.10 $
 *
 * This library is part of OpenCms -
 * the Open Source Content Mananagement System
 *
 * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.validation;

import org.opencms.db.CmsDbContext;
import org.opencms.db.CmsDbUtil;
import org.opencms.db.CmsDriverManager;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProject;
import org.opencms.file.CmsResource;
import org.opencms.file.types.I_CmsResourceType;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.report.CmsShellReport;
import org.opencms.report.I_CmsReport;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.commons.logging.Log;

/**
 * Validates HTML links in the (body) content of Cms resources in the OpenCms VFS. HTML links are 
 * considered as href attribs in anchor tags and src attribs in image tags.<p>
 * 
 * Validating links means to answer the question, whether we would have broken links in the 
 * online project if a file or a list of files would get published. External links to targets 
 * outside the OpenCms VFS don't get validated.<p>
 * 
 * Objects using the CmsHtmlLinkValidator are responsible to handle detected broken links.<p>
 * 
 * @author Thomas Weckert
 *   
 * @version $Revision: 1.10 $ 
 * 
 * @since 6.0.0 
 */
public class CmsXmlDocumentLinkValidator {

    /** The log object for this class. */
    private static final Log LOG = CmsLog.getLog(CmsXmlDocumentLinkValidator.class);

    /**
     * The driver manager.<p>
     */
    protected CmsDriverManager m_driverManager;

    /**
     * Default constructor.<p>
     * 
     * @param driverManager The Cms driver manager
     */
    public CmsXmlDocumentLinkValidator(CmsDriverManager driverManager) {

        m_driverManager = driverManager;
    }

    /**
     * Validates HTML links (hrefs and img tags) in the (body) content of the specified list of Cms resources.<p>
     * 
     * The result is printed to a shell report.<p>
     * 
     * @param cms the current user's Cms object the current request context
     * @param offlineResources a list of offline Cms resources
     * @return a Map with Lists of invalid hrefs keyed by resource names
     */
    public Map validateResources(CmsObject cms, List offlineResources) {

        return validateResources(cms, offlineResources, new CmsShellReport(cms.getRequestContext().getLocale()));
    }

    /**
     * Validates HTML links (hrefs and img tags) in the (body) content of the specified list of Cms resources.<p>
     * 
     * The result is printed to the given report.<p>
     * 
     * @param cms the current user's Cms object
     * @param offlineResources a list of offline Cms resources
     * @param report an instance of I_CmsReport to print messages
     * @return a map with lists of invalid links keyed by resource names
     */
    public Map validateResources(CmsObject cms, List offlineResources, I_CmsReport report) {

        CmsResource resource = null;
        List brokenLinks = null;
        Map offlineFilesLookup = null;
        List links = null;
        List validatableResources = null;
        Map invalidResources = new HashMap();
        String resourceName = null;
        int i = CmsDbUtil.UNKNOWN_ID, j = CmsDbUtil.UNKNOWN_ID;
        I_CmsResourceType resourceType = null;
        boolean foundBrokenLinks = false;

        report.println(Messages.get().container(Messages.RPT_HTMLLINK_VALIDATOR_BEGIN_0), I_CmsReport.FORMAT_HEADLINE);

        // populate a lookup map with the offline resources that 
        // actually get published keyed by their resource names.
        // second, resources that don't get validated are ignored.
        offlineFilesLookup = new HashMap();
        validatableResources = new ArrayList();
        for (i = 0; i < offlineResources.size(); i++) {
            resource = (CmsResource)offlineResources.get(i);
            offlineFilesLookup.put(resource.getRootPath(), resource);

            try {
                resourceType = OpenCms.getResourceManager().getResourceType(resource.getTypeId());
                if ((resourceType instanceof I_CmsXmlDocumentLinkValidatable)
                    && (resource.getState() != CmsResource.STATE_DELETED)) {
                    // don't validate links on deleted resources
                    validatableResources.add(resource);
                }
            } catch (CmsException e) {
                LOG.error(Messages.get().getBundle().key(Messages.LOG_RETRIEVAL_RESOURCE_1, resourceName), e);
            }
        }

        foundBrokenLinks = false;
        for (i = 0, j = validatableResources.size(); i < j; i++) {
            try {
                brokenLinks = null;
                resource = (CmsResource)validatableResources.get(i);
                resourceName = resource.getRootPath();
                resourceType = OpenCms.getResourceManager().getResourceType(resource.getTypeId());

                report.print(org.opencms.report.Messages.get().container(
                    org.opencms.report.Messages.RPT_SUCCESSION_2,
                    new Integer(i + 1),
                    new Integer(j)), I_CmsReport.FORMAT_NOTE);
                report.print(Messages.get().container(Messages.RPT_HTMLLINK_VALIDATING_0), I_CmsReport.FORMAT_NOTE);
                report.print(org.opencms.report.Messages.get().container(
                    org.opencms.report.Messages.RPT_ARGUMENT_1,
                    cms.getRequestContext().removeSiteRoot(resourceName)));
                report.print(org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_DOTS_0));

                links = ((I_CmsXmlDocumentLinkValidatable)resourceType).findLinks(cms, resource);

                if (links.size() > 0) {
                    brokenLinks = validateLinks(links, offlineFilesLookup);
                }

                if (brokenLinks != null && brokenLinks.size() > 0) {
                    // the resource contains broken links
                    invalidResources.put(resourceName, brokenLinks);
                    foundBrokenLinks = true;
                    report.println(
                        Messages.get().container(Messages.RPT_HTMLLINK_FOUND_BROKEN_LINKS_0),
                        I_CmsReport.FORMAT_WARNING);
                } else {
                    // the resource contains *NO* broken links
                    report.println(
                        org.opencms.report.Messages.get().container(org.opencms.report.Messages.RPT_OK_0),
                        I_CmsReport.FORMAT_OK);
                }
            } catch (CmsException e) {
                LOG.error(Messages.get().getBundle().key(Messages.LOG_LINK_SEARCH_1, resourceName), e);
            }
        }

        if (foundBrokenLinks) {
            // print a summary if we found broken links in the validated resources
            report.println(
                Messages.get().container(Messages.RPT_BROKEN_LINKS_SUMMARY_BEGIN_0),
                I_CmsReport.FORMAT_HEADLINE);

            Iterator outer = invalidResources.keySet().iterator();
            while (outer.hasNext()) {
                resourceName = (String)outer.next();
                brokenLinks = (List)invalidResources.get(resourceName);

                report.println(
                    Messages.get().container(Messages.RPT_BROKEN_LINKS_IN_1, resourceName),
                    I_CmsReport.FORMAT_WARNING);
                Iterator inner = brokenLinks.iterator();
                while (inner.hasNext()) {
                    report.print(org.opencms.report.Messages.get().container(
                        org.opencms.report.Messages.RPT_ARGUMENT_1,
                        inner.next()), I_CmsReport.FORMAT_WARNING);
                }
                report.println();
            }

            report.println(
                Messages.get().container(Messages.RPT_BROKEN_LINKS_SUMMARY_END_0),
                I_CmsReport.FORMAT_HEADLINE);
            report.println(Messages.get().container(Messages.RPT_HTMLLINK_VALIDATOR_ERROR_0), I_CmsReport.FORMAT_ERROR);
        }

        report.println(Messages.get().container(Messages.RPT_HTMLLINK_VALIDATOR_END_0), I_CmsReport.FORMAT_HEADLINE);

        return invalidResources;
    }

    /**
     * @see java.lang.Object#finalize()
     */
    protected void finalize() throws Throwable {

        try {
            m_driverManager = null;
        } catch (Throwable t) {
            // ignore
        }

        super.finalize();
    }

    /**
     * Validates the URIs in the specified link list.<p>
     * 
     * @param links a list of URIs inside a CmsResource
     * @param offlineFileLookup a map for faster lookup with all (offline) resources that get actually published keyed by their resource names (including the site root)
     * @return a list with the broken links in the specified link list, or an empty list if no broken links were found
     */
    protected List validateLinks(List links, Map offlineFileLookup) {

        List brokenLinks = new ArrayList();
        String link = null;
        boolean isValidLink = true;
        CmsResource unpublishedResource = null;
        List validatedLinks = new ArrayList();

        Iterator i = links.iterator();
        while (i.hasNext()) {
            link = ((String)i.next()).trim();
            isValidLink = true;

            if (validatedLinks.contains(link) || "".equals(link)) {
                // skip links that are already validated or empty
                continue;
            }

            // the link is valid...

            try {
                // ... if the linked resource exists in the online project
                m_driverManager.getVfsDriver().readResource(
                    new CmsDbContext(),
                    CmsProject.ONLINE_PROJECT_ID,
                    link,
                    true);

                // ... and if the linked resource in the online project won't get deleted if it gets actually published
                if (offlineFileLookup.containsKey(link)) {
                    unpublishedResource = (CmsResource)offlineFileLookup.get(link);

                    if (unpublishedResource.getState() == CmsResource.STATE_DELETED) {
                        isValidLink = false;
                    }
                }
            } catch (CmsException e) {
                // ... or if the linked resource is a resource that gets actually published
                if (!offlineFileLookup.containsKey(link)) {
                    isValidLink = false;
                }
            }

            if (!isValidLink) {
                brokenLinks.add(link);
            }

            validatedLinks.add(link);
        }

        return brokenLinks;
    }
}