PortletConfigurationPermissionsDisplayContext.java

/**
 * 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.configuration.web.internal.display.context;

import com.liferay.portal.kernel.dao.search.SearchContainer;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.ResourcePrimKeyException;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.Organization;
import com.liferay.portal.kernel.model.Portlet;
import com.liferay.portal.kernel.model.PortletConstants;
import com.liferay.portal.kernel.model.Resource;
import com.liferay.portal.kernel.model.ResourceConstants;
import com.liferay.portal.kernel.model.Role;
import com.liferay.portal.kernel.model.RoleConstants;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.portlet.LiferayPortletURL;
import com.liferay.portal.kernel.portlet.LiferayWindowState;
import com.liferay.portal.kernel.portlet.PortletProvider;
import com.liferay.portal.kernel.portlet.PortletProviderUtil;
import com.liferay.portal.kernel.portlet.PortletURLFactoryUtil;
import com.liferay.portal.kernel.security.permission.ActionKeys;
import com.liferay.portal.kernel.security.permission.ResourceActionsUtil;
import com.liferay.portal.kernel.service.GroupLocalServiceUtil;
import com.liferay.portal.kernel.service.LayoutLocalServiceUtil;
import com.liferay.portal.kernel.service.PortletLocalServiceUtil;
import com.liferay.portal.kernel.service.ResourceBlockLocalServiceUtil;
import com.liferay.portal.kernel.service.ResourceLocalServiceUtil;
import com.liferay.portal.kernel.service.ResourcePermissionLocalServiceUtil;
import com.liferay.portal.kernel.service.RoleLocalServiceUtil;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.util.Constants;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portal.util.PropsValues;
import com.liferay.portlet.configuration.web.internal.constants.PortletConfigurationPortletKeys;
import com.liferay.portlet.rolesadmin.search.RoleSearch;
import com.liferay.portlet.rolesadmin.search.RoleSearchTerms;
import com.liferay.sites.kernel.util.SitesUtil;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import javax.portlet.ActionRequest;
import javax.portlet.PortletMode;
import javax.portlet.PortletRequest;
import javax.portlet.PortletURL;
import javax.portlet.RenderRequest;
import javax.portlet.WindowStateException;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;

/**
 * @author Eudaldo Alonso
 */
public class PortletConfigurationPermissionsDisplayContext {

	public PortletConfigurationPermissionsDisplayContext(
			HttpServletRequest request, RenderRequest renderRequest)
		throws PortalException {

		_request = request;
		_renderRequest = renderRequest;

		long groupId = _getResourceGroupId();

		Group group = GroupLocalServiceUtil.getGroup(groupId);

		Layout selLayout = null;

		if (Objects.equals(getModelResource(), Layout.class.getName())) {
			selLayout = LayoutLocalServiceUtil.getLayout(
				GetterUtil.getLong(getResourcePrimKey()));

			group = selLayout.getGroup();

			groupId = group.getGroupId();
		}

		_selLayout = selLayout;
		_group = group;
		_groupId = groupId;
	}

	public List<String> getActions() throws PortalException {
		if (_actions != null) {
			return _actions;
		}

		List<String> actions = ResourceActionsUtil.getResourceActions(
			_getPortletResource(), getModelResource());

		if (Objects.equals(getModelResource(), Group.class.getName())) {
			long modelResourceGroupId = GetterUtil.getLong(
				getResourcePrimKey());

			Group modelResourceGroup = GroupLocalServiceUtil.getGroup(
				modelResourceGroupId);

			if (modelResourceGroup.isLayoutPrototype() ||
				modelResourceGroup.isLayoutSetPrototype() ||
				modelResourceGroup.isUserGroup()) {

				actions = new ArrayList<>(actions);

				actions.remove(ActionKeys.ADD_LAYOUT_BRANCH);
				actions.remove(ActionKeys.ADD_LAYOUT_SET_BRANCH);
				actions.remove(ActionKeys.ASSIGN_MEMBERS);
				actions.remove(ActionKeys.ASSIGN_USER_ROLES);
				actions.remove(ActionKeys.MANAGE_ANNOUNCEMENTS);
				actions.remove(ActionKeys.MANAGE_STAGING);
				actions.remove(ActionKeys.MANAGE_TEAMS);
				actions.remove(ActionKeys.PUBLISH_STAGING);
				actions.remove(ActionKeys.VIEW_MEMBERS);
				actions.remove(ActionKeys.VIEW_STAGING);
			}
		}
		else if (Objects.equals(getModelResource(), Role.class.getName())) {
			long modelResourceRoleId = GetterUtil.getLong(getResourcePrimKey());

			Role modelResourceRole = RoleLocalServiceUtil.getRole(
				modelResourceRoleId);

			String name = modelResourceRole.getName();

			if (name.equals(RoleConstants.GUEST) ||
				name.equals(RoleConstants.USER)) {

				actions = new ArrayList<>(actions);

				actions.remove(ActionKeys.ASSIGN_MEMBERS);
				actions.remove(ActionKeys.DEFINE_PERMISSIONS);
				actions.remove(ActionKeys.DELETE);
				actions.remove(ActionKeys.PERMISSIONS);
				actions.remove(ActionKeys.UPDATE);
				actions.remove(ActionKeys.VIEW);
			}
		}

		_actions = actions;

		return _actions;
	}

