org.opencms.search.galleries.CmsGallerySearchParameters Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* 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.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.search.galleries;
import org.opencms.ade.galleries.shared.CmsGallerySearchScope;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.i18n.CmsLocaleManager;
import org.opencms.main.OpenCms;
import org.opencms.search.CmsSearchIndex;
import org.opencms.search.CmsSearchParameters;
import org.opencms.search.CmsSearchUtil;
import org.opencms.search.fields.CmsSearchField;
import org.opencms.search.fields.CmsSearchFieldConfiguration;
import org.opencms.search.solr.CmsSolrQuery;
import org.opencms.util.CmsPair;
import org.opencms.xml.containerpage.CmsXmlDynamicFunctionHandler;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.solr.client.solrj.SolrQuery.ORDER;
/**
* Parameters used for the gallery search index.
*
* @since 8.0.0
*/
public class CmsGallerySearchParameters {
/** Sort parameter constants. */
public enum CmsGallerySortParam {
/** Sort by date created ascending. */
dateCreated_asc,
/** Sort by date created descending. */
dateCreated_desc,
/** Sort date expired ascending. */
dateExpired_asc,
/** Sort date expired descending. */
dateExpired_desc,
/** Sort by date modified ascending. */
dateLastModified_asc,
/** Sort by date modified descending. */
dateLastModified_desc,
/** Sort date released ascending. */
dateReleased_asc,
/** Sort date released descending. */
dateReleased_desc,
/** Sort by length ascending. */
length_asc,
/** Sort by length descending. */
length_desc,
/** Sort by VFS root path ascending. */
path_asc,
/** Sort by VFS root path descending. */
path_desc,
/** Sort by score ascending. */
score,
/** Sort state ascending. */
state_asc,
/** Sort state descending. */
state_desc,
/** Sort by title ascending. */
title_asc,
/** Sort by title ascending. */
title_desc,
/** Sort by type ascending. */
type_asc,
/** Sort by type descending. */
type_desc,
/** Sort created by ascending. */
userCreated_asc,
/** Sort created by descending. */
userCreated_desc,
/** Sort modified by ascending. */
userLastModified_asc,
/** Sort modified by descending. */
userLastModified_desc;
/** The default sort parameter. */
public static final CmsGallerySortParam DEFAULT = title_asc;
}
/**
* Helper class to store a time range.
*/
class CmsGallerySearchTimeRange {
/** The end time of the time range. */
long m_endTime;
/** The start time of the time range. */
long m_startTime;
/**
* Default constructor.
*
* This will create an object where the start date is equal to
* {@link Long#MIN_VALUE} and the end date is equal to {@link Long#MAX_VALUE}.
*/
public CmsGallerySearchTimeRange() {
m_startTime = Long.MIN_VALUE;
m_endTime = Long.MAX_VALUE;
}
/**
* Constructor with start and end time.
*
* @param startTime the start time of the time range
* @param endTime the end time of the time range
*/
public CmsGallerySearchTimeRange(long startTime, long endTime) {
m_startTime = startTime;
m_endTime = endTime;
}
/**
* Returns the end time of the time range.
*
* @return the end time of the time range
*/
public long getEndTime() {
return m_endTime;
}
/**
* Returns the start time of the time range.
*
* @return the start time of the time range
*/
public long getStartTime() {
return m_startTime;
}
}
/** The categories to search in. */
private List m_categories;
/** The container types to search in. */
private List m_containerTypes;
/** The time range for the date of resource creation to consider in the search. */
private CmsGallerySearchTimeRange m_dateCreatedTimeRange;
/** The time range for the date of resource last modification to consider in the search. */
private CmsGallerySearchTimeRange m_dateLastModifiedTimeRange;
/** The list of search index fields to search in. */
private List m_fields;
/** The list of folders to search in. */
private List m_folders;
/** The galleries to search in. */
private List m_galleries;
/** Indicates the search exclude property should be ignored. */
private boolean m_ignoreSearchExclude;
/** The locale for the search. */
private String m_locale;
/** The number of search results per page. */
private int m_matchesPerPage;
/** The sitemap reference path. */
private String m_referencePath;
/** The resource types to search for. */
private List m_resourceTypes;
/** The requested page of the result. */
private int m_resultPage;
/** The gallery search scope. */
private CmsGallerySearchScope m_scope;
/** The sort order for the search result. */
private CmsGallerySortParam m_sortOrder;
/** Search words to search for. */
private String m_words;
/** Enlists all VFS folders to perform a search in. */
private List m_foldersToSearchIn;
/**
* Default constructor.
*/
public CmsGallerySearchParameters() {
m_resultPage = 1;
m_matchesPerPage = 10;
}
/**
* Returns the categories that have been included in the search.
*
* If no categories have been set, then null is returned.
*
* @return the categories that have been included in the search
*/
public List getCategories() {
return m_categories;
}
/**
* Returns the container types that have been included in the search.
*
* @return the container types that have been included in the search
*/
public List getContainerTypes() {
return m_containerTypes;
}
/**
* Returns the time range for the date of creation that has been used for the search result.
*
* In case this time range has not been set, this will return an object
* where the start date is equal to {@link Long#MIN_VALUE} and the end date is equal to {@link Long#MAX_VALUE}.
*
* @return the time range for the date of creation that has been used for the search result
*/
public CmsGallerySearchTimeRange getDateCreatedRange() {
if (m_dateCreatedTimeRange == null) {
m_dateCreatedTimeRange = new CmsGallerySearchTimeRange();
}
return m_dateCreatedTimeRange;
}
/**
* Returns the time range for the dadelete examplete of last modification that has been used for the search result.
*
* In case this time range has not been set, this will return an object
* where the start date is equal to {@link Long#MIN_VALUE} and the end date is equal to {@link Long#MAX_VALUE}.
*
* @return the time range for the date of last modification that has been used for the search result
*/
public CmsGallerySearchTimeRange getDateLastModifiedRange() {
if (m_dateLastModifiedTimeRange == null) {
m_dateLastModifiedTimeRange = new CmsGallerySearchTimeRange();
}
return m_dateLastModifiedTimeRange;
}
/**
* Returns the list of the names of the fields to search in.
*
* If this has not been set, then the default fields defined in
* {@link CmsSearchIndex#DOC_META_FIELDS} are used as default.
*
* @return the list of the names of the fields to search in
*/
public List getFields() {
if (m_fields == null) {
setFields(Arrays.asList(CmsSearchIndex.DOC_META_FIELDS));
}
return m_fields;
}
/**
* Returns the list of folders to search in.
*
* @return a list of paths of VFS folders
*/
public List getFolders() {
return m_folders;
}
/**
* Returns the galleries that have been included in the search.
*
* If no galleries have been set, then null is returned.
*
* @return the galleries that have been included in the search
*/
public List getGalleries() {
return m_galleries;
}
/**
* Returns the locale that has been used for the search.
*
* If no locale has been set, then null is returned.
*
* @return the locale that has been used for the search
*/
public String getLocale() {
if (m_locale == null) {
m_locale = CmsLocaleManager.getDefaultLocale().toString();
}
return m_locale;
}
/**
* Returns the maximum number of matches per result page.
*
* @return the the maximum number of matches per result page
*
* @see #getMatchesPerPage()
* @see #setResultPage(int)
*/
public int getMatchesPerPage() {
return m_matchesPerPage;
}
/**
* Returns a CmsSolrQuery representation of this class.
* @param cms the openCms object.
* @return CmsSolrQuery representation of this class.
*/
public CmsSolrQuery getQuery(CmsObject cms) {
final CmsSolrQuery query = new CmsSolrQuery();
// set categories
query.setCategories(m_categories);
// set container types
if (null != m_containerTypes) {
query.addFilterQuery(CmsSearchField.FIELD_CONTAINER_TYPES, m_containerTypes, false, false);
}
// Set date created time filter
query.addFilterQuery(
CmsSearchUtil.getDateCreatedTimeRangeFilterQuery(
CmsSearchField.FIELD_DATE_CREATED,
getDateCreatedRange().m_startTime,
getDateCreatedRange().m_endTime));
// Set date last modified time filter
query.addFilterQuery(
CmsSearchUtil.getDateCreatedTimeRangeFilterQuery(
CmsSearchField.FIELD_DATE_LASTMODIFIED,
getDateLastModifiedRange().m_startTime,
getDateLastModifiedRange().m_endTime));
// Set fields
if (null != m_fields) {
query.setFields(m_fields.toArray(new String[m_fields.size()]));
}
// set scope / folders to search in
m_foldersToSearchIn = new ArrayList();
addFoldersToSearchIn(m_folders);
addFoldersToSearchIn(m_galleries);
setSearchFolders(cms);
query.addFilterQuery(
CmsSearchField.FIELD_PARENT_FOLDERS,
new ArrayList(m_foldersToSearchIn),
false,
true);
// TODO: ignoresearchexclude
if (!m_ignoreSearchExclude) {
// Reference for the values: CmsGallerySearchIndex.java, field EXCLUDE_PROPERTY_VALUES
query.addFilterQuery(
"-" + CmsSearchField.FIELD_SEARCH_EXCLUDE,
Arrays.asList(new String[] {"all", "gallery"}),
false,
true);
}
// set matches per page
query.setRows(new Integer(m_matchesPerPage));
// set resource types
if (null != m_resourceTypes) {
query.setResourceTypes(m_resourceTypes);
}
// set result page
query.setStart(new Integer((m_resultPage - 1) * m_matchesPerPage));
// set search locale
if (null != m_locale) {
query.setLocales(CmsLocaleManager.getLocale(m_locale));
}
// set search words
if (null != m_words) {
query.setQuery(m_words);
}
// set sort order
query.setSort(getSort().getFirst(), getSort().getSecond());
return query;
}
/**
* Gets the reference path.
*
* @return the gallery reference path
*/
public String getReferencePath() {
return m_referencePath;
}
/**
* Returns the names of the resource types that have been included in the search result.
*
* If no resource types have been set, then null is returned.
*
* @return the names of the resource types that have been included in the search result
*/
public List getResourceTypes() {
return m_resourceTypes;
}
/**
* Returns the index of the requested result page.
*
* @return the index of the requested result page
*
* @see #setResultPage(int)
* @see #getMatchesPerPage()
* @see #setMatchesPerPage(int)
*/
public int getResultPage() {
return m_resultPage;
}
/**
* The gallery search scope.
*
* @return the gallery search scope
*/
public CmsGallerySearchScope getScope() {
if (m_scope == null) {
return OpenCms.getWorkplaceManager().getGalleryDefaultScope();
}
return m_scope;
}
/**
* Returns the words (terms) that have been used for the full text search.
*
* If no search words have been set, then null is returned.
*
* @return the words (terms) that have been used for the full text search
*/
public String getSearchWords() {
return m_words;
}
/**
* Returns the sort order that has been used in the search.
*
* If the sort parameter has not been set the default sort order
* defined by {@link CmsGallerySortParam#DEFAULT} is used.
*
* @return the sort order that has been used in the search
*/
public CmsGallerySortParam getSortOrder() {
if (m_sortOrder == null) {
m_sortOrder = CmsGallerySortParam.DEFAULT;
}
return m_sortOrder;
}
/**
* Returns the search exclude property ignore flag.
*
* @return the search exclude property ignore flag
*/
public boolean isIgnoreSearchExclude() {
return m_ignoreSearchExclude;
}
/**
* Sets the categories for the search.
*
* Results are found only if they are contained in at least one of the given categories.
*
* @param categories the categories to set
*/
public void setCategories(List categories) {
m_categories = categories;
}
/**
* Sets the container types for the search.
*
* Results are found only if they are compatible with one of the given container types.
* If no container type is set, results compatible with any container will be returned in the search result.
*
* @param containerTypes the container types to set
*/
public void setContainerTypes(List containerTypes) {
m_containerTypes = containerTypes;
}
/**
* Sets the time range for the date of resource creation to consider in the search.
*
* @param startTime the start time of the time range
* @param endTime the end time of the time range
*/
public void setDateCreatedTimeRange(long startTime, long endTime) {
if (m_dateCreatedTimeRange == null) {
m_dateCreatedTimeRange = new CmsGallerySearchTimeRange(startTime, endTime);
}
}
/**
* Sets the time range for the date of resource last modification to consider in the search.
*
* @param startTime the start time of the time range
* @param endTime the end time of the time range
*/
public void setDateLastModifiedTimeRange(long startTime, long endTime) {
if (m_dateLastModifiedTimeRange == null) {
m_dateLastModifiedTimeRange = new CmsGallerySearchTimeRange(startTime, endTime);
}
}
/**
* Sets the list of the names of the fields to search in.
*
* @param fields the list of names of the fields to set
*/
public void setFields(List fields) {
m_fields = fields;
}
/**
* Sets the folders to search in.
*
* @param folders the list of VFS folders
*/
public void setFolders(List folders) {
m_folders = folders;
}
/**
* Sets the galleries for the search.
*
* Results are found only if they are contained in one of the given galleries.
* If no gallery is set, results from all galleries will be returned in the search result.
*
* @param galleries the galleries to set
*/
public void setGalleries(List galleries) {
m_galleries = galleries;
}
/**
* Sets the search exclude property ignore flag.
*
* @param excludeForPageEditor the search exclude property ignore flag
*/
public void setIgnoreSearchExclude(boolean excludeForPageEditor) {
m_ignoreSearchExclude = excludeForPageEditor;
}
/**
* Sets the maximum number of matches per result page.
*
* Use this together with {@link #setResultPage(int)} in order to split the result
* in more than one page.
*
* @param matchesPerPage the the maximum number of matches per result page to set
*
* @see #getMatchesPerPage()
* @see #setResultPage(int)
*/
public void setMatchesPerPage(int matchesPerPage) {
m_matchesPerPage = matchesPerPage;
}
/**
* Sets the gallery reference path.
*
* @param referencePath the gallery reference path
*/
public void setReferencePath(String referencePath) {
m_referencePath = referencePath;
}
/**
* Sets the names of the resource types to include in the search result.
*
* Results are found only if they resources match one of the given resource type names.
* If no resource type name is set, all resource types will be returned in the search result.
*
* @param resourceTypes the names of the resource types to include in the search result
*/
public void setResourceTypes(List resourceTypes) {
m_resourceTypes = resourceTypes;
}
/**
* Sets the index of the result page that should be returned.
*
* Use this together with {@link #setMatchesPerPage(int)} in order to split the result
* in more than one page.
*
* @param resultPage the index of the result page to return
*
* @see #getResultPage()
* @see #getMatchesPerPage()
* @see #setMatchesPerPage(int)
*/
public void setResultPage(int resultPage) {
m_resultPage = resultPage;
}
/**
* Sets the search scope.
*
* @param scope the search scope
*/
public void setScope(CmsGallerySearchScope scope) {
m_scope = scope;
}
/**
* Sets the locale for the search.
*
* Results are found only if they match the given locale.
* If no locale is set, results for all locales will be returned in the search result.
*
* @param locale the locale to set
*/
public void setSearchLocale(String locale) {
m_locale = locale;
}
/**
* Sets the words (terms) for the full text search.
*
* Results are found only if they text extraction for the resource contains all given search words.
* If no search word is set, all resources will be returned in the search result.
*
* Please note that this should be a list of words separated by white spaces.
* Simple Lucene modifiers such as (+), (-) and (*) are allowed, but anything more complex then this
* will be removed.
*
* @param words the words (terms) for the full text search to set
*/
public void setSearchWords(String words) {
m_words = words;
}
/**
* Sets the sort order for the search.
*
* @param sortOrder the sort order to set
*/
public void setSortOrder(CmsGallerySortParam sortOrder) {
m_sortOrder = sortOrder;
}
/**
* Wraps this parameters to the standard search parameters, so that inherited methods in the search index
* can be used.
*
* @return this parameters wrapped to the standard search parameters
*/
protected CmsSearchParameters getCmsSearchParams() {
CmsSearchParameters result = new CmsSearchParameters();
result.setFields(getFields());
result.setExcerptOnlySearchedFields(true);
if (getSearchWords() != null) {
result.setQuery(getSearchWords());
result.setIgnoreQuery(false);
} else {
result.setIgnoreQuery(true);
}
return result;
}
/**
* Adds folders to perform the search in.
* @param folders Folders to search in.
*/
private void addFoldersToSearchIn(final List folders) {
if (null == folders) {
return;
}
for (String folder : folders) {
if (!CmsResource.isFolder(folder)) {
folder += "/";
}
m_foldersToSearchIn.add(folder);
}
}
/**
* Returns the Lucene sort indicated by the selected sort order.
*
* @return the Lucene sort indicated by the selected sort order
*
* @see #getSortOrder()
*/
private CmsPair getSort() {
final String sortTitle = CmsSearchFieldConfiguration.getLocaleExtendedName(
CmsSearchField.FIELD_TITLE_UNSTORED,
getLocale()) + "_s";
switch (getSortOrder()) {
case dateCreated_asc:
return CmsPair.create(CmsSearchField.FIELD_DATE_CREATED, ORDER.asc);
case dateCreated_desc:
return CmsPair.create(CmsSearchField.FIELD_DATE_CREATED, ORDER.desc);
case dateExpired_asc:
return CmsPair.create(CmsSearchField.FIELD_DATE_EXPIRED, ORDER.asc);
case dateExpired_desc:
return CmsPair.create(CmsSearchField.FIELD_DATE_EXPIRED, ORDER.desc);
case dateLastModified_asc:
return CmsPair.create(CmsSearchField.FIELD_DATE_LASTMODIFIED, ORDER.asc);
case dateLastModified_desc:
return CmsPair.create(CmsSearchField.FIELD_DATE_LASTMODIFIED, ORDER.desc);
case dateReleased_asc:
return CmsPair.create(CmsSearchField.FIELD_DATE_RELEASED, ORDER.asc);
case dateReleased_desc:
return CmsPair.create(CmsSearchField.FIELD_DATE_RELEASED, ORDER.desc);
case length_asc:
return CmsPair.create(CmsSearchField.FIELD_SIZE, ORDER.asc);
case length_desc:
return CmsPair.create(CmsSearchField.FIELD_SIZE, ORDER.desc);
case path_asc:
return CmsPair.create(CmsSearchField.FIELD_PATH, ORDER.asc);
case path_desc:
return CmsPair.create(CmsSearchField.FIELD_PATH, ORDER.desc);
case score:
return CmsPair.create(CmsSearchField.FIELD_SCORE, ORDER.asc);
case state_asc:
return CmsPair.create(CmsSearchField.FIELD_STATE, ORDER.asc);
case state_desc:
return CmsPair.create(CmsSearchField.FIELD_STATE, ORDER.desc);
case title_asc:
return CmsPair.create(sortTitle, ORDER.asc);
case title_desc:
return CmsPair.create(sortTitle, ORDER.desc);
case type_asc:
return CmsPair.create(CmsSearchField.FIELD_TYPE, ORDER.asc);
case type_desc:
return CmsPair.create(CmsSearchField.FIELD_TYPE, ORDER.desc);
case userCreated_asc:
return CmsPair.create(CmsSearchField.FIELD_USER_CREATED, ORDER.asc);
case userCreated_desc:
return CmsPair.create(CmsSearchField.FIELD_USER_CREATED, ORDER.desc);
case userLastModified_asc:
return CmsPair.create(CmsSearchField.FIELD_USER_LAST_MODIFIED, ORDER.asc);
case userLastModified_desc:
return CmsPair.create(CmsSearchField.FIELD_USER_LAST_MODIFIED, ORDER.desc);
default:
return CmsPair.create(sortTitle, ORDER.asc);
}
}
/**
* Applies the defined search folders to the Solr query.
*
* @param obj The current CmsObject object.
*/
private void setSearchFolders(CmsObject obj) {
// check if parentFolders to search in have been set
// if this evaluates false, the search folders have already been set, so
// there's no need to add a scope filter
if (m_foldersToSearchIn.isEmpty()) {
// only append scope filter if no no folders or galleries given
setSearchScopeFilter(obj);
}
}
/**
* Sets the search scope.
*
* @param cms The current CmsObject object.
*/
private void setSearchScopeFilter(CmsObject cms) {
final List searchRoots = CmsSearchUtil.computeScopeFolders(cms, this);
// If the resource types contain the type "function" also
// add "/system/modules/" to the search path
if ((null != getResourceTypes()) && getResourceTypes().contains(CmsXmlDynamicFunctionHandler.TYPE_FUNCTION)) {
searchRoots.add("/system/modules/");
}
addFoldersToSearchIn(searchRoots);
}
}