Allow sorting in the API calls by path and date

Signed-off-by: Bernát Gábor <gaborjbernat@gmail.com>

Author: gaborbernat

apiary.apib

@@ -657,6 +657,10 @@ The repository path is relative to source root.
   + projects (optional, string) - projects to search in
   + maxresults (optional, string) - maximum number of documents whose hits will be returned (default 1000)
   + start (optional, string) - start index from which to return results
+  + sort (optional, string) - sort order for results (default: "relevancy"). Possible values are:
+    - `relevancy` - by relevancy (Lucene score)
+    - `fullpath` - by file path
+    - `lastmodtime` - by last modification date of the file.
 
 + Response 200 (application/json)
   + Body

opengrok-indexer/src/main/java/org/opengrok/indexer/search/SearchEngine.java

@@ -48,6 +48,10 @@
 import org.apache.lucene.search.IndexSearcher;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.search.ScoreDoc;
+import org.apache.lucene.search.Sort;
+import org.apache.lucene.search.SortField;
+import org.apache.lucene.search.TopDocsCollector;
+import org.apache.lucene.search.TopFieldCollector;
 import org.apache.lucene.search.TopScoreDocCollector;
 import org.apache.lucene.util.Version;
 import org.opengrok.indexer.analysis.AbstractAnalyzer;
@@ -66,6 +70,7 @@
 import org.opengrok.indexer.util.Statistics;
 import org.opengrok.indexer.util.TandemPath;
 import org.opengrok.indexer.web.Prefix;
+import org.opengrok.indexer.web.SortOrder;
 
 /**
  * This is an encapsulation of the details on how to search in the index database.
@@ -114,6 +119,10 @@ public class SearchEngine {
      * Holds value of property type.
      */
     private String type;
+    /**
+     * Holds value of property sort.
+     */
+    private SortOrder sortOrder;
     /**
      * Holds value of property indexDatabase.
      */
