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.base;
17
18 import org.codelibs.fess.app.web.admin.AdminAction;
19 import org.codelibs.fess.app.web.admin.dashboard.AdminDashboardAction;
20 import org.codelibs.fess.mylasta.action.FessUserBean;
21 import org.lastaflute.web.response.HtmlResponse;
22
23 /**
24 * Abstract base action class for handling login functionality in Fess.
25 * This action provides logic for redirecting authenticated users to appropriate
26 * admin interfaces based on their roles and permissions.
27 */
28 public abstract class FessLoginAction extends FessSearchAction {
29 /**
30 * Default constructor.
31 */
32 public FessLoginAction() {
33 super();
34 }
35
36 /**
37 * Returns the appropriate HTML response for login handling.
38 * If a user is already authenticated, redirects to the appropriate admin interface.
39 * Otherwise, displays the login page.
40 *
41 * @return HTML response for login page or redirect to admin interface
42 */
43 protected HtmlResponse getHtmlResponse() {
44 return getUserBean().map(this::redirectByUser).orElse(asHtml(virtualHost(path_Login_IndexJsp)));
45 }
46
47 /**
48 * Redirects an authenticated user to the appropriate admin interface based on their roles.
49 * Users with admin roles are redirected to the dashboard, while other users are redirected
50 * to their designated admin action class or to the root if no specific action is available.
51 *
52 * @param user the authenticated user bean containing role information
53 * @return HTML response redirecting to the appropriate admin interface
54 */
55 protected HtmlResponse redirectByUser(final FessUserBean user) {
56 if (user.hasRoles(fessConfig.getAuthenticationAdminRolesAsArray())) {
57 return redirect(AdminDashboardAction.class);
58 }
59 final Class<? extends FessAdminAction> actionClass = AdminAction.getAdminActionClass(user);
60 if (actionClass != null) {
61 return redirect(actionClass);
62 }
63 return redirectToRoot();
64 }
65 }