	public PortletURL getDefinePermissionsURL() throws Exception {
		ThemeDisplay themeDisplay = (ThemeDisplay)_request.getAttribute(
			WebKeys.THEME_DISPLAY);

		LiferayPortletURL liferayPortletURL =
			(LiferayPortletURL)PortletProviderUtil.getPortletURL(
				_request, Role.class.getName(), PortletProvider.Action.MANAGE);

		liferayPortletURL.setParameter(Constants.CMD, Constants.VIEW);
		liferayPortletURL.setParameter("backURL", themeDisplay.getURLCurrent());
		liferayPortletURL.setPortletMode(PortletMode.VIEW);
		liferayPortletURL.setRefererPlid(themeDisplay.getPlid());

		liferayPortletURL.setWindowState(LiferayWindowState.POP_UP);

		return liferayPortletURL;
	}

	public String getGroupDescriptiveName() throws PortalException {
		ThemeDisplay themeDisplay = (ThemeDisplay)_request.getAttribute(
			WebKeys.THEME_DISPLAY);

		return _group.getDescriptiveName(themeDisplay.getLocale());
	}

	public long getGroupId() {
		return _groupId;
	}

	public List<String> getGuestUnsupportedActions() {
		if (_guestUnsupportedActions != null) {
			return _guestUnsupportedActions;
		}

		List<String> guestUnsupportedActions =
			ResourceActionsUtil.getResourceGuestUnsupportedActions(
				_getPortletResource(), getModelResource());

		// LPS-32515

		if ((_selLayout != null) && _group.isGuest() &&
			SitesUtil.isFirstLayout(
				_selLayout.getGroupId(), _selLayout.isPrivateLayout(),
				_selLayout.getLayoutId())) {

			guestUnsupportedActions = new ArrayList<>(guestUnsupportedActions);

			guestUnsupportedActions.add(ActionKeys.VIEW);
		}

		_guestUnsupportedActions = guestUnsupportedActions;

		return _guestUnsupportedActions;
	}

	public PortletURL getIteratorURL() throws Exception {
		PortletURL portletURL = PortletURLFactoryUtil.create(
			_request, PortletConfigurationPortletKeys.PORTLET_CONFIGURATION,
			PortletRequest.RENDER_PHASE);

		portletURL.setParameter("mvcPath", "/edit_permissions.jsp");
		portletURL.setParameter(
			"returnToFullPageURL", _getReturnToFullPageURL());
		portletURL.setParameter(
			"portletConfiguration", Boolean.TRUE.toString());
		portletURL.setParameter("portletResource", _getPortletResource());
		portletURL.setParameter("modelResource", getModelResource());
		portletURL.setParameter(
			"resourceGroupId", String.valueOf(_getResourceGroupId()));
		portletURL.setParameter("resourcePrimKey", getResourcePrimKey());
		portletURL.setParameter("roleTypes", _getRoleTypesParam());

		portletURL.setWindowState(LiferayWindowState.POP_UP);

		return portletURL;
	}

	public String getModelResource() {
		if (_modelResource != null) {
			return _modelResource;
		}

		_modelResource = ParamUtil.getString(_request, "modelResource");

		return _modelResource;
	}

