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.modules;
  
  import org.opencms.jsp.CmsJspActionElement;
  import org.opencms.main.OpenCms;
  import org.opencms.module.CmsModule;
  import org.opencms.util.CmsStringUtil;
  import org.opencms.widgets.CmsDisplayWidget;
  import org.opencms.workplace.CmsDialog;
  import org.opencms.workplace.CmsWidgetDialog;
  import org.opencms.workplace.CmsWidgetDialogParameter;
  import org.opencms.workplace.CmsWorkplaceSettings;
  
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import javax.servlet.jsp.PageContext;
  
  /**
   * Class to show the module overview.<p>
   *
   * @since 6.0.0
   */
  public class CmsModulesOverview extends CmsWidgetDialog {
  
      /** The dialog type. */
      public static final String DIALOG_TYPE = "ModulesOverview";
  
      /** Defines which pages are valid for this dialog. */
      public static final String[] PAGES = {"page1"};
  
      /** The module object that is edited on this dialog. */
      private CmsModule m_module;
  
      /** Modulename. */
      private String m_paramModule;
  
      /**
       * Public constructor with JSP action element.<p>
       *
       * @param jsp an initialized JSP action element
       */
      public CmsModulesOverview(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 CmsModulesOverview(PageContext context, HttpServletRequest req, HttpServletResponse res) {
  
          this(new CmsJspActionElement(context, req, res));
      }
  
      /**
       * Commits the edited module.<p>
       */
      @Override
      public void actionCommit() {
  
          // noop
      }
  
      /**
       * Builds the HTML for the dialog form.<p>
       *
       * @return the HTML for the dialog form
       */
      @Override
      public String buildDialogForm() {
  
          StringBuffer result = new StringBuffer(1024);
  
          try {
  
              // create the dialog HTML
              result.append(createDialogHtml(getParamPage()));
  
          } catch (Throwable t) {
              // TODO: Error handling
          }
          return result.toString();
      }
  
      /**
       * @see org.opencms.workplace.CmsDialog#getCancelAction()
       */
      @Override
      public String getCancelAction() {
  
          // set the default action
          setParamPage(getPages().get(0));
  
          return DIALOG_SET;
      }
  
      /**
       * Gets the module parameter.<p>
       *
       * @return the module parameter
       */
      public String getParamModule() {
  
          return m_paramModule;
      }
  
      /**
       * Sets the module parameter.<p>
       * @param paramModule the module parameter
       */
      public void setParamModule(String paramModule) {
  
          m_paramModule = paramModule;
      }
  
      /**
       * Creates the dialog HTML for all defined widgets of the named dialog (page).<p>
       *
       * @param dialog the dialog (page) to get the HTML for
       * @return the dialog HTML for all defined widgets of the named dialog (page)
       */
      @Override
      protected String createDialogHtml(String dialog) {
  
          StringBuffer result = new StringBuffer(1024);
  
          // create table
          result.append(createWidgetTableStart());
  
          // show error header once if there were validation errors
          result.append(createWidgetErrorHeader());
  
          if (dialog.equals(PAGES[0])) {
              result.append(dialogBlockStart(key("label.moduleinformation")));
              result.append(createWidgetTableStart());
              result.append(createDialogRowsHtml(0, 5));
              result.append(createWidgetTableEnd());
              result.append(dialogBlockEnd());
              result.append(dialogBlockStart(key("label.modulecreator")));
              result.append(createWidgetTableStart());
              result.append(createDialogRowsHtml(6, 7));
              result.append(createWidgetTableEnd());
              result.append(dialogBlockEnd());
          }
  
          // close table
          result.append(createWidgetTableEnd());
  
          return result.toString();
      }
  
      /**
       * Creates the list of widgets for this dialog.<p>
       */
      @Override
      protected void defineWidgets() {
  
          initModule();
          setKeyPrefix(CmsModulesEditBase.KEY_PREFIX);
          addWidget(new CmsWidgetDialogParameter(m_module, "name", PAGES[0], new CmsDisplayWidget()));
          addWidget(new CmsWidgetDialogParameter(m_module, "niceName", PAGES[0], new CmsDisplayWidget()));
          addWidget(new CmsWidgetDialogParameter(m_module, "description", PAGES[0], new CmsDisplayWidget()));
          addWidget(new CmsWidgetDialogParameter(m_module, "version.version", PAGES[0], new CmsDisplayWidget()));
          addWidget(new CmsWidgetDialogParameter(m_module, "group", PAGES[0], new CmsDisplayWidget()));
          addWidget(new CmsWidgetDialogParameter(m_module, "actionClass", PAGES[0], new CmsDisplayWidget()));
          addWidget(new CmsWidgetDialogParameter(m_module, "authorName", PAGES[0], new CmsDisplayWidget()));
          addWidget(new CmsWidgetDialogParameter(m_module, "authorEmail", PAGES[0], new CmsDisplayWidget()));
  
      }
  
      /**
       * @see org.opencms.workplace.CmsWidgetDialog#getPageArray()
       */
      @Override
      protected String[] getPageArray() {
  
          return PAGES;
      }
  
      /**
       * @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 module  to work with depending on the dialog state and request parameters.<p>
       */
      protected void initModule() {
  
          Object o;
  
          if (CmsStringUtil.isEmpty(getParamAction()) || CmsDialog.DIALOG_INITIAL.equals(getParamAction())) {
              // this is the initial dialog call
              if (CmsStringUtil.isNotEmpty(m_paramModule)) {
                  // edit an existing module, get it from manager
                  o = OpenCms.getModuleManager().getModule(m_paramModule);
              } else {
                  // create a new module
                  o = null;
              }
          } else {
              // this is not the initial call, get module from session
              o = getDialogObject();
          }
  
          if (!(o instanceof CmsModule)) {
              // create a new module
              m_module = new CmsModule();
  
          } else {
              // reuse module stored in session
              m_module = (CmsModule)((CmsModule)o).clone();
          }
      }
  
      /**
       * @see org.opencms.workplace.CmsWorkplace#initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
       */
      @Override
      protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) {
  
          // set the dialog type
          setParamDialogtype(DIALOG_TYPE);
  
          super.initWorkplaceRequestValues(settings, request);
  
          // refresh the list
          Map<?, ?> objects = (Map<?, ?>)getSettings().getListObject();
          if (objects != null) {
              objects.remove(CmsExportpointsList.class.getName());
              objects.remove(CmsModulesDependenciesList.class.getName());
          }
  
          // save the current state of the module (may be changed because of the widget values)
          setDialogObject(m_module);
      }
  
      /**
       * @see org.opencms.workplace.CmsWidgetDialog#validateParamaters()
       */
      @Override
      protected void validateParamaters() throws Exception {
  
          String moduleName = getParamModule();
          // check module
          CmsModule module = OpenCms.getModuleManager().getModule(moduleName);
          if (module == null) {
              throw new Exception();
          }
      }
  }
  