/*
    * 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.badword;
  
  import java.io.BufferedReader;
  import java.io.BufferedWriter;
  import java.io.InputStream;
  import java.io.InputStreamReader;
  import java.io.OutputStreamWriter;
  import java.io.Reader;
  import java.io.Writer;
  import java.nio.file.Files;
  import java.nio.file.Path;
  
  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  import org.codelibs.core.beans.util.BeanUtil;
  import org.codelibs.core.concurrent.CommonPoolUtil;
  import org.codelibs.fess.Constants;
  import org.codelibs.fess.annotation.Secured;
  import org.codelibs.fess.app.pager.BadWordPager;
  import org.codelibs.fess.app.service.BadWordService;
  import org.codelibs.fess.app.web.CrudMode;
  import org.codelibs.fess.app.web.base.FessAdminAction;
  import org.codelibs.fess.exception.FessSystemException;
  import org.codelibs.fess.helper.SuggestHelper;
  import org.codelibs.fess.helper.SystemHelper;
  import org.codelibs.fess.opensearch.config.exentity.BadWord;
  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.ActionResponse;
  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 Bad Word management.
   *
   */
  public class AdminBadwordAction extends FessAdminAction {
  
      /**
       * Default constructor.
       */
      public AdminBadwordAction() {
          super();
      }
  
      /**
       * The role for this action.
       */
      public static final String ROLE = "admin-badword";
  
      private static final Logger logger = LogManager.getLogger(AdminBadwordAction.class);
  
      // ===================================================================================
      //                                                                           Attribute
      //                                                                           =========
      @Resource
      private BadWordService badWordService;
      @Resource
      private BadWordPager badWordPager;
  
      /**
       * The suggest helper.
       */
      @Resource
      protected SuggestHelper suggestHelper;
  
      // ===================================================================================
      //                                                                               Hook
      //                                                                              ======
      @Override
      protected void setupHtmlData(final ActionRuntime runtime) {
          super.setupHtmlData(runtime);
          runtime.registerData("helpLink", systemHelper.getHelpLink(fessConfig.getOnlineHelpNameBadword()));
      }
  
      @Override
      protected String getActionRole() {
          return ROLE;
     }
 
     // ===================================================================================
     //                                                                      Search Execute
     //                                                                      ==============
     /**
      * Show the index page.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse index() {
         return asListHtml();
     }
 
     /**
      * Show the list page.
      * @param pageNumber The page number.
      * @param form The search form.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse list(final OptionalThing<Integer> pageNumber, final SearchForm form) {
         pageNumber.ifPresent(num -> {
             badWordPager.setCurrentPageNumber(pageNumber.get());
         }).orElse(() -> {
             badWordPager.setCurrentPageNumber(0);
         });
         return asHtml(path_AdminBadword_AdminBadwordJsp).renderWith(data -> {
             searchPaging(data, form);
         });
     }
 
     /**
      * Search the bad words.
      * @param form The search form.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse search(final SearchForm form) {
         copyBeanToBean(form, badWordPager, op -> op.exclude(Constants.PAGER_CONVERSION_RULE));
         return asHtml(path_AdminBadword_AdminBadwordJsp).renderWith(data -> {
             searchPaging(data, form);
         });
     }
 
     /**
      * Reset the search form.
      * @param form The search form.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse reset(final SearchForm form) {
         badWordPager.clear();
         return asHtml(path_AdminBadword_AdminBadwordJsp).renderWith(data -> {
             searchPaging(data, form);
         });
     }
 
     /**
      * Search with paging.
      * @param data The render data.
      * @param form The search form.
      */
     protected void searchPaging(final RenderData data, final SearchForm form) {
         RenderDataUtil.register(data, "badWordItems", badWordService.getBadWordList(badWordPager)); // page navi
 
         // restore from pager
         copyBeanToBean(badWordPager, form, op -> op.include("id"));
     }
 
     // ===================================================================================
     //                                                                        Edit Execute
     //                                                                        ============
     // -----------------------------------------------------
     //                                            Entry Page
     //                                            ----------
     /**
      * Show the create new page.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse createnew() {
         saveToken();
         return asEditHtml().useForm(CreateForm.class, op -> {
             op.setup(form -> {
                 form.initialize();
                 form.crudMode = CrudMode.CREATE;
             });
         });
     }
 
     /**
      * Show the edit page.
      * @param form The edit form.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse edit(final EditForm form) {
         validate(form, messages -> {}, this::asListHtml);
         final String id = form.id;
         badWordService.getBadWord(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
     //                                               -------
     /**
      * Show the details page.
      * @param crudMode The CRUD mode.
      * @param id The ID.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse details(final int crudMode, final String id) {
         verifyCrudMode(crudMode, CrudMode.DETAILS, this::asListHtml);
         saveToken();
         return asDetailsHtml().useForm(EditForm.class, op -> {
             op.setup(form -> {
                 badWordService.getBadWord(id).ifPresent(entity -> {
                     copyBeanToBean(entity, form, copyOp -> {
                         copyOp.excludeNull();
                     });
                     form.crudMode = crudMode;
                 }).orElse(() -> {
                     throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), this::asListHtml);
                 });
             });
         });
     }
 
     // -----------------------------------------------------
     //                                              Download
     //                                               -------
     /**
      * Show the download page.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public HtmlResponse downloadpage() {
         saveToken();
         return asDownloadHtml();
     }
 
     /**
      * Download the bad words.
      * @param form The download form.
      * @return The action response.
      */
     @Execute
     @Secured({ ROLE, ROLE + VIEW })
     public ActionResponse download(final DownloadForm form) {
         verifyToken(this::asDownloadHtml);
 
         return asStream("badword.csv").contentTypeOctetStream().stream(out -> {
             final Path tempFile = ComponentUtil.getSystemHelper().createTempFile("fess-badword-", ".csv").toPath();
             try {
                 try (Writer writer = new BufferedWriter(new OutputStreamWriter(Files.newOutputStream(tempFile), getCsvEncoding()))) {
                     badWordService.exportCsv(writer);
                 } catch (final Exception e) {
                     logger.warn("Failed to process a request.", e);
                     throwValidationError(messages -> messages.addErrorsFailedToDownloadBadwordFile(GLOBAL), this::asDownloadHtml);
                 }
                 try (InputStream in = Files.newInputStream(tempFile)) {
                     out.write(in);
                 }
             } finally {
                 Files.delete(tempFile);
             }
         });
     }
 
     // -----------------------------------------------------
     //                                                Upload
     //                                               -------
     /**
      * Show the upload page.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse uploadpage() {
         saveToken();
         return asUploadHtml();
     }
 
     // -----------------------------------------------------
     //                                         Actually Crud
     //                                         -------------
     /**
      * Create a bad word.
      * @param form The create form.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse create(final CreateForm form) {
         verifyCrudMode(form.crudMode, CrudMode.CREATE, this::asListHtml);
         validate(form, messages -> {}, this::asEditHtml);
         verifyToken(this::asEditHtml);
         getBadWord(form).ifPresent(entity -> {
             try {
                 badWordService.store(entity);
                 suggestHelper.addBadWord(entity.getSuggestWord(), false);
                 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());
     }
 
     /**
      * Update a bad word.
      * @param form The edit form.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse update(final EditForm form) {
         verifyCrudMode(form.crudMode, CrudMode.EDIT, this::asListHtml);
         validate(form, messages -> {}, this::asEditHtml);
         verifyToken(this::asEditHtml);
         getBadWord(form).ifPresent(entity -> {
             try {
                 badWordService.store(entity);
                 suggestHelper.storeAllBadWords(false);
                 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());
     }
 
     /**
      * Delete a bad word.
      * @param form The edit form.
      * @return The HTML response.
      */
     @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;
         badWordService.getBadWord(id).ifPresent(entity -> {
             try {
                 badWordService.delete(entity);
                 suggestHelper.deleteBadWord(entity.getSuggestWord());
                 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::asDetailsHtml);
             }
         }).orElse(() -> {
             throwValidationError(messages -> messages.addErrorsCrudCouldNotFindCrudTable(GLOBAL, id), this::asDetailsHtml);
         });
         return redirect(getClass());
     }
 
     /**
      * Upload the bad words.
      * @param form The upload form.
      * @return The HTML response.
      */
     @Execute
     @Secured({ ROLE })
     public HtmlResponse upload(final UploadForm form) {
         validate(form, messages -> {}, this::asUploadHtml);
         verifyToken(this::asUploadHtml);
         CommonPoolUtil.execute(() -> {
             try (Reader reader = new BufferedReader(new InputStreamReader(form.badWordFile.getInputStream(), getCsvEncoding()))) {
                 badWordService.importCsv(reader);
                 suggestHelper.storeAllBadWords(false);
             } catch (final Exception e) {
                 throw new FessSystemException("Failed to import bad word data: fileName=" + form.badWordFile.getFileName(), e);
             }
         });
         saveInfo(messages -> messages.addSuccessUploadBadWord(GLOBAL));
         return redirect(getClass());
     }
 
     // ===================================================================================
     //                                                                        Assist Logic
     //                                                                        ============
     private static OptionalEntity<BadWord> getEntity(final CreateForm form, final String username, final long currentTime) {
         switch (form.crudMode) {
         case CrudMode.CREATE:
             return OptionalEntity.of(new BadWord()).map(entity -> {
                 entity.setCreatedBy(username);
                 entity.setCreatedTime(currentTime);
                 return entity;
             });
         case CrudMode.EDIT:
             if (form instanceof EditForm) {
                 return ComponentUtil.getComponent(BadWordService.class).getBadWord(((EditForm) form).id);
             }
             break;
         default:
             break;
         }
         return OptionalEntity.empty();
     }
 
     /**
      * Get the bad word.
      * @param form The create form.
      * @return The bad word.
      */
     public static OptionalEntity<BadWord> getBadWord(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);
             BeanUtil.copyBeanToBean(form, entity, op -> op.exclude(Constants.COMMON_CONVERSION_RULE));
             return entity;
         });
     }
 
     // ===================================================================================
     //                                                                        Small Helper
     //                                                                        ============
     private String getCsvEncoding() {
         return fessConfig.getCsvFileEncoding();
     }
 
     // ===================================================================================
     //                                                                              JSP
     //                                                                           =========
     private HtmlResponse asListHtml() {
         return asHtml(path_AdminBadword_AdminBadwordJsp).renderWith(data -> {
             RenderDataUtil.register(data, "badWordItems", badWordService.getBadWordList(badWordPager));
         }).useForm(SearchForm.class, setup -> {
             setup.setup(form -> {
                 copyBeanToBean(badWordPager, form, op -> op.include("id"));
             });
         });
     }
 
     private HtmlResponse asEditHtml() {
         return asHtml(path_AdminBadword_AdminBadwordEditJsp);
     }
 
     private HtmlResponse asDetailsHtml() {
         return asHtml(path_AdminBadword_AdminBadwordDetailsJsp);
     }
 
     private HtmlResponse asUploadHtml() {
         return asHtml(path_AdminBadword_AdminBadwordUploadJsp).useForm(UploadForm.class);
     }
 
     private HtmlResponse asDownloadHtml() {
         return asHtml(path_AdminBadword_AdminBadwordDownloadJsp).useForm(DownloadForm.class);
     }
 
 }