content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://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, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://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.jsp;
  
  import org.opencms.ade.publish.CmsPublishListHelper;
  import org.opencms.file.CmsFile;
  import org.opencms.file.CmsObject;
  import org.opencms.file.CmsResource;
  import org.opencms.file.CmsResourceFilter;
  import org.opencms.file.collectors.I_CmsCollectorPublishListProvider;
  import org.opencms.flex.CmsFlexController;
  import org.opencms.gwt.shared.I_CmsContentLoadCollectorInfo;
  import org.opencms.i18n.CmsLocaleManager;
  import org.opencms.jsp.search.config.CmsSearchConfiguration;
  import org.opencms.jsp.search.config.I_CmsSearchConfiguration;
  import org.opencms.jsp.search.config.parser.CmsJSONSearchConfigurationParser;
  import org.opencms.jsp.search.config.parser.CmsPlainQuerySearchConfigurationParser;
  import org.opencms.jsp.search.config.parser.CmsXMLSearchConfigurationParser;
  import org.opencms.jsp.search.controller.CmsSearchController;
  import org.opencms.jsp.search.controller.I_CmsSearchControllerCommon;
  import org.opencms.jsp.search.controller.I_CmsSearchControllerMain;
  import org.opencms.jsp.search.result.CmsSearchResultWrapper;
  import org.opencms.jsp.search.result.I_CmsSearchResultWrapper;
  import org.opencms.jsp.util.CmsJspElFunctions;
  import org.opencms.main.CmsException;
  import org.opencms.main.CmsIllegalArgumentException;
  import org.opencms.main.CmsLog;
  import org.opencms.main.OpenCms;
  import org.opencms.search.CmsSearchException;
  import org.opencms.search.CmsSearchResource;
  import org.opencms.search.fields.CmsSearchField;
  import org.opencms.search.solr.CmsSolrIndex;
  import org.opencms.search.solr.CmsSolrQuery;
  import org.opencms.search.solr.CmsSolrResultList;
  import org.opencms.util.CmsRequestUtil;
  import org.opencms.util.CmsUUID;
  import org.opencms.xml.content.CmsXmlContent;
  import org.opencms.xml.content.CmsXmlContentFactory;
  
  import java.util.HashSet;
  import java.util.Map;
  import java.util.Set;
  
  import javax.servlet.jsp.JspException;
  
  import org.apache.commons.logging.Log;
  
  /**
   * This tag is used to easily create a search form for a Solr search within a JSP.
   */
  public class CmsJspTagSearch extends CmsJspScopedVarBodyTagSuport implements I_CmsCollectorPublishListProvider {
  
      /**
       * Type for the file formats that can be parsed.
       * The format is given via the tag's attribute "fileFormat".
       */
      private static enum FileFormat {
          /**
           * XML file (of type jsp-search-form).
           */
          XML,
  
          /**
           * json file in respective format.
           */
          JSON
      }
  
      /** The log object for this class. */
      private static final Log LOG = CmsLog.getLog(CmsJspTagSearch.class);
  
      /** Serial version UID required for safe serialization. */
      private static final long serialVersionUID = 6048771777971251L;
  
      /** Default number of items which are checked for change for the "This page" publish dialog. */
      public static final int DEFAULT_CONTENTINFO_ROWS = 600;
  
      /** The CmsObject for the current user. */
      protected transient CmsObject m_cms;
  
      /** The FlexController for the current request. */
      protected CmsFlexController m_controller;
  
      /** Number of entries for which content info should be added to allow correct relations in "This page" publish dialog. */
      private Integer m_addContentInfoForEntries;
  
      /** The "configFile" tag attribute. */
      private Object m_configFile;
  
      /** The "configString" tag attribute. */
      private String m_configString;
  
      /** The "fileFormat" tag attribute converted to type FileFormat. */
      private FileFormat m_fileFormat;
  
      /** Search controller keeping all the config and state from the search. */
      private I_CmsSearchControllerMain m_searchController;
  
      /** The search index that should be used .
       *  It will either be the configured index, or "Solr Offline" / "Solr Online" depending on the project.
       * */
      private CmsSolrIndex m_index;
  
      /**
       * Empty constructor, required for JSP tags.
       *
       */
      public CmsJspTagSearch() {
  
          super();
          m_fileFormat = FileFormat.XML;
      }
  
      /**
       * @see org.opencms.file.collectors.I_CmsCollectorPublishListProvider#getPublishResources(org.opencms.file.CmsObject, org.opencms.gwt.shared.I_CmsContentLoadCollectorInfo)
       */
      @SuppressWarnings("javadoc")
      public static Set<CmsResource> getPublishResourcesInternal(CmsObject cms, I_CmsContentLoadCollectorInfo info)
      throws CmsException {
  
          CmsSolrIndex solrOnline = OpenCms.getSearchManager().getIndexSolr(CmsSolrIndex.DEFAULT_INDEX_NAME_ONLINE);
          CmsSolrIndex solrOffline = OpenCms.getSearchManager().getIndexSolr(CmsSolrIndex.DEFAULT_INDEX_NAME_OFFLINE);
          Set<CmsResource> result = new HashSet<CmsResource>();
          try {
              Map<String, String[]> searchParams = CmsRequestUtil.createParameterMap(
                  info.getCollectorParams(),
                  true,
                  null);
              // use "complicated" constructor to allow more than 50 results -> set ignoreMaxResults to true
              // adjust the CmsObject to prevent unintended filtering of resources
              CmsSolrResultList offlineResults = solrOffline.search(
                  CmsPublishListHelper.adjustCmsObject(cms, false),
                  new CmsSolrQuery(null, searchParams),
                  true);
              Set<String> offlineIds = new HashSet<String>(offlineResults.size());
              for (CmsSearchResource offlineResult : offlineResults) {
                  offlineIds.add(offlineResult.getField(CmsSearchField.FIELD_ID));
              }
              for (String id : offlineIds) {
                  CmsResource resource = cms.readResource(new CmsUUID(id));
                  if (!(resource.getState().isUnchanged())) {
                      result.add(resource);
                  }
              }
              CmsSolrResultList onlineResults = solrOnline.search(
                  CmsPublishListHelper.adjustCmsObject(cms, true),
                  new CmsSolrQuery(null, searchParams),
                  true);
              Set<String> deletedIds = new HashSet<String>(onlineResults.size());
              for (CmsSearchResource onlineResult : onlineResults) {
                  String uuid = onlineResult.getField(CmsSearchField.FIELD_ID);
                  if (!offlineIds.contains(uuid)) {
                      deletedIds.add(uuid);
                  }
              }
              for (String uuid : deletedIds) {
                  CmsResource resource = cms.readResource(new CmsUUID(uuid), CmsResourceFilter.ALL);
                  if (!(resource.getState().isUnchanged())) {
                      result.add(resource);
                  }
              }
          } catch (CmsSearchException e) {
              LOG.warn(Messages.get().getBundle().key(Messages.LOG_TAG_SEARCH_SEARCH_FAILED_0), e);
          }
          return result;
      }
  
      /**
       * @see javax.servlet.jsp.tagext.BodyTagSupport#doEndTag()
       */
      @Override
      public int doEndTag() throws JspException {
  
          release();
          return super.doEndTag();
      }
  
      /**
       * @see javax.servlet.jsp.tagext.Tag#doStartTag()
       */
      @Override
      public int doStartTag() throws JspException, CmsIllegalArgumentException {
  
          // initialize the content load tag
          init();
          addContentInfo();
          return EVAL_BODY_INCLUDE;
      }
  
      /** Get the value of the specified configuration file (given via the tag's "configFile" attribute).
       * @return The config file.
       */
      public Object getConfigFile() {
  
          return m_configFile;
      }
  
      /** Getter for the "configString".
       * @return The "configString".
       */
      public String getConfigString() {
  
          return m_configString;
      }
  
      /** Get the value of the specified format of the configuration file (given via the tag's "fileFormat" attribute).
       * @return The file format.
       */
      public String getFileFormat() {
  
          return m_fileFormat.toString();
      }
  
      /**
       * @see org.opencms.file.collectors.I_CmsCollectorPublishListProvider#getPublishResources(org.opencms.file.CmsObject, org.opencms.gwt.shared.I_CmsContentLoadCollectorInfo)
       */
      public Set<CmsResource> getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info) throws CmsException {
  
          return getPublishResourcesInternal(cms, info);
      }
  
      /**
       * @see javax.servlet.jsp.tagext.Tag#release()
       */
      @Override
      public void release() {
  
          m_cms = null;
          m_configFile = null;
          setConfigString(null);
          m_searchController = null;
          m_index = null;
          m_controller = null;
          m_addContentInfoForEntries = null;
          super.release();
      }
  
      /** Setter for "addContentInfo", indicating if content information should be added.
       * @param doAddInfo The value of the "addContentInfo" attribute of the tag
       */
      public void setAddContentInfo(final Boolean doAddInfo) {
  
          if ((null != doAddInfo) && doAddInfo.booleanValue() && (null == m_addContentInfoForEntries)) {
              m_addContentInfoForEntries = Integer.valueOf(DEFAULT_CONTENTINFO_ROWS);
          }
      }
  
      /** Setter for the configuration file.
       * @param fileName Name of the configuration file to use for the search.
       */
      public void setConfigFile(Object fileName) {
  
          m_configFile = fileName;
      }
  
      /** Setter for the "configString".
       * @param configString The "configString".
       */
      public void setConfigString(final String configString) {
  
          m_configString = configString;
      }
  
      /** Setter for "contentInfoMaxItems".
       * @param maxItems number of items to maximally check for alterations.
       */
      public void setContentInfoMaxItems(Integer maxItems) {
  
          if (null != maxItems) {
              m_addContentInfoForEntries = maxItems;
          }
      }
  
      /** Setter for the file format.
       * @param fileFormat File format the configuration file is in.
       */
      public void setFileFormat(String fileFormat) {
  
          if (fileFormat.toUpperCase().equals(FileFormat.JSON.toString())) {
              m_fileFormat = FileFormat.JSON;
          }
      }
  
      /**
       * Initializes this formatter tag.
       * <p>
       *
       * @throws JspException
       *             in case something goes wrong
       */
      protected void init() throws JspException {
  
          // initialize OpenCms access objects
          m_controller = CmsFlexController.getController(pageContext.getRequest());
          m_cms = m_controller.getCmsObject();
  
          try {
              I_CmsSearchConfiguration config = null;
              if (m_configFile != null) {
                  CmsFile configFile = m_cms.readFile(CmsJspElFunctions.convertRawResource(m_cms, m_configFile));
                  if (m_fileFormat == FileFormat.JSON) {
                      // read the JSON config file
                      OpenCms.getLocaleManager();
                      String configString = new String(
                          configFile.getContents(),
                          CmsLocaleManager.getResourceEncoding(m_cms, configFile));
                      config = new CmsSearchConfiguration(new CmsJSONSearchConfigurationParser(configString), m_cms);
                  } else { // assume XML
                      CmsXmlContent xmlContent = CmsXmlContentFactory.unmarshal(m_cms, configFile);
                      config = new CmsSearchConfiguration(
                          new CmsXMLSearchConfigurationParser(xmlContent, m_cms.getRequestContext().getLocale()),
                          m_cms);
                  }
              }
              if (m_configString != null) {
                  if (m_configString.trim().startsWith("{")) {
                      config = new CmsSearchConfiguration(
                          new CmsJSONSearchConfigurationParser(m_configString, config),
                          m_cms);
                  } else {
                      config = new CmsSearchConfiguration(
                          new CmsPlainQuerySearchConfigurationParser(m_configString, config),
                          m_cms);
                  }
              }
              m_searchController = new CmsSearchController(config);
  
              String indexName = m_searchController.getCommon().getConfig().getSolrIndex();
              m_index = OpenCms.getSearchManager().getIndexSolr(indexName);
  
              storeAttribute(getVar(), getSearchResults());
  
          } catch (Exception e) { // CmsException | UnsupportedEncodingException | JSONException
              LOG.error(e.getLocalizedMessage(), e);
              m_controller.setThrowable(e, m_cms.getRequestContext().getUri());
              throw new JspException(e);
          }
      }
  
      /**
       * Adds the content info for the collected resources used in the "This page" publish dialog.
       */
      private void addContentInfo() {
  
          if (!m_cms.getRequestContext().getCurrentProject().isOnlineProject()
              && CmsSolrIndex.DEFAULT_INDEX_NAME_OFFLINE.equals(m_searchController.getCommon().getConfig().getSolrIndex())
              && (null != m_addContentInfoForEntries)) {
              CmsSolrQuery query = new CmsSolrQuery();
              m_searchController.addQueryParts(query, m_cms);
              query.setStart(Integer.valueOf(0));
              query.setRows(m_addContentInfoForEntries);
              query.setFields(CmsSearchField.FIELD_ID);
              query.setFacet(false);
              CmsContentLoadCollectorInfo info = new CmsContentLoadCollectorInfo();
              info.setCollectorClass(this.getClass().getName());
              // Somehow the normal toString() does add '+' for spaces, but keeps "real" '+'
              // so we cannot reconstruct the correct query again.
              // Using toQueryString() puts '+' for spaces as well, but escapes the "real" '+'
              // so we can "repair" the query.
              // The method adds '?' as first character, what we do not need.
              String queryString = query.toQueryString();
              if (queryString.length() > 0) {
                  // Cut the leading '?' and put correct spaces in place
                  queryString = queryString.substring(1).replace('+', ' ');
              }
              info.setCollectorParams(queryString);
              info.setId((new CmsUUID()).getStringValue());
              if (CmsJspTagEditable.getDirectEditProvider(pageContext) != null) {
                  try {
                      CmsJspTagEditable.getDirectEditProvider(pageContext).insertDirectEditListMetadata(
                          pageContext,
                          info);
                  } catch (JspException e) {
                      LOG.error("Could not write content info.", e);
                  }
              }
          }
      }
  
      /** Here the search query is composed and executed.
       *  The result is wrapped in an easily usable form.
       *  It is exposed to the JSP via the tag's "var" attribute.
       * @return The result object exposed via the tag's attribute "var".
       */
      private I_CmsSearchResultWrapper getSearchResults() {
  
          // The second parameter is just ignored - so it does not matter
          m_searchController.updateFromRequestParameters(pageContext.getRequest().getParameterMap(), false);
          I_CmsSearchControllerCommon common = m_searchController.getCommon();
          // Do not search for empty query, if configured
          if (common.getState().getQuery().isEmpty()
              && (!common.getConfig().getIgnoreQueryParam() && !common.getConfig().getSearchForEmptyQueryParam())) {
              return new CmsSearchResultWrapper(m_searchController, null, null, m_cms, null);
          }
          Map<String, String[]> queryParams = null;
          boolean isEditMode = CmsJspTagEditable.isEditableRequest(pageContext.getRequest());
          if (isEditMode) {
              String params = "";
              if (common.getConfig().getIgnoreReleaseDate()) {
                  params += "&fq=released:[* TO *]";
              }
              if (common.getConfig().getIgnoreExpirationDate()) {
                  params += "&fq=expired:[* TO *]";
              }
              if (!params.isEmpty()) {
                  queryParams = CmsRequestUtil.createParameterMap(params.substring(1));
              }
          }
          CmsSolrQuery query = new CmsSolrQuery(null, queryParams);
          m_searchController.addQueryParts(query, m_cms);
          try {
              // use "complicated" constructor to allow more than 50 results -> set ignoreMaxResults to true
              // also set resource filter to allow for returning unreleased/expired resources if necessary.
              CmsSolrResultList solrResultList = m_index.search(
                  m_cms,
                  query.clone(), // use a clone of the query, since the search function manipulates the query (removes highlighting parts), but we want to keep the original one.
                  true,
                  null,
                  false,
                  isEditMode ? CmsResourceFilter.IGNORE_EXPIRATION : null,
                  m_searchController.getCommon().getConfig().getMaxReturnedResults());
              return new CmsSearchResultWrapper(m_searchController, solrResultList, query, m_cms, null);
          } catch (CmsSearchException e) {
              LOG.warn(Messages.get().getBundle().key(Messages.LOG_TAG_SEARCH_SEARCH_FAILED_0), e);
              return new CmsSearchResultWrapper(m_searchController, null, query, m_cms, e);
          }
      }
  }
  