• Home
• com.liferay.commerce
• com.liferay.commerce.product.service
• 6.0.151
• source code
• CPDisplayLayoutIndexer.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.commerce.product.internal.search.CPDisplayLayoutIndexer 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.commerce.product.internal.search;

import com.liferay.asset.kernel.model.AssetCategory;
import com.liferay.asset.kernel.service.AssetCategoryLocalService;
import com.liferay.commerce.product.constants.CPDisplayLayoutConstants;
import com.liferay.commerce.product.constants.CPField;
import com.liferay.commerce.product.model.CPDefinition;
import com.liferay.commerce.product.model.CPDisplayLayout;
import com.liferay.commerce.product.model.CommerceCatalog;
import com.liferay.commerce.product.service.CPDefinitionLocalService;
import com.liferay.commerce.product.service.CPDisplayLayoutLocalService;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
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.search.BaseIndexer;
import com.liferay.portal.kernel.search.BooleanClauseOccur;
import com.liferay.portal.kernel.search.BooleanQuery;
import com.liferay.portal.kernel.search.Document;
import com.liferay.portal.kernel.search.Field;
import com.liferay.portal.kernel.search.IndexWriterHelper;
import com.liferay.portal.kernel.search.Indexer;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.search.Summary;
import com.liferay.portal.kernel.search.filter.BooleanFilter;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.HtmlUtil;
import com.liferay.portal.kernel.util.LocaleUtil;
import com.liferay.portal.kernel.util.Localization;
import com.liferay.portal.kernel.util.Portal;
import com.liferay.portal.kernel.util.Validator;

import java.io.Serializable;

import java.util.Locale;
import java.util.Map;

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

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

/**
 * @author Alessio Antonio Rendina
 */
@Component(service = Indexer.class)
public class CPDisplayLayoutIndexer extends BaseIndexer {

	public static final String CLASS_NAME = CPDisplayLayout.class.getName();

	public static final String FIELD_ENTRY_MODEL_CLASS_NAME =
		"entryModelClassName";

	public CPDisplayLayoutIndexer() {
		setDefaultSelectedFieldNames(
			Field.ENTRY_CLASS_NAME, Field.ENTRY_CLASS_PK, Field.UID);
		setFilterSearch(false);
		setPermissionAware(false);
	}

	@Override
	public String getClassName() {
		return CLASS_NAME;
	}

	@Override
	public void postProcessContextBooleanFilter(
			BooleanFilter contextBooleanFilter, SearchContext searchContext)
		throws Exception {

		Map attributes = searchContext.getAttributes();

		String entryModelClassName = (String)attributes.get(
			FIELD_ENTRY_MODEL_CLASS_NAME);

		if (Validator.isNotNull(entryModelClassName)) {
			contextBooleanFilter.addTerm(
				FIELD_ENTRY_MODEL_CLASS_NAME, entryModelClassName,
				BooleanClauseOccur.MUST);
		}

		String groupId = GetterUtil.getString(attributes.get(Field.GROUP_ID));

		if (Validator.isNotNull(groupId)) {
			contextBooleanFilter.addTerm(
				Field.GROUP_ID, groupId, BooleanClauseOccur.MUST);
		}

		Integer type = (Integer)attributes.get(Field.TYPE);

		if (type != null) {
			contextBooleanFilter.addRequiredTerm(Field.TYPE, type);
		}
	}

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

