ContentVisitedRule.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.content.targeting.rule.visited;

import com.liferay.content.targeting.InvalidRuleException;
import com.liferay.content.targeting.analytics.service.AnalyticsEventLocalService;
import com.liferay.content.targeting.analytics.util.AnalyticsUtil;
import com.liferay.content.targeting.anonymous.users.model.AnonymousUser;
import com.liferay.content.targeting.api.model.BaseRule;
import com.liferay.content.targeting.api.model.Rule;
import com.liferay.content.targeting.lar.AssetEntryReferencedStagedModel;
import com.liferay.content.targeting.lar.ContentTargetingPortletDataHandler;
import com.liferay.content.targeting.model.RuleInstance;
import com.liferay.content.targeting.model.UserSegment;
import com.liferay.content.targeting.rule.categories.BehaviorRuleCategory;
import com.liferay.content.targeting.util.ContentTargetingContextUtil;
import com.liferay.content.targeting.util.ContentTargetingUtil;
import com.liferay.content.targeting.util.WebKeys;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.lar.ExportImportPathUtil;
import com.liferay.portal.kernel.lar.PortletDataContext;
import com.liferay.portal.kernel.lar.PortletDataException;
import com.liferay.portal.kernel.lar.StagedModelDataHandlerUtil;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.util.Constants;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.StringPool;
import com.liferay.portal.kernel.xml.Element;
import com.liferay.portal.model.Company;
import com.liferay.portal.theme.ThemeDisplay;
import com.liferay.portlet.asset.AssetRendererFactoryRegistryUtil;
import com.liferay.portlet.asset.model.AssetEntry;
import com.liferay.portlet.asset.model.AssetRenderer;
import com.liferay.portlet.asset.model.AssetRendererFactory;
import com.liferay.portlet.asset.service.AssetEntryLocalServiceUtil;

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

import javax.portlet.PortletRequest;
import javax.portlet.PortletResponse;
import javax.portlet.RenderRequest;

import javax.servlet.http.HttpServletRequest;

import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;

/**
 * @author Eudaldo Alonso
 */
@Component(immediate = true, service = Rule.class)
public class ContentVisitedRule extends BaseRule {

	@Activate
	@Override
	public void activate() {
		super.activate();
	}

	@Deactivate
	@Override
	public void deActivate() {
		super.deActivate();
	}

	@Override
	public boolean evaluate(
			HttpServletRequest request, RuleInstance ruleInstance,
			AnonymousUser anonymousUser)
		throws Exception {

		long assetEntryId = GetterUtil.getLong(ruleInstance.getTypeSettings());

		AssetEntry assetEntry = AssetEntryLocalServiceUtil.fetchEntry(
			assetEntryId);

		if (assetEntry == null) {
			return false;
		}

		int count = _analyticsEventLocalService.getAnalyticsEventsCount(
			anonymousUser.getAnonymousUserId(), assetEntry.getClassName(),
			assetEntry.getClassPK(), "view");

		return count > 0;
	}

	@Override
	public void exportData(
			PortletDataContext portletDataContext, Element userSegmentElement,
			UserSegment userSegment, Element ruleInstanceElement,
			RuleInstance ruleInstance)
		throws Exception {

		long assetEntryId = GetterUtil.getLong(ruleInstance.getTypeSettings());

		AssetEntry assetEntry = AssetEntryLocalServiceUtil.fetchEntry(
			assetEntryId);

		if (assetEntry == null) {
			throw new PortletDataException(
				getExportImportErrorMessage(
					userSegment, ruleInstance, AssetEntry.class.getName(),
					String.valueOf(assetEntryId), Constants.EXPORT));
		}

		ruleInstance.setTypeSettings(assetEntry.getClassUuid());

		AssetEntryReferencedStagedModel assetEntryReferencedStagedModel =
			new AssetEntryReferencedStagedModel(assetEntry);

		if (portletDataContext.getBooleanParameter(
				ContentTargetingPortletDataHandler.NAMESPACE,
				"user-segment-referenced-content")) {

			try {
				StagedModelDataHandlerUtil.exportReferenceStagedModel(
					portletDataContext, ruleInstance, ruleInstanceElement,
					assetEntryReferencedStagedModel,
					AssetEntryReferencedStagedModel.class,
					PortletDataContext.REFERENCE_TYPE_WEAK);

				return;
			}
			catch (Exception e) {
				if (_log.isWarnEnabled()) {
					_log.warn(
						"Cannot export referenced content for rule " +
							"instance with id " +
								ruleInstance.getRuleInstanceId());
				}
			}
		}

		portletDataContext.addReferenceElement(
			ruleInstance, ruleInstanceElement, assetEntryReferencedStagedModel,
			AssetEntryReferencedStagedModel.class,
			PortletDataContext.REFERENCE_TYPE_WEAK, true);

		Element assetEntryReferencedStagedModelElement =
			portletDataContext.getExportDataElement(
				assetEntryReferencedStagedModel);

		portletDataContext.addClassedModel(
			assetEntryReferencedStagedModelElement,
			ExportImportPathUtil.getModelPath(assetEntryReferencedStagedModel),
			assetEntryReferencedStagedModel);
	}

	@Override
	public String getIcon() {
		return "icon-file-text";
	}

	@Override
	public String getRuleCategoryKey() {
		return BehaviorRuleCategory.KEY;
	}

