Merge branch 'master' into fix-4878

Author: maximd-g

.github/workflows/build.yml

@@ -28,7 +28,7 @@ jobs:
         distribution: 'oracle'
         java-version: '21'
     - name: Cache Maven packages
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
@@ -57,7 +57,7 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: ./dev/main
     - name: Upload artifact
-      uses: actions/upload-artifact@v5
+      uses: actions/upload-artifact@v6
       with:
         name: opengrok-${{ github.sha }}-${{ matrix.os }}.tar.gz
         path: distribution/target/opengrok-*.tar.gz

.github/workflows/javadoc.yml

@@ -24,7 +24,7 @@ jobs:
         distribution: 'oracle'
         java-version: '21'
     - name: Cache Maven packages
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.github/workflows/release.yml

@@ -31,7 +31,7 @@ jobs:
         distribution: 'oracle'
         java-version: '21'
     - name: Cache Maven packages
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.gitignore

@@ -60,3 +60,4 @@ pmd.bat
 .classpath
 .checkstyle
 .tox
+opengrok-indexer/index/dirty

Dockerfile

@@ -41,7 +41,7 @@ RUN cp `ls -t distribution/target/*.tar.gz | head -1` /opengrok.tar.gz
 # Store the version in a file so that the tools can report it.
 RUN /mvn/mvnw help:evaluate -Dexpression=project.version -q -DforceStdout > /mvn/VERSION
 
-FROM tomcat:10.1.49-jdk21
+FROM tomcat:10.1.50-jdk21
 LABEL maintainer="https://github.com/oracle/opengrok"
 LABEL org.opencontainers.image.source="https://github.com/oracle/opengrok"
 LABEL org.opencontainers.image.description="OpenGrok code search"

apiary.apib

@@ -643,7 +643,7 @@ The repository path is relative to source root.
   + repository - repository path with native path separators (of the machine
   running the service) starting with path separator for which to return type
 
-## Search [/search{?full,def,symbol,path,hist,type,projects,maxresults,start}]
+## Search [/search{?full,def,symbol,path,hist,type,projects,maxresults,start,sort}]
 
 ## return search results [GET]
 
@@ -657,6 +657,15 @@ 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: relevancy (optional, enum[string])
+     + Enum
+         + relevancy
+         + fullpath
+         + lastmodtime
+     + Description: Sort order for results. Possible values:
+         - `relevancy`: Sort by Lucene score (most relevant first).
+         - `fullpath`: Sort by file path (alphabetical).
+         - `lastmodtime`: Sort by last modification date (newest first).
 
 + Response 200 (application/json)
   + Body

distribution/pom.xml

@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.opengrok</groupId>
     <artifactId>opengrok-top</artifactId>
-    <version>1.14.4</version>
+    <version>1.14.5</version>
   </parent>
 
   <artifactId>opengrok-dist</artifactId>
@@ -28,20 +28,20 @@
     <dependency>
       <groupId>org.opengrok</groupId>
       <artifactId>opengrok</artifactId>
-      <version>1.14.4</version>
+      <version>1.14.5</version>
     </dependency>
 
     <dependency>
       <groupId>org.opengrok</groupId>
       <artifactId>opengrok-web</artifactId>
-      <version>1.14.4</version>
+      <version>1.14.5</version>
       <type>war</type>
     </dependency>
 
     <dependency>
       <groupId>org.opengrok</groupId>
       <artifactId>tools</artifactId>
-      <version>1.14.4</version>
+      <version>1.14.5</version>
       <type>pom</type>
     </dependency>
   </dependencies>

opengrok-indexer/index/dirty

@@ -29,11 +29,11 @@ Portions Copyright (c) 2020-2020, Lubos Kosco <tarzanek@gmail.com>.
     <parent>
         <groupId>org.opengrok</groupId>
         <artifactId>opengrok-top</artifactId>
-        <version>1.14.4</version>
+        <version>1.14.5</version>
     </parent>
 
     <artifactId>opengrok</artifactId>
-    <version>1.14.4</version>
+    <version>1.14.5</version>
     <packaging>jar</packaging>
 
     <name>OpenGrok Indexer</name>

opengrok-indexer/pom.xml

@@ -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.TopDocs;
+import org.apache.lucene.search.TopFieldCollectorManager;
 import org.apache.lucene.search.TopScoreDocCollectorManager;
 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,6 @@ public class SearchEngine {
     int cachePages = RuntimeEnvironment.getInstance().getCachePages();
     int totalHits = 0;
     private ScoreDoc[] hits;
-    private TopScoreDocCollectorManager collectorManager;
     private IndexSearcher searcher;
     boolean allCollected;
     private final ArrayList<SuperIndexSearcher> searcherList = new ArrayList<>();
@@ -181,6 +189,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,20 +217,39 @@ private void searchMultiDatabase(List<Project> projectList, boolean paging) thro
     }
 
     private void searchIndex(IndexSearcher searcher, boolean paging) throws IOException {
-        collectorManager = new TopScoreDocCollectorManager(hitsPerPage * cachePages, Short.MAX_VALUE);
+        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));
+        }
+
+        int numHits = hitsPerPage * cachePages;
+        TopDocs topDocs;
+        if (luceneSort == null) {
+            topDocs = searcher.search(query, new TopScoreDocCollectorManager(numHits, Short.MAX_VALUE));
+        } else {
+            topDocs = searcher.search(query, new TopFieldCollectorManager(luceneSort, numHits, Short.MAX_VALUE));
+        }
+        hits = topDocs.scoreDocs;
+        totalHits = (int) topDocs.totalHits.value;
+
         Statistics stat = new Statistics();
-        hits = searcher.search(query, collectorManager).scoreDocs;
-        totalHits = searcher.count(query);
         stat.report(LOGGER, Level.FINEST, "search via SearchEngine done",
                 "search.latency", new String[]{"category", "engine",
                         "outcome", totalHits > 0 ? "success" : "empty"});
-        if (!paging && totalHits > hitsPerPage * cachePages) {
-            collectorManager = new TopScoreDocCollectorManager(totalHits, Short.MAX_VALUE);
-            hits = searcher.search(query, collectorManager).scoreDocs;
-            stat.report(LOGGER, Level.FINEST, "FULL search via SearchEngine done",
-                    "search.latency", new String[]{"category", "engine",
-                            "outcome", totalHits > 0 ? "success" : "empty"});
+
+        if (!paging && totalHits > numHits) {
+            if (luceneSort == null) {
+                topDocs = searcher.search(query, new TopScoreDocCollectorManager(totalHits, Short.MAX_VALUE));
+            } else {
+                topDocs = searcher.search(query, new TopFieldCollectorManager(luceneSort, totalHits, Short.MAX_VALUE));
+            }
+            hits = topDocs.scoreDocs;
         }
+
+        allCollected = !paging || totalHits <= numHits;
+
         StoredFields storedFields = searcher.storedFields();
         for (ScoreDoc hit : hits) {
             int docId = hit.doc;
@@ -414,7 +445,7 @@ public void results(int start, int end, List<Hit> ret) {
         // TODO check if below fits for if end=old hits.length, or it should include it
         if (end > hits.length && !allCollected) {
             //do the requery, we want more than 5 pages
-            collectorManager = new TopScoreDocCollectorManager(totalHits, Short.MAX_VALUE);
+            var collectorManager = new TopScoreDocCollectorManager(totalHits, Short.MAX_VALUE);
             try {
                 hits = searcher.search(query, collectorManager).scoreDocs;
             } catch (Exception e) { // this exception should never be hit, since search() will hit this before
@@ -646,4 +677,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;
+    }
 }