All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.liferay.portlet.portletconfiguration.action.ActionUtil Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* 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.
*/
package com.liferay.portlet.portletconfiguration.action;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.LayoutTypePortlet;
import com.liferay.portal.kernel.model.Portlet;
import com.liferay.portal.kernel.model.PublicRenderParameter;
import com.liferay.portal.kernel.portlet.PortletConfigurationLayoutUtil;
import com.liferay.portal.kernel.portlet.PortletPreferencesFactoryUtil;
import com.liferay.portal.kernel.portlet.PortletQNameUtil;
import com.liferay.portal.kernel.security.auth.PrincipalException;
import com.liferay.portal.kernel.security.permission.ActionKeys;
import com.liferay.portal.kernel.security.permission.PermissionChecker;
import com.liferay.portal.kernel.service.PortletLocalServiceUtil;
import com.liferay.portal.kernel.service.permission.PortletPermissionUtil;
import com.liferay.portal.kernel.servlet.SessionErrors;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.JavaConstants;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portlet.configuration.kernel.util.PortletConfigurationUtil;
import com.liferay.portlet.portletconfiguration.util.ConfigurationActionRequest;
import com.liferay.portlet.portletconfiguration.util.ConfigurationPortletRequest;
import com.liferay.portlet.portletconfiguration.util.ConfigurationRenderRequest;
import com.liferay.portlet.portletconfiguration.util.ConfigurationResourceRequest;
import com.liferay.portlet.portletconfiguration.util.PublicRenderParameterConfiguration;
import com.liferay.portlet.portletconfiguration.util.PublicRenderParameterIdentifierComparator;
import com.liferay.portlet.portletconfiguration.util.PublicRenderParameterIdentifierConfigurationComparator;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import javax.portlet.ActionRequest;
import javax.portlet.PortletPreferences;
import javax.portlet.PortletRequest;
import javax.portlet.RenderRequest;
import javax.portlet.ResourceRequest;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
/**
* @author Jorge Ferrer
* @author Raymond Augé
*/
public class ActionUtil {
public static final String ACTION = "_ACTION_";
public static final String PRESELECTED = "_PRESELECTED_";
public static PortletPreferences getLayoutPortletSetup(
PortletRequest portletRequest, Portlet portlet) {
ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
Layout layout = themeDisplay.getLayout();
return PortletPreferencesFactoryUtil.getLayoutPortletSetup(
layout, portlet.getPortletId());
}
public static void getLayoutPublicRenderParameters(
PortletRequest portletRequest)
throws Exception {
ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
Set identifiers = new HashSet<>();
Set publicRenderParameters = new TreeSet<>(
new PublicRenderParameterIdentifierComparator());
LayoutTypePortlet layoutTypePortlet =
themeDisplay.getLayoutTypePortlet();
for (Portlet portlet : layoutTypePortlet.getAllPortlets()) {
for (PublicRenderParameter publicRenderParameter :
portlet.getPublicRenderParameters()) {
if (!identifiers.contains(
publicRenderParameter.getIdentifier())) {
identifiers.add(publicRenderParameter.getIdentifier());
publicRenderParameters.add(publicRenderParameter);
}
}
}
portletRequest.setAttribute(
WebKeys.PUBLIC_RENDER_PARAMETERS, publicRenderParameters);
}
public static Portlet getPortlet(PortletRequest portletRequest)
throws Exception {
ThemeDisplay themeDisplay = (ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
PermissionChecker permissionChecker =
themeDisplay.getPermissionChecker();
String portletId = ParamUtil.getString(
portletRequest, "portletResource");
Layout layout = PortletConfigurationLayoutUtil.getLayout(themeDisplay);
if (!PortletPermissionUtil.contains(
permissionChecker, themeDisplay.getScopeGroupId(), layout,
portletId, ActionKeys.CONFIGURATION)) {
throw new PrincipalException.MustHavePermission(
permissionChecker, Portlet.class.getName(), portletId,
ActionKeys.CONFIGURATION);
}
return PortletLocalServiceUtil.getPortletById(
themeDisplay.getCompanyId(), portletId);
}
public static void getPublicRenderParameterConfigurationList(
PortletRequest portletRequest, Portlet portlet)
throws Exception {
PortletPreferences preferences = null;
if (portletRequest instanceof ConfigurationPortletRequest) {
preferences = portletRequest.getPreferences();
}
else {
ThemeDisplay themeDisplay =
(ThemeDisplay)portletRequest.getAttribute(
WebKeys.THEME_DISPLAY);
Layout layout = themeDisplay.getLayout();
preferences = PortletPreferencesFactoryUtil.getLayoutPortletSetup(
layout, portlet.getPortletId());
}
List
publicRenderParameterConfigurations = new ArrayList<>();
for (PublicRenderParameter publicRenderParameter :
portlet.getPublicRenderParameters()) {
String publicRenderParameterName =
PortletQNameUtil.getPublicRenderParameterName(
publicRenderParameter.getQName());
String mappingKey =
PublicRenderParameterConfiguration.getMappingKey(
publicRenderParameterName);
String ignoreKey = PublicRenderParameterConfiguration.getIgnoreKey(
publicRenderParameterName);
String mappingValue = null;
boolean ignoreValue = false;
if (SessionErrors.isEmpty(portletRequest)) {
mappingValue = preferences.getValue(mappingKey, null);
ignoreValue = GetterUtil.getBoolean(
preferences.getValue(ignoreKey, null));
}
else {
mappingValue = ParamUtil.getString(portletRequest, mappingKey);
ignoreValue = GetterUtil.getBoolean(
ParamUtil.getString(portletRequest, ignoreKey));
}
publicRenderParameterConfigurations.add(
new PublicRenderParameterConfiguration(
publicRenderParameter, mappingValue, ignoreValue));
}
Collections.sort(
publicRenderParameterConfigurations,
new PublicRenderParameterIdentifierConfigurationComparator());
portletRequest.setAttribute(
WebKeys.PUBLIC_RENDER_PARAMETER_CONFIGURATIONS,
publicRenderParameterConfigurations);
}
public static String getTitle(Portlet portlet, RenderRequest renderRequest)
throws Exception {
ThemeDisplay themeDisplay = (ThemeDisplay)renderRequest.getAttribute(
WebKeys.THEME_DISPLAY);
PortletPreferences portletSetup = null;
if (renderRequest instanceof ConfigurationPortletRequest) {
portletSetup = renderRequest.getPreferences();
}
else {
HttpServletRequest request = PortalUtil.getHttpServletRequest(
renderRequest);
portletSetup = getLayoutPortletSetup(renderRequest, portlet);
portletSetup = getPortletSetup(
request, renderRequest.getPreferences(), portletSetup);
}
String title = PortletConfigurationUtil.getPortletTitle(
portletSetup, themeDisplay.getLanguageId());
if (Validator.isNull(title)) {
ServletContext servletContext =
(ServletContext)renderRequest.getAttribute(WebKeys.CTX);
title = PortalUtil.getPortletTitle(
portlet, servletContext, themeDisplay.getLocale());
}
return title;
}
public static ActionRequest getWrappedActionRequest(
ActionRequest actionRequest, PortletPreferences portletPreferences)
throws PortalException {
HttpServletRequest request = PortalUtil.getHttpServletRequest(
actionRequest);
portletPreferences = getPortletPreferences(
request, actionRequest.getPreferences(), portletPreferences);
return new ConfigurationActionRequest(
actionRequest, portletPreferences);
}
public static RenderRequest getWrappedRenderRequest(
RenderRequest renderRequest, PortletPreferences portletPreferences)
throws PortalException {
HttpServletRequest request = PortalUtil.getHttpServletRequest(
renderRequest);
portletPreferences = getPortletPreferences(
request, renderRequest.getPreferences(), portletPreferences);
renderRequest = new ConfigurationRenderRequest(
renderRequest, portletPreferences);
request.setAttribute(
JavaConstants.JAVAX_PORTLET_REQUEST, renderRequest);
return renderRequest;
}
public static ResourceRequest getWrappedResourceRequest(
ResourceRequest resourceRequest,
PortletPreferences portletPreferences)
throws PortalException {
HttpServletRequest request = PortalUtil.getHttpServletRequest(
resourceRequest);
portletPreferences = getPortletPreferences(
request, resourceRequest.getPreferences(), portletPreferences);
return new ConfigurationResourceRequest(
resourceRequest, portletPreferences);
}
protected static PortletPreferences getPortletPreferences(
HttpServletRequest request,
PortletPreferences portletConfigPortletPreferences,
PortletPreferences portletPreferences)
throws PortalException {
String portletResource = ParamUtil.getString(
request, "portletResource");
if (Validator.isNull(portletResource)) {
return portletConfigPortletPreferences;
}
if (portletPreferences != null) {
return portletPreferences;
}
return PortletPreferencesFactoryUtil.getPortletPreferences(
request, portletResource);
}
protected static PortletPreferences getPortletSetup(
HttpServletRequest request,
PortletPreferences portletConfigPortletSetup,
PortletPreferences portletSetup)
throws PortalException {
String portletResource = ParamUtil.getString(
request, "portletResource");
if (Validator.isNull(portletResource)) {
return portletConfigPortletSetup;
}
if (portletSetup != null) {
return portletSetup;
}
return PortletPreferencesFactoryUtil.getPortletSetup(
request, portletResource);
}
}