	public String getModelResourceDescription() {
		if (_modelResourceDescription != null) {
			return _modelResourceDescription;
		}

		_modelResourceDescription = ParamUtil.getString(
			_request, "modelResourceDescription");

		return _modelResourceDescription;
	}

	public Resource getResource() throws PortalException {
		if (_resource != null) {
			return _resource;
		}

		ThemeDisplay themeDisplay = (ThemeDisplay)_request.getAttribute(
			WebKeys.THEME_DISPLAY);

		if (ResourceBlockLocalServiceUtil.isSupported(getSelResource())) {
			ResourceBlockLocalServiceUtil.verifyResourceBlockId(
				themeDisplay.getCompanyId(), getSelResource(),
				Long.valueOf(getResourcePrimKey()));
		}
		else {
			int count =
				ResourcePermissionLocalServiceUtil.getResourcePermissionsCount(
					themeDisplay.getCompanyId(), getSelResource(),
					ResourceConstants.SCOPE_INDIVIDUAL, getResourcePrimKey());

			if (count == 0) {
				boolean portletActions = Validator.isNull(getModelResource());

				ResourceLocalServiceUtil.addResources(
					themeDisplay.getCompanyId(), getGroupId(), 0,
					getSelResource(), getResourcePrimKey(), portletActions,
					true, true);
			}
		}

		_resource = ResourceLocalServiceUtil.getResource(
			themeDisplay.getCompanyId(), getSelResource(),
			ResourceConstants.SCOPE_INDIVIDUAL, getResourcePrimKey());

		return _resource;
	}

	public String getResourcePrimKey() throws ResourcePrimKeyException {
		if (_resourcePrimKey != null) {
			return _resourcePrimKey;
		}

		_resourcePrimKey = ParamUtil.getString(_request, "resourcePrimKey");

		if (Validator.isNull(_resourcePrimKey)) {
			throw new ResourcePrimKeyException();
		}

		return _resourcePrimKey;
	}

	public SearchContainer getRoleSearchContainer() throws Exception {
		if (_roleSearchContainer != null) {
			return _roleSearchContainer;
		}

		ThemeDisplay themeDisplay = (ThemeDisplay)_request.getAttribute(
			WebKeys.THEME_DISPLAY);

		SearchContainer roleSearchContainer = new RoleSearch(
			_renderRequest, getIteratorURL());

		RoleSearchTerms searchTerms =
			(RoleSearchTerms)roleSearchContainer.getSearchTerms();

		boolean filterGroupRoles = !ResourceActionsUtil.isPortalModelResource(
			getModelResource());

		if (Objects.equals(getModelResource(), Role.class.getName())) {
			long modelResourceRoleId = GetterUtil.getLong(getResourcePrimKey());

			Role modelResourceRole = RoleLocalServiceUtil.getRole(
				modelResourceRoleId);

			if ((modelResourceRole.getType() ==
					RoleConstants.TYPE_ORGANIZATION) ||
				(modelResourceRole.getType() == RoleConstants.TYPE_SITE)) {

				filterGroupRoles = true;
			}
		}

		long modelResourceRoleId = 0;

		if (Objects.equals(getModelResource(), Role.class.getName())) {
			modelResourceRoleId = GetterUtil.getLong(getResourcePrimKey());
		}

		boolean filterGuestRole = false;
		boolean permissionCheckGuestEnabled =
			PropsValues.PERMISSIONS_CHECK_GUEST_ENABLED;

		if (Objects.equals(getModelResource(), Layout.class.getName())) {
			Layout resourceLayout = LayoutLocalServiceUtil.getLayout(
				GetterUtil.getLong(getResourcePrimKey()));

			if (resourceLayout.isPrivateLayout()) {
				Group resourceLayoutGroup = resourceLayout.getGroup();

				if (!resourceLayoutGroup.isLayoutSetPrototype() &&
					!permissionCheckGuestEnabled) {

					filterGuestRole = true;
				}
			}
		}
		else if (Validator.isNotNull(_getPortletResource())) {
			int pos =
				getResourcePrimKey().indexOf(PortletConstants.LAYOUT_SEPARATOR);

			if (pos > 0) {
				long resourcePlid = GetterUtil.getLong(
					getResourcePrimKey().substring(0, pos));

				Layout resourceLayout = LayoutLocalServiceUtil.getLayout(
					resourcePlid);

				if (resourceLayout.isPrivateLayout()) {
					Group resourceLayoutGroup = resourceLayout.getGroup();

					if (!resourceLayoutGroup.isLayoutPrototype() &&
						!resourceLayoutGroup.isLayoutSetPrototype() &&
						!permissionCheckGuestEnabled) {

						filterGuestRole = true;
					}
				}
			}
		}

		List<String> excludedRoleNames = new ArrayList<>();

		excludedRoleNames.add(RoleConstants.ADMINISTRATOR);

		if (filterGroupRoles) {
			excludedRoleNames.add(RoleConstants.ORGANIZATION_ADMINISTRATOR);
			excludedRoleNames.add(RoleConstants.ORGANIZATION_OWNER);
			excludedRoleNames.add(RoleConstants.SITE_ADMINISTRATOR);
			excludedRoleNames.add(RoleConstants.SITE_OWNER);
		}

		if (filterGuestRole) {
			excludedRoleNames.add(RoleConstants.GUEST);
		}

		long teamGroupId = _group.getGroupId();

		if (_group.isLayout()) {
			teamGroupId = _group.getParentGroupId();
		}

		int count = RoleLocalServiceUtil.getGroupRolesAndTeamRolesCount(
			themeDisplay.getCompanyId(), searchTerms.getKeywords(),
			excludedRoleNames, getRoleTypes(), modelResourceRoleId,
			teamGroupId);

		roleSearchContainer.setTotal(count);

		List<Role> roles = RoleLocalServiceUtil.getGroupRolesAndTeamRoles(
			themeDisplay.getCompanyId(), searchTerms.getKeywords(),
			excludedRoleNames, getRoleTypes(), modelResourceRoleId, teamGroupId,
			roleSearchContainer.getStart(), roleSearchContainer.getResultEnd());

		roleSearchContainer.setResults(roles);

		_roleSearchContainer = roleSearchContainer;

		return _roleSearchContainer;
	}

