Merge pull request #2633 from ahornace/rename_q

Replace "q" query param name with "full"

Author: tarzanek

apiary.apib

@@ -372,7 +372,7 @@ with a colon. If the type cannot be determined "N/A" is returned.
 + Request (application/json)
   + Body
 
-            ["http://localhost:8080/source/search?project=kotlin&q=text"]
+            ["http://localhost:8080/source/search?project=kotlin&full=text"]
 
 + Response 204
 

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/JFlexXref.java

@@ -315,7 +315,7 @@ public void linkageMatched(LinkageMatchedEvent evt) {
                 case QUERY:
                     out.write("<a href=\"");
                     out.write(urlPrefix);
-                    out.write("q=");
+                    out.write("full=");
                     Util.qurlencode(lstr, out);
                     JFlexXrefUtils.appendProject(out, project);
                     out.write("\">");

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

@@ -18,7 +18,7 @@
  */
 
 /* 
- * Copyright (c) 2010, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright 2011 Jens Elkner.
  * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
@@ -72,7 +72,7 @@ public class QueryBuilder {
     public static final String OBJSER = "objser"; // object serialized
     public static final String OBJVER = "objver"; // object version
 
-    public static final List<String> searchFields = Arrays.asList("q", DEFS, REFS, PATH, HIST);
+    public static final List<String> searchFields = Arrays.asList(FULL, DEFS, REFS, PATH, HIST);
 
     /** Used for paths, so SHA-1 is completely sufficient */
     private static final String DIRPATH_HASH_ALGORITHM = "SHA-1";

opengrok-indexer/src/main/java/org/opengrok/indexer/search/context/Context.java

@@ -18,15 +18,10 @@
  */
 
 /*
- * Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright 2011 Jens Elkner.
  * Portions Copyright (c) 2018, Chris Fraire <cfraire@me.com>.
  */
-
-/**
- * This is supposed to get the matching lines from sourcefile.
- * since lucene does not easily give the match context.
- */
 package org.opengrok.indexer.search.context;
 
 import java.io.IOException;
@@ -55,6 +50,10 @@
 import org.opengrok.indexer.util.IOUtils;
 import org.opengrok.indexer.web.Util;
 
+/**
+ * This is supposed to get the matching lines from sourcefile.
+ * since lucene does not easily give the match context.
+ */
 public class Context {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(Context.class);
@@ -245,9 +244,6 @@ private void buildQueryAsURI(Map<String, String> subqueries) {
         for (Map.Entry<String, String> entry : subqueries.entrySet()) {
             String field = entry.getKey();
             String queryText = entry.getValue();
-            if (QueryBuilder.FULL.equals(field)) {
-                field = "q"; // bah - search query params should be consistent!
-            }
             sb.append(field).append("=").append(Util.URIEncode(queryText))
                 .append('&');
         }

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

@@ -597,7 +597,7 @@ public List<SortOrder> getSortOrder() {
      */
     public QueryBuilder getQueryBuilder() {
         if (queryBuilder == null) {
-            queryBuilder = new QueryBuilder().setFreetext(req.getParameter("q"))
+            queryBuilder = new QueryBuilder().setFreetext(req.getParameter(QueryBuilder.FULL))
                     .setDefs(req.getParameter(QueryBuilder.DEFS))
                     .setRefs(req.getParameter(QueryBuilder.REFS))
                     .setPath(req.getParameter(QueryBuilder.PATH))
@@ -1602,8 +1602,8 @@ private String addTitleDelimiter(String title) {
     public String getSearchTitle() {
         String title = "";
 
-        if (req.getParameter("q") != null && !req.getParameter("q").isEmpty()) {
-            title += req.getParameter("q") + " (full)";
+        if (req.getParameter(QueryBuilder.FULL) != null && !req.getParameter(QueryBuilder.FULL).isEmpty()) {
+            title += req.getParameter(QueryBuilder.FULL) + " (full)";
         }
         if (req.getParameter(QueryBuilder.DEFS) != null && !req.getParameter(QueryBuilder.DEFS).isEmpty()) {
             title = addTitleDelimiter(title);

opengrok-indexer/src/test/java/org/opengrok/indexer/analysis/JFlexXrefTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2010, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 
@@ -434,7 +434,7 @@ public void truncatedUuencodedFile() throws IOException {
         assertLinesEqual("UuencodeXref truncated",
                 "<a class=\"l\" name=\"1\" href=\"#1\">1</a>"
                 + "<strong>begin</strong> <em>644</em> "
-                + "<a href=\"/source/s?q=%22test.txt%22\">test.txt</a>"
+                + "<a href=\"/source/s?full=%22test.txt%22\">test.txt</a>"
                 + "<span class=\"c\">\n"
                 + "<a class=\"l\" name=\"2\" href=\"#2\">2</a></span>",
                 out.toString());

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.web.api.v1.controller;
 
@@ -181,7 +181,7 @@ public void rebuild(@PathParam("project") final String project) {
      * Initializes the search data used by suggester to perform most popular completion. The passed {@code urls} are
      * decomposed into single terms which search counts are then increased by 1.
      * @param urls list of URLs in JSON format, e.g.
-     * {@code ["http://demo.opengrok.org/search?project=opengrok&q=test"]}
+     * {@code ["http://demo.opengrok.org/search?project=opengrok&full=test"]}
      */
     @POST
     @Path("/init/queries")
@@ -227,7 +227,7 @@ private Query getQuery(final String field, final String value) throws ParseExcep
         QueryBuilder builder = new QueryBuilder();
 
         switch (field) {
-            case "q":
+            case QueryBuilder.FULL:
                 builder.setFreetext(value);
                 break;
             case QueryBuilder.DEFS:

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

@@ -16,7 +16,7 @@ information: Portions Copyright [yyyy] [name of copyright owner]
 
 CDDL HEADER END
 
-Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
 Portions Copyright 2011 Jens Elkner.
 Portions Copyright (c) 2018, Chris Fraire <cfraire@me.com>.
 
@@ -61,27 +61,27 @@ include file="menu.jspf"
 <pre class="example">
 
 To find where setResourceMonitors is defined:
-<a href="search?q=&amp;defs=setResourceMonitors">defs:setResourceMonitors</a>
+<a href="search?full=&amp;defs=setResourceMonitors">defs:setResourceMonitors</a>
 
 To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
 <a href="search?refs=sprintf&amp;path=usr%2Fsrc%2Fcmd%2Fcmd-inet%2Fusr.sbin%2F"
 >refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
 
 To find assignments to variable foo:
-<a href="search?q=%22foo+%3D%22">"foo ="</a>
+<a href="search?full=%22foo+%3D%22">"foo ="</a>
 
 To find Makefiles where pstack binary is being built:
-<a href="search?q=pstack&amp;path=Makefile">pstack path:Makefile</a>
+<a href="search?full=pstack&amp;path=Makefile">pstack path:Makefile</a>
 
 to search for phrase "Bill Joy":
-<a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
+<a href="search?full=%22Bill+Joy%22">"Bill Joy"</a>
 
 To find perl files that do not use /usr/bin/perl but something else:
-<a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22"
+<a href="search?full=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22"
 >-"/usr/bin/perl" +"/bin/perl"</a>
 
 To find all strings beginning with foo use the wildcard:
-<a href="search?q=foo*">foo*</a>
+<a href="search?full=foo*">foo*</a>
 
 To find all files which have . c in their name (dot is a token!):
 <a href="search?path=%22. c%22">". c"</a>
@@ -90,7 +90,7 @@ To find all files which start with "ma" and then have only alphabet characters d
 <a href="search?path=/ma[a-zA-Z]*/">path:/ma[a-zA-Z]*/</a>
 
 To find all main methods in all files analyzed by C analyzer (so .c, .h, ...) do:
-<a href="search?q=main&type=c">main type:c</a>
+<a href="search?full=main&type=c">main type:c</a>
 </pre>
 
 <h4>More info:</h4>

opengrok-web/src/main/webapp/js/utils-0.0.28.js

@@ -945,7 +945,7 @@
 
                     this.$search_defs.attr('href', this.getSearchLink('defs'));
                     this.$search_refs.attr('href', this.getSearchLink('refs'));
-                    this.$search_full.attr('href', this.getSearchLink('q'));
+                    this.$search_full.attr('href', this.getSearchLink('full'));
                     this.$search_files.attr('href', this.getSearchLink('path'));
                     this.$search_google.attr('href', this.options.google_url + this.symbol)
                 },
@@ -1745,7 +1745,7 @@ function initAutocomplete(config, minisearch) {
     if (minisearch) {
         initMinisearchAutocomplete(config);
     } else {
-        initAutocompleteForField("q", "full", config);
+        initAutocompleteForField("full", "full", config);
         initAutocompleteForField("defs", "defs", config);
         initAutocompleteForField("refs", "refs", config);
         initAutocompleteForField("path", "path", config);
@@ -1799,7 +1799,7 @@ function initAutocompleteForField(inputId, field, config, dataFunction, errorEle
         dataFunction = getAutocompleteMenuData;
     }
     if (!errorElemId) {
-        errorElemId = 'q';
+        errorElemId = 'full';
     }
     var errorElem = $('#' + errorElemId);
 
@@ -1909,7 +1909,7 @@ function getAutocompleteMenuData(input, field) {
     return {
         projects: getSelectedProjectNames(),
         field: field,
-        full: $('#q').val(),
+        full: $('#full').val(),
         defs: $('#defs').val(),
         refs: $('#refs').val(),
         path: $('#path').val(),

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

@@ -18,7 +18,7 @@ information: Portions Copyright [yyyy] [name of copyright owner]
 
 CDDL HEADER END
 
-Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved.
 
 Portions Copyright 2011 Jens Elkner.
 
@@ -156,8 +156,8 @@ document.domReady.push(function() { domReadyMenu(); });
     %>
     <tbody>
     <tr>
-        <td><label for="q" title="The text token(s) or other fields to be found (lucene query, this is not full text!)">Full&nbsp;Search</label></td>
-        <td colspan="2"><input tabindex="1" class="q" name="q" id="q" type="text" value="<%=
+        <td><label for="full" title="The text token(s) or other fields to be found (lucene query, this is not full text!)">Full&nbsp;Search</label></td>
+        <td colspan="2"><input tabindex="1" class="q" name="full" id="full" type="text" value="<%=
                 Util.formQuoteEscape(queryParams.getFreetext()) %>"/></td>
     </tr>
     <tr>