• Home
• com.liferay
• com.liferay.cookies.impl
• 6.0.12
• source code
• CookiesConfigurationProviderImpl.java

×

Project download

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.cookies.internal.configuration.provider.CookiesConfigurationProviderImpl Maven / Gradle / Ivy

/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.cookies.internal.configuration.provider;

import com.liferay.configuration.admin.constants.ConfigurationAdminPortletKeys;
import com.liferay.cookies.configuration.CookiesConfigurationProvider;
import com.liferay.cookies.configuration.CookiesPreferenceHandlingConfiguration;
import com.liferay.cookies.configuration.banner.CookiesBannerConfiguration;
import com.liferay.cookies.configuration.consent.CookiesConsentConfiguration;
import com.liferay.cookies.internal.configuration.admin.service.CookiesPreferenceHandlingManagedServiceFactory;
import com.liferay.petra.string.StringBundler;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.configuration.metatype.annotations.ExtendedObjectClassDefinition;
import com.liferay.portal.configuration.module.configuration.ConfigurationProvider;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.LayoutSet;
import com.liferay.portal.kernel.module.configuration.ConfigurationException;
import com.liferay.portal.kernel.portlet.url.builder.PortletURLBuilder;
import com.liferay.portal.kernel.security.permission.PermissionChecker;
import com.liferay.portal.kernel.security.permission.PermissionCheckerFactory;
import com.liferay.portal.kernel.service.LayoutSetLocalService;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.util.HashMapDictionary;
import com.liferay.portal.kernel.util.HashMapDictionaryBuilder;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.kernel.util.Portal;
import com.liferay.portal.kernel.util.WebKeys;

import java.io.IOException;

import java.util.Dictionary;
import java.util.function.Function;
import java.util.function.Supplier;

import javax.portlet.PortletRequest;

import javax.servlet.http.HttpServletRequest;

import org.osgi.framework.InvalidSyntaxException;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;
import org.osgi.service.cm.ManagedServiceFactory;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

/**
 * @author Daniel Sanz
 */
