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 GmbH & Co. KG, 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.workplace.tools.searchindex;
  
  import org.opencms.configuration.CmsSearchConfiguration;
  import org.opencms.jsp.CmsJspActionElement;
  import org.opencms.main.CmsIllegalStateException;
  import org.opencms.main.OpenCms;
  import org.opencms.search.A_CmsSearchIndex;
  import org.opencms.search.CmsSearchIndex;
  import org.opencms.search.CmsSearchIndexSource;
  import org.opencms.search.CmsSearchManager;
  import org.opencms.search.I_CmsSearchIndex;
  import org.opencms.util.CmsStringUtil;
  import org.opencms.workplace.CmsWidgetDialog;
  import org.opencms.workplace.CmsWorkplaceSettings;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Locale;
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import javax.servlet.jsp.PageContext;
  
  /**
   * Abstract dialog class for all dialogs that work on a <code>A_CmsSearchIndex</code>.<p>
   *
   * The <code>{@link #PARAM_INDEXNAME}</code> ("searchindex") is supported
   * by means of widget technology (setter / getter).<p>
   *
   * Also - for accessing search functionality a member <code>{@link #m_searchManager}</code>
   * is accessible for implementations. <p>
   *
   * @since 6.0.0
   */
  public abstract class A_CmsEditSearchIndexDialog extends CmsWidgetDialog {
  
      /** The name constraints when generating new index names. */
      public static final String INDEX_NAME_CONSTRAINTS = "-._~$ ";
  
      /** localized messages Keys prefix. */
      public static final String KEY_PREFIX = "searchindex";
  
      /** Defines which pages are valid for this dialog. */
      public static final String[] PAGES = {"page1"};
  
      /**
       * The request parameter for the search index to work with when contacting
       * this dialog from another. <p>
       *
       * It may be emtpy if we are on the new index dialog (/searchindex/new-index.jsp).<p>
       *
       **/
      public static final String PARAM_INDEXNAME = "indexname";
  
      /** The user object that is edited on this dialog. */
      protected A_CmsSearchIndex m_index;
  
      /** The search manager singleton for convenient access. **/
      protected CmsSearchManager m_searchManager;
  
      /** Stores the value of the request parameter for the search index Name. */
      private String m_paramIndexName;
  
      /**
       * Public constructor with JSP action element.<p>
       *
       * @param jsp an initialized JSP action element
       */
      public A_CmsEditSearchIndexDialog(CmsJspActionElement jsp) {
  
          super(jsp);
      }
  
      /**
       * Public constructor with JSP variables.<p>
       *
       * @param context the JSP page context
       * @param req the JSP request
       * @param res the JSP response
       */
      public A_CmsEditSearchIndexDialog(PageContext context, HttpServletRequest req, HttpServletResponse res) {
  
          this(new CmsJspActionElement(context, req, res));
      }
  
      /**
       * Writes the updated search configuration back to the XML
       * configuration file and refreshes the complete list.<p>
       */
      protected static void writeConfiguration() {
  
          // update the XML configuration
          OpenCms.writeConfiguration(CmsSearchConfiguration.class);
      }
  
      /**
       * Commits the edited search index to the search manager.<p>
       */
      @Override
      public void actionCommit() {
  
          List<Throwable> errors = new ArrayList<Throwable>();
  
          try {
  
              // if new create it first
              if (!m_searchManager.getSearchIndexesAll().contains(m_index)) {
                  // check the index name for invalid characters
                  CmsStringUtil.checkName(
                      m_index.getName(),
                      INDEX_NAME_CONSTRAINTS,
                      Messages.ERR_SEARCHINDEX_BAD_INDEXNAME_4,
                      Messages.get());
                  // empty or null name and uniqueness check in add method
                  m_searchManager.addSearchIndex(m_index);
              }
              // check if field configuration has been updated, if thus set field configuration to the now used
              if (!m_index.getFieldConfigurationName().equals(m_index.getFieldConfiguration().getName())) {
                  m_index.setFieldConfiguration(
                      m_searchManager.getFieldConfiguration(m_index.getFieldConfigurationName()));
              }
              writeConfiguration();
  
          } catch (Throwable t) {
              errors.add(t);
          }
  
          // set the list of errors to display when saving failed
          setCommitErrors(errors);
      }
  
      /**
       * Returns the request parameter value for parameter paramSearchIndex. <p>
       *
       * @return the request parameter value for parameter paramSearchIndex
       */
      public String getParamIndexName() {
  
          return m_paramIndexName;
      }
  
      /**
       * Sets the value of the request parameter paramSearchIndex.
       *
       * @param paramSearchIndex the value of the request parameter paramSearchIndex to set
       */
      public void setParamIndexName(String paramSearchIndex) {
  
          m_paramIndexName = paramSearchIndex;
      }
  
      /**
       * Initializes the user object (a <code>{@link A_CmsSearchIndex}</code> instance.<p>
       *
       * Implementation always have to call <code>"super.defineWidgets()"</code> first as
       * this action may only be done here (relies on filled request parameters, the next
       * following operation <code>{@link CmsWidgetDialog#createDialogHtml()}</code> will
       * rely on this. <p>
       *
       * @see org.opencms.workplace.CmsWidgetDialog#defineWidgets()
       */
      @Override
      protected void defineWidgets() {
  
          initUserObject();
          setKeyPrefix(KEY_PREFIX);
  
      }
  
      /**
       * @see org.opencms.workplace.CmsWidgetDialog#getPageArray()
       */
      @Override
      protected String[] getPageArray() {
  
          return PAGES;
      }
  
      /**
       * Returns the search index.<p>
       *
       * @return the search index
       */
      protected A_CmsSearchIndex getSearchIndexIndex() {
  
          return m_index;
      }
  
      /**
       * Returns the root path of this dialog (path relative to "/system/workplace/admin").<p>
       *
       * @return the root path of this dialog (path relative to "/system/workplace/admin")
       */
      protected String getToolPath() {
  
          return "/searchindex";
      }
  
      /**
       * @see org.opencms.workplace.CmsWorkplace#initMessages()
       */
      @Override
      protected void initMessages() {
  
          // add specific dialog resource bundle
          addMessages(Messages.get().getBundleName());
          // add default resource bundles
          super.initMessages();
      }
  
      /**
       * Initializes the user object to work with depending on the dialog state and request parameters.<p>
       *
       * Two initializations of the user object on first dialog call are possible:
       * <ul>
       * <li>edit an existing search index</li>
       * <li>create a new search index with default initialization</li>
       * </ul>
       */
      protected void initUserObject() {
  
          try {
              I_CmsSearchIndex idx = m_searchManager.getIndex(getParamIndexName());
              m_index = idx instanceof CmsSearchIndex ? (CmsSearchIndex)idx : null;
              if (m_index == null) {
                  m_index = createDummySearchIndex();
              }
          } catch (Exception e) {
              m_index = createDummySearchIndex();
          }
      }
  
      /**
       * Overridden to initialize the internal <code>CmsSearchManager</code> before initWorkplaceRequestValues ->
       * defineWidgets ->  will access it (NPE). <p>
       *
       * @see org.opencms.workplace.CmsWorkplace#initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement)
       */
      @Override
      protected void initWorkplaceMembers(CmsJspActionElement jsp) {
  
          m_searchManager = OpenCms.getSearchManager();
          super.initWorkplaceMembers(jsp);
      }
  
      /**
       * @see org.opencms.workplace.CmsWorkplace#initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
       */
      @Override
      protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) {
  
          // initialize parameters and dialog actions in super implementation
          super.initWorkplaceRequestValues(settings, request);
  
          // save the current search index
          @SuppressWarnings("unchecked")
          Map<String, A_CmsSearchIndex> dialogObject = (Map<String, A_CmsSearchIndex>)getDialogObject();
          if (dialogObject == null) {
              dialogObject = new HashMap<String, A_CmsSearchIndex>();
              dialogObject.put(PARAM_INDEXNAME, m_index);
              setDialogObject(dialogObject);
          }
  
      }
  
      /**
       * Checks if the new search index dialog has to be displayed.<p>
       *
       * @return <code>true</code> if the new search index dialog has to be displayed
       */
      protected boolean isNewSearchIndex() {
  
          return DIALOG_INITIAL.equals(getParamAction());
      }
  
      /**
       * @see org.opencms.workplace.CmsWidgetDialog#validateParamaters()
       */
      @Override
      protected void validateParamaters() throws Exception {
  
          if (!isNewSearchIndex()) {
              // test the needed parameters: if initial we have "indexname", if from same widget we have name.0
              if ((getParamIndexName() == null) && (getJsp().getRequest().getParameter("name.0") == null)) {
                  throw new CmsIllegalStateException(
                      Messages.get().container(Messages.ERR_SEARCHINDEX_EDIT_MISSING_PARAM_1, PARAM_INDEXNAME));
              }
          }
      }
  
      /**
       * Creates a dummy index source.<p>
       *
       * @return the dummy search index source
       */
      private CmsSearchIndexSource createDummyIndexSource() {
  
          CmsSearchIndexSource result = new CmsSearchIndexSource();
          result.setName("default");
          result.setIndexerClassName("org.opencms.search.CmsVfsIndexer");
          result.addDocumentType("html");
          result.addDocumentType("generic");
          result.addDocumentType("pdf");
          // add search index source to config:
          m_searchManager.addSearchIndexSource(result);
          return result;
      }
  
      /**
       * Creates a "dummy" search index that is not linked to the search manager and has
       * a <code>null</code> name property that will be used for being filled with
       * the widget bean technology. <p>
       *
       * @return a "dummy" search index that is not linked to the search manager and has
       *         a <code>null</code> name property that will be used for being filled with
       *         the widget bean technology
       */
      private CmsSearchIndex createDummySearchIndex() {
  
          CmsSearchIndex result = new CmsSearchIndex();
          result.setLocale(Locale.ENGLISH);
          result.setProject("Online");
          result.setRebuildMode("auto");
  
          // find default source
          Map<String, CmsSearchIndexSource> sources = m_searchManager.getSearchIndexSources();
          if (sources.isEmpty()) {
              CmsSearchIndexSource source = createDummyIndexSource();
              sources.put(source.getName(), source);
          }
          result.addSourceName(sources.keySet().iterator().next());
  
          return result;
      }
  }