	public int[] getRoleTypes() {
		if (_roleTypes != null) {
			return _roleTypes;
		}

		String roleTypesParam = _getRoleTypesParam();

		if (Validator.isNotNull(roleTypesParam)) {
			_roleTypes = StringUtil.split(roleTypesParam, 0);
		}

		if (_roleTypes != null) {
			return _roleTypes;
		}

		_roleTypes = RoleConstants.TYPES_REGULAR_AND_SITE;

		if (ResourceActionsUtil.isPortalModelResource(getModelResource())) {
			if (Objects.equals(
					getModelResource(), Organization.class.getName()) ||
				Objects.equals(getModelResource(), User.class.getName())) {

				_roleTypes = RoleConstants.TYPES_ORGANIZATION_AND_REGULAR;
			}
			else {
				_roleTypes = RoleConstants.TYPES_REGULAR;
			}

			return _roleTypes;
		}

		if (_group == null) {
			return _roleTypes;
		}

		Group parentGroup = null;

		if (_group.isLayout()) {
			parentGroup = GroupLocalServiceUtil.fetchGroup(
				_group.getParentGroupId());
		}

		if (parentGroup == null) {
			if (_group.isOrganization()) {
				_roleTypes =
					RoleConstants.TYPES_ORGANIZATION_AND_REGULAR_AND_SITE;
			}
			else if (_group.isUser()) {
				_roleTypes = RoleConstants.TYPES_REGULAR;
			}
		}
		else {
			if (parentGroup.isOrganization()) {
				_roleTypes =
					RoleConstants.TYPES_ORGANIZATION_AND_REGULAR_AND_SITE;
			}
			else if (parentGroup.isUser()) {
				_roleTypes = RoleConstants.TYPES_REGULAR;
			}
		}

		return _roleTypes;
	}

	public String getSelResource() {
		_selResource = getModelResource();

		if (Validator.isNotNull(_selResource)) {
			return _selResource;
		}

		ThemeDisplay themeDisplay = (ThemeDisplay)_request.getAttribute(
			WebKeys.THEME_DISPLAY);

		Portlet portlet = PortletLocalServiceUtil.getPortletById(
			themeDisplay.getCompanyId(), _getPortletResource());

		_selResource = portlet.getRootPortletId();

		return _selResource;
	}