@@ -132,7 +141,7 @@ public class SearchEngine {
     int cachePages = RuntimeEnvironment.getInstance().getCachePages();
     int totalHits = 0;
     private ScoreDoc[] hits;
-    private TopScoreDocCollector collector;
+    private TopDocsCollector<?> collector;
     private IndexSearcher searcher;
     boolean allCollected;
     private final ArrayList<SuperIndexSearcher> searcherList = new ArrayList<>();
@@ -181,6 +190,10 @@ private void searchSingleDatabase(boolean paging) throws IOException {
         SuperIndexSearcher superIndexSearcher = RuntimeEnvironment.getInstance().getSuperIndexSearcher("");
         searcherList.add(superIndexSearcher);
         searcher = superIndexSearcher;
+        // If a field-based sort is requested, collect all hits (disable paging optimization)
+        if (sortOrder != SortOrder.RELEVANCY) {
+            paging = false;
+        }
         searchIndex(superIndexSearcher, paging);
     }
 
@@ -205,16 +218,33 @@ private void searchMultiDatabase(List<Project> projectList, boolean paging) thro
     }
 
     private void searchIndex(IndexSearcher searcher, boolean paging) throws IOException {
-        collector = TopScoreDocCollector.create(hitsPerPage * cachePages, Short.MAX_VALUE);
-        Statistics stat = new Statistics();
+        Sort luceneSort = null;
+        if (getSortOrder() == SortOrder.LASTMODIFIED) {
+            luceneSort = new Sort(new SortField(QueryBuilder.DATE, SortField.Type.STRING, true));
+        } else if (getSortOrder() == SortOrder.BY_PATH) {
+            luceneSort = new Sort(new SortField(QueryBuilder.FULLPATH, SortField.Type.STRING));
+        }
+        if (luceneSort == null) {
+            collector = TopScoreDocCollector.create(hitsPerPage * cachePages, Short.MAX_VALUE);
+        } else {
+            collector = TopFieldCollector.create(luceneSort, hitsPerPage * cachePages, Short.MAX_VALUE);
+        }
         searcher.search(query, collector);
         totalHits = collector.getTotalHits();
+        Statistics stat = new Statistics();
         stat.report(LOGGER, Level.FINEST, "search via SearchEngine done",
                 "search.latency", new String[]{"category", "engine",
                         "outcome", totalHits > 0 ? "success" : "empty"});
-        if (!paging && totalHits > 0) {
-            collector = TopScoreDocCollector.create(totalHits, Short.MAX_VALUE);
-            searcher.search(query, collector);
+        if (luceneSort == null) {
+            if (!paging && totalHits > 0) {
+                collector = TopScoreDocCollector.create(totalHits, Short.MAX_VALUE);
+                searcher.search(query, collector);
+            }
+        } else {
+            if (!paging && totalHits > 0) {
+                collector = TopFieldCollector.create(luceneSort, totalHits, Short.MAX_VALUE);
+                searcher.search(query, collector);
+            }
         }
         hits = collector.topDocs().scoreDocs;
         StoredFields storedFields = searcher.storedFields();
@@ -645,4 +675,22 @@ public String getType() {
     public void setType(String fileType) {
         this.type = fileType;
     }
+
+    /**
+     * Getter for property sort.
+     *
+     * @return Value of property sortOrder.
+     */
+    public SortOrder getSortOrder() {
+        return this.sortOrder;
+    }
+
+    /**
+     * Setter for property sort.
+     *
+     * @param sortOrder New value of property sortOrder.
+     */
+    public void setSortOrder(SortOrder sortOrder) {
+        this.sortOrder = sortOrder;
+    }
 }

opengrok-web/src/main/java/org/opengrok/web/api/v1/controller/SearchController.java

@@ -39,6 +39,7 @@
 import org.opengrok.indexer.search.Hit;
 import org.opengrok.indexer.search.SearchEngine;
 import org.opengrok.indexer.web.QueryParameters;
+import org.opengrok.indexer.web.SortOrder;
 import org.opengrok.web.PageConfig;
 import org.opengrok.web.api.v1.filter.CorsEnable;
 import org.opengrok.web.api.v1.suggester.provider.service.SuggesterService;
@@ -58,6 +59,7 @@ public class SearchController {
     public static final String PATH = "search";
 
     private static final int MAX_RESULTS = 1000;
+    private static final String DEFAULT_SORT_ORDER = "relevancy";
 
     private final SuggesterService suggester;
 
@@ -81,9 +83,10 @@ public SearchResult search(
             @QueryParam("projects") final List<String> projects,
             @QueryParam("maxresults") // Akin to QueryParameters.COUNT_PARAM
             @DefaultValue(MAX_RESULTS + "") final int maxResults,
-            @QueryParam(QueryParameters.START_PARAM) @DefaultValue(0 + "") final int startDocIndex
+            @QueryParam(QueryParameters.START_PARAM) @DefaultValue(0 + "") final int startDocIndex,
+            @QueryParam(QueryParameters.SORT_PARAM) @DefaultValue(DEFAULT_SORT_ORDER) final String sort
     ) {
-        try (SearchEngineWrapper engine = new SearchEngineWrapper(full, def, symbol, path, hist, type)) {
+        try (SearchEngineWrapper engine = new SearchEngineWrapper(full, def, symbol, path, hist, type, SortOrder.get(sort))) {
 
             if (!engine.isValid()) {
                 throw new WebApplicationException("Invalid request", Response.Status.BAD_REQUEST);
@@ -119,14 +122,16 @@ private SearchEngineWrapper(
                 final String symbol,
                 final String path,
                 final String hist,
-                final String type
+                final String type,
+                final SortOrder sortOrder
         ) {
             engine.setFreetext(full);
             engine.setDefinition(def);
             engine.setSymbol(symbol);
             engine.setFile(path);
             engine.setHistory(hist);
             engine.setType(type);
+            engine.setSortOrder(sortOrder);
         }
 
         public List<Hit> search(

opengrok-web/src/main/java/org/opengrok/web/api/v1/filter/IncomingFilter.java

@@ -66,7 +66,7 @@ public class IncomingFilter implements ContainerRequestFilter, ConfigurationChan
     /**
      * Endpoint paths that are exempted from this filter.
      * @see SearchController#search(HttpServletRequest, String, String, String, String, String, String,
-     * java.util.List, int, int)
+     * java.util.List, int, int, String)
      * @see SuggesterController#getSuggestions(org.opengrok.web.api.v1.suggester.model.SuggesterQueryData)
      * @see SuggesterController#getConfig()
      */