		addSearchTerm(searchQuery, searchContext, Field.ENTRY_CLASS_PK, false);
	}

	@Override
	protected void doDelete(CPDisplayLayout cpDisplayLayout) throws Exception {
		deleteDocument(
			cpDisplayLayout.getCompanyId(),
			cpDisplayLayout.getCPDisplayLayoutId());
	}

	@Override
	protected Document doGetDocument(CPDisplayLayout cpDisplayLayout)
		throws Exception {

		if (_log.isDebugEnabled()) {
			_log.debug(
				"Indexing commerce product display layout " + cpDisplayLayout);
		}

		Document document = getBaseModelDocument(CLASS_NAME, cpDisplayLayout);

		String className = cpDisplayLayout.getClassName();

		document.addKeyword(FIELD_ENTRY_MODEL_CLASS_NAME, className);

		if (className.equals(CPDefinition.class.getName())) {
			CPDefinition cpDefinition =
				_cpDefinitionLocalService.getCPDefinition(
					cpDisplayLayout.getClassPK());

			CommerceCatalog commerceCatalog = cpDefinition.getCommerceCatalog();

			document.addKeyword(
				CPField.COMMERCE_CATALOG_GROUP_ID, cpDefinition.getGroupId());

			Locale locale = LocaleUtil.fromLanguageId(
				commerceCatalog.getCatalogDefaultLanguageId());

			addLocalizedField(
				document, Field.TITLE, locale, cpDefinition.getNameMap());

			document.addText(
				Field.NAME,
				cpDefinition.getName(
					commerceCatalog.getCatalogDefaultLanguageId()));
		}

		if (className.equals(AssetCategory.class.getName())) {
			AssetCategory assetCategory =
				_assetCategoryLocalService.getAssetCategory(
					cpDisplayLayout.getClassPK());

			String[] availableLanguageIds =
				_localization.getAvailableLanguageIds(
					assetCategory.getDescription());

			for (String availableLanguageId : availableLanguageIds) {
				document.addText(
					_localization.getLocalizedName(
						Field.DESCRIPTION, availableLanguageId),
					HtmlUtil.stripHtml(
						assetCategory.getDescription(availableLanguageId)));
			}

			Locale siteDefaultLocale = _portal.getSiteDefaultLocale(
				assetCategory.getGroupId());

			document.addText(
				Field.DESCRIPTION,
				HtmlUtil.stripHtml(
					assetCategory.getDescription(siteDefaultLocale)));

			document.addText(Field.NAME, assetCategory.getName());

			addLocalizedField(
				document, Field.TITLE, siteDefaultLocale,
				assetCategory.getTitleMap());
		}

		document.addKeyword(Field.GROUP_ID, cpDisplayLayout.getGroupId());

		if (Validator.isNotNull(
				cpDisplayLayout.getLayoutPageTemplateEntryUuid())) {

			document.addKeyword(
				Field.TYPE,
				CPDisplayLayoutConstants.TYPE_LAYOUT_PAGE_TEMPLATE_ENTRY);
		}
		else if (Validator.isNotNull(cpDisplayLayout.getLayoutUuid())) {
			document.addKeyword(
				Field.TYPE, CPDisplayLayoutConstants.TYPE_LAYOUT);
		}

		if (_log.isDebugEnabled()) {
			_log.debug(
				"Commerce product display layout " + cpDisplayLayout +
					" indexed successfully");
		}

		return document;
	}

	@Override
	protected Summary doGetSummary(
		Document document, Locale locale, String snippet,
		PortletRequest portletRequest, PortletResponse portletResponse) {

		Summary summary = createSummary(
			document, Field.ENTRY_CLASS_PK, Field.ENTRY_CLASS_PK);

		summary.setMaxContentLength(200);

		return summary;
	}

	@Override
	protected void doReindex(CPDisplayLayout cpDisplayLayout) throws Exception {
		_indexWriterHelper.updateDocument(
			cpDisplayLayout.getCompanyId(), getDocument(cpDisplayLayout));
	}

	@Override
	protected void doReindex(String className, long classPK) throws Exception {
		doReindex(_cpDisplayLayoutLocalService.getCPDisplayLayout(classPK));
	}

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

		_reindexCPDisplayLayouts(companyId);
	}

	private void _reindexCPDisplayLayouts(long companyId) throws Exception {
		IndexableActionableDynamicQuery indexableActionableDynamicQuery =
			_cpDisplayLayoutLocalService.getIndexableActionableDynamicQuery();

		indexableActionableDynamicQuery.setCompanyId(companyId);
		indexableActionableDynamicQuery.setPerformActionMethod(
			(CPDisplayLayout cpDisplayLayout) -> {
				try {
					indexableActionableDynamicQuery.addDocuments(
						getDocument(cpDisplayLayout));
				}
				catch (PortalException portalException) {
					if (_log.isWarnEnabled()) {
						_log.warn(
							"Unable to index commerce product display layout " +
								cpDisplayLayout,
							portalException);
					}
				}
			});

		indexableActionableDynamicQuery.performActions();
	}

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

	@Reference
	private AssetCategoryLocalService _assetCategoryLocalService;

	@Reference
	private CPDefinitionLocalService _cpDefinitionLocalService;

	@Reference
	private CPDisplayLayoutLocalService _cpDisplayLayoutLocalService;

	@Reference
	private IndexWriterHelper _indexWriterHelper;

	@Reference
	private Localization _localization;

	@Reference
	private Portal _portal;

}