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, 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.xml.templatemapper;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.main.CmsException;
033import org.opencms.main.CmsLog;
034import org.opencms.main.OpenCms;
035import org.opencms.security.CmsRole;
036import org.opencms.ui.CmsVaadinUtils;
037import org.opencms.ui.I_CmsDialogContext;
038import org.opencms.ui.Messages;
039import org.opencms.ui.actions.A_CmsWorkplaceAction;
040import org.opencms.ui.components.CmsBasicDialog.DialogWidth;
041import org.opencms.ui.contextmenu.CmsMenuItemVisibilityMode;
042import org.opencms.ui.components.CmsErrorDialog;
043
044import java.util.List;
045
046import org.apache.commons.logging.Log;
047
048/**
049 * Action for replacing formatters in pages according to a template mapper configuration.<p>
050 */
051public class CmsTemplateMapperAction extends A_CmsWorkplaceAction {
052
053    /** The logger instance for this class. */
054    private static final Log LOG = CmsLog.getLog(CmsTemplateMapperAction.class);
055
056    /**
057     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#executeAction(org.opencms.ui.I_CmsDialogContext)
058     */
059    public void executeAction(I_CmsDialogContext context) {
060
061        try {
062            CmsTemplateMapperDialog dialog = new CmsTemplateMapperDialog(context);
063            context.start(
064                CmsVaadinUtils.getMessageText(Messages.GUI_TEMPLATEMAPPER_DIALOG_TITLE_0),
065                dialog,
066                DialogWidth.wide);
067            dialog.setReportThread(
068                new CmsTemplateMappingContentRewriter(context.getCms(), context.getResources().get(0)));
069        } catch (CmsException e) {
070            CmsErrorDialog.showErrorDialog(e);
071            LOG.error(e.getLocalizedMessage(), e);
072        }
073    }
074
075    /**
076     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#getId()
077     */
078    public String getId() {
079
080        return "template-mapper";
081    }
082
083    /**
084     * @see org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility#getVisibility(org.opencms.file.CmsObject, java.util.List)
085     */
086    public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, List<CmsResource> resources) {
087
088        CmsMenuItemVisibilityMode invisible = CmsMenuItemVisibilityMode.VISIBILITY_INVISIBLE;
089        if (!CmsTemplateMappingContentRewriter.checkConfiguredInModules()) {
090            return invisible;
091        }
092
093        if (resources.size() != 1) {
094            return invisible;
095        }
096        if (!resources.get(0).isFolder()) {
097            return invisible;
098        }
099
100        if (cms.getRequestContext().getCurrentProject().isOnlineProject()) {
101            return invisible;
102        }
103
104        if (!OpenCms.getRoleManager().hasRole(cms, CmsRole.DEVELOPER)) {
105            return invisible;
106        }
107
108        return CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE;
109    }
110
111    /**
112     * @see org.opencms.ui.actions.A_CmsWorkplaceAction#getTitleKey()
113     */
114    @Override
115    protected String getTitleKey() {
116
117        return Messages.GUI_TEMPLATEMAPPER_MENU_TITLE_0;
118    }
119
120}