xref: /OpenGrok/opengrok-web/src/main/webapp/search.jsp (revision d6df19e1b22784c78f567cf74c42f18e3901b900)
1<%--
2CDDL HEADER START
3
4The contents of this file are subject to the terms of the
5Common Development and Distribution License (the "License").
6You may not use this file except in compliance with the License.
7
8See LICENSE.txt included in this distribution for the specific
9language governing permissions and limitations under the License.
10
11When distributing Covered Code, include this CDDL HEADER in each
12file and include the License file at LICENSE.txt.
13If applicable, add the following below this CDDL HEADER, with the
14fields enclosed by brackets "[]" replaced with your own identifying
15information: Portions Copyright [yyyy] [name of copyright owner]
16
17CDDL HEADER END
18
19Copyright (c) 2005, 2021, Oracle and/or its affiliates. All rights reserved.
20Portions Copyright 2011 Jens Elkner.
21Portions Copyright (c) 2017-2018, 2020, Chris Fraire <cfraire@me.com>.
22
23--%>
24<%@page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
25<%@page import="jakarta.servlet.http.HttpServletResponse"%>
26<%@page session="false" errorPage="error.jsp" import="
27org.apache.lucene.queryparser.classic.QueryParser,
28org.opengrok.indexer.search.Results,
29org.opengrok.web.api.v1.suggester.provider.service.SuggesterServiceFactory,
30org.opengrok.indexer.web.QueryParameters,
31org.opengrok.indexer.web.SearchHelper,
32org.opengrok.indexer.web.SortOrder,
33org.opengrok.indexer.web.Suggestion,
34
35java.util.List"
36%>
37<%@ page import="jakarta.servlet.http.HttpServletRequest" %>
38<%@ page import="jakarta.servlet.http.Cookie" %>
39<%@ page import="java.nio.charset.StandardCharsets" %>
40<%
41{
42    PageConfig cfg = PageConfig.get(request);
43    cfg.checkSourceRootExistence();
44}
45%><%@
46
47include file="projects.jspf"
48
49%><%!
50    private StringBuilder createUrl(HttpServletRequest request, SearchHelper sh, boolean menu) {
51        StringBuilder url = new StringBuilder(64);
52        QueryBuilder qb = sh.getBuilder();
53        if (menu) {
54            url.append("search?");
55        } else {
56            Util.appendQuery(url, QueryParameters.SORT_PARAM, sh.getOrder().toString());
57        }
58        if (qb != null) {
59            Util.appendQuery(url, QueryParameters.FULL_SEARCH_PARAM, qb.getFreetext());
60            Util.appendQuery(url, QueryParameters.DEFS_SEARCH_PARAM, qb.getDefs());
61            Util.appendQuery(url, QueryParameters.REFS_SEARCH_PARAM, qb.getRefs());
62            Util.appendQuery(url, QueryParameters.PATH_SEARCH_PARAM, qb.getPath());
63            Util.appendQuery(url, QueryParameters.HIST_SEARCH_PARAM, qb.getHist());
64            Util.appendQuery(url, QueryParameters.TYPE_SEARCH_PARAM, qb.getType());
65        }
66        if (sh.getProjects() != null && !sh.getProjects().isEmpty()) {
67            if (Boolean.parseBoolean(request.getParameter(QueryParameters.ALL_PROJECT_SEARCH))) {
68                Util.appendQuery(url, QueryParameters.ALL_PROJECT_SEARCH, Boolean.TRUE.toString());
69            } else {
70                Util.appendQuery(url, QueryParameters.PROJECT_SEARCH_PARAM,
71                        PageConfig.get(request).getRequestedProjectsAsString());
72            }
73        }
74        return url;
75    }
76%><%
77/* ---------------------- search.jsp start --------------------- */
78{
79    PageConfig cfg = PageConfig.get(request);
80
81    SearchHelper searchHelper = cfg.prepareSearch();
82    // N.b. searchHelper.destroy() is called via
83    // WebappListener.requestDestroyed() on presence of the following
84    // REQUEST_ATTR.
85    request.setAttribute(SearchHelper.REQUEST_ATTR, searchHelper);
86    searchHelper.prepareExec(cfg.getRequestedProjects()).executeQuery().prepareSummary();
87    // notify suggester that query was searched
88    SuggesterServiceFactory.getDefault().onSearch(cfg.getRequestedProjects(), searchHelper.getQuery());
89    String redirect = searchHelper.getRedirect();
90    if (redirect != null) {
91        response.sendRedirect(redirect);
92        return;
93    }
94    if (searchHelper.getErrorMsg() != null) {
95        cfg.setTitle("Search Error");
96        // Set status to Internal error. This should help to avoid caching
97        // the page by some proxies.
98        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
99    } else {
100        cfg.setTitle(cfg.getSearchTitle());
101    }
102    response.addCookie(new Cookie("OpenGrokSorting",
103            URLEncoder.encode(searchHelper.getOrder().toString(), StandardCharsets.UTF_8)));
104}
105%><%@
106
107include file="httpheader.jspf"
108
109%><body>
110<div id="page">
111    <header id="whole_header">
112        <%@include file="pageheader.jspf" %>
113        <div id="Masthead">
114            <a href="<%= request.getContextPath() %>/"><span id="home"></span>Home</a>
115            <%-- TODO: jel: IMHO it should be move to menu.jspf as combobox --%>
116            <div id="sortfield">
117                <label for="sortby">Sort by</label>
118                <%
119{
120    SearchHelper searchHelper = (SearchHelper) request.getAttribute(SearchHelper.REQUEST_ATTR);
121    StringBuilder url = createUrl(request, searchHelper, true).append("&amp;").
122            append(QueryParameters.SORT_PARAM_EQ);
123    int ordcnt = 0;
124    for (SortOrder o : SortOrder.values()) {
125        if (searchHelper.getOrder() == o) {
126                    %><span class="active"><%= o.getDesc() %></span><%
127        } else {
128                    %><a href="<%= url %><%= o %>"><%= o.getDesc() %></a><%
129        }
130        ordcnt++;
131        if (ordcnt != (SortOrder.values().length)) {
132            %> | <%
133        }
134    }
135}
136                %>
137            </div>
138        </div>
139        <div id="bar">
140        </div>
141        <div id="menu"><%@
142
143include file="menu.jspf"
144
145%>
146        </div>
147    </header>
148
149    <div id="results"> <%
150{
151    SearchHelper searchHelper = (SearchHelper) request.getAttribute(SearchHelper.REQUEST_ATTR);
152    // TODO spellchecking cycle below is not that great and we only create
153    // suggest links for every token in query, not for a query as whole
154    String errorMsg = searchHelper.getErrorMsg();
155    if (errorMsg != null) {
156        %><h3>Error</h3><p class="pagetitle"><%
157        if (searchHelper.getErrorMsg().startsWith((SearchHelper.PARSE_ERROR_MSG))) {
158            %><%= Util.htmlize(SearchHelper.PARSE_ERROR_MSG) %>
159            <br/>You might try to enclose your search term in quotes,
160            <a href="help.jsp#escaping">escape special characters</a>
161            with <code>\</code>, or read the <a href="help.jsp">Help</a>
162            on the query language. Error message from parser:<br/>
163            <%= Util.htmlize(errorMsg.substring(SearchHelper.PARSE_ERROR_MSG.length())) %><%
164        } else {
165            %><%= Util.htmlize(errorMsg) %><%
166        }%></p><%
167    } else if (searchHelper.getHits() == null) {
168        %><p class="pagetitle">No hits</p><%
169    } else if (searchHelper.getHits().length == 0) {
170        List<Suggestion> hints = searchHelper.getSuggestions();
171        for (Suggestion hint : hints) {
172        %><p class="suggestions"><span style="color: #cc0000; ">Did you mean (for <%= hint.getName() %>)</span>:<%
173	  if (hint.getFreetext() != null) {
174	    for (String word : hint.getFreetext()) {
175            %> <a href="search?<%= QueryParameters.FULL_SEARCH_PARAM_EQ %>
176<%= Util.uriEncode(QueryParser.escape(word)) %>"><%=
177                Util.htmlize(word) %></a> &nbsp; <%
178	    }
179	  }
180	  if (hint.getRefs() != null)  {
181	    for (String word : hint.getRefs()) {
182            %> <a href="search?<%= QueryParameters.REFS_SEARCH_PARAM_EQ %>
183<%= Util.uriEncode(QueryParser.escape(word)) %>"><%=
184                Util.htmlize(word) %></a> &nbsp; <%
185	    }
186	  }
187	  if (hint.getDefs() != null) {
188	    for (String word : hint.getDefs()) {
189            %> <a href="search?<%= QueryParameters.DEFS_SEARCH_PARAM_EQ %>
190<%= Util.uriEncode(QueryParser.escape(word)) %>"><%=
191                Util.htmlize(word) %></a> &nbsp; <%
192            }
193	  }
194        %></p><%
195        }
196        %>
197        <p class="pagetitle"> Your search <span class="bold"><%
198            Util.htmlize(searchHelper.getQuery().toString(), out); %></span>
199            did not match any files.
200            <br/> Suggestions:<br/>
201        </p>
202        <ul>
203            <li>Make sure all terms are spelled correctly.</li>
204            <li>Try different keywords.</li>
205            <li>Try more general keywords.</li>
206            <li>Use 'wil*' cards if you are looking for partial match.</li>
207        </ul>
208	<%
209    } else {
210        int start = searchHelper.getStart();
211        int max = searchHelper.getMaxItems();
212        long totalHits = searchHelper.getTotalHits();
213        long thispage = Math.min(totalHits - start, max);  // number of items to display on the current page
214        // We have a lots of results to show: create a slider for
215        String slider = Util.createSlider(start, max, totalHits, request);
216        %>
217        <p class="pagetitle">Searched <span class="bold"><%
218            Util.htmlize(searchHelper.getQuery().toString(), out);
219            %></span> (Results <span class="bold"> <%= start + 1 %> – <%= thispage + start
220            %></span> of <span class="bold"><%= totalHits %></span>) sorted by <%=
221            searchHelper.getOrder().getDesc() %></p><%
222        if (slider.length() > 0) {
223        %>
224        <p class="slider"><%= slider %></p><%
225        }
226        %>
227        <table aria-label="table of results"><%
228        Results.prettyPrint(out, searchHelper, start, start + thispage);
229        %>
230        </table>
231        <%
232        if (slider.length() > 0) {
233        %>
234        <p class="slider"><%= slider %></p><%
235        }
236        %>
237    </div><%
238    }
239    // Note that searchHelper.destroy() is called via WebappListener.requestDestroyed().
240}
241/* ---------------------- search.jsp end --------------------- */
242%><%@
243
244include file="foot.jspf"
245
246%>
247