All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencms.gwt.CmsQuickLaunchProvider Maven / Gradle / Ivy

Go to download

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0
Show newest version
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (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, 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.gwt;

import org.opencms.ade.configuration.CmsADEManager;
import org.opencms.db.CmsUserSettings;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.types.CmsResourceTypeXmlContainerPage;
import org.opencms.gwt.shared.CmsQuickLaunchData;
import org.opencms.gwt.shared.CmsQuickLaunchParams;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.ui.apps.CmsAppVisibilityStatus;
import org.opencms.ui.apps.CmsFileExplorerConfiguration;
import org.opencms.ui.apps.CmsLegacyAppConfiguration;
import org.opencms.ui.apps.CmsPageEditorConfiguration;
import org.opencms.ui.apps.CmsQuickLaunchLocationCache;
import org.opencms.ui.apps.CmsSitemapEditorConfiguration;
import org.opencms.ui.apps.CmsTraditionalWorkplaceConfiguration;
import org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration;
import org.opencms.workplace.CmsWorkplace;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

import javax.servlet.http.HttpSession;

import org.apache.commons.logging.Log;

import com.google.common.collect.Lists;
import com.vaadin.server.ExternalResource;
import com.vaadin.server.FontIcon;
import com.vaadin.server.Resource;

/**
 * Provides the data for the buttons in the quick launch menu.

*/ public class CmsQuickLaunchProvider { /** The font icon HTML format String. */ private static final String FONT_ICON_HTML = "fonticon:&#x%3$x;"; /** Log instance for this class. */ private static final Log LOG = CmsLog.getLog(CmsQuickLaunchProvider.class); /** * Gets the quick launch data for the current user and context.

* * The context is a string which identifies where the quick launch menu is located * @param cms the cms context * @param session the user session * * @param params the quick launch parameters * * @return the list of available quick launch items */ public static List getQuickLaunchData( CmsObject cms, HttpSession session, CmsQuickLaunchParams params) { List result = Lists.newArrayList(); Locale locale = OpenCms.getWorkplaceManager().getWorkplaceLocale(cms); CmsUserSettings userSettings = new CmsUserSettings(cms); boolean usesNewWorkplace = userSettings.usesNewWorkplace(); List appConfigs = new ArrayList( OpenCms.getWorkplaceAppManager().getQuickLaunchConfigurations(cms)); if (!usesNewWorkplace) { // the workplace app is only available within ADE in case of the traditional workplace user setting I_CmsWorkplaceAppConfiguration config = OpenCms.getWorkplaceAppManager().getAppConfiguration( CmsTraditionalWorkplaceConfiguration.APP_ID); if ((config != null) && config.getVisibility(cms).isActive()) { appConfigs.add(config); } } CmsResource currentPage = null; if (params.getPageId() != null) { try { currentPage = cms.readResource(params.getPageId(), CmsResourceFilter.ONLY_VISIBLE_NO_DELETED); } catch (CmsException e) { LOG.warn(e.getLocalizedMessage(), e); } } CmsQuickLaunchLocationCache locationCache = CmsQuickLaunchLocationCache.getLocationCache(session); for (I_CmsWorkplaceAppConfiguration config : appConfigs) { try { boolean reload = false; String link = null; String errorTitle = null; String errorMessage = null; boolean useLegacyButtonStyle = config instanceof CmsLegacyAppConfiguration; if (CmsFileExplorerConfiguration.APP_ID.equals(config.getId())) { if (!usesNewWorkplace) { continue; } String page = locationCache.getFileExplorerLocation(cms.getRequestContext().getSiteRoot()); if (page != null) { link = CmsCoreService.getVaadinWorkplaceLink(cms, cms.getRequestContext().addSiteRoot(page)); } else { if (cms.existsResource("/", CmsResourceFilter.ONLY_VISIBLE_NO_DELETED)) { link = CmsCoreService.getVaadinWorkplaceLink(cms, cms.getRequestContext().getSiteRoot()); } else if (currentPage != null) { link = CmsCoreService.getVaadinWorkplaceLink(cms, params.getPageId()); } else { errorTitle = config.getName(locale); errorMessage = Messages.get().getBundle(locale).key( Messages.GUI_QUICKLAUNCH_EXPLORER_NOT_ALLOWED_0); } } } else if (CmsPageEditorConfiguration.APP_ID.equals(config.getId())) { if (params.isPageContext()) { if ((currentPage != null) && CmsResourceTypeXmlContainerPage.MODEL_GROUP_TYPE_NAME.equals( OpenCms.getResourceManager().getResourceType(currentPage).getTypeName())) { String page = locationCache.getPageEditorLocation(cms.getRequestContext().getSiteRoot()); if (page != null) { link = OpenCms.getLinkManager().substituteLink(cms, page); } else { reload = true; } } else { reload = true; } } else if (params.isSitemapContext()) { String page = locationCache.getPageEditorLocation(cms.getRequestContext().getSiteRoot()); if (page == null) { page = locationCache.getSitemapEditorLocation(cms.getRequestContext().getSiteRoot()); } if (page != null) { link = OpenCms.getLinkManager().substituteLink(cms, page); } } } else if (CmsSitemapEditorConfiguration.APP_ID.equals(config.getId())) { if (params.isSitemapContext()) { reload = true; } else if (params.isPageContext()) { String sitemapLink = OpenCms.getLinkManager().substituteLinkForUnknownTarget( cms, CmsADEManager.PATH_SITEMAP_EDITOR_JSP); String page = locationCache.getPageEditorLocation(cms.getRequestContext().getSiteRoot()); link = sitemapLink + "?path=" + page; } } else if (CmsTraditionalWorkplaceConfiguration.APP_ID.equals(config.getId())) { String resourceRootFolder = currentPage != null ? CmsResource.getFolderPath(currentPage.getRootPath()) : cms.getRequestContext().getSiteRoot(); link = CmsWorkplace.getWorkplaceExplorerLink(cms, resourceRootFolder); useLegacyButtonStyle = true; } else { if (!usesNewWorkplace) { continue; } link = OpenCms.getSystemInfo().getWorkplaceContext() + "#!" + config.getId(); } Resource icon = config.getIcon(); String imageLink = ""; if (icon instanceof ExternalResource) { imageLink = ((ExternalResource)icon).getURL(); // no icon if not an external resource } else if (icon instanceof FontIcon) { imageLink = String.format( FONT_ICON_HTML, config.getButtonStyle(), ((FontIcon)icon).getFontFamily(), Integer.valueOf(((FontIcon)icon).getCodepoint())); } String name = config.getName(OpenCms.getWorkplaceManager().getWorkplaceLocale(cms)); CmsAppVisibilityStatus visibility = config.getVisibility(cms); if (!visibility.isActive()) { errorTitle = name; errorMessage = visibility.getHelpText(); } CmsQuickLaunchData data = new CmsQuickLaunchData( link, name, imageLink, errorTitle, errorMessage, useLegacyButtonStyle, reload); result.add(data); } catch (Exception e) { LOG.error(e.getLocalizedMessage(), e); } } return result; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy