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.ui.actions;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.file.CmsResourceFilter;
033import org.opencms.gwt.CmsVfsService;
034import org.opencms.main.OpenCms;
035import org.opencms.ui.I_CmsDialogContext;
036import org.opencms.ui.contextmenu.CmsMenuItemVisibilityMode;
037
038import java.util.HashMap;
039import java.util.List;
040import java.util.Map;
041
042/**
043 * Action to edit a file given by the file param.<p>
044 * Used within the ADE context only.<p>
045 */
046public abstract class A_CmsEditFileAction extends A_CmsWorkplaceAction implements I_CmsADEAction {
047
048    /**
049     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#executeAction(org.opencms.ui.I_CmsDialogContext)
050     */
051    public void executeAction(I_CmsDialogContext context) {
052
053        // not supported
054    }
055
056    /**
057     * @see org.opencms.ui.actions.I_CmsADEAction#getCommandClassName()
058     */
059    public String getCommandClassName() {
060
061        return "org.opencms.gwt.client.ui.contextmenu.CmsEditFile";
062    }
063
064    /**
065     * @see org.opencms.ui.actions.I_CmsADEAction#getJspPath()
066     */
067    public String getJspPath() {
068
069        return null;
070    }
071
072    /**
073     * @see org.opencms.ui.actions.I_CmsADEAction#getParams()
074     */
075    public Map<String, String> getParams() {
076
077        Map<String, String> params = new HashMap<String, String>();
078        params.put("reload", Boolean.TRUE.toString());
079        params.put("immediateReload", Boolean.TRUE.toString());
080        params.put("filename", getFileParam());
081        return params;
082    }
083
084    /**
085     * @see org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility#getVisibility(org.opencms.file.CmsObject, java.util.List)
086     */
087    public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, List<CmsResource> resources) {
088
089        return CmsMenuItemVisibilityMode.VISIBILITY_INVISIBLE;
090    }
091
092    /**
093     * @see org.opencms.ui.actions.I_CmsADEAction#isAdeSupported()
094     */
095    public boolean isAdeSupported() {
096
097        return true;
098    }
099
100    /**
101     * Checks whether the file specified by the file param and the given context exists and is visible.<p>
102     *
103     * @param context the dialog context
104     *
105     * @return <code>true</code> in case the file exists and is visible
106     */
107    protected boolean existsFile(I_CmsDialogContext context) {
108
109        CmsResource res = context.getResources().get(0);
110        if (OpenCms.getADEManager().isEditorRestricted(context.getCms(), res)) {
111            return false;
112        }
113        String sitePath = CmsVfsService.prepareFileNameForEditor(context.getCms(), res, getFileParam());
114        return context.getCms().existsResource(sitePath, CmsResourceFilter.ONLY_VISIBLE_NO_DELETED);
115    }
116
117    /**
118     * Returns the file parameter.<p>
119     *
120     * @return parameter of the file to edit
121     */
122    protected abstract String getFileParam();
123}