All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencms.workplace.tools.searchindex.CmsSearchResultView Maven / Gradle / Ivy

Go to download

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0
Show newest version
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.workplace.tools.searchindex;

import org.opencms.file.CmsProject;
import org.opencms.i18n.CmsEncoder;
import org.opencms.i18n.CmsLocaleManager;
import org.opencms.i18n.CmsMessages;
import org.opencms.jsp.CmsJspActionElement;
import org.opencms.main.CmsException;
import org.opencms.main.OpenCms;
import org.opencms.search.CmsSearch;
import org.opencms.search.CmsSearchResult;
import org.opencms.search.fields.CmsSearchField;
import org.opencms.util.CmsStringUtil;
import org.opencms.workplace.CmsWidgetDialog;

import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.SortedMap;
import java.util.StringTokenizer;
import java.util.TreeMap;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.jsp.PageContext;

/**
 * Displays the result of a {@link org.opencms.search.CmsSearch}.

* * Requires the following request parameters (see constructor): *

    *
  • * index:
    the String identifying the required search index. *
  • * query:
    the search query to run. *
*

* * @since 6.0.0 */ public class CmsSearchResultView { /** * A simple wrapper around html for a form and it's name for value * side of form cache, necessary as order in Map is arbitrary, * SortedMap unusable as backlinks have higher order, lower formname...

*/ private final class HTMLForm { /** The html of the generated form. **/ String m_formHtml; /** The name of the generated form. **/ String m_formName; /** * Creates an instance with the given formname and the given html code for the form.

* * @param formName the form name of the form * @param formHtml the form html of the form */ HTMLForm(String formName, String formHtml) { m_formName = formName; m_formHtml = formHtml; } /** * Returns the form html.

* * @return the form html * * @see java.lang.Object#toString() */ @Override public String toString() { return m_formHtml; } } /** The project that forces evaluation of all dynamic content. */ protected CmsProject m_offlineProject; /** The project that allows static export. */ protected CmsProject m_onlineProject; /** The flag that decides whether links to search result point to their exported version or not. */ private boolean m_exportLinks; /** * A small cache for the forms generated by {@link #toPostParameters(String, CmsSearch)} during a request.

* * Avoids duplicate forms.

*/ private SortedMap m_formCache; /** The CmsJspActionElement to use. **/ private CmsJspActionElement m_jsp; /** The url to a proprietary search url (different from m_jsp.getRequestContext().getUri). **/ private String m_searchRessourceUrl; /** * Constructor with the action element to use.

* * @param action the action element to use */ public CmsSearchResultView(CmsJspActionElement action) { m_jsp = action; m_formCache = new TreeMap(); try { m_onlineProject = m_jsp.getCmsObject().readProject(CmsProject.ONLINE_PROJECT_ID); m_offlineProject = m_jsp.getRequestContext().getCurrentProject(); } catch (CmsException e) { // failed to get online project, at least avoid NPE m_onlineProject = m_offlineProject; } } /** * Constructor with arguments for construction of a {@link CmsJspActionElement}.

* * @param pageContext the page context to use * @param request the current request * @param response the current response */ public CmsSearchResultView(PageContext pageContext, HttpServletRequest request, HttpServletResponse response) { this(new CmsJspActionElement(pageContext, request, response)); } /** * Returns the formatted search results.

* * @param search the pre-configured search bean * @return the formatted search results */ public String displaySearchResult(CmsSearch search) { StringBuffer result = new StringBuffer(800); Locale locale = m_jsp.getRequestContext().getLocale(); CmsMessages messages = org.opencms.search.Messages.get().getBundle(locale); result.append("

\n"); result.append(messages.key(org.opencms.search.Messages.GUI_HELP_SEARCH_RESULT_TITLE_0)); result.append("\n

\n"); List searchResult; if (CmsStringUtil.isEmptyOrWhitespaceOnly(search.getQuery())) { search.setQuery(""); searchResult = Collections.emptyList(); } else { search.setMatchesPerPage(5); searchResult = search.getSearchResult(); } HttpServletRequest request = m_jsp.getRequest(); // get the action to perform from the request String action = request.getParameter("action"); if ((action != null) && (searchResult == null)) { result.append("

\n"); if (search.getLastException() != null) { result.append(messages.key(org.opencms.search.Messages.GUI_HELP_SEARCH_UNAVAILABLE_0)); result.append("\n\n"); } else { result.append(messages.key(org.opencms.search.Messages.GUI_HELP_SEARCH_NOMATCH_1, search.getQuery())); result.append("\n"); } result.append("

\n"); } else if ((action != null) && (searchResult.size() <= 0)) { result.append("

\n"); result.append(messages.key(org.opencms.search.Messages.GUI_HELP_SEARCH_NOMATCH_1, search.getQuery())); result.append("\n"); result.append("

\n"); } else if ((action != null) && (searchResult.size() > 0)) { result.append("

\n"); result.append(messages.key(org.opencms.search.Messages.GUI_HELP_SEARCH_RESULT_START_0)); result.append("\n"); result.append("

\n

\n"); Iterator iterator = searchResult.iterator(); try { if (m_exportLinks) { m_jsp.getRequestContext().setCurrentProject(m_onlineProject); } String name; String path; while (iterator.hasNext()) { CmsSearchResult entry = iterator.next(); result.append("\n

"); result.append("\n"); name = entry.getField(CmsSearchField.FIELD_TITLE); if (name == null) { name = entry.getPath(); } result.append(name); result.append(""); result.append(" (").append(entry.getScore()).append(" %)\n"); result.append("\n"); String excerptString = entry.getExcerpt(); if (CmsStringUtil.isEmptyOrWhitespaceOnly(excerptString)) { result.append(messages.key(org.opencms.search.Messages.GUI_HELP_SEARCH_EXCERPT_UNAVAILABLE_0)); } else { result.append(excerptString).append('\n'); } result.append("\n"); result.append("
\n"); } } finally { m_jsp.getRequestContext().setCurrentProject(m_offlineProject); } result.append("

\n"); // search page links below results if ((search.getPreviousUrl() != null) || (search.getNextUrl() != null)) { result.append("

"); if (search.getPreviousUrl() != null) { result.append(""); result.append(messages.key(org.opencms.search.Messages.GUI_HELP_BUTTON_BACK_0)); result.append(" <<  \n"); } Map pageLinks = search.getPageLinks(); Iterator i = pageLinks.keySet().iterator(); while (i.hasNext()) { int pageNumber = (i.next()).intValue(); result.append(" "); if (pageNumber != search.getSearchPage()) { result.append("").append(pageNumber).append("\n"); } else { result.append(pageNumber); } } if (search.getNextUrl() != null) { result.append("   >>"); result.append(messages.key(org.opencms.search.Messages.GUI_HELP_BUTTON_NEXT_0)); result.append("\n"); } result.append("

\n"); } } // include the post forms for the page links: Iterator values = m_formCache.values().iterator(); while (values.hasNext()) { result.append(values.next()); } return result.toString(); } /** * Returns true if the links to search results shall point to exported content, false else.

* @return true if the links to search results shall point to exported content, false else */ public boolean isExportLinks() { return m_exportLinks; } /** * Set wether the links to search results point to exported content or not.

* * @param exportLinks The value that decides Set wether the links to search results point to exported content or not. */ public void setExportLinks(boolean exportLinks) { m_exportLinks = exportLinks; } /** * Set a proprietary resource uri for the search page.

* * This is optional but allows to override the standard search result links * (for next or previous pages) that point to * getJsp().getRequestContext().getUri() whenever the search * uri is element of some template and should not be linked directly.

* * @param uri the proprietary resource uri for the search page */ public void setSearchRessourceUrl(String uri) { m_searchRessourceUrl = uri; } /** * Returns the resource uri to the search page with respect to the * optionally configured value {@link #setSearchRessourceUrl(String)} * with the request parameters of the given argument.

* * This is a workaround for Tomcat bug 35775 * (http://issues.apache.org/bugzilla/show_bug.cgi?id=35775). After it has been * fixed the version 1.1 should be restored (or at least this codepath should be switched back.

* * @param link the suggestion of the search result bean ( a previous, next or page number url) * @param search the search bean * * @return the resource uri to the search page with respect to the * optionally configured value {@link #setSearchRessourceUrl(String)} * with the request parameters of the given argument */ private String getSearchPageLink(String link, CmsSearch search) { if (m_searchRessourceUrl != null) { // for the form to generate we need params. String pageParams = ""; int paramIndex = link.indexOf('?'); if (paramIndex > 0) { pageParams = link.substring(paramIndex); } StringBuffer formurl = new StringBuffer(m_searchRessourceUrl); if (m_searchRessourceUrl.indexOf('?') != -1) { // the search page url already has a query string, don't start params of search-generated link // with '?' pageParams = new StringBuffer("&").append(pageParams.substring(1)).toString(); } formurl.append(pageParams).toString(); String formname = toPostParameters(formurl.toString(), search); link = new StringBuffer("javascript:document.forms['").append(formname).append("'].submit()").toString(); } return link; } /** * Generates a html form (named form<n>) with parameters found in * the given GET request string (appended params with "?value=param&value2=param2). * >n< is the number of forms that already have been generated. * This is a content-expensive bugfix for http://issues.apache.org/bugzilla/show_bug.cgi?id=35775 * and should be replaced with the 1.1 revision as soon that bug is fixed.

* * The forms action will point to the given uri's path info part: All links in the page * that includes this generated html and that are related to the get request should * have "src='#'" and "onclick=documents.forms['<getRequestUri>'].submit()".

* * The generated form lands in the internal Map {@link #m_formCache} as mapping * from uris to Strings and has to be appended to the output at a valid position.

* * Warning: Does not work with multiple values mapped to one parameter ("key = value1,value2..").

* * * * @param getRequestUri a request uri with optional query, will be used as name of the form too * @param search the search bean to get the parameters from * * @return the formname of the the generated form that contains the parameters of the given request uri or * the empty String if there weren't any get parameters in the given request uri. */ private String toPostParameters(String getRequestUri, CmsSearch search) { StringBuffer result; String formname = ""; if (!m_formCache.containsKey(getRequestUri)) { result = new StringBuffer(); int index = getRequestUri.indexOf('?'); String query = ""; String path = ""; if (index > 0) { query = getRequestUri.substring(index + 1); path = getRequestUri.substring(0, index); formname = new StringBuffer("searchform").append(m_formCache.size()).toString(); result.append("\n

\n"); // "key=value" pairs as tokens: StringTokenizer entryTokens = new StringTokenizer(query, "&", false); while (entryTokens.hasMoreTokens()) { StringTokenizer keyValueToken = new StringTokenizer(entryTokens.nextToken(), "=", false); if (keyValueToken.countTokens() != 2) { continue; } // Undo the possible already performed url encoding for the given url String key = CmsEncoder.decode(keyValueToken.nextToken()); String value = CmsEncoder.decode(keyValueToken.nextToken()); if ("action".equals(key)) { // cannot use the "search"-action value in combination with CmsWidgetDialog: prepareCommit would be left out! value = CmsWidgetDialog.DIALOG_SAVE; } result.append(" \n"); } // custom search index code for making category widget - compatible // this is needed for transforming e.g. the CmsSearch-generated // "&category=a,b,c" to widget fields categories.0..categories.n. List categories = search.getParameters().getCategories(); Iterator it = categories.iterator(); int count = 0; while (it.hasNext()) { result.append(" \n"); count++; } List roots = search.getParameters().getRoots(); it = roots.iterator(); count = 0; while (it.hasNext()) { result.append(" \n"); count++; } result.append(" \n"); result.append(" \n"); result.append("\n"); HTMLForm form = new HTMLForm(formname, result.toString()); m_formCache.put(getRequestUri, form); return formname; } // empty String for no get parameters return formname; } else { HTMLForm form = m_formCache.get(getRequestUri); return form.m_formName; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy