com.liferay.search.experiences.internal.blueprint.parameter.SXPParameterDataCreator 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.search.experiences.internal.blueprint.parameter;
import com.liferay.asset.kernel.service.AssetCategoryLocalService;
import com.liferay.asset.kernel.service.AssetTagLocalService;
import com.liferay.expando.kernel.service.ExpandoColumnLocalService;
import com.liferay.expando.kernel.service.ExpandoValueLocalService;
import com.liferay.petra.string.CharPool;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.configuration.module.configuration.ConfigurationProvider;
import com.liferay.portal.kernel.language.Language;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.service.GroupLocalService;
import com.liferay.portal.kernel.service.UserGroupGroupRoleLocalService;
import com.liferay.portal.kernel.service.UserGroupLocalService;
import com.liferay.portal.kernel.service.UserGroupRoleLocalService;
import com.liferay.portal.kernel.service.UserLocalService;
import com.liferay.portal.kernel.util.ArrayUtil;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.ListUtil;
import com.liferay.portal.kernel.util.MapUtil;
import com.liferay.portal.kernel.util.Portal;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.search.experiences.blueprint.parameter.SXPParameter;
import com.liferay.search.experiences.blueprint.parameter.contributor.SXPParameterContributorDefinition;
import com.liferay.search.experiences.blueprint.parameter.contributor.SXPParameterContributorDefinitionProvider;
import com.liferay.search.experiences.configuration.SemanticSearchConfigurationProvider;
import com.liferay.search.experiences.internal.blueprint.parameter.contributor.ContextSXPParameterContributor;
import com.liferay.search.experiences.internal.blueprint.parameter.contributor.IpstackSXPParameterContributor;
import com.liferay.search.experiences.internal.blueprint.parameter.contributor.MLSXPParameterContributor;
import com.liferay.search.experiences.internal.blueprint.parameter.contributor.OpenWeatherMapSXPParameterContributor;
import com.liferay.search.experiences.internal.blueprint.parameter.contributor.SXPParameterContributor;
import com.liferay.search.experiences.internal.blueprint.parameter.contributor.TimeSXPParameterContributor;
import com.liferay.search.experiences.internal.blueprint.parameter.contributor.UserSXPParameterContributor;
import com.liferay.search.experiences.ml.embedding.text.TextEmbeddingRetriever;
import com.liferay.search.experiences.rest.dto.v1_0.Configuration;
import com.liferay.search.experiences.rest.dto.v1_0.Parameter;
import com.liferay.search.experiences.rest.dto.v1_0.ParameterConfiguration;
import com.liferay.search.experiences.rest.dto.v1_0.SXPBlueprint;
import com.liferay.segments.SegmentsEntryRetriever;
import java.beans.ExceptionListener;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.TimeZone;
import org.apache.commons.lang.StringUtils;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
/**
* @author Petteri Karttunen
*/
@Component(
enabled = false,
service = {
SXPParameterContributorDefinitionProvider.class,
SXPParameterDataCreator.class
}
)
public class SXPParameterDataCreator
implements SXPParameterContributorDefinitionProvider {
public SXPParameterData create(
ExceptionListener exceptionListener, SearchContext searchContext,
SXPBlueprint sxpBlueprint) {
Map sxpParameters = new LinkedHashMap<>();
String keywords = _addKeywordsSXPParameters(
searchContext, sxpParameters);
Configuration configuration = sxpBlueprint.getConfiguration();
if (configuration != null) {
_addSXPParameters(
configuration.getParameterConfiguration(), searchContext,
sxpParameters);
}
_contribute(
exceptionListener, searchContext, sxpBlueprint, sxpParameters);
return new SXPParameterData(keywords, sxpParameters);
}
@Override
public List
getSXPParameterContributorDefinitions(long companyId, Locale locale) {
if (ArrayUtil.isEmpty(_sxpParameterContributors)) {
return Collections.emptyList();
}
List
sxpParameterContributorDefinitions = new ArrayList<>();
for (SXPParameterContributor sxpParameterContributor :
_sxpParameterContributors) {
sxpParameterContributorDefinitions.addAll(
sxpParameterContributor.getSXPParameterContributorDefinitions(
companyId, locale));
}
return sxpParameterContributorDefinitions;
}
@Activate
protected void activate() {
_sxpParameterContributors = new SXPParameterContributor[] {
new ContextSXPParameterContributor(_groupLocalService, _language),
new IpstackSXPParameterContributor(_configurationProvider),
new MLSXPParameterContributor(
_language, _semanticSearchConfigurationProvider,
_textEmbeddingRetriever),
new OpenWeatherMapSXPParameterContributor(_configurationProvider),
new TimeSXPParameterContributor(),
new UserSXPParameterContributor(
_assetCategoryLocalService, _assetTagLocalService,
_expandoColumnLocalService, _expandoValueLocalService,
_groupLocalService, _language, _portal, _segmentsEntryRetriever,
_userGroupGroupRoleLocalService, _userGroupLocalService,
_userGroupRoleLocalService, _userLocalService)
};
}
private void _add(
SXPParameter sxpParameter, Map sxpParameters) {
sxpParameters.put(sxpParameter.getName(), sxpParameter);
}
private String _addKeywordsSXPParameters(
SearchContext searchContext, Map sxpParameters) {
String keywords = GetterUtil.getString(searchContext.getKeywords());
if ((StringUtil.count(keywords, CharPool.QUOTE) % 2) != 0) {
keywords = StringUtil.replace(
keywords, CharPool.QUOTE, StringPool.BLANK);
}
keywords = keywords.replaceAll("/", "∕");
keywords = keywords.replaceAll("\"", """);
keywords = keywords.replaceAll("\\$", "$");
keywords = keywords.replaceAll("\\[", "[");
keywords = keywords.replaceAll("\\\\", "\");
keywords = keywords.replaceAll("\\]", "]");
_add(new StringSXPParameter("keywords", true, keywords), sxpParameters);
return keywords;
}
private void _addSXPParameter(
SearchContext searchContext,
SXPParameterContributorDefinition sxpParameterContributorDefinition,
Map sxpParameters) {
String name = StringUtils.substringBetween(
sxpParameterContributorDefinition.getTemplateVariable(),
StringPool.DOLLAR_AND_OPEN_CURLY_BRACE,
StringPool.CLOSE_CURLY_BRACE);
Object object = searchContext.getAttribute(name);
if (object == null) {
return;
}
SXPParameter sxpParameter = _getSXPParameter(
name, object, new Parameter(), searchContext,
_getType(sxpParameterContributorDefinition));
if (sxpParameter == null) {
return;
}
_add(sxpParameter, sxpParameters);
}
private void _addSXPParameter(
String name, Parameter parameter, SearchContext searchContext,
Map sxpParameters) {
Object object = searchContext.getAttribute(name);
if (object == null) {
return;
}
SXPParameter sxpParameter = _getSXPParameter(
name, object, parameter, searchContext, parameter.getType());
if (sxpParameter == null) {
return;
}
_add(sxpParameter, sxpParameters);
}
private void _addSXPParameters(
ParameterConfiguration parameterConfiguration,
SearchContext searchContext, Map sxpParameters) {
if (parameterConfiguration == null) {
return;
}
MapUtil.isNotEmptyForEach(
parameterConfiguration.getParameters(),
(name, parameter) -> _addSXPParameter(
name, parameter, searchContext, sxpParameters));
}
private void _contribute(
ExceptionListener exceptionListener, SearchContext searchContext,
SXPBlueprint sxpBlueprint, Map sxpParameters) {
if (ArrayUtil.isEmpty(_sxpParameterContributors)) {
return;
}
for (SXPParameterContributor sxpParameterContributor :
_sxpParameterContributors) {
Set set = new LinkedHashSet<>();
sxpParameterContributor.contribute(
exceptionListener, searchContext, sxpBlueprint, set);
for (SXPParameter sxpParameter : set) {
_add(sxpParameter, sxpParameters);
}
List
sxpParameterContributorDefinitions =
sxpParameterContributor.
getSXPParameterContributorDefinitions(
searchContext.getCompanyId(),
searchContext.getLocale());
if (ListUtil.isNotEmpty(sxpParameterContributorDefinitions)) {
for (SXPParameterContributorDefinition
sxpParameterContributorDefinition :
sxpParameterContributorDefinitions) {
_addSXPParameter(
searchContext, sxpParameterContributorDefinition,
sxpParameters);
}
}
}
}
private Double _fit(Double maxValue, Double minValue, Double value) {
if ((minValue != null) && (value < minValue)) {
return minValue;
}
if ((maxValue != null) && (value > maxValue)) {
return maxValue;
}
return value;
}
private Float _fit(Float maxValue, Float minValue, Float value) {
if ((minValue != null) && (value < minValue)) {
return minValue;
}
if ((maxValue != null) && (value > maxValue)) {
return maxValue;
}
return value;
}
private Integer _fit(Integer maxValue, Integer minValue, Integer value) {
if ((minValue != null) && (value < minValue)) {
return minValue;
}
if ((maxValue != null) && (value > maxValue)) {
return maxValue;
}
return value;
}
private Long _fit(Long maxValue, Long minValue, Long value) {
if ((minValue != null) && (value < minValue)) {
return minValue;
}
if ((maxValue != null) && (value > maxValue)) {
return maxValue;
}
return value;
}
private Boolean _getBoolean(Boolean defaultValue, Object object) {
if (object != null) {
return GetterUtil.getBoolean(object);
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private SXPParameter _getBooleanSXPParameter(
String name, Object object, Parameter parameter) {
Boolean value = _getBoolean(
(Boolean)parameter.getDefaultValue(), object);
if (value == null) {
return null;
}
return new BooleanSXPParameter(name, true, value);
}
private SXPParameter _getDateSXPParameter(
String name, Object object, TimeZone timeZone, Parameter parameter) {
String value = _getString(null, object);
if (value == null) {
return null;
}
LocalDate localDate = LocalDate.parse(
value, DateTimeFormatter.ofPattern(parameter.getFormat()));
Calendar calendar = GregorianCalendar.from(
localDate.atStartOfDay(timeZone.toZoneId()));
Date date = calendar.getTime();
if (date == null) {
return null;
}
return new DateSXPParameter(name, true, date);
}
private Double _getDouble(Double defaultValue, Object object) {
if (object != null) {
return GetterUtil.getDouble(object);
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private SXPParameter _getDoubleSXPParameter(
String name, Object object, Parameter parameter) {
Double value = _getDouble((Double)parameter.getDefaultValue(), object);
if (value == null) {
return null;
}
return new DoubleSXPParameter(
name, true,
_fit(
(Double)parameter.getMax(), (Double)parameter.getMin(), value));
}
private Float _getFloat(Float defaultValue, Object object) {
if (object != null) {
return GetterUtil.getFloat(object);
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private SXPParameter _getFloatSXPParameter(
String name, Object object, Parameter parameter) {
Float value = _getFloat((Float)parameter.getDefaultValue(), object);
if (value == null) {
return null;
}
return new FloatSXPParameter(
name, true,
_fit((Float)parameter.getMax(), (Float)parameter.getMin(), value));
}
private Integer _getInteger(Integer defaultValue, Object object) {
if (object != null) {
return GetterUtil.getInteger(object);
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private Integer[] _getIntegerArray(Integer[] defaultValue, Object object) {
if (object instanceof String) {
return ArrayUtil.toArray(
GetterUtil.getIntegerValues(StringUtil.split((String)object)));
}
if (object != null) {
return ArrayUtil.toArray(GetterUtil.getIntegerValues(object));
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private SXPParameter _getIntegerArraySXPParameter(
String name, Object object, Parameter parameter) {
Integer[] value = _getIntegerArray(
(Integer[])parameter.getDefaultValue(), object);
if (ArrayUtil.isEmpty(value)) {
return null;
}
return new IntegerArraySXPParameter(name, true, value);
}
private SXPParameter _getIntegerSXPParameter(
String name, Object object, Parameter parameter) {
Integer value = _getInteger(
(Integer)parameter.getDefaultValue(), object);
if (value == null) {
return null;
}
return new IntegerSXPParameter(
name, true,
_fit(
(Integer)parameter.getMax(), (Integer)parameter.getMin(),
value));
}
private Long _getLong(Long defaultValue, Object object) {
if (object != null) {
return GetterUtil.getLong(object);
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private Long[] _getLongArray(Long[] defaultValue, Object object) {
if (object instanceof String) {
return ArrayUtil.toArray(
GetterUtil.getLongValues(StringUtil.split((String)object)));
}
if (object != null) {
return ArrayUtil.toArray(GetterUtil.getLongValues(object));
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private SXPParameter _getLongArraySXPParameter(
String name, Object object, Parameter parameter) {
Long[] value = _getLongArray(
(Long[])parameter.getDefaultValue(), object);
if (ArrayUtil.isEmpty(value)) {
return null;
}
return new LongArraySXPParameter(name, true, value);
}
private SXPParameter _getLongSXPParameter(
String name, Object object, Parameter parameter) {
Long value = _getLong((Long)parameter.getDefaultValue(), object);
if (value == null) {
return null;
}
return new LongSXPParameter(
name, true,
_fit((Long)parameter.getMax(), (Long)parameter.getMin(), value));
}
private String _getString(String defaultValue, Object object) {
if (object != null) {
return GetterUtil.getString(object);
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private String[] _getStringArray(String[] defaultValue, Object object) {
if (object != null) {
return GetterUtil.getStringValues(object);
}
if (defaultValue != null) {
return defaultValue;
}
return null;
}
private SXPParameter _getStringArraySXPParameter(
String name, Object object, Parameter parameter) {
String[] value = _getStringArray(
(String[])parameter.getDefaultValue(), object);
if (ArrayUtil.isEmpty(value)) {
return null;
}
return new StringArraySXPParameter(name, true, value);
}
private SXPParameter _getStringSXPParameter(
String name, Object object, Parameter parameter) {
String value = _getString((String)parameter.getDefaultValue(), object);
if (value == null) {
return null;
}
return new StringSXPParameter(name, true, value);
}
private SXPParameter _getSXPParameter(
String name, Object object, Parameter parameter,
SearchContext searchContext, Parameter.Type type) {
if (type.equals(Parameter.Type.BOOLEAN)) {
return _getBooleanSXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.DATE)) {
return _getDateSXPParameter(
name, object, searchContext.getTimeZone(), parameter);
}
else if (type.equals(Parameter.Type.DOUBLE)) {
return _getDoubleSXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.FLOAT)) {
return _getFloatSXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.INTEGER)) {
return _getIntegerSXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.INTEGER_ARRAY)) {
return _getIntegerArraySXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.LONG)) {
return _getLongSXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.LONG_ARRAY)) {
return _getLongArraySXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.STRING)) {
return _getStringSXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.STRING_ARRAY)) {
return _getStringArraySXPParameter(name, object, parameter);
}
else if (type.equals(Parameter.Type.TIME_RANGE)) {
return _getTimeRangeSXPParameter(name, object);
}
throw new IllegalArgumentException();
}
private SXPParameter _getTimeRangeSXPParameter(String name, Object object) {
String value = _getString(null, object);
if (value == null) {
return null;
}
Calendar calendar = Calendar.getInstance();
if (value.equals("last-day")) {
calendar.add(Calendar.DAY_OF_MONTH, -1);
}
else if (value.equals("last-hour")) {
calendar.add(Calendar.HOUR_OF_DAY, -1);
}
else if (value.equals("last-month")) {
calendar.add(Calendar.MONTH, -1);
}
else if (value.equals("last-week")) {
calendar.add(Calendar.WEEK_OF_MONTH, -1);
}
else if (value.equals("last-year")) {
calendar.add(Calendar.YEAR, -1);
}
return new DateSXPParameter(name, true, calendar.getTime());
}
private Parameter.Type _getType(
SXPParameterContributorDefinition sxpParameterContributorDefinition) {
String className = sxpParameterContributorDefinition.getClassName();
if (className.equals(BooleanSXPParameter.class.getName())) {
return Parameter.Type.BOOLEAN;
}
else if (className.equals(DateSXPParameter.class.getName())) {
return Parameter.Type.DATE;
}
else if (className.equals(DoubleSXPParameter.class.getName())) {
return Parameter.Type.DOUBLE;
}
else if (className.equals(FloatSXPParameter.class.getName())) {
return Parameter.Type.FLOAT;
}
else if (className.equals(IntegerSXPParameter.class.getName())) {
return Parameter.Type.INTEGER;
}
else if (className.equals(IntegerArraySXPParameter.class.getName())) {
return Parameter.Type.INTEGER_ARRAY;
}
else if (className.equals(LongSXPParameter.class.getName())) {
return Parameter.Type.LONG;
}
else if (className.equals(LongArraySXPParameter.class.getName())) {
return Parameter.Type.LONG_ARRAY;
}
else if (className.equals(StringSXPParameter.class.getName())) {
return Parameter.Type.STRING;
}
else if (className.equals(StringArraySXPParameter.class.getName())) {
return Parameter.Type.STRING_ARRAY;
}
throw new IllegalArgumentException();
}
@Reference
private AssetCategoryLocalService _assetCategoryLocalService;
@Reference
private AssetTagLocalService _assetTagLocalService;
@Reference
private ConfigurationProvider _configurationProvider;
@Reference
private ExpandoColumnLocalService _expandoColumnLocalService;
@Reference
private ExpandoValueLocalService _expandoValueLocalService;
@Reference
private GroupLocalService _groupLocalService;
@Reference
private Language _language;
@Reference
private Portal _portal;
@Reference
private SegmentsEntryRetriever _segmentsEntryRetriever;
@Reference
private SemanticSearchConfigurationProvider
_semanticSearchConfigurationProvider;
private SXPParameterContributor[] _sxpParameterContributors;
@Reference
private TextEmbeddingRetriever _textEmbeddingRetriever;
@Reference
private UserGroupGroupRoleLocalService _userGroupGroupRoleLocalService;
@Reference
private UserGroupLocalService _userGroupLocalService;
@Reference
private UserGroupRoleLocalService _userGroupRoleLocalService;
@Reference
private UserLocalService _userLocalService;
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy