Short URL for all projects search implemented (#2717)

fixes #1357

Author: tulinkry

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

@@ -106,6 +106,7 @@ public final class PageConfig {
     public static final String OPEN_GROK_PROJECT = "OpenGrokProject";
 
     // 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";
 
@@ -806,6 +807,8 @@ public String getRequestedProjectsAsString() {
      * <li>If there is no project in the configuration an empty set is returned. Otherwise:</li>
      * <li>If there is only one project in the configuration,
      * this one gets returned (no matter, what the request actually says). Otherwise</li>
+     * <li>If the request parameter {@code ALL_PROJECT_SEARCH} contains a true value,
+     * all projects are added to searching. Otherwise:</li>
      * <li>If the request parameter {@code PROJECT_PARAM_NAME} contains any available project,
      * the set with invalid projects removed gets returned. Otherwise:</li>
      * <li>If the request parameter {@code GROUP_PARAM_NAME} contains any available group,
@@ -819,14 +822,15 @@ public String getRequestedProjectsAsString() {
      * </ol>
      *
      * @return a possible empty set of project names but never {@code null}.
+     * @see #ALL_PROJECT_SEARCH
      * @see #PROJECT_PARAM_NAME
      * @see #GROUP_PARAM_NAME
      * @see #OPEN_GROK_PROJECT
      */
     public SortedSet<String> getRequestedProjects() {
         if (requestedProjects == null) {
             requestedProjects
-                    = getRequestedProjects(PROJECT_PARAM_NAME, GROUP_PARAM_NAME, OPEN_GROK_PROJECT);
+                    = getRequestedProjects(ALL_PROJECT_SEARCH, PROJECT_PARAM_NAME, GROUP_PARAM_NAME, OPEN_GROK_PROJECT);
         }
         return requestedProjects;
     }
@@ -892,13 +896,15 @@ private List<String> getParamVals(String paramName) {
      * Same as {@link #getRequestedProjects()}, but with a variable cookieName
      * and parameter name.
      *
-     * @param projectParamName the name of the request parameter corresponding to a project name.
-     * @param groupParamName   the name of the request parameter corresponding to a group name
-     * @param cookieName       name of the cookie which possible contains project
-     *                         names used as fallback
+     * @param searchAllParamName the name of the request parameter corresponding to search all projects.
+     * @param projectParamName   the name of the request parameter corresponding to a project name.
+     * @param groupParamName     the name of the request parameter corresponding to a group name
+     * @param cookieName         name of the cookie which possible contains project
+     *                           names used as fallback
      * @return set of project names. Possibly empty set but never {@code null}.
      */
     protected SortedSet<String> getRequestedProjects(
+            String searchAllParamName,
             String projectParamName,
             String groupParamName,
             String cookieName
@@ -911,6 +917,14 @@ protected SortedSet<String> getRequestedProjects(
             return projectNames;
         }
 
+        if (Boolean.parseBoolean(req.getParameter(searchAllParamName))) {
+            return getProjectHelper()
+                    .getAllProjects()
+                    .stream()
+                    .map(Project::getName)
+                    .collect(Collectors.toCollection(TreeSet::new));
+        }
+
         // Use a project determined directly from the URL
         if (getProject() != null && getProject().isIndexed()) {
             projectNames.add(getProject().getName());

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

@@ -104,8 +104,8 @@ public String toHtml() {
         SCRIPTS.put("jquery-ui", new FileScript("js/jquery-ui-1.12.1-custom.min.js", 11));
         SCRIPTS.put("jquery-tablesorter", new FileScript("js/jquery-tablesorter-2.26.6.min.js", 12));
         SCRIPTS.put("tablesorter-parsers", new FileScript("js/tablesorter-parsers-0.0.1.js", 13));
-        SCRIPTS.put("searchable-option-list", new FileScript("js/searchable-option-list-2.0.6.js", 14));
-        SCRIPTS.put("utils", new FileScript("js/utils-0.0.30.js", 15));
+        SCRIPTS.put("searchable-option-list", new FileScript("js/searchable-option-list-2.0.7.min.js", 14));
+        SCRIPTS.put("utils", new FileScript("js/utils-0.0.31.js", 15));
         SCRIPTS.put("repos", new FileScript("js/repos-0.0.1.js", 20));
         SCRIPTS.put("diff", new FileScript("js/diff-0.0.3.js", 20));
         SCRIPTS.put("jquery-caret", new FileScript("js/jquery.caret-1.5.2.min.js", 25));

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

@@ -180,7 +180,7 @@ public void testNonIndexedInGroup() {
      */
     @Test
     public void testNonExistentProject() {
-        final HttpServletRequest request = createRequest(null, new String[]{"no-project"});
+        final HttpServletRequest request = createRequest(new String[]{"no-project"}, null);
 
         final PageConfig cfg = PageConfig.get(request);
         Assert.assertEquals(new HashSet<>(), cfg.getRequestedProjects());
@@ -197,6 +197,42 @@ public void testNonExistentGroup() {
         Assert.assertEquals(new HashSet<>(), cfg.getRequestedProjects());
     }
 
+    @Test
+    public void testSelectAllProjects() {
+        final HttpServletRequest request = createRequest(null, null);
+        Mockito.when(request.getParameter(PageConfig.ALL_PROJECT_SEARCH)).thenReturn("true");
+
+        final PageConfig cfg = PageConfig.get(request);
+        Assert.assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());
+    }
+
+    @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");
+
+        final PageConfig cfg = PageConfig.get(request);
+        Assert.assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());
+    }
+
+    @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");
+
+        final PageConfig cfg = PageConfig.get(request);
+        Assert.assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());
+    }
+
+    @Test
+    public void testSelectAllOverrideNonExistentProject() {
+        final HttpServletRequest request = createRequest(new String[]{"no-project"}, null);
+        Mockito.when(request.getParameter(PageConfig.ALL_PROJECT_SEARCH)).thenReturn("true");
+
+        final PageConfig cfg = PageConfig.get(request);
+        Assert.assertEquals(new TreeSet<>(env.getProjectNames()), cfg.getRequestedProjects());
+    }
+
     /**
      * Create a request with the specified path elements.
      *

opengrok-web/src/main/webapp/js/searchable-option-list-2.0.6.js renamed to opengrok-web/src/main/webapp/js/searchable-option-list-2.0.7.js

@@ -1192,15 +1192,15 @@
             }
         },
         /*
-         * Modified 2016
+         * Modified 2016, 2019
          */
-        invert: function() {
+        invert: function () {
             if (this.config.multiple) {
                 var $closedInputs = this.$selectionContainer
-                    .find('input[type="checkbox"]:not([disabled], :checked)')
+                    .find('input[type="checkbox"][name=project]:not([disabled], :checked)')
                 var $openedInputs = this.$selectionContainer
-                    .find('input[type="checkbox"]').filter('[disabled], :checked')
-            
+                    .find('input[type="checkbox"][name=project]').filter('[disabled], :checked')
+
                 $openedInputs.prop('checked', false)
                              .trigger('change', true);
                 $closedInputs.prop('checked', true)

opengrok-web/src/main/webapp/js/searchable-option-list-2.0.6.min.js renamed to opengrok-web/src/main/webapp/js/searchable-option-list-2.0.7.min.js

@@ -2273,11 +2273,49 @@ function isOnSearchPage() {
     return $(document.documentElement).hasClass('search');
 }
 
-function transform_projects_to_groups() {
+/**
+ * Preprocess the searched projects in the form with:
+ *
+ * <ol>
+ *  <li>For all project search -> replace the projects with simple searchall parameter</li>
+ *  <li>For group search -> replace all projects in a group by the group parameter</li>
+ * </ol>
+ * @param form the form containing the checkboxes
+ */
+function preprocess_searched_projects(form) {
     var sol = $('#project').searchableOptionList();
 
     var $sel = sol.$selectionContainer;
 
+    /*
+     * For all project search check if all project checkbox are checked and then uncheck them (they
+     * would appear in the url) and add a hidden checkbox with searchall name.
+     */
+    var allProjectsSearch = $.makeArray($sel.find('.sol-checkbox[name=project]')).every(function (checkbox) {
+        return $(checkbox).is(':checked')
+    });
+
+    if (allProjectsSearch && $('#search_all_projects').length === 0) {
+        $sel.find('.sol-checkbox').prop('checked', false);
+        var $input = $('<input>')
+        var $all = $input
+            .attr({
+                id: 'search_all_projects',
+                type: 'checkbox',
+                value: true,
+                name: 'searchall',
+            })
+            .prop('checked', true)
+            .css('display', 'none')
+        $all.appendTo($(form));
+        return;
+    }
+
+    /*
+     * For selecting groups instead of projects, ommit the "Other" group. Loop over
+     * all project checkbox in a group and when all of them are checked, uncheck them (they
+     * would appear in the URL) and then check the group checkbox.
+     */
     $sel.find('.sol-optiongroup').each(function () {
         var $el = $(this);
 
@@ -2324,8 +2362,9 @@ function searchSubmit(form) {
         form.appendChild(input);
     }
 
+    // replace all projects search with searchall parameter
     // select groups instead of projects if all projects in one group are selected
-    transform_projects_to_groups();
+    preprocess_searched_projects(form);
 }
 
 /**