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.portal.action.LayoutAction 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.portal.action;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.audit.AuditMessage;
import com.liferay.portal.kernel.audit.AuditRouterUtil;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.LayoutConstants;
import com.liferay.portal.kernel.model.LayoutTypePortlet;
import com.liferay.portal.kernel.model.Portlet;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.portlet.LiferayPortletRequest;
import com.liferay.portal.kernel.portlet.PortletContainerUtil;
import com.liferay.portal.kernel.portlet.PortletURLFactoryUtil;
import com.liferay.portal.kernel.security.permission.ActionKeys;
import com.liferay.portal.kernel.service.PortletLocalServiceUtil;
import com.liferay.portal.kernel.servlet.BufferCacheServletResponse;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.util.ContentTypes;
import com.liferay.portal.kernel.util.HttpUtil;
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.PortletKeys;
import com.liferay.portal.kernel.util.ServerDetector;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portal.security.sso.SSOUtil;
import com.liferay.portal.struts.ActionConstants;
import com.liferay.portal.util.PropsValues;
import com.liferay.portlet.LiferayPortletUtil;
import com.liferay.portlet.RenderParametersPool;
import com.liferay.portlet.internal.RenderData;
import com.liferay.portlet.internal.RenderStateUtil;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.portlet.PortletMode;
import javax.portlet.PortletRequest;
import javax.portlet.PortletURL;
import javax.portlet.ResourceRequest;
import javax.portlet.WindowState;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
/**
* @author Brian Wing Shun Chan
* @author Shuyang Zhou
* @author Neil Griffin
*/
public class LayoutAction extends Action {
@Override
public ActionForward execute(
ActionMapping actionMapping, ActionForm actionForm,
HttpServletRequest request, HttpServletResponse response)
throws Exception {
ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(
WebKeys.THEME_DISPLAY);
Boolean layoutDefault = (Boolean)request.getAttribute(
WebKeys.LAYOUT_DEFAULT);
if (Boolean.TRUE.equals(layoutDefault)) {
Layout requestedLayout = (Layout)request.getAttribute(
WebKeys.REQUESTED_LAYOUT);
if (requestedLayout != null) {
String redirectParam = "redirect";
if (Validator.isNotNull(PropsValues.AUTH_LOGIN_PORTLET_NAME)) {
String portletNamespace = PortalUtil.getPortletNamespace(
PropsValues.AUTH_LOGIN_PORTLET_NAME);
redirectParam = portletNamespace + redirectParam;
}
String authLoginURL = SSOUtil.getSignInURL(
themeDisplay.getCompanyId(), themeDisplay.getURLSignIn());
if (Validator.isNull(authLoginURL)) {
authLoginURL = PortalUtil.getSiteLoginURL(themeDisplay);
}
if (Validator.isNull(authLoginURL)) {
authLoginURL = PropsValues.AUTH_LOGIN_URL;
}
if (Validator.isNull(authLoginURL)) {
PortletURL loginURL = PortletURLFactoryUtil.create(
request, PortletKeys.LOGIN,
PortletRequest.RENDER_PHASE);
loginURL.setParameter(
"saveLastPath", Boolean.FALSE.toString());
loginURL.setParameter(
"mvcRenderCommandName", "/login/login");
loginURL.setPortletMode(PortletMode.VIEW);
loginURL.setWindowState(WindowState.MAXIMIZED);
authLoginURL = loginURL.toString();
}
authLoginURL = HttpUtil.setParameter(
authLoginURL, "p_p_id",
PropsValues.AUTH_LOGIN_PORTLET_NAME);
String currentURL = PortalUtil.getCurrentURL(request);
authLoginURL = HttpUtil.setParameter(
authLoginURL, redirectParam, currentURL);
if (_log.isDebugEnabled()) {
_log.debug("Redirect requested layout to " + authLoginURL);
}
response.sendRedirect(authLoginURL);
}
else {
Layout layout = themeDisplay.getLayout();
String redirect = PortalUtil.getLayoutURL(layout, themeDisplay);
if (_log.isDebugEnabled()) {
_log.debug("Redirect default layout to " + redirect);
}
response.sendRedirect(redirect);
}
return null;
}
long plid = ParamUtil.getLong(request, "p_l_id");
if (_log.isDebugEnabled()) {
_log.debug("p_l_id is " + plid);
}
if (plid > 0) {
Layout layout = themeDisplay.getLayout();
if (layout != null) {
plid = layout.getPlid();
}
return processLayout(actionMapping, request, response, plid);
}
try {
forwardLayout(request);
return actionMapping.findForward(
ActionConstants.COMMON_FORWARD_JSP);
}
catch (Exception e) {
PortalUtil.sendError(e, request, response);
return null;
}
}
protected void forwardLayout(HttpServletRequest request) throws Exception {
Layout layout = (Layout)request.getAttribute(WebKeys.LAYOUT);
long plid = LayoutConstants.DEFAULT_PLID;
String layoutFriendlyURL = null;
ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(
WebKeys.THEME_DISPLAY);
if (layout != null) {
plid = layout.getPlid();
layoutFriendlyURL = PortalUtil.getLayoutFriendlyURL(
layout, themeDisplay);
}
String forwardURL = layoutFriendlyURL;
if (Validator.isNull(forwardURL)) {
forwardURL =
themeDisplay.getPathMain() + "/portal/layout?p_l_id=" + plid;
}
if (Validator.isNotNull(themeDisplay.getDoAsUserId())) {
forwardURL = HttpUtil.addParameter(
forwardURL, "doAsUserId", themeDisplay.getDoAsUserId());
}
if (Validator.isNotNull(themeDisplay.getDoAsUserLanguageId())) {
forwardURL = HttpUtil.addParameter(
forwardURL, "doAsUserLanguageId",
themeDisplay.getDoAsUserLanguageId());
}
if (_log.isDebugEnabled()) {
_log.debug("Forward layout to " + forwardURL);
}
request.setAttribute(WebKeys.FORWARD_URL, forwardURL);
}
protected String getRenderStateJSON(
HttpServletRequest request, HttpServletResponse response,
ThemeDisplay themeDisplay, String portletId,
LayoutTypePortlet layoutTypePortlet)
throws Exception {
Map renderDataMap = new HashMap<>();
List allPortlets = layoutTypePortlet.getAllPortlets();
for (Portlet curPortlet : allPortlets) {
String curPortletId = curPortlet.getPortletId();
if (curPortletId.equals(portletId) ||
curPortlet.isPartialActionServeResource()) {
BufferCacheServletResponse bufferCacheServletResponse =
new BufferCacheServletResponse(response);
PortletContainerUtil.preparePortlet(request, curPortlet);
PortletContainerUtil.serveResource(
request, bufferCacheServletResponse, curPortlet);
RenderData renderData = new RenderData(
bufferCacheServletResponse.getContentType(),
bufferCacheServletResponse.getString());
renderDataMap.put(curPortletId, renderData);
}
}
return RenderStateUtil.generateJSON(
request, themeDisplay, renderDataMap);
}
protected ActionForward processLayout(
ActionMapping actionMapping, HttpServletRequest request,
HttpServletResponse response, long plid)
throws Exception {
HttpSession session = request.getSession();
ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(
WebKeys.THEME_DISPLAY);
try {
Layout layout = themeDisplay.getLayout();
if ((layout != null) && layout.isTypeURL()) {
String redirect = PortalUtil.getLayoutActualURL(layout);
response.sendRedirect(redirect);
return null;
}
Long previousLayoutPlid = (Long)session.getAttribute(
WebKeys.PREVIOUS_LAYOUT_PLID);
if ((previousLayoutPlid == null) ||
(layout.getPlid() != previousLayoutPlid.longValue())) {
session.setAttribute(
WebKeys.PREVIOUS_LAYOUT_PLID, layout.getPlid());
if (themeDisplay.isSignedIn() &&
PropsValues.
AUDIT_MESSAGE_COM_LIFERAY_PORTAL_MODEL_LAYOUT_VIEW &&
AuditRouterUtil.isDeployed()) {
User user = themeDisplay.getUser();
AuditMessage auditMessage = new AuditMessage(
ActionKeys.VIEW, user.getCompanyId(), user.getUserId(),
user.getFullName(), Layout.class.getName(),
String.valueOf(layout.getPlid()));
AuditRouterUtil.route(auditMessage);
}
}
boolean resetLayout = ParamUtil.getBoolean(
request, "p_l_reset", PropsValues.LAYOUT_DEFAULT_P_L_RESET);
String portletId = ParamUtil.getString(request, "p_p_id");
if (resetLayout &&
(Validator.isNull(portletId) ||
((previousLayoutPlid != null) &&
(layout.getPlid() != previousLayoutPlid.longValue())))) {
// Always clear render parameters on a layout url, but do not
// clear on portlet urls invoked on the same layout
RenderParametersPool.clear(request, plid);
}
Portlet portlet = null;
if (Validator.isNotNull(portletId)) {
long companyId = PortalUtil.getCompanyId(request);
portlet = PortletLocalServiceUtil.getPortletById(
companyId, portletId);
}
if (portlet != null) {
PortletContainerUtil.preparePortlet(request, portlet);
if (themeDisplay.isLifecycleAction()) {
PortletContainerUtil.processAction(
request, response, portlet);
if (response.isCommitted()) {
return null;
}
String renderStateJSON = StringPool.BLANK;
if (themeDisplay.isHubAction()) {
renderStateJSON = RenderStateUtil.generateJSON(
request, themeDisplay);
}
else if (themeDisplay.isHubPartialAction()) {
LayoutTypePortlet layoutTypePortlet =
themeDisplay.getLayoutTypePortlet();
if (layoutTypePortlet != null) {
renderStateJSON = getRenderStateJSON(
request, response, themeDisplay,
portlet.getPortletId(), layoutTypePortlet);
}
}
if (themeDisplay.isHubAction() ||
themeDisplay.isHubPartialAction()) {
response.setContentLength(renderStateJSON.length());
response.setContentType(ContentTypes.APPLICATION_JSON);
PrintWriter printWriter = response.getWriter();
printWriter.write(renderStateJSON);
return null;
}
}
else if (themeDisplay.isLifecycleResource()) {
PortletContainerUtil.serveResource(
request, response, portlet);
return null;
}
}
if (layout != null) {
if (themeDisplay.isStateExclusive()) {
PortletContainerUtil.renderHeaders(
request, response, portlet);
PortletContainerUtil.render(request, response, portlet);
return null;
}
// Include layout content before the page loads because portlets
// on the page can set the page title and page subtitle
PortletContainerUtil.processPublicRenderParameters(
request, layout, portlet);
if (layout.includeLayoutContent(request, response)) {
return null;
}
}
return actionMapping.findForward("portal.layout");
}
catch (Exception e) {
PortalUtil.sendError(e, request, response);
return null;
}
finally {
if (!ServerDetector.isResin()) {
PortletRequest portletRequest =
(PortletRequest)request.getAttribute(
JavaConstants.JAVAX_PORTLET_REQUEST);
if (portletRequest != null) {
LiferayPortletRequest liferayPortletRequest =
LiferayPortletUtil.getLiferayPortletRequest(
portletRequest);
if (liferayPortletRequest instanceof ResourceRequest) {
ResourceRequest resourceRequest =
(ResourceRequest)liferayPortletRequest;
if (!resourceRequest.isAsyncStarted()) {
liferayPortletRequest.cleanUp();
}
}
else {
liferayPortletRequest.cleanUp();
}
}
}
}
}
private static final Log _log = LogFactoryUtil.getLog(LayoutAction.class);
}
