inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-09-17 14:21:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

ACS-6928 backported to 23.N (#3390)

Browse Source
This commit is contained in:
jakubkochman
2025-06-17 17:12:37 +02:00
committed by GitHub
parent 93d678dc30
commit bd0aaa08b3
2 changed files with 256 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

325
remote-api/src/main/java/org/alfresco/rest/api/impl/QueriesImpl.java
View File

@@ -2,23 +2,23 @@
* #%L * #%L
* Alfresco Remote API * Alfresco Remote API
* %% * %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of * If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is * the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms: * provided under the following open source license terms:
* *
* Alfresco is free software: you can redistribute it and/or modify * Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by * it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or * the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version. * (at your option) any later version.
* *
* Alfresco is distributed in the hope that it will be useful, * Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details. * GNU Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public License * You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>. * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L% * #L%
@@ -38,11 +38,19 @@ import java.util.Collections;
import java.util.Comparator; import java.util.Comparator;
import java.util.HashMap; import java.util.HashMap;
import java.util.Iterator; import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.extensions.surf.util.I18NUtil;
import org.alfresco.model.ContentModel; import org.alfresco.model.ContentModel;
import org.alfresco.query.PagingRequest; import org.alfresco.query.PagingRequest;
import org.alfresco.repo.security.permissions.AccessDeniedException;
import org.alfresco.repo.site.SiteModel; import org.alfresco.repo.site.SiteModel;
import org.alfresco.rest.api.Nodes; import org.alfresco.rest.api.Nodes;
import org.alfresco.rest.api.People; import org.alfresco.rest.api.People;
@@ -77,8 +85,6 @@ import org.alfresco.util.AlfrescoCollator;
import org.alfresco.util.ISO9075; import org.alfresco.util.ISO9075;
import org.alfresco.util.ParameterCheck; import org.alfresco.util.ParameterCheck;
import org.alfresco.util.SearchLanguageConversion; import org.alfresco.util.SearchLanguageConversion;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.extensions.surf.util.I18NUtil;
/** /**
* Queries implementation * Queries implementation
@@ -88,43 +94,43 @@ import org.springframework.extensions.surf.util.I18NUtil;
*/ */
public class QueriesImpl implements Queries, InitializingBean public class QueriesImpl implements Queries, InitializingBean
{ {
private final static Map<String,QName> NODE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames( private static final Log LOGGER = LogFactory.getLog(QueriesImpl.class);
PARAM_NAME, ContentModel.PROP_NAME, private final static Map<String, QName> NODE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames(
PARAM_CREATEDAT, ContentModel.PROP_CREATED, PARAM_NAME, ContentModel.PROP_NAME,
PARAM_MODIFIEDAT, ContentModel.PROP_MODIFIED); PARAM_CREATEDAT, ContentModel.PROP_CREATED,
PARAM_MODIFIEDAT, ContentModel.PROP_MODIFIED);
private final static Map<String, QName> PEOPLE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames( private final static Map<String, QName> PEOPLE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames(
PARAM_PERSON_ID, ContentModel.PROP_USERNAME, PARAM_PERSON_ID, ContentModel.PROP_USERNAME,
ContentModel.PROP_FIRSTNAME, ContentModel.PROP_FIRSTNAME,
ContentModel.PROP_LASTNAME); ContentModel.PROP_LASTNAME);
private final static Map<String, QName> SITE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames( private final static Map<String, QName> SITE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames(
PARAM_SITE_ID, ContentModel.PROP_NAME, PARAM_SITE_ID, ContentModel.PROP_NAME,
PARAM_SITE_TITLE, ContentModel.PROP_TITLE, PARAM_SITE_TITLE, ContentModel.PROP_TITLE,
PARAM_SITE_DESCRIPTION, ContentModel.PROP_DESCRIPTION); PARAM_SITE_DESCRIPTION, ContentModel.PROP_DESCRIPTION);
/** /**
* Helper method to build a map of sort parameter names to QNames. This method iterates through * Helper method to build a map of sort parameter names to QNames. This method iterates through the parameters. If a parameter is a String it is assumed to be a sort parameter name and will be followed by a QName to which it maps. If however it is a QName the local name of the OName is used as the sort parameter name.
* the parameters. If a parameter is a String it is assumed to be a sort parameter name and will *
* be followed by a QName to which it maps. If however it is a QName the local name of the OName * @param parameters
* is used as the sort parameter name. * to build up the map.
* @param parameters to build up the map.
* @return the map * @return the map
*/ */
private static Map<String, QName> sortParamsToQNames(Object... parameters) private static Map<String, QName> sortParamsToQNames(Object... parameters)
{ {
Map<String, QName> map = new HashMap<>(); Map<String, QName> map = new HashMap<>();
for (int i=0; i<parameters.length; i++) for (int i = 0; i < parameters.length; i++)
{ {
map.put( map.put(
parameters[i] instanceof String parameters[i] instanceof String
? (String)parameters[i++] ? (String) parameters[i++]
: ((QName)parameters[i]).getLocalName(), : ((QName) parameters[i]).getLocalName(),
(QName)parameters[i]); (QName) parameters[i]);
} }
return Collections.unmodifiableMap(map); return Collections.unmodifiableMap(map);
} }
private ServiceRegistry sr; private ServiceRegistry sr;
private NodeService nodeService; private NodeService nodeService;
private NamespaceService namespaceService; private NamespaceService namespaceService;
@@ -162,7 +168,7 @@ public class QueriesImpl implements Queries, InitializingBean
ParameterCheck.mandatory("nodes", this.nodes); ParameterCheck.mandatory("nodes", this.nodes);
ParameterCheck.mandatory("people", this.people); ParameterCheck.mandatory("people", this.people);
ParameterCheck.mandatory("sites", this.sites); ParameterCheck.mandatory("sites", this.sites);
this.nodeService = sr.getNodeService(); this.nodeService = sr.getNodeService();
this.namespaceService = sr.getNamespaceService(); this.namespaceService = sr.getNamespaceService();
this.dictionaryService = sr.getDictionaryService(); this.dictionaryService = sr.getDictionaryService();
@@ -173,10 +179,9 @@ public class QueriesImpl implements Queries, InitializingBean
public CollectionWithPagingInfo<Node> findNodes(Parameters parameters) public CollectionWithPagingInfo<Node> findNodes(Parameters parameters)
{ {
SearchService searchService = sr.getSearchService(); SearchService searchService = sr.getSearchService();
return new AbstractQuery<Node>(nodeService, searchService) return new AbstractQuery<Node>(nodeService, searchService) {
{
private final Map<String, UserInfo> mapUserInfo = new HashMap<>(10); private final Map<String, UserInfo> mapUserInfo = new HashMap<>(10);
@Override @Override
protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName) protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName)
{ {
@@ -198,14 +203,14 @@ public class QueriesImpl implements Queries, InitializingBean
{ {
query.append(")"); query.append(")");
} }
String nodeTypeStr = parameters.getParameter(PARAM_NODE_TYPE); String nodeTypeStr = parameters.getParameter(PARAM_NODE_TYPE);
if (nodeTypeStr != null) if (nodeTypeStr != null)
{ {
QName filterNodeTypeQName = nodes.createQName(nodeTypeStr); QName filterNodeTypeQName = nodes.createQName(nodeTypeStr);
if (dictionaryService.getType(filterNodeTypeQName) == null) if (dictionaryService.getType(filterNodeTypeQName) == null)
{ {
throw new InvalidArgumentException("Unknown filter nodeType: "+nodeTypeStr); throw new InvalidArgumentException("Unknown filter nodeType: " + nodeTypeStr);
} }
query.append(" AND (+TYPE:\"").append(nodeTypeStr).append(("\")")); query.append(" AND (+TYPE:\"").append(nodeTypeStr).append(("\")"));
@@ -229,7 +234,7 @@ public class QueriesImpl implements Queries, InitializingBean
Path path = null; Path path = null;
try try
{ {
path = nodeService.getPath(nodeRef); path = nodeService.getPath(nodeRef);
} }
catch (InvalidNodeRefException inre) catch (InvalidNodeRefException inre)
{ {
@@ -248,7 +253,7 @@ public class QueriesImpl implements Queries, InitializingBean
{ {
// first request for this namespace prefix, get and cache result // first request for this namespace prefix, get and cache result
Collection<String> prefixes = namespaceService.getPrefixes(qname.getNamespaceURI()); Collection<String> prefixes = namespaceService.getPrefixes(qname.getNamespaceURI());
prefix = prefixes.size() != 0 ? prefixes.iterator().next() : ""; prefix = !prefixes.isEmpty() ? prefixes.iterator().next() : "";
cache.put(qname.getNamespaceURI(), prefix); cache.put(qname.getNamespaceURI(), prefix);
} }
buf.append('/').append(prefix).append(':').append(ISO9075.encode(qname.getLocalName())); buf.append('/').append(prefix).append(':').append(ISO9075.encode(qname.getLocalName()));
@@ -262,12 +267,6 @@ public class QueriesImpl implements Queries, InitializingBean
return buf.toString(); return buf.toString();
} }
@Override
protected List<Node> newList(int capacity)
{
return new ArrayList<Node>(capacity);
}
@Override @Override
protected Node convert(NodeRef nodeRef, List<String> includeParam) protected Node convert(NodeRef nodeRef, List<String> includeParam)
{ {
@@ -281,18 +280,17 @@ public class QueriesImpl implements Queries, InitializingBean
term = SearchLanguageConversion.escapeLuceneQuery(term); term = SearchLanguageConversion.escapeLuceneQuery(term);
return term; return term;
} }
}.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_NODES, "keywords", }.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_NODES, "keywords",
IN_QUERY_SORT, NODE_SORT_PARAMS_TO_QNAMES, IN_QUERY_SORT, NODE_SORT_PARAMS_TO_QNAMES,
new SortColumn(PARAM_MODIFIEDAT, false)); new SortColumn(PARAM_MODIFIEDAT, false));
} }
@Override @Override
public CollectionWithPagingInfo<Person> findPeople(Parameters parameters) public CollectionWithPagingInfo<Person> findPeople(Parameters parameters)
{ {
SearchService searchService = sr.getSearchService(); SearchService searchService = sr.getSearchService();
return new AbstractQuery<Person>(nodeService, searchService) return new AbstractQuery<Person>(nodeService, searchService) {
{
@Override @Override
protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName) protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName)
{ {
@@ -305,33 +303,25 @@ public class QueriesImpl implements Queries, InitializingBean
query.append("*\")"); query.append("*\")");
} }
@Override
protected List<Person> newList(int capacity)
{
return new ArrayList<Person>(capacity);
}
@Override @Override
protected Person convert(NodeRef nodeRef, List<String> includeParam) protected Person convert(NodeRef nodeRef, List<String> includeParam)
{ {
String personId = (String) nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME); String personId = (String) nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME);
Person person = people.getPerson(personId); return people.getPerson(personId);
return person;
} }
// TODO Do the sort in the query on day. A comment in the code for the V0 API used for live people // TODO Do the sort in the query on day. A comment in the code for the V0 API used for live people
// search says adding sort values for this query don't work - tried it and they really don't. // search says adding sort values for this query don't work - tried it and they really don't.
}.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_PEOPLE, "_PERSON", }.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_PEOPLE, "_PERSON",
POST_QUERY_SORT, PEOPLE_SORT_PARAMS_TO_QNAMES, POST_QUERY_SORT, PEOPLE_SORT_PARAMS_TO_QNAMES,
new SortColumn(PARAM_FIRSTNAME, true), new SortColumn(PARAM_LASTNAME, true)); new SortColumn(PARAM_FIRSTNAME, true), new SortColumn(PARAM_LASTNAME, true));
} }
@Override @Override
public CollectionWithPagingInfo<Site> findSites(Parameters parameters) public CollectionWithPagingInfo<Site> findSites(Parameters parameters)
{ {
SearchService searchService = sr.getSearchService(); SearchService searchService = sr.getSearchService();
return new AbstractQuery<Site>(nodeService, searchService) return new AbstractQuery<Site>(nodeService, searchService) {
{
@Override @Override
protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName) protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName)
{ {
@@ -343,44 +333,34 @@ public class QueriesImpl implements Queries, InitializingBean
query.append(term); query.append(term);
query.append("*\")"); query.append("*\")");
} }
@Override
protected List<Site> newList(int capacity)
{
return new ArrayList<>(capacity);
}
@Override @Override
protected Site convert(NodeRef nodeRef, List<String> includeParam) protected Site convert(NodeRef nodeRef, List<String> includeParam)
{ {
return getSite(siteService.getSite(nodeRef), true); return getSite(siteService.getSite(nodeRef));
} }
// note: see also Sites.getSite // note: see also Sites.getSite
private Site getSite(SiteInfo siteInfo, boolean includeRole) private Site getSite(SiteInfo siteInfo)
{ {
// set the site id to the short name (to deal with case sensitivity issues with using the siteId from the url) // set the site id to the short name (to deal with case sensitivity issues with using the siteId from the url)
String siteId = siteInfo.getShortName(); String siteId = siteInfo.getShortName();
String role = null; String role = sites.getSiteRole(siteId);
if(includeRole)
{
role = sites.getSiteRole(siteId);
}
return new Site(siteInfo, role); return new Site(siteInfo, role);
} }
}.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_SITES, "_SITE", POST_QUERY_SORT, SITE_SORT_PARAMS_TO_QNAMES, new SortColumn(PARAM_SITE_TITLE, true)); }.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_SITES, "_SITE", POST_QUERY_SORT, SITE_SORT_PARAMS_TO_QNAMES, new SortColumn(PARAM_SITE_TITLE, true));
} }
public abstract static class AbstractQuery<T> public abstract static class AbstractQuery<T>
{ {
public enum Sort public enum Sort
{ {
IN_QUERY_SORT, POST_QUERY_SORT IN_QUERY_SORT, POST_QUERY_SORT
} }
private final NodeService nodeService; private final NodeService nodeService;
private final SearchService searchService; private final SearchService searchService;
public AbstractQuery(NodeService nodeService, SearchService searchService) public AbstractQuery(NodeService nodeService, SearchService searchService)
{ {
this.nodeService = nodeService; this.nodeService = nodeService;
@@ -388,14 +368,14 @@ public class QueriesImpl implements Queries, InitializingBean
} }
public CollectionWithPagingInfo<T> find(Parameters parameters, public CollectionWithPagingInfo<T> find(Parameters parameters,
String termName, int minTermLength, String queryTemplateName, String termName, int minTermLength, String queryTemplateName,
Sort sort, Map<String, QName> sortParamsToQNames, SortColumn... defaultSort) Sort sort, Map<String, QName> sortParamsToQNames, SortColumn... defaultSort)
{ {
SearchParameters sp = new SearchParameters(); SearchParameters sp = new SearchParameters();
sp.setLanguage(SearchService.LANGUAGE_FTS_ALFRESCO); sp.setLanguage(SearchService.LANGUAGE_FTS_ALFRESCO);
sp.addStore(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE); sp.addStore(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE);
sp.setDefaultFieldName(queryTemplateName); sp.setDefaultFieldName(queryTemplateName);
String term = getTerm(parameters, termName, minTermLength); String term = getTerm(parameters, termName, minTermLength);
StringBuilder query = new StringBuilder(); StringBuilder query = new StringBuilder();
@@ -404,7 +384,7 @@ public class QueriesImpl implements Queries, InitializingBean
Paging paging = parameters.getPaging(); Paging paging = parameters.getPaging();
PagingRequest pagingRequest = Util.getPagingRequest(paging); PagingRequest pagingRequest = Util.getPagingRequest(paging);
List<SortColumn> defaultSortCols = (defaultSort != null ? Arrays.asList(defaultSort) : Collections.emptyList()); List<SortColumn> defaultSortCols = (defaultSort != null ? Arrays.asList(defaultSort) : Collections.emptyList());
if (sort == IN_QUERY_SORT) if (sort == IN_QUERY_SORT)
{ {
@@ -413,36 +393,43 @@ public class QueriesImpl implements Queries, InitializingBean
sp.setSkipCount(pagingRequest.getSkipCount()); sp.setSkipCount(pagingRequest.getSkipCount());
sp.setMaxItems(pagingRequest.getMaxItems()); sp.setMaxItems(pagingRequest.getMaxItems());
} }
ResultSet queryResults = null; ResultSet queryResults = null;
List<T> collection = null;
try try
{ {
queryResults = searchService.query(sp); queryResults = searchService.query(sp);
List<NodeRef> nodeRefs = queryResults.getNodeRefs(); List<NodeRef> nodeRefs = queryResults.getNodeRefs();
if (sort == POST_QUERY_SORT) Map<NodeRef, T>
{
nodeRefs = postQuerySort(parameters, sortParamsToQNames, defaultSortCols, nodeRefs); collection = new LinkedHashMap<>(nodeRefs.size());
}
collection = newList(nodeRefs.size());
List<String> includeParam = parameters.getInclude(); List<String> includeParam = parameters.getInclude();
for (NodeRef nodeRef : nodeRefs) for (NodeRef nodeRef : nodeRefs)
{ {
T t = convert(nodeRef, includeParam); try
collection.add(t); {
T t = convert(nodeRef, includeParam);
collection.put(nodeRef, t);
}
catch (AccessDeniedException ade)
{
LOGGER.debug("Ignoring search result for nodeRef " + nodeRef + " due to access denied exception", ade);
}
} }
if (sort == POST_QUERY_SORT) if (sort == POST_QUERY_SORT)
{ {
return listPage(collection, paging); List<T> postQuerySortedCollection = postQuerySort(parameters, sortParamsToQNames, defaultSortCols, collection.keySet())
.stream()
.map(collection::get)
.toList();
return listPage(postQuerySortedCollection, paging);
} }
else else
{ {
return CollectionWithPagingInfo.asPaged(paging, collection, queryResults.hasMore(), Long.valueOf(queryResults.getNumberFound()).intValue()); return CollectionWithPagingInfo.asPaged(paging, collection.values(), queryResults.hasMore(), Long.valueOf(queryResults.getNumberFound()).intValue());
} }
} }
finally finally
@@ -455,40 +442,39 @@ public class QueriesImpl implements Queries, InitializingBean
} }
/** /**
* Builds up the query and is expected to call {@link SearchParameters#setDefaultFieldName(String)} * Builds up the query and is expected to call {@link SearchParameters#setDefaultFieldName(String)} and {@link SearchParameters#addQueryTemplate(String, String)}
* and {@link SearchParameters#addQueryTemplate(String, String)} *
* @param query StringBuilder into which the query should be built. * @param query
* @param term to be searched for * StringBuilder into which the query should be built.
* @param sp SearchParameters * @param term
* to be searched for
* @param sp
* SearchParameters
* @param queryTemplateName * @param queryTemplateName
*/ */
protected abstract void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName); protected abstract void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName);
/**
* Returns a list of the correct type.
* @param capacity of the list
* @return a new list.
*/
protected abstract List<T> newList(int capacity);
/** /**
* Converts a nodeRef into the an object of the required type. * Converts a nodeRef into the an object of the required type.
* @param nodeRef to be converted *
* @param includeParam additional fields to be included * @param nodeRef
* to be converted
* @param includeParam
* additional fields to be included
* @return the object * @return the object
*/ */
protected abstract T convert(NodeRef nodeRef, List<String> includeParam); protected abstract T convert(NodeRef nodeRef, List<String> includeParam);
protected String getTerm(Parameters parameters, String termName, int minTermLength) protected String getTerm(Parameters parameters, String termName, int minTermLength)
{ {
String term = parameters.getParameter(termName); String term = parameters.getParameter(termName);
if (term == null) if (term == null)
{ {
throw new InvalidArgumentException("Query '"+termName+"' not specified"); throw new InvalidArgumentException("Query '" + termName + "' not specified");
} }
term = escapeTerm(term); term = escapeTerm(term);
int cnt = 0; int cnt = 0;
for (int i = 0; i < term.length(); i++) for (int i = 0; i < term.length(); i++)
{ {
@@ -505,7 +491,7 @@ public class QueriesImpl implements Queries, InitializingBean
if (cnt < minTermLength) if (cnt < minTermLength)
{ {
throw new InvalidArgumentException("Query '"+termName+"' is too short. Must have at least "+minTermLength+" alphanumeric chars"); throw new InvalidArgumentException("Query '" + termName + "' is too short. Must have at least " + minTermLength + " alphanumeric chars");
} }
return term; return term;
@@ -524,12 +510,12 @@ public class QueriesImpl implements Queries, InitializingBean
term = SearchLanguageConversion.escapeLuceneQuery(term); term = SearchLanguageConversion.escapeLuceneQuery(term);
return term; return term;
} }
/** /**
* Adds sort order to the SearchParameters. * Adds sort order to the SearchParameters.
*/ */
protected void addSortOrder(Parameters parameters, Map<String, QName> sortParamsToQNames, protected void addSortOrder(Parameters parameters, Map<String, QName> sortParamsToQNames,
List<SortColumn> defaultSortCols, SearchParameters sp) List<SortColumn> defaultSortCols, SearchParameters sp)
{ {
List<SortColumn> sortCols = getSorting(parameters, defaultSortCols); List<SortColumn> sortCols = getSorting(parameters, defaultSortCols);
for (SortColumn sortCol : sortCols) for (SortColumn sortCol : sortCols)
@@ -537,16 +523,16 @@ public class QueriesImpl implements Queries, InitializingBean
QName sortPropQName = sortParamsToQNames.get(sortCol.column); QName sortPropQName = sortParamsToQNames.get(sortCol.column);
if (sortPropQName == null) if (sortPropQName == null)
{ {
throw new InvalidArgumentException("Invalid sort field: "+sortCol.column); throw new InvalidArgumentException("Invalid sort field: " + sortCol.column);
} }
sp.addSort("@" + sortPropQName, sortCol.asc); sp.addSort("@" + sortPropQName, sortCol.asc);
} }
} }
private List<SortColumn> getSorting(Parameters parameters, List<SortColumn> defaultSortCols) private List<SortColumn> getSorting(Parameters parameters, List<SortColumn> defaultSortCols)
{ {
List<SortColumn> sortCols = parameters.getSorting(); List<SortColumn> sortCols = parameters.getSorting();
if (sortCols == null || sortCols.size() == 0) if (sortCols == null || sortCols.isEmpty())
{ {
sortCols = defaultSortCols == null ? Collections.emptyList() : defaultSortCols; sortCols = defaultSortCols == null ? Collections.emptyList() : defaultSortCols;
} }
@@ -554,63 +540,66 @@ public class QueriesImpl implements Queries, InitializingBean
} }
protected List<NodeRef> postQuerySort(Parameters parameters, Map<String, QName> sortParamsToQNames, protected List<NodeRef> postQuerySort(Parameters parameters, Map<String, QName> sortParamsToQNames,
List<SortColumn> defaultSortCols, List<NodeRef> nodeRefs) List<SortColumn> defaultSortCols, Set<NodeRef> unsortedNodeRefs)
{ {
final List<SortColumn> sortCols = getSorting(parameters, defaultSortCols); final List<SortColumn> sortCols = getSorting(parameters, defaultSortCols);
int sortColCount = sortCols.size(); int sortColCount = sortCols.size();
if (sortColCount > 0)
{
// make copy of nodeRefs because it can be unmodifiable list.
nodeRefs = new ArrayList<NodeRef>(nodeRefs);
List<QName> sortPropQNames = new ArrayList<>(sortColCount);
for (SortColumn sortCol : sortCols)
{
QName sortPropQName = sortParamsToQNames.get(sortCol.column);
if (sortPropQName == null)
{
throw new InvalidArgumentException("Invalid sort field: "+sortCol.column);
}
sortPropQNames.add(sortPropQName);
}
final Collator col = AlfrescoCollator.getInstance(I18NUtil.getLocale());
Collections.sort(nodeRefs, new Comparator<NodeRef>()
{
@Override
public int compare(NodeRef n1, NodeRef n2)
{
int result = 0;
for (int i=0; i<sortCols.size(); i++)
{
SortColumn sortCol = sortCols.get(i);
QName sortPropQName = sortPropQNames.get(i);
Serializable p1 = getProperty(n1, sortPropQName);
Serializable p2 = getProperty(n2, sortPropQName);
result = ((p1 instanceof Long) && (p2 instanceof Long) if (sortColCount == 0)
? Long.compare((Long)p1, (Long)p2) {
return new ArrayList<>(unsortedNodeRefs);
}
// make copy of nodeRefs because it can be unmodifiable list.
List<NodeRef> sortedNodeRefs = new ArrayList<>(unsortedNodeRefs);
List<QName> sortPropQNames = new ArrayList<>(sortColCount);
for (SortColumn sortCol : sortCols)
{
QName sortPropQName = sortParamsToQNames.get(sortCol.column);
if (sortPropQName == null)
{
throw new InvalidArgumentException("Invalid sort field: " + sortCol.column);
}
sortPropQNames.add(sortPropQName);
}
final Collator col = AlfrescoCollator.getInstance(I18NUtil.getLocale());
Collections.sort(sortedNodeRefs, new Comparator<NodeRef>() {
@Override
public int compare(NodeRef n1, NodeRef n2)
{
int result = 0;
for (int i = 0; i < sortCols.size(); i++)
{
SortColumn sortCol = sortCols.get(i);
QName sortPropQName = sortPropQNames.get(i);
Serializable p1 = getProperty(n1, sortPropQName);
Serializable p2 = getProperty(n2, sortPropQName);
result = ((p1 instanceof Long) && (p2 instanceof Long)
? Long.compare((Long) p1, (Long) p2)
: col.compare(p1.toString(), p2.toString())) : col.compare(p1.toString(), p2.toString()))
* (sortCol.asc ? 1 : -1); * (sortCol.asc ? 1 : -1);
if (result != 0) if (result != 0)
{ {
break; break;
}
} }
return result;
} }
return result;
}
private Serializable getProperty(NodeRef nodeRef, QName sortPropQName) private Serializable getProperty(NodeRef nodeRef, QName sortPropQName)
{ {
Serializable result = nodeService.getProperty(nodeRef, sortPropQName); Serializable result = nodeService.getProperty(nodeRef, sortPropQName);
return result == null ? "" : result; return result == null ? "" : result;
} }
}); });
}
return nodeRefs; return sortedNodeRefs;
} }
// note: see also AbstractNodeRelation // note: see also AbstractNodeRelation

