Respect searchall query param when changing sort option

fixes #3547

Author: ahornace

opengrok-indexer/src/main/java/org/opengrok/indexer/web/QueryParameters.java

@@ -229,6 +229,12 @@ public class QueryParameters {
      */
     public static final String WINDOW_HASH_PARAM_EQ = WINDOW_HASH_PARAM + "=";
 
+    /**
+     * Parameter to be used when searching all projects. Useful when instance has too many projects and the resulting
+     * URL consisting of all projects could be too long.
+     */
+    public static final String ALL_PROJECT_SEARCH = "searchall";
+
     /* private to enforce static */
     private QueryParameters() {
     }

opengrok-web/src/main/java/org/opengrok/web/PageConfig.java

@@ -128,7 +128,6 @@ public final class PageConfig {
     public static final String DUMMY_REVISION = "unknown";
 
     // query parameters
-    protected static final String ALL_PROJECT_SEARCH = "searchall";
     protected static final String PROJECT_PARAM_NAME = "project";
     protected static final String GROUP_PARAM_NAME = "group";
     private static final String DEBUG_PARAM_NAME = "debug";
@@ -800,17 +799,7 @@ public Project getProject() {
      */
     public String getRequestedProjectsAsString() {
         if (requestedProjectsString == null) {
-            Set<String> projects = getRequestedProjects();
-            if (projects.isEmpty()) {
-                requestedProjectsString = "";
-            } else {
-                StringBuilder buf = new StringBuilder();
-                for (String name : projects) {
-                    buf.append(name).append(',');
-                }
-                buf.setLength(buf.length() - 1);
-                requestedProjectsString = buf.toString();
-            }
+            requestedProjectsString = String.join(",", getRequestedProjects());
         }
         return requestedProjectsString;
     }
@@ -842,15 +831,15 @@ public String getRequestedProjectsAsString() {
      * </ol>
      *
      * @return a possible empty set of project names but never {@code null}.
-     * @see #ALL_PROJECT_SEARCH
+     * @see QueryParameters#ALL_PROJECT_SEARCH
      * @see #PROJECT_PARAM_NAME
      * @see #GROUP_PARAM_NAME
      * @see #OPEN_GROK_PROJECT
      */
     public SortedSet<String> getRequestedProjects() {
         if (requestedProjects == null) {
-            requestedProjects
-                    = getRequestedProjects(ALL_PROJECT_SEARCH, PROJECT_PARAM_NAME, GROUP_PARAM_NAME, OPEN_GROK_PROJECT);
+            requestedProjects = getRequestedProjects(
+                    QueryParameters.ALL_PROJECT_SEARCH, PROJECT_PARAM_NAME, GROUP_PARAM_NAME, OPEN_GROK_PROJECT);
         }
         return requestedProjects;
     }

opengrok-web/src/main/webapp/search.jsp

@@ -63,9 +63,13 @@ include file="projects.jspf"
             Util.appendQuery(url, QueryParameters.HIST_SEARCH_PARAM, qb.getHist());
             Util.appendQuery(url, QueryParameters.TYPE_SEARCH_PARAM, qb.getType());
         }
-        if (sh.projects != null && sh.projects.size() != 0) {
-            Util.appendQuery(url, QueryParameters.PROJECT_SEARCH_PARAM,
-                    PageConfig.get(request).getRequestedProjectsAsString());
+        if (sh.projects != null && !sh.projects.isEmpty()) {
+            if (Boolean.parseBoolean(request.getParameter(QueryParameters.ALL_PROJECT_SEARCH))) {
+                Util.appendQuery(url, QueryParameters.ALL_PROJECT_SEARCH, Boolean.TRUE.toString());
+            } else {
+                Util.appendQuery(url, QueryParameters.PROJECT_SEARCH_PARAM,
+                        PageConfig.get(request).getRequestedProjectsAsString());
+            }
         }
         return url;
     }

opengrok-web/src/test/java/org/opengrok/web/PageConfigRequestedProjectsTest.java

@@ -39,6 +39,7 @@
 import org.opengrok.indexer.configuration.Group;
 import org.opengrok.indexer.configuration.Project;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
+import org.opengrok.indexer.web.QueryParameters;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
@@ -225,7 +226,7 @@ public void testNonExistentGroup() {
     @Test
     public void testSelectAllProjects() {
         final HttpServletRequest request = createRequest(null, null);
-        Mockito.when(request.getParameter(PageConfig.ALL_PROJECT_SEARCH)).thenReturn("true");
+        Mockito.when(request.getParameter(QueryParameters.ALL_PROJECT_SEARCH)).thenReturn("true");
 
         final PageConfig cfg = PageConfig.get(request);
         assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());
@@ -234,7 +235,7 @@ public void testSelectAllProjects() {
     @Test
     public void testSelectAllProjectsOverrideProjectParam() {
         final HttpServletRequest request = createRequest(new String[]{"project-1", "project-2"}, null);
-        Mockito.when(request.getParameter(PageConfig.ALL_PROJECT_SEARCH)).thenReturn("true");
+        Mockito.when(request.getParameter(QueryParameters.ALL_PROJECT_SEARCH)).thenReturn("true");
 
         final PageConfig cfg = PageConfig.get(request);
         assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());
@@ -243,7 +244,7 @@ public void testSelectAllProjectsOverrideProjectParam() {
     @Test
     public void testSelectAllProjectsOverrideGroupParam() {
         final HttpServletRequest request = createRequest(null, new String[]{"group-1-2-3"});
-        Mockito.when(request.getParameter(PageConfig.ALL_PROJECT_SEARCH)).thenReturn("true");
+        Mockito.when(request.getParameter(QueryParameters.ALL_PROJECT_SEARCH)).thenReturn("true");
 
         final PageConfig cfg = PageConfig.get(request);
         assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());
@@ -252,7 +253,7 @@ public void testSelectAllProjectsOverrideGroupParam() {
     @Test
     public void testSelectAllOverrideNonExistentProject() {
         final HttpServletRequest request = createRequest(new String[]{"no-project"}, null);
-        Mockito.when(request.getParameter(PageConfig.ALL_PROJECT_SEARCH)).thenReturn("true");
+        Mockito.when(request.getParameter(QueryParameters.ALL_PROJECT_SEARCH)).thenReturn("true");
 
         final PageConfig cfg = PageConfig.get(request);
         assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());