Added new field “type” to the web search form.

The field is a single selection containing file types
with user readable descriptions. It is mapped to the field
“fileType” in Lucene.

Author: svenpilz

src/org/opensolaris/opengrok/web/PageConfig.java

@@ -461,7 +461,12 @@ public List<SortOrder> getSortOrder() {
      */
     public QueryBuilder getQueryBuilder() {
         if (queryBuilder == null) {
-            queryBuilder = new QueryBuilder().setFreetext(req.getParameter("q")).setDefs(req.getParameter("defs")).setRefs(req.getParameter("refs")).setPath(req.getParameter("path")).setHist(req.getParameter("hist"));
+            queryBuilder = new QueryBuilder().setFreetext(req.getParameter("q"))
+                    .setDefs(req.getParameter("defs"))
+                    .setRefs(req.getParameter("refs"))
+                    .setPath(req.getParameter("path"))
+                    .setHist(req.getParameter("hist"))
+                    .setFileType(req.getParameter("type"));
 
             // This is for backward compatibility with links created by OpenGrok
             // 0.8.x and earlier. We used to concatenate the entire query into a

src/org/opensolaris/opengrok/web/SearchHelper.java

@@ -29,7 +29,10 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
+import java.util.Set;
 import java.util.SortedSet;
+import java.util.TreeMap;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.logging.Level;
@@ -161,13 +164,54 @@ public class SearchHelper {
      * history context usually created via {@link #prepareSummary()}.
      */
     public HistoryContext historyContext;
+    /**
+     * User readable description for file types.
+     * Only those listed in fileTypeDescription will be shown
+     * to the user.
+     */
+    private static final Map<String, String> fileTypeDescription;
     /**
      * Default query parse error message prefix
      */
     public static final String PARSE_ERROR_MSG = "Unable to parse your query: ";
     private ExecutorService executor = null;
     private static final Logger log = Logger.getLogger(SearchHelper.class.getName());
 
+    static {
+        fileTypeDescription = new TreeMap<>();
+        
+        fileTypeDescription.put("xml", "XML");
+        fileTypeDescription.put("troff", "Troff");
+        fileTypeDescription.put("elf", "ELF");
+        fileTypeDescription.put("javaclass", "Java class");
+        fileTypeDescription.put("image", "Image file");
+        fileTypeDescription.put("c", "C");
+        fileTypeDescription.put("csharp", "C#");
+        fileTypeDescription.put("vb", "Visual Basic");
+        fileTypeDescription.put("cxx", "C++");
+        fileTypeDescription.put("sh", "Shell script");
+        fileTypeDescription.put("java", "Java");
+        fileTypeDescription.put("javascript", "JavaScript");
+        fileTypeDescription.put("python", "Python");
+        fileTypeDescription.put("perl", "Perl");
+        fileTypeDescription.put("php", "PHP");
+        fileTypeDescription.put("lisp", "Lisp");
+        fileTypeDescription.put("tcl", "Tcl");
+        fileTypeDescription.put("scala", "Scala");
+        fileTypeDescription.put("sql", "SQL");
+        fileTypeDescription.put("plsql", "PL/SQL");
+        fileTypeDescription.put("fortran", "Fortran");
+    }
+    
+    /**
+     * Returns a set of file type descriptions to be used for a
+     * search form.
+     * @return Set of tuples with file type and description.
+     */
+    public static Set<Map.Entry<String, String>> getFileTypeDescirptions() {
+        return fileTypeDescription.entrySet();
+    }
+    
     /**
      * Create the searcher to use wrt. to currently set parameters and the given
      * projects. Does not produce any {@link #redirect} link. It also does

web/menu.jspf

@@ -23,7 +23,9 @@ Use is subject to license terms.
 
 Portions Copyright 2011 Jens Elkner.
 
---%><%@page import="
+--%><%@page import="org.opensolaris.opengrok.web.SearchHelper"%>
+<%@page import="java.util.Map"%>
+<%@page import="
 java.util.SortedSet,
 java.util.TreeMap,
 java.util.Map.Entry,
@@ -101,6 +103,24 @@ org.opensolaris.opengrok.web.Util"
         <td><input class="q" tabindex="5" name="hist" id="hist" value="<%=
             Util.formQuoteEscape(queryParams.getHist()) %>"/></td>
     </tr>
+    <tr>
+        <td><label for="s5">Type</label></td>
+        <td><select class="q" tabindex="6" name="type" id="type"><%
+                String selection = queryParams.getFileType();  
+                %>
+                <option value="">Any</option><%
+                for (Map.Entry<String, String> d : SearchHelper.getFileTypeDescirptions()) {
+                    %>
+                <option value="<%= d.getKey() %>"<% 
+                    if (d.getKey().equals(selection)) {
+                        %> selected="selected"<%
+                    }
+                    %>><%= Util.formQuoteEscape(d.getValue()) %></option><%
+                }
+            %>
+            </select>
+        </td>
+    </tr>
 <%-- TODO  Bug 11749
 <%
     if (projects.size() != 0) {

web/search.jsp

@@ -45,6 +45,7 @@ include file="projects.jspf"
             Util.appendQuery(url, "refs", qb.getRefs());
             Util.appendQuery(url, "path", qb.getPath());
             Util.appendQuery(url, "hist", qb.getHist());
+            Util.appendQuery(url, "type", qb.getFileType());
         }
         if (sh.projects != null && sh.projects.size() != 0) {
             Util.appendQuery(url, "project", cfg.getRequestedProjectsAsString());