UserSegmentIndexer.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.util;

import com.liferay.content.targeting.model.UserSegment;
import com.liferay.content.targeting.service.UserSegmentLocalServiceUtil;
import com.liferay.content.targeting.service.permission.UserSegmentPermission;
import com.liferay.content.targeting.service.persistence.UserSegmentActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.search.BaseIndexer;
import com.liferay.portal.kernel.search.BooleanQuery;
import com.liferay.portal.kernel.search.Document;
import com.liferay.portal.kernel.search.DocumentImpl;
import com.liferay.portal.kernel.search.Field;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.search.SearchEngineUtil;
import com.liferay.portal.kernel.search.Summary;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.security.permission.ActionKeys;
import com.liferay.portal.security.permission.PermissionChecker;

import java.util.Locale;

import javax.portlet.PortletURL;

/**
 * @author Eudaldo Alonso
 */
public class UserSegmentIndexer extends BaseIndexer {

	public static final String[] CLASS_NAMES = {UserSegment.class.getName()};

	public static final String PORTLET_ID = PortletKeys.CT_CORE;

	public UserSegmentIndexer() {
		setFilterSearch(true);
		setPermissionAware(true);
	}

	@Override
	public String[] getClassNames() {
		return CLASS_NAMES;
	}

	@Override
	public String getPortletId() {
		return PORTLET_ID;
	}

	@Override
	public boolean hasPermission(
			PermissionChecker permissionChecker, String entryClassName,
			long entryClassPK, String actionId)
		throws Exception {

		UserSegment userSegment = UserSegmentLocalServiceUtil.getUserSegment(
			entryClassPK);

		return UserSegmentPermission.contains(
			permissionChecker, userSegment, ActionKeys.VIEW);
	}

	@Override
	public void postProcessSearchQuery(
			BooleanQuery searchQuery, SearchContext searchContext)
		throws Exception {

		addSearchLocalizedTerm(
			searchQuery, searchContext, Field.DESCRIPTION, true);
		addSearchLocalizedTerm(searchQuery, searchContext, Field.NAME, true);
	}

	@Override
	protected void doDelete(Object obj) throws Exception {
		UserSegment userSegment = (UserSegment)obj;

		Document document = new DocumentImpl();

		document.addUID(PORTLET_ID, userSegment.getUserSegmentId());

		SearchEngineUtil.deleteDocument(
			getSearchEngineId(), userSegment.getCompanyId(),
			document.get(Field.UID));
	}

	@Override
	protected Document doGetDocument(Object obj) throws Exception {
		UserSegment userSegment = (UserSegment)obj;

		if (_log.isDebugEnabled()) {
			_log.debug("Indexing user segment " + userSegment);
		}

		Document document = getBaseModelDocument(PORTLET_ID, userSegment);

		document.addLocalizedText(
			Field.DESCRIPTION, userSegment.getDescriptionMap());
		document.addLocalizedText(Field.NAME, userSegment.getNameMap());

		document.addKeyword("userSegmentId", userSegment.getUserSegmentId());

		if (_log.isDebugEnabled()) {
			_log.debug("User segment " + userSegment + " indexed successfully");
		}

		return document;
	}

	@Override
	protected Summary doGetSummary(
		Document document, Locale locale, String snippet,
		PortletURL portletURL) {

		return null;
	}

	@Override
	protected void doReindex(Object obj) throws Exception {
		UserSegment userSegment = (UserSegment)obj;

		Document document = getDocument(userSegment);

		if (document != null) {
			SearchEngineUtil.updateDocument(
				getSearchEngineId(), userSegment.getCompanyId(), document);
		}
	}

	@Override
	protected void doReindex(String className, long classPK) throws Exception {
		UserSegment userSegment = UserSegmentLocalServiceUtil.getUserSegment(
			classPK);

		doReindex(userSegment);
	}

	@Override
	protected void doReindex(String[] ids) throws Exception {
		long companyId = GetterUtil.getLong(ids[0]);

		reindexUserSegments(companyId);
	}

	@Override
	protected String getPortletId(SearchContext searchContext) {
		return PORTLET_ID;
	}

	protected void reindexUserSegments(final long companyId)
		throws PortalException, SystemException {

		ActionableDynamicQuery actionableDynamicQuery =
			new UserSegmentActionableDynamicQuery() {

			@Override
			protected void performAction(Object object) {
				UserSegment userSegment = (UserSegment)object;

				try {
					Document document = getDocument(userSegment);

					if (document != null) {
						addDocument(document);
					}
				}
				catch (PortalException e) {
					if (_log.isWarnEnabled()) {
						_log.warn(
							"Unable to index user segment: " +
								userSegment.getUserSegmentId(),
							e);
					}
				}
			}

		};

		actionableDynamicQuery.setCompanyId(companyId);
		actionableDynamicQuery.setSearchEngineId(getSearchEngineId());

		actionableDynamicQuery.performActions();
	}

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

}