Fix #3078 : record user intent for projects

Avoids the issue of a user interacting in the
browser to ultimately select zero projects but
then reviving the project list from cookies.

Also add options to SOL instead of hard-coding
OpenGrok-specific elements.

Author: idodeclare

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

@@ -923,10 +923,6 @@ protected SortedSet<String> getRequestedProjects(
         TreeSet<String> projectNames = new TreeSet<>();
         List<Project> projects = getEnv().getProjectList();
 
-        if (projects == null) {
-            return projectNames;
-        }
-
         if (Boolean.parseBoolean(req.getParameter(searchAllParamName))) {
             return getProjectHelper()
                     .getAllProjects()
@@ -973,7 +969,7 @@ protected SortedSet<String> getRequestedProjects(
         }
 
         // Add projects based on cookie.
-        if (projectNames.isEmpty()) {
+        if (projectNames.isEmpty() && getIntParam(QueryParameters.NUM_SELECTED_PARAM, -1) != 0) {
             List<String> cookies = getCookieVals(cookieName);
             for (String s : cookies) {
                 Project x = Project.getByName(s);

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

@@ -124,6 +124,12 @@ public class QueryParameters {
      */
     public static final String NO_REDIRECT_PARAM = "xrd";
 
+    /**
+     * Parameter name to specify a count of projects selected by the user
+     * through browser interaction.
+     */
+    public static final String NUM_SELECTED_PARAM = "nn";
+
     /**
      * Parameter name to specify an OpenGrok search of paths.
      */

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

@@ -110,8 +110,8 @@ public String toHtml() {
         putjs("jquery-ui", "js/jquery-ui-1.12.1-custom", 11);
         putjs("jquery-tablesorter", "js/jquery-tablesorter-2.26.6", 12);
         putjs("tablesorter-parsers", "js/tablesorter-parsers-0.0.2", 13, true);
-        putjs("searchable-option-list", "js/searchable-option-list-2.0.12", 14);
-        putjs("utils", "js/utils-0.0.34", 15, true);
+        putjs("searchable-option-list", "js/searchable-option-list-2.0.13", 14);
+        putjs("utils", "js/utils-0.0.35", 15, true);
         putjs("repos", "js/repos-0.0.2", 20, true);
         putjs("diff", "js/diff-0.0.4", 20, true);
         putjs("jquery-caret", "js/jquery.caret-1.5.2", 25);

opengrok-web/src/main/webapp/js/searchable-option-list-2.0.12.js renamed to opengrok-web/src/main/webapp/js/searchable-option-list-2.0.13.js

@@ -1045,6 +1045,9 @@
 
         _addSelectionDisplayItem: function ($changedItem) {
             this.numSelected = 1 + this.numSelected;
+            if (this.config.numSelectedItem) {
+                this.config.numSelectedItem.val(this.numSelected);
+            }
 
             if (this.config.maxShow !== 0 && this.numSelected > this.config.maxShow) {
                 if (this.valMap == null) {
@@ -1057,6 +1060,7 @@
 
         _buildSelectionDisplayItem: function ($changedItem) {
             var solOptionItem = $changedItem.data('sol-item'),
+                self = this,
                 $existingDisplayItem,
                 $displayItemText;
 
@@ -1093,9 +1097,14 @@
                         /*
                          * Modified for OpenGrok in 2017.
                          */
-                        if (isOnSearchPage()) {
-                            $('#xrd').val("1"); // no redirect
-                            $('#sbox').submit();
+                        if (self.config.quickDeleteForm) {
+                            if (self.config.quickDeletePermit) {
+                                if (self.config.quickDeletePermit()) {
+                                    self.config.quickDeleteForm.submit();
+                                }
+                            } else {
+                                self.config.quickDeleteForm.submit();
+                            }
                         }
                     })
                     .prependTo($existingDisplayItem);
@@ -1110,6 +1119,9 @@
 
             var wasExceeding = this.config.maxShow !== 0 && this.numSelected > this.config.maxShow;
             this.numSelected = this.numSelected - 1;
+            if (this.config.numSelectedItem) {
+                this.config.numSelectedItem.val(this.numSelected);
+            }
 
             if ($myDisplayItem) {
                 $myDisplayItem.remove();
@@ -1294,7 +1306,7 @@
                             .prop('checked', false)
                             .trigger('change', true);
 
-                this.options.closeOnClick && this.close();
+                this.config.closeOnClick && this.close();
 
                 if ($.isFunction(this.config.events.onChange)) {
                     this.config.events.onChange.call(this, this, $changedInputs);

opengrok-web/src/main/webapp/js/utils-0.0.34.js renamed to opengrok-web/src/main/webapp/js/utils-0.0.35.js

@@ -1366,6 +1366,9 @@ function init_searchable_option_list() {
         showSelectAll: false,
         maxShow: 30,
         resultsContainer: $("#ltbl"),
+        numSelectedItem: $("#nn"),
+        quickDeleteForm: $("#sbox"),
+        quickDeletePermit: checkIsOnSearchPage,
         texts: {
             searchplaceholder: 'Click here to select project(s)'
         },
@@ -2237,6 +2240,14 @@ function isOnSearchPage() {
     return $(document.documentElement).hasClass('search');
 }
 
+function checkIsOnSearchPage() {
+    if (isOnSearchPage()) {
+        $('#xrd').val("1"); // no redirect
+        return true;
+    }
+    return false;
+}
+
 /**
  * Preprocess the searched projects in the form with:
  *

opengrok-web/src/main/webapp/menu.jspf

@@ -27,7 +27,6 @@ Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
 java.util.Map,
 java.util.Set,
 java.util.SortedSet,
-java.util.TreeMap,
 java.util.TreeSet,
 
 org.opengrok.indexer.configuration.Group,
@@ -47,25 +46,14 @@ org.opengrok.indexer.web.messages.MessagesUtils"
     ProjectHelper ph = ProjectHelper.getInstance(cfg);
     String messages;
     Set<Project> projects = ph.getAllProjects();
-    if (projects == null) {
-        projects = new TreeSet<>();
-    }
     int projectsSize = ph.getAllUngrouped().size();
     if (ph.getGroups().size() > 0 && ph.getAllUngrouped().size() > 0)
         projectsSize++;
     for (Group group : ph.getGroups()) {
         projectsSize++;
         projectsSize += ph.getAllGrouped(group).size();
     }
-    TreeMap<String, String> pMap = new TreeMap<>();
     QueryBuilder queryParams = cfg.getQueryBuilder();
-    if (projects.size() != 0) {
-        for (Project p : projects) {
-            String name = p.getName();
-            String esc = Util.formQuoteEscape(p.getName());
-            pMap.put(name, esc);
-        }
-    }
 %>
 <script type="text/javascript">/* <![CDATA[ */
 document.domReady.push(function() { domReadyMenu(); });
@@ -243,6 +231,8 @@ document.domReady.push(function() { domReadyMenu(); });
 </div>
 <input type="hidden" id="<%= QueryParameters.NO_REDIRECT_PARAM %>"
        name="<%= QueryParameters.NO_REDIRECT_PARAM %>" value=""/>
+<input type="hidden" id="<%= QueryParameters.NUM_SELECTED_PARAM %>"
+       name="<%= QueryParameters.NUM_SELECTED_PARAM %>" value=""/>
 </form>
 <div class="clearfix"></div>
 <%