@Component(service = CookiesConfigurationProvider.class)
public class CookiesConfigurationProviderImpl
	implements CookiesConfigurationProvider {

	@Override
	public String getCompanyConfigurationURL(
			HttpServletRequest httpServletRequest)
		throws PortalException {

		PermissionChecker permissionChecker = _permissionCheckerFactory.create(
			_portal.getUser(httpServletRequest));

		if (!permissionChecker.isCompanyAdmin()) {
			return null;
		}

		String factoryPid =
			CookiesPreferenceHandlingConfiguration.class.getName();

		String pid = factoryPid;

		Configuration configuration =
			_getCookiesPreferenceHandlingCompanyConfiguration(
				_portal.getCompanyId(httpServletRequest));

		if (configuration != null) {
			pid = configuration.getPid();
		}

		return PortletURLBuilder.create(
			_portal.getControlPanelPortletURL(
				httpServletRequest,
				ConfigurationAdminPortletKeys.INSTANCE_SETTINGS,
				PortletRequest.RENDER_PHASE)
		).setMVCRenderCommandName(
			"/configuration_admin/edit_configuration"
		).setRedirect(
			ParamUtil.getString(
				httpServletRequest, "backURL",
				_portal.getCurrentCompleteURL(httpServletRequest))
		).setParameter(
			"factoryPid", factoryPid
		).setParameter(
			"pid", pid
		).buildString();
	}

	@Override
	public CookiesBannerConfiguration getCookiesBannerConfiguration(
			ThemeDisplay themeDisplay)
		throws Exception {

		return _getCookiesConfiguration(
			CookiesBannerConfiguration.class, themeDisplay);
	}

	@Override
	public CookiesConsentConfiguration getCookiesConsentConfiguration(
			ThemeDisplay themeDisplay)
		throws Exception {

		return _getCookiesConfiguration(
			CookiesConsentConfiguration.class, themeDisplay);
	}

	@Override
	public CookiesPreferenceHandlingConfiguration
			getCookiesPreferenceHandlingConfiguration(ThemeDisplay themeDisplay)
		throws Exception {

		return _getCookiesConfiguration(
			CookiesPreferenceHandlingConfiguration.class, themeDisplay);
	}

	@Override
	public String getGroupConfigurationURL(
			HttpServletRequest httpServletRequest)
		throws PortalException {

		PermissionChecker permissionChecker = _permissionCheckerFactory.create(
			_portal.getUser(httpServletRequest));

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

		if (!permissionChecker.isGroupAdmin(themeDisplay.getScopeGroupId())) {
			return null;
		}

		String factoryPid =
			CookiesPreferenceHandlingConfiguration.class.getName();

		String pid = factoryPid;

		Configuration configuration =
			_getCookiesPreferenceHandlingGroupConfiguration(
				themeDisplay.getScopeGroupId());

		if (configuration != null) {
			pid = configuration.getPid();
		}

		return PortletURLBuilder.create(
			_portal.getControlPanelPortletURL(
				httpServletRequest, ConfigurationAdminPortletKeys.SITE_SETTINGS,
				PortletRequest.RENDER_PHASE)
		).setMVCRenderCommandName(
			"/configuration_admin/edit_configuration"
		).setRedirect(
			ParamUtil.getString(
				httpServletRequest, "backURL",
				_portal.getCurrentCompleteURL(httpServletRequest))
		).setParameter(
			"factoryPid", factoryPid
		).setParameter(
			"pid", pid
		).buildString();
	}

	@Override
	public String getSystemConfigurationURL(
			HttpServletRequest httpServletRequest)
		throws PortalException {

		PermissionChecker permissionChecker = _permissionCheckerFactory.create(
			_portal.getUser(httpServletRequest));

		if (!permissionChecker.isOmniadmin()) {
			return null;
		}

		return PortletURLBuilder.create(
			_portal.getControlPanelPortletURL(
				httpServletRequest,
				ConfigurationAdminPortletKeys.SYSTEM_SETTINGS,
				PortletRequest.RENDER_PHASE)
		).setMVCRenderCommandName(
			"/configuration_admin/edit_configuration"
		).setRedirect(
			_portal.getCurrentCompleteURL(httpServletRequest)
		).setParameter(
			"factoryPid", CookiesPreferenceHandlingConfiguration.class.getName()
		).buildString();
	}

	@Override
	public boolean isCookiesPreferenceHandlingConfigurationDefined(
			ExtendedObjectClassDefinition.Scope scope, long scopePK)
		throws Exception {

		if (scope == ExtendedObjectClassDefinition.Scope.SYSTEM) {
			try {
				CookiesPreferenceHandlingConfiguration
					cookiesPreferenceHandlingConfiguration =
						_configurationProvider.getSystemConfiguration(
							CookiesPreferenceHandlingConfiguration.class);

				if (cookiesPreferenceHandlingConfiguration != null) {
					return true;
				}
			}
			catch (ConfigurationException configurationException) {
				_log.error(configurationException);

				return false;
			}
		}

		if (_getScopedConfiguration(scope, scopePK) == null) {
			return false;
		}

		return true;
	}

	@Override
	public boolean isCookiesPreferenceHandlingEnabled(
		ExtendedObjectClassDefinition.Scope scope, long scopePK) {

		return _getScopeConfigurationAttribute(
			scope, scopePK, this::_isCompanyCookiesPreferenceHandlingEnabled,
			this::_isGroupCookiesPreferenceHandlingEnabled,
			this::_isSystemCookiesPreferenceHandlingEnabled);
	}

	@Override
	public boolean isCookiesPreferenceHandlingExplicitConsentMode(
		ExtendedObjectClassDefinition.Scope scope, long scopePK) {

		return _getScopeConfigurationAttribute(
			scope, scopePK,
			this::_isCompanyCookiesPreferenceHandlingExplicitConsentMode,
			this::_isGroupCookiesPreferenceHandlingExplicitConsentMode,
			this::_isSystemCookiesPreferenceHandlingExplicitConsentMode);
	}

	@Override
	public void resetCookiesPreferenceHandlingConfiguration(
			ExtendedObjectClassDefinition.Scope scope, long scopePK)
		throws ConfigurationException {

		if (scope == ExtendedObjectClassDefinition.Scope.COMPANY) {
			_configurationProvider.deleteCompanyConfiguration(
				CookiesPreferenceHandlingConfiguration.class, scopePK);
		}
		else if (scope == ExtendedObjectClassDefinition.Scope.GROUP) {
			_configurationProvider.deleteGroupConfiguration(
				CookiesPreferenceHandlingConfiguration.class, scopePK);
		}
		else if (scope == ExtendedObjectClassDefinition.Scope.SYSTEM) {
			_configurationProvider.deleteSystemConfiguration(
				CookiesPreferenceHandlingConfiguration.class);
		}
	}

	@Override
	public void updateCookiesPreferenceHandlingConfiguration(
			boolean enabled, boolean explicitConsentMode,
			ExtendedObjectClassDefinition.Scope scope, long scopePK)
		throws Exception {

		Dictionary dictionary = _createDictionary(
			enabled, explicitConsentMode);

		if (scope == ExtendedObjectClassDefinition.Scope.COMPANY) {
			_configurationProvider.saveCompanyConfiguration(
				CookiesPreferenceHandlingConfiguration.class, scopePK,
				dictionary);
		}
		else if (scope == ExtendedObjectClassDefinition.Scope.GROUP) {
			_configurationProvider.saveGroupConfiguration(
				CookiesPreferenceHandlingConfiguration.class, scopePK,
				dictionary);
		}
		else if (scope == ExtendedObjectClassDefinition.Scope.SYSTEM) {
			_configurationProvider.saveSystemConfiguration(
				CookiesPreferenceHandlingConfiguration.class, dictionary);
		}
		else {
			throw new IllegalArgumentException("Unsupported scope: " + scope);
		}
	}

	private HashMapDictionary _createDictionary(
		boolean enabled, boolean explicitConsentMode) {

		return HashMapDictionaryBuilder.put(
			"enabled", enabled
		).put(
			"explicitConsentMode", explicitConsentMode
		).build();
	}

	private  T _getCookiesConfiguration(
			Class clazz, ThemeDisplay themeDisplay)
		throws Exception {

		LayoutSet layoutSet = _layoutSetLocalService.fetchLayoutSet(
			themeDisplay.getServerName());

		if (layoutSet != null) {
			Group group = layoutSet.getGroup();

			return _configurationProvider.getGroupConfiguration(
				clazz, group.getGroupId());
		}

		return _configurationProvider.getCompanyConfiguration(
			clazz, themeDisplay.getCompanyId());
	}

	private Configuration _getCookiesPreferenceHandlingCompanyConfiguration(
			long companyId)
		throws ConfigurationException {

		try {
			String filterString = StringBundler.concat(
				"(&(", ConfigurationAdmin.SERVICE_FACTORYPID, StringPool.EQUAL,
				CookiesPreferenceHandlingConfiguration.class.getName(),
				".scoped)(companyId=", companyId, "))");

			Configuration[] configuration =
				_configurationAdmin.listConfigurations(filterString);

			if (configuration != null) {
				return configuration[0];
			}

			return null;
		}
		catch (InvalidSyntaxException | IOException exception) {
			throw new ConfigurationException(exception);
		}
	}

	private Configuration _getCookiesPreferenceHandlingGroupConfiguration(
			long groupId)
		throws ConfigurationException {

		try {
			String filterString = StringBundler.concat(
				"(&(", ConfigurationAdmin.SERVICE_FACTORYPID, StringPool.EQUAL,
				CookiesPreferenceHandlingConfiguration.class.getName(),
				".scoped)(groupId=", groupId, "))");

			Configuration[] configuration =
				_configurationAdmin.listConfigurations(filterString);

			if (configuration != null) {
				return configuration[0];
			}

			return null;
		}
		catch (InvalidSyntaxException | IOException exception) {
			throw new ConfigurationException(exception);
		}
	}

	private  T _getScopeConfigurationAttribute(
		ExtendedObjectClassDefinition.Scope scope, long scopePK,
		Function companyFunction, Function groupFunction,
		Supplier systemFunction) {

		if (scope == ExtendedObjectClassDefinition.Scope.COMPANY) {
			return companyFunction.apply(scopePK);
		}
		else if (scope == ExtendedObjectClassDefinition.Scope.GROUP) {
			return groupFunction.apply(scopePK);
		}
		else if (scope == ExtendedObjectClassDefinition.Scope.SYSTEM) {
			return systemFunction.get();
		}

		throw new IllegalArgumentException("Unsupported scope: " + scope);
	}

	private Configuration _getScopedConfiguration(
			ExtendedObjectClassDefinition.Scope scope, long scopePK)
		throws Exception {

		Configuration[] configurations = _configurationAdmin.listConfigurations(
			String.format(
				"(&(service.factoryPid=%s)(%s=%d))",
				CookiesPreferenceHandlingConfiguration.class.getName() +
					".scoped",
				scope.getPropertyKey(), scopePK));

		if (configurations == null) {
			return null;
		}

		return configurations[0];
	}

	private boolean _isCompanyCookiesPreferenceHandlingEnabled(long companyId) {
		if (_cookiesPreferenceHandlingManagedServiceFactory == null) {
			_cookiesPreferenceHandlingManagedServiceFactory =
				(CookiesPreferenceHandlingManagedServiceFactory)
					_managedServiceFactory;
		}

		return _cookiesPreferenceHandlingManagedServiceFactory.
			getCompanyEnabled(companyId);
	}

	private boolean _isCompanyCookiesPreferenceHandlingExplicitConsentMode(
		long companyId) {

		if (_cookiesPreferenceHandlingManagedServiceFactory == null) {
			_cookiesPreferenceHandlingManagedServiceFactory =
				(CookiesPreferenceHandlingManagedServiceFactory)
					_managedServiceFactory;
		}

		return _cookiesPreferenceHandlingManagedServiceFactory.
			getCompanyExplicitConsentMode(companyId);
	}

	private boolean _isGroupCookiesPreferenceHandlingEnabled(long groupId) {
		if (_cookiesPreferenceHandlingManagedServiceFactory == null) {
			_cookiesPreferenceHandlingManagedServiceFactory =
				(CookiesPreferenceHandlingManagedServiceFactory)
					_managedServiceFactory;
		}

		return _cookiesPreferenceHandlingManagedServiceFactory.getGroupEnabled(
			groupId);
	}

	private boolean _isGroupCookiesPreferenceHandlingExplicitConsentMode(
		long groupId) {

		if (_cookiesPreferenceHandlingManagedServiceFactory == null) {
			_cookiesPreferenceHandlingManagedServiceFactory =
				(CookiesPreferenceHandlingManagedServiceFactory)
					_managedServiceFactory;
		}

		return _cookiesPreferenceHandlingManagedServiceFactory.
			getGroupExplicitConsentMode(groupId);
	}

	private boolean _isSystemCookiesPreferenceHandlingEnabled() {
		if (_cookiesPreferenceHandlingManagedServiceFactory == null) {
			_cookiesPreferenceHandlingManagedServiceFactory =
				(CookiesPreferenceHandlingManagedServiceFactory)
					_managedServiceFactory;
		}

		return _cookiesPreferenceHandlingManagedServiceFactory.
			getSystemEnabled();
	}

	private boolean _isSystemCookiesPreferenceHandlingExplicitConsentMode() {
		if (_cookiesPreferenceHandlingManagedServiceFactory == null) {
			_cookiesPreferenceHandlingManagedServiceFactory =
				(CookiesPreferenceHandlingManagedServiceFactory)
					_managedServiceFactory;
		}

		return _cookiesPreferenceHandlingManagedServiceFactory.
			getSystemExplicitConsentMode();
	}

	private static final Log _log = LogFactoryUtil.getLog(
		CookiesConfigurationProviderImpl.class);

	@Reference
	private ConfigurationAdmin _configurationAdmin;

	@Reference
	private ConfigurationProvider _configurationProvider;

	private CookiesPreferenceHandlingManagedServiceFactory
		_cookiesPreferenceHandlingManagedServiceFactory;

	@Reference
	private LayoutSetLocalService _layoutSetLocalService;

	@Reference(
		target = "(component.name=com.liferay.cookies.internal.configuration.admin.service.CookiesPreferenceHandlingManagedServiceFactory)"
	)
	private ManagedServiceFactory _managedServiceFactory;

	@Reference
	private PermissionCheckerFactory _permissionCheckerFactory;

	@Reference
	private Portal _portal;

}