	@Override
	public String getSummary(RuleInstance ruleInstance, Locale locale) {
		long assetEntryId = GetterUtil.getLong(ruleInstance.getTypeSettings());

		AssetEntry assetEntry = null;

		try {
			assetEntry = AssetEntryLocalServiceUtil.fetchEntry(assetEntryId);
		}
		catch (SystemException e) {
		}

		if (assetEntry != null) {
			return assetEntry.getTitle(locale);
		}

		return StringPool.BLANK;
	}

	@Override
	public void importData(
			PortletDataContext portletDataContext, UserSegment userSegment,
			RuleInstance ruleInstance)
		throws Exception {

		if (portletDataContext.getBooleanParameter(
				ContentTargetingPortletDataHandler.NAMESPACE,
				"user-segment-referenced-content")) {

			StagedModelDataHandlerUtil.importReferenceStagedModels(
				portletDataContext, ruleInstance,
				AssetEntryReferencedStagedModel.class);
		}

		String classUuid = ruleInstance.getTypeSettings();

		AssetEntry assetEntry = AssetEntryLocalServiceUtil.fetchEntry(
			portletDataContext.getScopeGroupId(), classUuid);

		if (assetEntry != null ) {
			ruleInstance.setTypeSettings(
				String.valueOf(assetEntry.getEntryId()));

			return;
		}

		throw new PortletDataException(
			getExportImportErrorMessage(
				userSegment, ruleInstance, AssetEntry.class.getName(),
				classUuid, Constants.IMPORT));
	}

	@Override
	public String processRule(
			PortletRequest request, PortletResponse response, String id,
			Map<String, String> values)
		throws InvalidRuleException {

		long assetEntryId = GetterUtil.getLong(values.get("assetEntryId"));

		if (assetEntryId > 0) {
			AssetEntry assetEntry = null;

			try {
				assetEntry = AssetEntryLocalServiceUtil.fetchAssetEntry(
					assetEntryId);
			}
			catch (SystemException e) {
				_log.error(e);
			}

			if (assetEntry == null) {
				throw new InvalidRuleException(
					"the-selected-content-can-not-be-found");
			}

			return String.valueOf(assetEntryId);
		}
		else {
			throw new InvalidRuleException("please-select-some-content");
		}
	}

	@Reference
	public void setAnalyticsEventLocalService(
		AnalyticsEventLocalService analyticsEventLocalService) {

		_analyticsEventLocalService = analyticsEventLocalService;
	}

	protected String getFormTemplatePath() {
		return _FORM_TEMPLATE_PATH_CONTENT;
	}

	protected List<AssetRendererFactory> getSelectableAssetRendererFactories(
		long companyId) {

		List<AssetRendererFactory> selectableAssetRendererFactories =
			new ArrayList<AssetRendererFactory>();

		List<AssetRendererFactory> assetRendererFactories =
			AssetRendererFactoryRegistryUtil.getAssetRendererFactories(
				companyId);

		for (AssetRendererFactory rendererFactory : assetRendererFactories) {
			if (!rendererFactory.isSelectable()) {
				continue;
			}

			selectableAssetRendererFactories.add(rendererFactory);
		}

		return selectableAssetRendererFactories;
	}

	@Override
	protected void populateContext(
		RuleInstance ruleInstance, Map<String, Object> context,
		Map<String, String> values) {

		long assetEntryId = 0;

		if (!values.isEmpty()) {
			assetEntryId = GetterUtil.getLong(values.get("assetEntryId"));
		}
		else if (ruleInstance != null) {
			assetEntryId = GetterUtil.getLong(ruleInstance.getTypeSettings());
		}

		context.put("assetEntryId", assetEntryId);

		String assetImage = StringPool.BLANK;
		String assetTitle = StringPool.BLANK;
		String assetType = StringPool.BLANK;

		if (assetEntryId > 0) {
			try {
				RenderRequest renderRequest = (RenderRequest)context.get(
					"renderRequest");

				AssetEntry assetEntry =
					AssetEntryLocalServiceUtil.fetchAssetEntry(assetEntryId);

				if (assetEntry != null) {
					AssetRendererFactory assetRendererFactory =
						AssetRendererFactoryRegistryUtil.
							getAssetRendererFactoryByClassName(
								assetEntry.getClassName());

					AssetRenderer assetRenderer =
						assetRendererFactory.getAssetRenderer(
							assetEntry.getClassPK());

					assetImage = assetRenderer.getThumbnailPath(renderRequest);

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

					assetTitle = assetRenderer.getTitle(
						themeDisplay.getLocale());
					assetType = assetRendererFactory.getTypeName(
						themeDisplay.getLocale(), true);
				}
			}
			catch (Exception e) {
				_log.error(e);
			}
		}

		context.put("assetImage", assetImage);
		context.put("assetTitle", assetTitle);
		context.put("assetType", assetType);

		Company company = (Company)context.get("company");

		context.put(
			"assetRendererFactories",
			getSelectableAssetRendererFactories(company.getCompanyId()));

		long groupId = (Long)context.get("scopeGroupId");

		boolean trackingContentEnabled =
			AnalyticsUtil.isAnalyticsContentEnabled(groupId);

		context.put("trackingContentEnabled", trackingContentEnabled);

		if (!trackingContentEnabled) {
			ContentTargetingContextUtil.populateContextAnalyticsSettingsURLs(
				context);
		}

		context.put("contentTargetingUtilClass", new ContentTargetingUtil());
	}

	private static final String _FORM_TEMPLATE_PATH_CONTENT =
		"templates/ct_fields_content.ftl";

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

	private AnalyticsEventLocalService _analyticsEventLocalService;

}