View Javadoc
1   /*
2    * Copyright 2012-2025 CodeLibs Project and the Others.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific language
14   * governing permissions and limitations under the License.
15   */
16  package org.codelibs.fess.app.web.admin.suggest;
17  
18  import org.codelibs.fess.annotation.Secured;
19  import org.codelibs.fess.app.web.base.FessAdminAction;
20  import org.codelibs.fess.helper.SuggestHelper;
21  import org.lastaflute.web.Execute;
22  import org.lastaflute.web.response.HtmlResponse;
23  import org.lastaflute.web.ruts.process.ActionRuntime;
24  
25  import jakarta.annotation.Resource;
26  
27  /**
28   * Admin action for suggest management.
29   *
30   */
31  public class AdminSuggestAction extends FessAdminAction {
32  
33      /**
34       * Default constructor.
35       */
36      public AdminSuggestAction() {
37          super();
38      }
39  
40      /** Role name for admin suggest operations */
41      public static final String ROLE = "admin-suggest";
42  
43      // ===================================================================================
44      //                                                                           Attribute
45      //                                                                           =========
46      /** Helper for managing suggest functionality. */
47      @Resource
48      protected SuggestHelper suggestHelper;
49  
50      // ===================================================================================
51      //                                                                               Hook
52      //                                                                              ======
53      @Override
54      protected void setupHtmlData(final ActionRuntime runtime) {
55          super.setupHtmlData(runtime);
56          runtime.registerData("helpLink", systemHelper.getHelpLink(fessConfig.getOnlineHelpNameSuggest()));
57          runtime.registerData("totalWordsNum", suggestHelper.getAllWordsNum());
58          runtime.registerData("documentWordsNum", suggestHelper.getDocumentWordsNum());
59          runtime.registerData("queryWordsNum", suggestHelper.getQueryWordsNum());
60      }
61  
62      @Override
63      protected String getActionRole() {
64          return ROLE;
65      }
66  
67      // ===================================================================================
68      //                                                                             Execute
69      //                                                                            ========
70      /**
71       * Displays the suggest management index page.
72       *
73       * @return HTML response for the suggest management page
74       */
75      @Execute
76      @Secured({ ROLE, ROLE + VIEW })
77      public HtmlResponse index() {
78          saveToken();
79          return asHtml(path_AdminSuggest_AdminSuggestJsp).useForm(SuggestForm.class);
80      }
81  
82      /**
83       * Deletes all suggest words from the suggest index.
84       *
85       * @return HTML response redirecting to the index page
86       */
87      @Execute
88      @Secured({ ROLE })
89      public HtmlResponse deleteAllWords() {
90          if (!suggestHelper.deleteAllWords()) {
91              throwValidationError(messages -> messages.addErrorsFailedToDeleteDocInAdmin(GLOBAL),
92                      () -> asHtml(path_AdminSuggest_AdminSuggestJsp).useForm(SuggestForm.class));
93          }
94          saveInfo(messages -> messages.addSuccessDeleteDocFromIndex(GLOBAL));
95          verifyToken(() -> asHtml(path_AdminSuggest_AdminSuggestJsp).useForm(SuggestForm.class));
96          return redirect(getClass());
97      }
98  
99      /**
100      * Deletes document-based suggest words from the suggest index.
101      *
102      * @return HTML response redirecting to the index page
103      */
104     @Execute
105     @Secured({ ROLE })
106     public HtmlResponse deleteDocumentWords() {
107         if (!suggestHelper.deleteDocumentWords()) {
108             throwValidationError(messages -> messages.addErrorsFailedToDeleteDocInAdmin(GLOBAL),
109                     () -> asHtml(path_AdminSuggest_AdminSuggestJsp).useForm(SuggestForm.class));
110         }
111         saveInfo(messages -> messages.addSuccessDeleteDocFromIndex(GLOBAL));
112         verifyToken(() -> asHtml(path_AdminSuggest_AdminSuggestJsp).useForm(SuggestForm.class));
113         return redirect(getClass());
114     }
115 
116     /**
117      * Deletes query-based suggest words from the suggest index.
118      *
119      * @return HTML response redirecting to the index page
120      */
121     @Execute
122     @Secured({ ROLE })
123     public HtmlResponse deleteQueryWords() {
124         if (!suggestHelper.deleteQueryWords()) {
125             throwValidationError(messages -> messages.addErrorsFailedToDeleteDocInAdmin(GLOBAL),
126                     () -> asHtml(path_AdminSuggest_AdminSuggestJsp).useForm(SuggestForm.class));
127         }
128         saveInfo(messages -> messages.addSuccessDeleteDocFromIndex(GLOBAL));
129         verifyToken(() -> asHtml(path_AdminSuggest_AdminSuggestJsp).useForm(SuggestForm.class));
130         return redirect(getClass());
131     }
132 }