	public String getSelResourceDescription() {
		_selResourceDescription = getModelResourceDescription();

		if (Validator.isNotNull(_selResourceDescription)) {
			return _selResourceDescription;
		}

		ThemeDisplay themeDisplay = (ThemeDisplay)_request.getAttribute(
			WebKeys.THEME_DISPLAY);

		Portlet portlet = PortletLocalServiceUtil.getPortletById(
			themeDisplay.getCompanyId(), _getPortletResource());

		ServletContext servletContext =
			_request.getSession().getServletContext();

		_selResourceDescription = PortalUtil.getPortletTitle(
			portlet, servletContext, themeDisplay.getLocale());

		return _selResourceDescription;
	}

	public PortletURL getUpdateRolePermissionsURL()
		throws ResourcePrimKeyException, WindowStateException {

		int cur = ParamUtil.getInteger(
			_request, SearchContainer.DEFAULT_CUR_PARAM);
		int delta = ParamUtil.getInteger(
			_request, SearchContainer.DEFAULT_DELTA_PARAM);

		PortletURL portletURL = PortletURLFactoryUtil.create(
			_request, PortletConfigurationPortletKeys.PORTLET_CONFIGURATION,
			PortletRequest.ACTION_PHASE);

		portletURL.setParameter(
			ActionRequest.ACTION_NAME, "updateRolePermissions");
		portletURL.setParameter("mvcPath", "/edit_permissions.jsp");
		portletURL.setParameter("cur", String.valueOf(cur));
		portletURL.setParameter("delta", String.valueOf(delta));
		portletURL.setParameter(
			"returnToFullPageURL", _getReturnToFullPageURL());
		portletURL.setParameter(
			"portletConfiguration", Boolean.TRUE.toString());
		portletURL.setParameter("portletResource", _getPortletResource());
		portletURL.setParameter("modelResource", getModelResource());
		portletURL.setParameter(
			"modelResourceDescription", getModelResourceDescription());
		portletURL.setParameter(
			"resourceGroupId", String.valueOf(_getResourceGroupId()));
		portletURL.setParameter("resourcePrimKey", getResourcePrimKey());
		portletURL.setParameter("roleTypes", _getRoleTypesParam());

		portletURL.setWindowState(LiferayWindowState.POP_UP);

		return portletURL;
	}

	private String _getPortletResource() {
		if (_portletResource != null) {
			return _portletResource;
		}

		_portletResource = ParamUtil.getString(_request, "portletResource");

		return _portletResource;
	}

	private long _getResourceGroupId() {
		if (_resourceGroupId != null) {
			return _resourceGroupId;
		}

		ThemeDisplay themeDisplay = (ThemeDisplay)_request.getAttribute(
			WebKeys.THEME_DISPLAY);

		_resourceGroupId = ParamUtil.getLong(_request, "resourceGroupId");

		if (_resourceGroupId == 0) {
			_resourceGroupId = themeDisplay.getScopeGroupId();
		}

		return _resourceGroupId;
	}

	private String _getReturnToFullPageURL() {
		if (_returnToFullPageURL != null) {
			return _returnToFullPageURL;
		}

		_returnToFullPageURL = ParamUtil.getString(
			_request, "returnToFullPageURL");

		return _returnToFullPageURL;
	}

	private String _getRoleTypesParam() {
		if (_roleTypesParam != null) {
			return _roleTypesParam;
		}

		_roleTypesParam = ParamUtil.getString(_request, "roleTypes");

		return _roleTypesParam;
	}

	private List<String> _actions;
	private Group _group;
	private final long _groupId;
	private List<String> _guestUnsupportedActions;
	private String _modelResource;
	private String _modelResourceDescription;
	private String _portletResource;
	private final RenderRequest _renderRequest;
	private final HttpServletRequest _request;
	private Resource _resource;
	private Long _resourceGroupId;
	private String _resourcePrimKey;
	private String _returnToFullPageURL;
	private SearchContainer _roleSearchContainer;
	private int[] _roleTypes;
	private String _roleTypesParam;
	private final Layout _selLayout;
	private String _selResource;
	private String _selResourceDescription;

}