/*
    * Copyright 2012-2025 CodeLibs Project and the Others.
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
   * either express or implied. See the License for the specific language
   * governing permissions and limitations under the License.
   */
  package org.codelibs.fess.app.web.admin.webauth;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Locale;
  import java.util.Map;
  
  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  import org.codelibs.fess.Constants;
  import org.codelibs.fess.annotation.Secured;
  import org.codelibs.fess.app.pager.WebAuthPager;
  import org.codelibs.fess.app.service.WebAuthenticationService;
  import org.codelibs.fess.app.service.WebConfigService;
  import org.codelibs.fess.app.web.CrudMode;
  import org.codelibs.fess.app.web.base.FessAdminAction;
  import org.codelibs.fess.helper.SystemHelper;
  import org.codelibs.fess.opensearch.config.exentity.WebAuthentication;
  import org.codelibs.fess.opensearch.config.exentity.WebConfig;
  import org.codelibs.fess.util.ComponentUtil;
  import org.codelibs.fess.util.RenderDataUtil;
  import org.dbflute.optional.OptionalEntity;
  import org.dbflute.optional.OptionalThing;
  import org.lastaflute.web.Execute;
  import org.lastaflute.web.response.HtmlResponse;
  import org.lastaflute.web.response.render.RenderData;
  import org.lastaflute.web.ruts.process.ActionRuntime;
  
  import jakarta.annotation.Resource;
  
  /**
   * Admin action for Web Authentication management.
   *
   */
  public class AdminWebauthAction extends FessAdminAction {
  
      /**
       * Default constructor.
       */
      public AdminWebauthAction() {
          super();
      }
  
      /** Role name for admin web auth operations */
      public static final String ROLE = "admin-webauth";
  
      private static final Logger logger = LogManager.getLogger(AdminWebauthAction.class);
  
      // ===================================================================================
      //                                                                           Attribute
      //                                                                           =========
      /** Service for managing web authentication configurations */
      @Resource
      private WebAuthenticationService webAuthenticationService;
      /** Pager for paginating web authentication results */
      @Resource
      private WebAuthPager webAuthPager;
      /** Service for accessing and modifying web configuration settings */
      @Resource
      protected WebConfigService webConfigService;
  
      // ===================================================================================
      //                                                                               Hook
      //                                                                              ======
      @Override
      protected void setupHtmlData(final ActionRuntime runtime) {
          super.setupHtmlData(runtime);
          runtime.registerData("helpLink", systemHelper.getHelpLink(fessConfig.getOnlineHelpNameWebauth()));
      }
  
      @Override
      protected String getActionRole() {
          return ROLE;
      }
  
      // ===================================================================================
      //                                                                      Search Execute
      //                                                                      ==============
      /**
       * Displays the web authentication management index page.
       *
       * @param form the search form for filtering
       * @return HTML response for the web authentication list page
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse index(final SearchForm form) {
         return asListHtml();
     }
 
     /**
      * Displays a paginated list of web authentication configurations.
      *
      * @param pageNumber the page number to display (optional)
      * @param form the search form containing filter criteria
      * @return HTML response with the web authentication list
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse list(final OptionalThing<Integer> pageNumber, final SearchForm form) {
         pageNumber.ifPresent(num -> {
             webAuthPager.setCurrentPageNumber(pageNumber.get());
         }).orElse(() -> {
             webAuthPager.setCurrentPageNumber(0);
         });
         return asHtml(path_AdminWebauth_AdminWebauthJsp).renderWith(data -> {
             searchPaging(data, form);
         });
     }
 
     /**
      * Searches for web authentication configurations based on the provided search criteria.
      *
      * @param form the search form containing search criteria
      * @return HTML response with filtered web authentication results
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse search(final SearchForm form) {
         copyBeanToBean(form, webAuthPager, op -> op.exclude(Constants.PAGER_CONVERSION_RULE));
         return asHtml(path_AdminWebauth_AdminWebauthJsp).renderWith(data -> {
             searchPaging(data, form);
         });
     }
 
     /**
      * Resets the search criteria and displays all web authentication configurations.
      *
      * @param form the search form to reset
      * @return HTML response with the reset web authentication list
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse reset(final SearchForm form) {
         webAuthPager.clear();
         return asHtml(path_AdminWebauth_AdminWebauthJsp).renderWith(data -> {
             searchPaging(data, form);
         });
     }
 
     /**
      * Sets up pagination data for the web authentication search results.
      * Registers web authentication items and determines if the create link should be displayed.
      *
      * @param data the render data to populate with search results
      * @param form the search form containing filter criteria
      */
     protected void searchPaging(final RenderData data, final SearchForm form) {
         RenderDataUtil.register(data, "webAuthenticationItems", webAuthenticationService.getWebAuthenticationList(webAuthPager)); // page navi
         RenderDataUtil.register(data, "displayCreateLink", !crawlingConfigHelper.getAllWebConfigList(false, false, false, null).isEmpty());
         // restore from pager
         copyBeanToBean(webAuthPager, form, op -> op.include("id"));
     }
 
     // ===================================================================================
     //                                                                        Edit Execute
     //                                                                        ============
     // -----------------------------------------------------
     //                                            Entry Page
     //                                            ----------
     /**
      * Displays the form for creating a new web authentication configuration.
      *
      * @return HTML response for the web authentication creation form
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse createnew() {
         saveToken();
         return asHtml(path_AdminWebauth_AdminWebauthEditJsp).useForm(CreateForm.class, op -> {
             op.setup(form -> {
                 form.initialize();
                 form.crudMode = CrudMode.CREATE;
             });
         }).renderWith(data -> {
             registerProtocolSchemeItems(data);
             registerWebConfigItems(data);
         });
     }
 
     /**
      * Displays the form for editing an existing web authentication configuration.
      *
      * @param form the edit form containing web authentication ID
      * @return HTML response for the web authentication edit form
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse edit(final EditForm form) {
         validate(form, messages -> {}, this::asListHtml);
         final String id = form.id;
         webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
             copyBeanToBean(entity, form, op -> {});
         }).orElse(() -> {
             throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), this::asListHtml);
         });
         saveToken();
         if (form.crudMode.intValue() == CrudMode.EDIT) {
             // back
             form.crudMode = CrudMode.DETAILS;
             return asDetailsHtml();
         }
         form.crudMode = CrudMode.EDIT;
         return asEditHtml();
     }
 
     // -----------------------------------------------------
     //                                               Details
     //                                               -------
     /**
      * Displays the details of a web authentication configuration.
      *
      * @param crudMode the CRUD mode for the operation
      * @param id the ID of the web authentication to display
      * @return HTML response for the web authentication details page
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse details(final int crudMode, final String id) {
         verifyCrudMode(crudMode, CrudMode.DETAILS, this::asListHtml);
         saveToken();
         return asHtml(path_AdminWebauth_AdminWebauthDetailsJsp).useForm(EditForm.class, op -> {
             op.setup(form -> {
                 webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
                     copyBeanToBean(entity, form, copyOp -> {
                         copyOp.excludeNull();
                     });
                     form.crudMode = crudMode;
                 }).orElse(() -> {
                     throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), this::asListHtml);
                 });
             });
         }).renderWith(data -> {
             registerProtocolSchemeItems(data);
             registerWebConfigItems(data);
         });
     }
 
     // -----------------------------------------------------
     //                                         Actually Crud
     //                                         -------------
     /**
      * Creates a new web authentication configuration.
      *
      * @param form the create form containing the new web authentication data
      * @return HTML response redirecting to the list page after creation
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse create(final CreateForm form) {
         verifyCrudMode(form.crudMode, CrudMode.CREATE, this::asListHtml);
         validate(form, messages -> {}, this::asEditHtml);
         verifyToken(this::asEditHtml);
         getWebAuthentication(form).ifPresent(entity -> {
             try {
                 webAuthenticationService.store(entity);
                 saveInfo(messages -> messages.addSuccessCrudCreateCrudTable(GLOBAL));
             } catch (final Exception e) {
                 logger.warn("Failed to process a request.", e);
                 throwValidationError(messages -> messages.addErrorsCrudFailedToCreateCrudTable(GLOBAL, buildThrowableMessage(e)),
                         this::asEditHtml);
             }
         }).orElse(() -> {
             throwValidationError(messages -> messages.addErrorsCrudFailedToCreateInstance(GLOBAL), this::asEditHtml);
         });
         return redirect(getClass());
     }
 
     /**
      * Updates an existing web authentication configuration.
      *
      * @param form the edit form containing the updated web authentication data
      * @return HTML response redirecting to the list page after update
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse update(final EditForm form) {
         verifyCrudMode(form.crudMode, CrudMode.EDIT, this::asListHtml);
         validate(form, messages -> {}, this::asEditHtml);
         verifyToken(this::asEditHtml);
         getWebAuthentication(form).ifPresent(entity -> {
             try {
                 webAuthenticationService.store(entity);
                 saveInfo(messages -> messages.addSuccessCrudUpdateCrudTable(GLOBAL));
             } catch (final Exception e) {
                 logger.warn("Failed to process a request.", e);
                 throwValidationError(messages -> messages.addErrorsCrudFailedToUpdateCrudTable(GLOBAL, buildThrowableMessage(e)),
                         this::asEditHtml);
             }
         }).orElse(() -> {
             throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, form.id), this::asEditHtml);
         });
         return redirect(getClass());
     }
 
     /**
      * Deletes a web authentication configuration.
      *
      * @param form the edit form containing the ID of the web authentication to delete
      * @return HTML response redirecting to the list page after deletion
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse delete(final EditForm form) {
         verifyCrudMode(form.crudMode, CrudMode.DETAILS, this::asListHtml);
         validate(form, messages -> {}, this::asDetailsHtml);
         verifyToken(this::asDetailsHtml);
         final String id = form.id;
         webAuthenticationService.getWebAuthentication(id).ifPresent(entity -> {
             try {
                 webAuthenticationService.delete(entity);
                 saveInfo(messages -> messages.addSuccessCrudDeleteCrudTable(GLOBAL));
             } catch (final Exception e) {
                 logger.warn("Failed to process a request.", e);
                 throwValidationError(messages -> messages.addErrorsCrudFailedToDeleteCrudTable(GLOBAL, buildThrowableMessage(e)),
                         this::asEditHtml);
             }
         }).orElse(() -> {
             throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), this::asDetailsHtml);
         });
         return redirect(getClass());
     }
 
     //===================================================================================
     //                                                                        Assist Logic
     //                                                                        ============
     /**
      * Retrieves or creates a WebAuthentication entity based on the form's CRUD mode.
      *
      * @param form the form containing the web authentication data
      * @param username the username of the current user
      * @param currentTime the current timestamp
      * @return an optional WebAuthentication entity
      */
     public static OptionalEntity<WebAuthentication> getEntity(final CreateForm form, final String username, final long currentTime) {
         switch (form.crudMode) {
         case CrudMode.CREATE:
             return OptionalEntity.of(new WebAuthentication()).map(entity -> {
                 entity.setCreatedBy(username);
                 entity.setCreatedTime(currentTime);
                 return entity;
             });
         case CrudMode.EDIT:
             if (form instanceof EditForm) {
                 return ComponentUtil.getComponent(WebAuthenticationService.class).getWebAuthentication(((EditForm) form).id);
             }
             break;
         default:
             break;
         }
         return OptionalEntity.empty();
     }
 
     /**
      * Converts a form to a WebAuthentication entity with proper user and timestamp information.
      *
      * @param form the form containing the web authentication data
      * @return an optional WebAuthentication entity with updated metadata
      */
     public static OptionalEntity<WebAuthentication> getWebAuthentication(final CreateForm form) {
         final SystemHelper systemHelper = ComponentUtil.getSystemHelper();
         final String username = systemHelper.getUsername();
         final long currentTime = systemHelper.getCurrentTimeAsLong();
         return getEntity(form, username, currentTime).map(entity -> {
             entity.setUpdatedBy(username);
             entity.setUpdatedTime(currentTime);
             copyBeanToBean(form, entity, op -> op.exclude(Constants.COMMON_CONVERSION_RULE));
             return entity;
         });
     }
 
     /**
      * Registers available protocol scheme items for web authentication forms.
      * Includes Basic, Digest, NTLM, and Form authentication schemes.
      *
      * @param data the render data to register the protocol scheme items with
      */
     protected void registerProtocolSchemeItems(final RenderData data) {
         final List<Map<String, String>> itemList = new ArrayList<>();
         final Locale locale = ComponentUtil.getRequestManager().getUserLocale();
         itemList.add(createItem(ComponentUtil.getMessageManager().getMessage(locale, "labels.webauth_scheme_basic"), Constants.BASIC));
         itemList.add(createItem(ComponentUtil.getMessageManager().getMessage(locale, "labels.webauth_scheme_digest"), Constants.DIGEST));
         itemList.add(createItem(ComponentUtil.getMessageManager().getMessage(locale, "labels.webauth_scheme_ntlm"), Constants.NTLM));
         itemList.add(createItem(ComponentUtil.getMessageManager().getMessage(locale, "labels.webauth_scheme_form"), Constants.FORM));
         RenderDataUtil.register(data, "protocolSchemeItems", itemList);
     }
 
     /**
      * Registers available web configuration items for use in web authentication forms.
      * Retrieves all web configurations and creates form items from them.
      *
      * @param data the render data to register the web configuration items with
      */
     protected void registerWebConfigItems(final RenderData data) {
         final List<Map<String, String>> itemList = new ArrayList<>();
         final List<WebConfig> webConfigList = crawlingConfigHelper.getAllWebConfigList(false, false, false, null);
         for (final WebConfig webConfig : webConfigList) {
             itemList.add(createItem(webConfig.getName(), webConfig.getId().toString()));
         }
         RenderDataUtil.register(data, "webConfigItems", itemList);
     }
 
     /**
      * Creates a map item with label and value for use in dropdown lists and form options.
      *
      * @param label the display label for the item
      * @param value the value associated with the item
      * @return a map containing the label and value
      */
     protected Map<String, String> createItem(final String label, final String value) {
         final Map<String, String> map = new HashMap<>(2);
         map.put(Constants.ITEM_LABEL, label);
         map.put(Constants.ITEM_VALUE, value);
         return map;
     }
 
     // ===================================================================================
     //                                                                        Small Helper
     //                                                                        ============
     //                                                                              JSP
     //                                                                           =========
 
     private HtmlResponse asListHtml() {
         return asHtml(path_AdminWebauth_AdminWebauthJsp).renderWith(data -> {
             RenderDataUtil.register(data, "webAuthenticationItems", webAuthenticationService.getWebAuthenticationList(webAuthPager)); // page navi
             RenderDataUtil.register(data, "displayCreateLink",
                     !crawlingConfigHelper.getAllWebConfigList(false, false, false, null).isEmpty());
         }).useForm(SearchForm.class, setup -> {
             setup.setup(form -> {
                 copyBeanToBean(webAuthPager, form, op -> op.include("id"));
             });
         });
     }
 
     private HtmlResponse asEditHtml() {
         return asHtml(path_AdminWebauth_AdminWebauthEditJsp).renderWith(data -> {
             registerProtocolSchemeItems(data);
             registerWebConfigItems(data);
         });
     }
 
     private HtmlResponse asDetailsHtml() {
         return asHtml(path_AdminWebauth_AdminWebauthDetailsJsp).renderWith(data -> {
             registerProtocolSchemeItems(data);
             registerWebConfigItems(data);
         });
     }
 }