1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.search;
24  
25  import com.liferay.portal.SystemException;
26  import com.liferay.portal.kernel.dao.search.SearchContainer;
27  import com.liferay.portal.kernel.search.OpenSearch;
28  import com.liferay.portal.kernel.search.SearchException;
29  import com.liferay.portal.kernel.util.GetterUtil;
30  import com.liferay.portal.kernel.util.HttpUtil;
31  import com.liferay.portal.kernel.util.StringPool;
32  import com.liferay.portal.kernel.util.StringUtil;
33  import com.liferay.portal.kernel.uuid.PortalUUIDUtil;
34  import com.liferay.portal.kernel.xml.Document;
35  import com.liferay.portal.kernel.xml.Element;
36  import com.liferay.portal.kernel.xml.SAXReaderUtil;
37  import com.liferay.portal.model.Layout;
38  import com.liferay.portal.service.LayoutLocalServiceUtil;
39  import com.liferay.portal.service.UserLocalServiceUtil;
40  import com.liferay.portal.theme.ThemeDisplay;
41  import com.liferay.portal.util.PortalUtil;
42  import com.liferay.portal.util.PropsUtil;
43  import com.liferay.portal.util.WebKeys;
44  import com.liferay.portlet.PortletURLImpl;
45  
46  import java.util.Date;
47  
48  import javax.portlet.PortletMode;
49  import javax.portlet.PortletModeException;
50  import javax.portlet.PortletRequest;
51  import javax.portlet.PortletURL;
52  import javax.portlet.WindowState;
53  import javax.portlet.WindowStateException;
54  
55  import javax.servlet.http.HttpServletRequest;
56  
57  /**
58   * <a href="BaseOpenSearchImpl.java.html"><b><i>View Source</i></b></a>
59   *
60   * @author Charles May
61   * @author Brian Wing Shun Chan
62   */
63  public abstract class BaseOpenSearchImpl implements OpenSearch {
64  
65      public boolean isEnabled() {
66          return _enabled;
67      }
68  
69      public String search(HttpServletRequest request, String url)
70          throws SearchException {
71  
72          try {
73              long userId = PortalUtil.getUserId(request);
74  
75              if (userId == 0) {
76                  long companyId = PortalUtil.getCompanyId(request);
77  
78                  userId = UserLocalServiceUtil.getDefaultUserId(companyId);
79              }
80  
81              String keywords = GetterUtil.getString(
82                  HttpUtil.getParameter(url, "keywords", false));
83              int startPage = GetterUtil.getInteger(
84                  HttpUtil.getParameter(url, "p", false), 1);
85              int itemsPerPage = GetterUtil.getInteger(
86                  HttpUtil.getParameter(url, "c", false),
87                  SearchContainer.DEFAULT_DELTA);
88              String format = GetterUtil.getString(
89                  HttpUtil.getParameter(url, "format", false));
90  
91              return search(
92                  request, userId, keywords, startPage, itemsPerPage, format);
93          }
94          catch (SearchException se) {
95              throw se;
96          }
97          catch (Exception e) {
98              throw new SearchException(e);
99          }
100     }
101 
102     public String search(
103             HttpServletRequest request, long userId, String keywords,
104             int startPage, int itemsPerPage, String format)
105         throws SearchException {
106 
107         return search(
108             request, 0, userId, keywords, startPage, itemsPerPage, format);
109     }
110 
111     public abstract String search(
112             HttpServletRequest request, long groupId, long userId,
113             String keywords, int startPage, int itemsPerPage, String format)
114         throws SearchException;
115 
116     protected void addSearchResult(
117         Element root, String title, String link, Date updated,
118         String summary, double score, String format) {
119 
120         addSearchResult(
121             root, title, link, updated, summary, new String[0], 0, score,
122             format);
123     }
124 
125     protected void addSearchResult(
126         Element root, String title, String link, Date updated, String summary,
127         String[] tags, double ratings, double score, String format) {
128 
129         if (format.equals("rss")) {
130             addSearchResultRSS(
131                 root, title, link, updated, summary, tags, ratings, score);
132         }
133         else {
134             addSearchResultAtom(
135                 root, title, link, updated, summary, tags, ratings, score);
136         }
137     }
138 
139     protected void addSearchResultAtom(
140         Element root, String title, String link, Date updated, String summary,
141         String[] tags, double ratings, double score) {
142 
143         // entry
144 
145         Element entry = OpenSearchUtil.addElement(
146             root, "entry", OpenSearchUtil.DEFAULT_NAMESPACE);
147 
148         // title
149 
150         OpenSearchUtil.addElement(
151             entry, "title", OpenSearchUtil.DEFAULT_NAMESPACE, title);
152 
153         // link
154 
155         Element entryLink = OpenSearchUtil.addElement(
156             entry, "link", OpenSearchUtil.DEFAULT_NAMESPACE);
157 
158         entryLink.addAttribute("href", link);
159 
160         // id
161 
162         OpenSearchUtil.addElement(
163             entry, "id", OpenSearchUtil.DEFAULT_NAMESPACE,
164             "urn:uuid:" + PortalUUIDUtil.generate());
165 
166         // updated
167 
168         OpenSearchUtil.addElement(
169             entry, "updated", OpenSearchUtil.DEFAULT_NAMESPACE, updated);
170 
171         // summary
172 
173         OpenSearchUtil.addElement(
174             entry, "summary", OpenSearchUtil.DEFAULT_NAMESPACE, summary);
175 
176         // tags
177 
178         OpenSearchUtil.addElement(
179             entry, "tags", OpenSearchUtil.DEFAULT_NAMESPACE,
180             StringUtil.merge(tags));
181 
182         // ratings
183 
184         OpenSearchUtil.addElement(
185             entry, "ratings", OpenSearchUtil.DEFAULT_NAMESPACE, ratings);
186 
187         // relevance:score
188 
189         OpenSearchUtil.addElement(
190             entry, "score", OpenSearchUtil.RELEVANCE_NAMESPACE, score);
191     }
192 
193     protected void addSearchResultRSS(
194         Element root, String title, String link, Date updated, String summary,
195         String[] tags, double ratings, double score) {
196 
197         // item
198 
199         Element item = root.addElement("item");
200 
201         // title
202 
203         OpenSearchUtil.addElement(
204             item, "title", OpenSearchUtil.NO_NAMESPACE, title);
205 
206         // link
207 
208         OpenSearchUtil.addElement(
209             item, "link", OpenSearchUtil.NO_NAMESPACE, link);
210 
211         // summary
212 
213         OpenSearchUtil.addElement(
214             item, "description", OpenSearchUtil.NO_NAMESPACE, summary);
215 
216         // tags
217 
218         OpenSearchUtil.addElement(
219             item, "tags", OpenSearchUtil.NO_NAMESPACE, StringUtil.merge(tags));
220 
221         // ratings
222 
223         OpenSearchUtil.addElement(
224             item, "ratings", OpenSearchUtil.NO_NAMESPACE, ratings);
225 
226         // relevance:score
227 
228         OpenSearchUtil.addElement(
229             item, "score", OpenSearchUtil.RELEVANCE_NAMESPACE, score);
230     }
231 
232     /**
233      * @deprecated
234      */
235     protected Object[] addSearchResults(
236         String keywords, int startPage, int itemsPerPage, int total, int start,
237         String title, String searchPath, String format,
238         ThemeDisplay themeDisplay) {
239 
240         return addSearchResults(
241             new String[0], keywords, startPage, itemsPerPage, total, start,
242             title, searchPath, format, themeDisplay);
243     }
244 
245     protected Object[] addSearchResults(
246         String[] queryTerms, String keywords, int startPage, int itemsPerPage,
247         int total, int start, String title, String searchPath, String format,
248         ThemeDisplay themeDisplay) {
249 
250         int totalPages = 0;
251 
252         if (total % itemsPerPage == 0) {
253             totalPages = total / itemsPerPage;
254         }
255         else {
256             totalPages = (total / itemsPerPage) + 1;
257         }
258 
259         int previousPage = startPage - 1;
260         int nextPage = startPage + 1;
261 
262         Document doc = SAXReaderUtil.createDocument();
263 
264         if (format.equals("rss")) {
265             return addSearchResultsRSS(
266                 doc, queryTerms, keywords, startPage, itemsPerPage, total,
267                 start, totalPages, previousPage, nextPage, title, searchPath,
268                 themeDisplay);
269         }
270         else {
271             return addSearchResultsAtom(
272                 doc, queryTerms, keywords, startPage, itemsPerPage, total,
273                 start, totalPages, previousPage, nextPage, title, searchPath,
274                 themeDisplay);
275         }
276     }
277 
278     protected Object[] addSearchResultsAtom(
279         Document doc, String[] queryTerms, String keywords, int startPage,
280         int itemsPerPage, int total, int start, int totalPages,
281         int previousPage, int nextPage, String title, String searchPath,
282         ThemeDisplay themeDisplay) {
283 
284         // feed
285 
286         Element root = doc.addElement("feed");
287 
288         root.add(OpenSearchUtil.getNamespace(OpenSearchUtil.DEFAULT_NAMESPACE));
289         root.add(OpenSearchUtil.getNamespace(OpenSearchUtil.OS_NAMESPACE));
290         root.add(
291             OpenSearchUtil.getNamespace(OpenSearchUtil.RELEVANCE_NAMESPACE));
292 
293         // title
294 
295         OpenSearchUtil.addElement(
296             root, "title", OpenSearchUtil.DEFAULT_NAMESPACE, title);
297 
298         // updated
299 
300         OpenSearchUtil.addElement(
301             root, "updated", OpenSearchUtil.DEFAULT_NAMESPACE, new Date());
302 
303         // author
304 
305         Element author = OpenSearchUtil.addElement(
306             root, "author", OpenSearchUtil.DEFAULT_NAMESPACE);
307 
308         // name
309 
310         OpenSearchUtil.addElement(
311             author, "name", OpenSearchUtil.DEFAULT_NAMESPACE,
312             themeDisplay.getUserId());
313 
314         // id
315 
316         OpenSearchUtil.addElement(
317             root, "id", OpenSearchUtil.DEFAULT_NAMESPACE,
318             "urn:uuid:" + PortalUUIDUtil.generate());
319 
320         // queryTerms
321 
322         OpenSearchUtil.addElement(
323             root, "queryTerms", OpenSearchUtil.DEFAULT_NAMESPACE,
324             StringUtil.merge(queryTerms, StringPool.COMMA_AND_SPACE));
325 
326         // opensearch:totalResults
327 
328         OpenSearchUtil.addElement(
329             root, "totalResults", OpenSearchUtil.OS_NAMESPACE, total);
330 
331         // opensearch:startIndex
332 
333         OpenSearchUtil.addElement(
334             root, "startIndex", OpenSearchUtil.OS_NAMESPACE, start + 1);
335 
336         // opensearch:itemsPerPage
337 
338         OpenSearchUtil.addElement(
339             root, "itemsPerPage", OpenSearchUtil.OS_NAMESPACE, itemsPerPage);
340 
341         // opensearch:Query
342 
343         Element query = OpenSearchUtil.addElement(
344             root, "Query", OpenSearchUtil.OS_NAMESPACE);
345 
346         query.addAttribute("role", "request");
347         query.addAttribute("searchTerms", keywords);
348         query.addAttribute("startPage", String.valueOf(startPage));
349 
350         // links
351 
352         String searchURL = themeDisplay.getURLPortal() + searchPath;
353 
354         OpenSearchUtil.addLink(
355             root, searchURL, "self", keywords, startPage, itemsPerPage);
356         OpenSearchUtil.addLink(
357             root, searchURL, "first", keywords, 1, itemsPerPage);
358 
359         if (previousPage > 0) {
360             OpenSearchUtil.addLink(
361                 root, searchURL, "previous", keywords, previousPage,
362                 itemsPerPage);
363         }
364 
365         if (nextPage <= totalPages) {
366             OpenSearchUtil.addLink(
367                 root, searchURL, "next", keywords, nextPage, itemsPerPage);
368         }
369 
370         OpenSearchUtil.addLink(
371             root, searchURL, "last", keywords, totalPages, itemsPerPage);
372 
373         Element link = OpenSearchUtil.addElement(
374             root, "link", OpenSearchUtil.DEFAULT_NAMESPACE);
375 
376         link.addAttribute("rel", "search");
377         link.addAttribute("href", searchPath + "_description.xml");
378         link.addAttribute("type", "application/opensearchdescription+xml");
379 
380         return new Object[] {doc, root};
381     }
382 
383     protected Object[] addSearchResultsRSS(
384         Document doc, String[] queryTerms, String keywords, int startPage,
385         int itemsPerPage, int total, int start, int totalPages,
386         int previousPage, int nextPage, String title, String searchPath,
387         ThemeDisplay themeDisplay) {
388 
389         // rss
390 
391         Element root = doc.addElement("rss");
392 
393         root.addAttribute("version", "2.0");
394         root.add(
395             SAXReaderUtil.createNamespace(
396                 "atom", "http://www.w3.org/2005/Atom"));
397         root.add(OpenSearchUtil.getNamespace(OpenSearchUtil.OS_NAMESPACE));
398         root.add(
399             OpenSearchUtil.getNamespace(OpenSearchUtil.RELEVANCE_NAMESPACE));
400 
401         // channel
402 
403         Element channel = root.addElement("channel");
404 
405         // title
406 
407         OpenSearchUtil.addElement(
408             channel, "title", OpenSearchUtil.NO_NAMESPACE, title);
409 
410         // link
411 
412         OpenSearchUtil.addElement(
413             channel, "link", OpenSearchUtil.NO_NAMESPACE,
414             themeDisplay.getURLPortal() + searchPath);
415 
416         // description
417 
418         OpenSearchUtil.addElement(
419             channel, "description", OpenSearchUtil.NO_NAMESPACE, title);
420 
421         // queryTerms
422 
423         OpenSearchUtil.addElement(
424             channel, "queryTerms", OpenSearchUtil.NO_NAMESPACE,
425             StringUtil.merge(queryTerms, StringPool.COMMA_AND_SPACE));
426 
427         // opensearch:totalResults
428 
429         OpenSearchUtil.addElement(
430             channel, "totalResults", OpenSearchUtil.OS_NAMESPACE, total);
431 
432         // opensearch:startIndex
433 
434         OpenSearchUtil.addElement(
435             channel, "startIndex", OpenSearchUtil.OS_NAMESPACE, start + 1);
436 
437         // opensearch:itemsPerPage
438 
439         OpenSearchUtil.addElement(
440             channel, "itemsPerPage", OpenSearchUtil.OS_NAMESPACE, itemsPerPage);
441 
442         // opensearch:Query
443 
444         Element query = OpenSearchUtil.addElement(
445             channel, "Query", OpenSearchUtil.OS_NAMESPACE);
446 
447         query.addAttribute("role", "request");
448         query.addAttribute("searchTerms", keywords);
449         query.addAttribute("startPage", String.valueOf(startPage));
450 
451         return new Object[] {doc, channel};
452     }
453 
454     protected PortletURL getPortletURL(
455             HttpServletRequest request, String portletId)
456         throws PortletModeException, SystemException, WindowStateException {
457 
458         return getPortletURL(request, portletId, 0);
459     }
460 
461     protected PortletURL getPortletURL(
462             HttpServletRequest request, String portletId, long groupId)
463         throws PortletModeException, SystemException, WindowStateException {
464 
465         long plid = LayoutLocalServiceUtil.getDefaultPlid(
466             groupId, false, portletId);
467 
468         if (plid == 0) {
469             plid = LayoutLocalServiceUtil.getDefaultPlid(
470                 groupId, true, portletId);
471         }
472 
473         if (plid == 0) {
474             Layout layout = (Layout)request.getAttribute(WebKeys.LAYOUT);
475 
476             if (layout != null) {
477                 plid = layout.getPlid();
478             }
479         }
480 
481         PortletURL portletURL = new PortletURLImpl(
482             request, portletId, plid, PortletRequest.RENDER_PHASE);
483 
484         portletURL.setWindowState(WindowState.MAXIMIZED);
485         portletURL.setPortletMode(PortletMode.VIEW);
486 
487         return portletURL;
488     }
489 
490     private boolean _enabled = GetterUtil.getBoolean(
491         PropsUtil.get(getClass().getName()), true);
492 
493 }