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