146
remote-api/src/test/java/org/alfresco/rest/api/tests/QueriesSitesApiTest.java
View File

@@ -25,6 +25,20 @@
*/ */
package org.alfresco.rest.api.tests; package org.alfresco.rest.api.tests;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.alfresco.repo.security.authentication.AuthenticationUtil; import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.rest.AbstractSingleNetworkSiteTest; import org.alfresco.rest.AbstractSingleNetworkSiteTest;
import org.alfresco.rest.api.Queries; import org.alfresco.rest.api.Queries;
@@ -36,27 +50,12 @@ import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.search.SearchParameters; import org.alfresco.service.cmr.search.SearchParameters;
import org.alfresco.service.cmr.site.SiteService; import org.alfresco.service.cmr.site.SiteService;
import org.alfresco.service.cmr.site.SiteVisibility; import org.alfresco.service.cmr.site.SiteVisibility;
import org.alfresco.util.testing.category.LuceneTests;
import org.junit.Before;
import org.junit.Test;
import org.junit.experimental.categories.Category;
import org.mockito.ArgumentCaptor;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
/** /**
* V1 REST API tests for pre-defined 'live' search Queries on Sites * V1 REST API tests for pre-defined 'live' search Queries on Sites
* *
* <ul> * <ul>
* <li> {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/queries/sites} </li> * <li>{@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/queries/sites}</li>
* </ul> * </ul>
* *
* @author janv * @author janv
@@ -64,7 +63,7 @@ import static org.mockito.Mockito.verify;
public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
{ {
private static final String URL_QUERIES_LSS = "queries/sites"; private static final String URL_QUERIES_LSS = "queries/sites";
private SiteService siteService; private SiteService siteService;
@Before @Before
@@ -72,7 +71,7 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
public void setup() throws Exception public void setup() throws Exception
{ {
super.setup(); super.setup();
siteService = (SiteService)applicationContext.getBean("SiteService"); siteService = (SiteService) applicationContext.getBean("SiteService");
} }
// Note expectedIds defaults to ids // Note expectedIds defaults to ids
@@ -86,7 +85,7 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
} }
dummySearchServiceQueryNodeRefs.clear(); dummySearchServiceQueryNodeRefs.clear();
for (String id: ids) for (String id : ids)
{ {
NodeRef nodeRef = getNodeRef(id); NodeRef nodeRef = getNodeRef(id);
dummySearchServiceQueryNodeRefs.add(nodeRef); dummySearchServiceQueryNodeRefs.add(nodeRef);
@@ -98,7 +97,7 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
if (expectedStatus == 200) if (expectedStatus == 200)
{ {
String termWithEscapedAsterisks = term.replaceAll("\\*", "\\\\*"); String termWithEscapedAsterisks = term.replaceAll("\\*", "\\\\*");
String expectedQuery = "TYPE:\"{http://www.alfresco.org/model/site/1.0}site\" AND (\"*"+ termWithEscapedAsterisks +"*\")"; String expectedQuery = "TYPE:\"{http://www.alfresco.org/model/site/1.0}site\" AND (\"*" + termWithEscapedAsterisks + "*\")";
ArgumentCaptor<SearchParameters> searchParametersCaptor = ArgumentCaptor.forClass(SearchParameters.class); ArgumentCaptor<SearchParameters> searchParametersCaptor = ArgumentCaptor.forClass(SearchParameters.class);
verify(mockSearchService, times(++callCountToMockSearchService)).query(searchParametersCaptor.capture()); verify(mockSearchService, times(++callCountToMockSearchService)).query(searchParametersCaptor.capture());
SearchParameters parameters = searchParametersCaptor.getValue(); SearchParameters parameters = searchParametersCaptor.getValue();
@@ -109,30 +108,32 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
if (orderBy != null) if (orderBy != null)
{ {
for (int i=0; i<expectedIds.length; i++) for (int i = 0; i < expectedIds.length; i++)
{ {
String id = expectedIds[i]; String id = expectedIds[i];
String actualId = sites.get(i).getId(); String actualId = sites.get(i).getId();
assertEquals("Order "+i+":", id, actualId); assertEquals("Order " + i + ":", id, actualId);
} }
} }
} }
} }
/** /**
* Tests basic api for nodes live search sites - metadata (id, title, description) * Tests basic api for nodes live search sites - metadata (id, title, description)
* *
* <p>GET:</p> * <p>
* GET:
* </p>
* {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/queries/sites} * {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/queries/sites}
*/ */
@Test @Test
public void testLiveSearchSites() throws Exception public void testLiveSearchSites() throws Exception
{ {
setRequestContext(user1); setRequestContext(user1);
AuthenticationUtil.setFullyAuthenticatedUser(user1);
int sCount = 5; int sCount = 5;
assertTrue(sCount > 4); // as relied on by test below assertTrue(sCount > 4); // as relied on by test below
List<String> siteIds = new ArrayList<>(sCount); List<String> siteIds = new ArrayList<>(sCount);
try try
@@ -149,14 +150,14 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
String siteD = "siteD"; String siteD = "siteD";
int charValue = siteI.charAt(0); int charValue = siteI.charAt(0);
// create some some sites with site id: ab00001, abc00002, abcd00003, abcde00004, abcdef00005 (and some specific titles and descriptions) // create some some sites with site id: ab00001, abc00002, abcd00003, abcde00004, abcdef00005 (and some specific titles and descriptions)
for (int i = 1; i <= sCount; i++) for (int i = 1; i <= sCount; i++)
{ {
String num = String.format("%05d", i); String num = String.format("%05d", i);
charValue = charValue+1; charValue = charValue + 1;
siteI = siteI + String.valueOf((char)charValue); siteI = siteI + String.valueOf((char) charValue);
String siteId = siteI + num + RUNID; String siteId = siteI + num + RUNID;
String siteTitle = siteT + num + siteT; String siteTitle = siteT + num + siteT;
@@ -220,7 +221,7 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
{ {
// some cleanup // some cleanup
setRequestContext(user1); setRequestContext(user1);
for (String siteId : siteIds) for (String siteId : siteIds)
{ {
deleteSite(siteId, true, 204); deleteSite(siteId, true, 204);
@@ -230,14 +231,20 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
private NodeRef getNodeRef(String createdSiteId) private NodeRef getNodeRef(String createdSiteId)
{ {
AuthenticationUtil.setFullyAuthenticatedUser(user1); // Created sites do not return NodeRefs to the caller so we need to get the NodeRef from the siteService.
// Temporarily as admin we will get NodeRefs to handle ACL authorization.
String userUnderTest = AuthenticationUtil.getFullyAuthenticatedUser();
AuthenticationUtil.setFullyAuthenticatedUser(DEFAULT_ADMIN);
// The following call to siteService.getSite(createdSiteId).getNodeRef() returns a NodeRef like: // The following call to siteService.getSite(createdSiteId).getNodeRef() returns a NodeRef like:
// workspace://SpacesStore/9db76769-96de-4de4-bdb4-a127130af362 // workspace://SpacesStore/9db76769-96de-4de4-bdb4-a127130af362
// We call tenantService.getName(nodeRef) to get a fully qualified NodeRef as Solr returns this. // We call tenantService.getName(nodeRef) to get a fully qualified NodeRef as Solr returns this.
// They look like: // They look like:
// workspace://@org.alfresco.rest.api.tests.queriespeopleapitest@SpacesStore/9db76769-96de-4de4-bdb4-a127130af362 // workspace://@org.alfresco.rest.api.tests.queriespeopleapitest@SpacesStore/9db76769-96de-4de4-bdb4-a127130af362
NodeRef nodeRef = siteService.getSite(createdSiteId).getNodeRef(); NodeRef nodeRef = siteService.getSite(createdSiteId).getNodeRef();
nodeRef = tenantService.getName(nodeRef); nodeRef = tenantService.getName(nodeRef);
AuthenticationUtil.setFullyAuthenticatedUser(userUnderTest);
return nodeRef; return nodeRef;
} }
@@ -245,7 +252,7 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
public void testLiveSearchSites_SortPage() throws Exception public void testLiveSearchSites_SortPage() throws Exception
{ {
setRequestContext(user1); setRequestContext(user1);
AuthenticationUtil.setFullyAuthenticatedUser(user1);
List<String> siteIds = new ArrayList<>(5); List<String> siteIds = new ArrayList<>(5);
try try
@@ -253,14 +260,14 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
// As user 1 ... // As user 1 ...
Paging paging = getPaging(0, 100); Paging paging = getPaging(0, 100);
// create site // create site
String s1 = createSite("siABCDEF"+RUNID, "ABCDEF DEF", "sdABCDEF", SiteVisibility.PRIVATE, 201).getId(); String s1 = createSite("siABCDEF" + RUNID, "ABCDEF DEF", "sdABCDEF", SiteVisibility.PRIVATE, 201).getId();
String s2 = createSite("siABCD"+RUNID, "ABCD DEF", "sdABCD", SiteVisibility.PRIVATE, 201).getId(); String s2 = createSite("siABCD" + RUNID, "ABCD DEF", "sdABCD", SiteVisibility.PRIVATE, 201).getId();
String s3 = createSite("siABCDE"+RUNID, "ABCDE DEF", "sdABCDE", SiteVisibility.PRIVATE, 201).getId(); String s3 = createSite("siABCDE" + RUNID, "ABCDE DEF", "sdABCDE", SiteVisibility.PRIVATE, 201).getId();
String s4 = createSite("siAB"+RUNID, "AB DEF", "sdAB", SiteVisibility.PRIVATE, 201).getId(); String s4 = createSite("siAB" + RUNID, "AB DEF", "sdAB", SiteVisibility.PRIVATE, 201).getId();
String s5 = createSite("siABC"+RUNID, "ABC DEF", "sdABC", SiteVisibility.PRIVATE, 201).getId(); String s5 = createSite("siABC" + RUNID, "ABC DEF", "sdABC", SiteVisibility.PRIVATE, 201).getId();
// test sort order // test sort order
{ {
// default sort order - title asc // default sort order - title asc
@@ -276,11 +283,11 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
// basic paging tests // basic paging tests
{ {
// sort order - title desc // sort order - title desc
checkApiCall("siAB", "title desc", getPaging(0, 2), 200, new String[] {s1, s3}, s1, s3, s2, s5, s4); checkApiCall("siAB", "title desc", getPaging(0, 2), 200, new String[]{s1, s3}, s1, s3, s2, s5, s4);
checkApiCall("siAB", "title desc", getPaging(2, 2), 200, new String[] {s2, s5}, s1, s3, s2, s5, s4); checkApiCall("siAB", "title desc", getPaging(2, 2), 200, new String[]{s2, s5}, s1, s3, s2, s5, s4);
checkApiCall("siAB", "title desc", getPaging(4, 2), 200, new String[] {s4}, s1, s3, s2, s5, s4); checkApiCall("siAB", "title desc", getPaging(4, 2), 200, new String[]{s4}, s1, s3, s2, s5, s4);
} }
// -ve tests // -ve tests
{ {
// -ve test - invalid sort field // -ve test - invalid sort field
@@ -304,7 +311,52 @@ public class QueriesSitesApiTest extends AbstractSingleNetworkSiteTest
} }
} }
} }
/**
* If the search service do not support ACL filtering, then the Queries API should handle the response to exclude private sites and potential unauthorized error when building response.
*/
@Test
public void testLiveSearchExcludesPrivateSites() throws Exception
{
String publicSiteId = null;
String privateSiteId = null;
try
{
// given
setRequestContext(null, DEFAULT_ADMIN, DEFAULT_ADMIN_PWD);
createUser("bartender");
publicSiteId = createSite("samePrefixPublicSite", "samePrefixPublicSite", "Visible to all users", SiteVisibility.PUBLIC, 201).getId();
privateSiteId = createSite("samePrefixPrivateSite", "samePrefixPrivateSite", "Hidden from bartender", SiteVisibility.PRIVATE, 201).getId();
String[] searchResults = {publicSiteId, privateSiteId};
String[] expectedSites = {publicSiteId};
// when
setRequestContext(null, "bartender", "password");
AuthenticationUtil.setFullyAuthenticatedUser("bartender");
// then
checkApiCall("samePrefix", null, getPaging(0, 100), 200, expectedSites, searchResults);
}
finally
{
// cleanup
AuthenticationUtil.setFullyAuthenticatedUser(DEFAULT_ADMIN);
setRequestContext(null, DEFAULT_ADMIN, DEFAULT_ADMIN_PWD);
if (publicSiteId != null)
{
deleteSite(publicSiteId, true, 204);
}
if (privateSiteId != null)
{
deleteSite(privateSiteId, true, 204);
}
deleteUser("bartender", null);
}
}
@Override @Override
public String getScope() public String getScope()
{ {