001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workplace.commons;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.file.CmsResourceFilter;
033import org.opencms.main.CmsException;
034import org.opencms.main.CmsLog;
035import org.opencms.workplace.explorer.CmsResourceUtil;
036import org.opencms.workplace.list.A_CmsListExplorerDialog;
037import org.opencms.workplace.list.A_CmsListResourceCollector;
038import org.opencms.workplace.list.CmsListItem;
039
040import java.util.ArrayList;
041import java.util.Iterator;
042import java.util.List;
043import java.util.Map;
044
045import org.apache.commons.logging.Log;
046
047/**
048 * Collector for resources with links that could get broken after publishing.<p>
049 *
050 * @since 6.5.5
051 */
052public class CmsPublishBrokenRelationsCollector extends A_CmsListResourceCollector {
053
054    /** The log object for this class. */
055    private static final Log LOG = CmsLog.getLog(CmsPublishBrokenRelationsCollector.class);
056
057    /** Parameter of the default collector name. */
058    public static final String COLLECTOR_NAME = "potentialBrokenResources";
059
060    /**
061     * Constructor, creates a new instance.<p>
062     *
063     * @param wp the workplace object
064     * @param resources list of locked resources
065     */
066    public CmsPublishBrokenRelationsCollector(A_CmsListExplorerDialog wp, List<String> resources) {
067
068        super(wp);
069        setResourcesParam(resources);
070    }
071
072    /**
073     * @see org.opencms.file.collectors.I_CmsResourceCollector#getCollectorNames()
074     */
075    public List<String> getCollectorNames() {
076
077        List<String> names = new ArrayList<String>();
078        names.add(COLLECTOR_NAME);
079        return names;
080    }
081
082    /**
083     * @see org.opencms.workplace.list.A_CmsListResourceCollector#getResources(org.opencms.file.CmsObject, java.util.Map)
084     */
085    @Override
086    public List<CmsResource> getResources(CmsObject cms, Map<String, String> params) {
087
088        String siteRoot = cms.getRequestContext().getSiteRoot();
089        if (siteRoot == null) {
090            siteRoot = "";
091        }
092        List<CmsResource> resources = new ArrayList<CmsResource>();
093        try {
094            cms.getRequestContext().setSiteRoot("");
095            Iterator<String> itResourceNames = getResourceNamesFromParam(params).iterator();
096            while (itResourceNames.hasNext()) {
097                String resName = itResourceNames.next();
098                try {
099                    resources.add(cms.readResource(resName, CmsResourceFilter.ALL));
100                } catch (CmsException e) {
101                    if (LOG.isErrorEnabled()) {
102                        LOG.error(e.getLocalizedMessage(), e);
103                    }
104                }
105            }
106        } finally {
107            cms.getRequestContext().setSiteRoot(siteRoot);
108        }
109        return resources;
110    }
111
112    /**
113     * @see org.opencms.workplace.list.A_CmsListResourceCollector#setAdditionalColumns(org.opencms.workplace.list.CmsListItem, org.opencms.workplace.explorer.CmsResourceUtil)
114     */
115    @Override
116    protected void setAdditionalColumns(CmsListItem item, CmsResourceUtil resUtil) {
117
118        // no-op
119    }
120}