Refactor Bean Scopes: Project, Template, Workflow, Docket, Ruleset forms

Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/User.java

@@ -354,7 +354,7 @@
      *
      * @return a list of all roles of the user
      */
     public List<Role> getRoles() {
         initialize(new UserDAO(), this.roles);
         if (Objects.isNull(this.roles)) {
             this.roles = new ArrayList<>();
@@ -400,7 +400,7 @@
      *
      * @return all projects
      */
     public List<Project> getProjects() {
         initialize(new UserDAO(), this.projects);
         if (Objects.isNull(this.projects)) {
             this.projects = new ArrayList<>();
@@ -423,7 +423,7 @@
      *
      * @return the clients
      */
     public List<Client> getClients() {
         initialize(new UserDAO(), this.clients);
         if (Objects.isNull(this.clients)) {
             this.clients = new ArrayList<>();
@@ -690,7 +690,7 @@
      * <p>
      * To allow recreation of an account with the same login the login is cleaned -
      * otherwise it would be blocked eternally by the login existence test performed
-     * in the UserForm.save() function. In addition, all personally identifiable
+     * in the UserEditView.save() function. In addition, all personally identifiable
      * information is removed from the database as well.
      */
     public void selfDestruct() {

Kitodo/src/main/java/org/kitodo/production/filters/FilterMenu.java

@@ -26,7 +26,7 @@
 import org.kitodo.production.enums.FilterString;
 import org.kitodo.production.forms.CurrentTaskForm;
 import org.kitodo.production.forms.ProcessForm;
-import org.kitodo.production.forms.UserForm;
+import org.kitodo.production.forms.user.UserListView;
 import org.kitodo.production.services.ServiceManager;
 import org.kitodo.production.services.data.FilterService;
 
@@ -76,7 +76,7 @@ public class FilterMenu {
 
     private ProcessForm processForm = null;
     private CurrentTaskForm taskForm = null;
-    private UserForm userForm = null;
+    private UserListView userListView = null;
     private List<Suggestion> suggestions;
     private final List<ParsedFilter> parsedFilters;
     private String filterInEditMode;
@@ -106,10 +106,10 @@ public FilterMenu(CurrentTaskForm taskForm) {
     /**
      * Constructor of filter menu for users.
      *
-     * @param userForm instance of UserForm
+     * @param userListView instance of UserListView
      */
-    public FilterMenu(UserForm userForm) {
-        this.userForm = userForm;
+    public FilterMenu(UserListView userListView) {
+        this.userListView = userListView;
         suggestions = createSuggestionsForUserCategory("");
         parsedFilters = new ArrayList<>();
     }
@@ -148,7 +148,7 @@ public void updateSuggestions(String input) {
                 suggestions = createSuggestionsForProcessCategory(input);
             } else if (Objects.nonNull(taskForm)) {
                 suggestions = createSuggestionsForTaskCategory(input);
-            } else if (Objects.nonNull(userForm)) {
+            } else if (Objects.nonNull(userListView)) {
                 suggestions = createSuggestionsForUserCategory(input);
             }
         } else {
@@ -178,7 +178,7 @@ public void updateSuggestions(String input) {
                     String category = matcherPreviousCategory.find() ? matcherPreviousCategory.group() : "";
                     suggestions = createSuggestionsForTaskValue(checkFilterCategory(category, taskCategories), lastPart);
                 }
-            } else if (Objects.nonNull(userForm)) {
+            } else if (Objects.nonNull(userListView)) {
                 if (matcherNextCategory.find()) {
                     // strings ends with " | "
                     suggestions = createSuggestionsForUserCategory(matcherNextCategory.group());
@@ -399,8 +399,8 @@ public void updateFilters() {
             processForm.setFilter(newFilter.toString());
         } else if (Objects.nonNull(taskForm)) {
             taskForm.setFilter(newFilter.toString());
-        } else if (Objects.nonNull(userForm)) {
-            userForm.setFilter(newFilter.toString());
+        } else if (Objects.nonNull(userListView)) {
+            userListView.setFilter(newFilter.toString());
         }
     }
 }

Kitodo/src/main/java/org/kitodo/production/forms/AuthorityForm.java → Kitodo/src/main/java/org/kitodo/production/forms/AuthorityEditView.java

@@ -14,7 +14,8 @@
 import java.text.MessageFormat;
 import java.util.Objects;
 
-import jakarta.enterprise.context.SessionScoped;
+import jakarta.annotation.PostConstruct;
+import jakarta.faces.view.ViewScoped;
 import jakarta.inject.Named;
 
 import org.apache.logging.log4j.LogManager;
@@ -23,28 +24,26 @@
 import org.kitodo.data.database.exceptions.DAOException;
 import org.kitodo.production.enums.ObjectType;
 import org.kitodo.production.helper.Helper;
-import org.kitodo.production.model.LazyBeanModel;
 import org.kitodo.production.services.ServiceManager;
-import org.primefaces.model.SortMeta;
-import org.primefaces.model.SortOrder;
 
-@Named("AuthorityForm")
-@SessionScoped
-public class AuthorityForm extends BaseForm {
-    private static final Logger logger = LogManager.getLogger(AuthorityForm.class);
-    private Authority authority = new Authority();
+@Named("AuthorityEditView")
+@ViewScoped
+public class AuthorityEditView extends BaseEditView {
+
+    public static final String VIEW_PATH = MessageFormat.format(REDIRECT_PATH, "authorityEdit");
+
+    private static final Logger logger = LogManager.getLogger(AuthorityEditView.class);
+
+    private Authority authority;
     private String title;
     private String type;
-    private final String authorityEditPath = MessageFormat.format(REDIRECT_PATH, "authorityEdit");
 
     /**
-     * Default constructor that also sets the LazyBeanModel instance of this
-     * bean.
+     * Initialize AuthorityEditView.
      */
-    public AuthorityForm() {
-        super();
-        super.setLazyBeanModel(new LazyBeanModel(ServiceManager.getAuthorityService()));
-        sortBy = SortMeta.builder().field("title").order(SortOrder.ASCENDING).build();
+    @PostConstruct
+    public void init() {
+        authority = new Authority();
     }
 
     /**
@@ -85,16 +84,6 @@ public void setType(String type) {
         this.type = type;
     }
 
-    /**
-     * Create new authority.
-     *
-     * @return page address
-     */
-    public String newAuthority() {
-        this.authority = new Authority();
-        return authorityEditPath;
-    }
-
     /**
      * Save authority.
      *
@@ -104,30 +93,13 @@ public String save() {
         try {
             this.authority.setTitle(this.title + "_" + this.type);
             ServiceManager.getAuthorityService().save(this.authority);
-            return usersPage;
+            return AuthorityListView.VIEW_PATH + "&" + getReferrerListOptions();
         } catch (DAOException e) {
-            Helper.setErrorMessage(ERROR_SAVING, new Object[] {ObjectType.AUTHORITY.getTranslationSingular() }, logger,
-                e);
+            Helper.setErrorMessage(ERROR_SAVING, new Object[] {ObjectType.AUTHORITY.getTranslationSingular() }, logger, e);
             return this.stayOnCurrentPage;
         }
     }
 
-    /**
-     * Remove authority.
-     */
-    public void delete() {
-        try {
-            if (!this.authority.getRoles().isEmpty()) {
-                Helper.setErrorMessage("authorityAssignedError");
-                return;
-            }
-            ServiceManager.getAuthorityService().remove(this.authority);
-        } catch (DAOException e) {
-            Helper.setErrorMessage(ERROR_DELETING, new Object[] {ObjectType.AUTHORITY.getTranslationSingular() },
-                logger, e);
-        }
-    }
-
     /**
      * Method being used as viewAction for authority edit form.
      *
@@ -136,38 +108,17 @@ public void delete() {
      */
     public void load(int id) {
         if (!Objects.equals(id, 0)) {
-            setAuthorityById(id);
+            try {
+                authority = ServiceManager.getAuthorityService().getById(id);
+                title = authority.getTitleWithoutSuffix();
+                type = authority.getType();
+            } catch (DAOException e) {
+                Helper.setErrorMessage(ERROR_LOADING_ONE, new Object[] {ObjectType.ROLE.getTranslationSingular(), id }, logger, e);
+            }
         }
         setSaveDisabled(true);
     }
 
-    /**
-     * Set authority by id.
-     *
-     * @param id
-     *            ID of authority to set
-     */
-    public void setAuthorityById(int id) {
-        try {
-            setAuthority(ServiceManager.getAuthorityService().getById(id));
-        } catch (DAOException e) {
-            Helper.setErrorMessage(ERROR_LOADING_ONE, new Object[] {ObjectType.ROLE.getTranslationSingular(), id },
-                logger, e);
-        }
-    }
-
-    /**
-     * Set authority.
-     *
-     * @param authority
-     *            as org.kitodo.data.database.beans.Authority
-     */
-    public void setAuthority(Authority authority) {
-        this.authority = authority;
-        this.title = this.authority.getTitleWithoutSuffix();
-        this.type = this.authority.getType();
-    }
-
     /**
      * Get authority.
      *

Kitodo/src/main/java/org/kitodo/production/forms/AuthorityListView.java

@@ -0,0 +1,60 @@
+/*
+ * (c) Kitodo. Key to digital objects e. V. <[email protected]>
+ *
+ * This file is part of the Kitodo project.
+ *
+ * It is licensed under GNU General Public License version 3 or later.
+ *
+ * For the full copyright and license information, please read the
+ * GPL3-License.txt file that was distributed with this source code.
+ */
+
+package org.kitodo.production.forms;
+
+import java.text.MessageFormat;
+import java.util.Set;
+
+import jakarta.annotation.PostConstruct;
+import jakarta.faces.view.ViewScoped;
+import jakarta.inject.Named;
+
+import org.kitodo.production.model.LazyBeanModel;
+import org.kitodo.production.services.ServiceManager;
+import org.primefaces.model.SortMeta;
+import org.primefaces.model.SortOrder;
+
+@Named("AuthorityListView")
+@ViewScoped
+public class AuthorityListView extends BaseListView {
+
+    public static final String VIEW_PATH = MessageFormat.format(REDIRECT_PATH, "users") + "&tabIndex=3";
+
+    /**
+     * Initialize AuthorityListView.
+     */
+    @PostConstruct
+    public void init() {
+        setLazyBeanModel(new LazyBeanModel(ServiceManager.getAuthorityService()));
+        sortBy = SortMeta.builder().field("title").order(SortOrder.ASCENDING).build();
+    }
+
+    /**
+     * Navigate to the authority edit page to create a new authority.
+     *
+     * @return page address
+     */
+    public String newAuthority() {
+        return AuthorityEditView.VIEW_PATH;
+    }
+
+    /**
+     * The set of allowed sort fields (columns) to sanitize the URL query parameter "sortField".
+     * 
+     * @return the set of allowed sort fields (columns)
+     */
+    @Override
+    protected Set<String> getAllowedSortFields() {
+        return Set.of("title", "type");
+    }
+
+}

Kitodo/src/main/java/org/kitodo/production/forms/BaseEditView.java

@@ -0,0 +1,44 @@
+/*
+ * (c) Kitodo. Key to digital objects e. V. <[email protected]>
+ *
+ * This file is part of the Kitodo project.
+ *
+ * It is licensed under GNU General Public License version 3 or later.
+ *
+ * For the full copyright and license information, please read the
+ * GPL3-License.txt file that was distributed with this source code.
+ */
+
+package org.kitodo.production.forms;
+
+/**
+ * Base class for an edit view.
+ * 
+ * <p>Manages the view state, e.g. forwarded list view options via URL query parameters.</p>
+ * 
+ * <p>(BaseForm methods specific to edit views should be moved here in the future)</p>
+ */
+public class BaseEditView extends BaseForm {
+
+    protected String referrerListOptions;
+
+    /**
+     * Return the list options (URL query parameters) that were used while browsing a list before navigating to an edit view.
+     * 
+     * @return the referrer list view options (URL query parameters)
+     */
+    public String getReferrerListOptions() {
+        return referrerListOptions;
+    }
+
+    /**
+     * Set the list options (URL query parameters) that were used while browsing a list before navigating to an edit view.
+     * 
+     * @param referrerListOptions the referrer list options (URL query parameters)
+     */
+    public void setReferrerListOptionsFromTemplate(String referrerListOptions) {
+        this.referrerListOptions = referrerListOptions;
+    }
+
+
+}

Kitodo/src/main/java/org/kitodo/production/forms/BaseForm.java

@@ -35,6 +35,7 @@
 import org.kitodo.production.services.ServiceManager;
 import org.kitodo.production.services.data.ClientService;
 import org.kitodo.production.services.data.RoleService;
+import org.primefaces.PrimeFaces;
 import org.primefaces.component.datatable.DataTable;
 import org.primefaces.event.TabChangeEvent;
 import org.primefaces.event.data.PageEvent;
@@ -101,11 +102,27 @@ public void setFirstRow(int firstRow) {
     }
 
     /**
-     * Update first row to show in datatable on PageEvent.
+     * Set first row from the view parameter (query parameter), which might be unavailable or an arbitrary value.
+     */
+    public void setFirstRowFromTemplate(String firstRow) {
+        if (Objects.nonNull(firstRow) && !firstRow.isEmpty()) {
+            try {
+                this.firstRow = Integer.parseInt(firstRow);
+            } catch (NumberFormatException e) {
+                this.firstRow = 0;
+            }
+        }
+    }
+
+    /**
+     * Event listener in case a user navigates to a different page in the list view.
+     * 
      * @param pageEvent PageEvent triggered by data tables paginator
      */
     public void onPageChange(PageEvent pageEvent) {
-        this.setFirstRow(((DataTable) pageEvent.getSource()).getFirst());
+        DataTable source = (DataTable) pageEvent.getSource();
+        String script = "kitodo.updateQueryParameter('firstRow', '" + source.getRows() * pageEvent.getPage() + "');";
+        PrimeFaces.current().executeScript(script);
     }
 
     /**
@@ -172,7 +189,14 @@ public void setStayOnCurrentPage(String stayOnCurrentPage) {
      */
     public User getUser() {
         if (Objects.isNull(this.user)) {
-            this.user = ServiceManager.getUserService().getCurrentUser();
+            try {
+                User authenticatedUser = ServiceManager.getUserService().getCurrentUser();
+                // reload user from database, since authenticated user object might contain outdated data,
+                // e.g. outdated filters
+                this.user = ServiceManager.getUserService().getById(authenticatedUser.getId());
+            } catch (DAOException e) {
+                Helper.setErrorMessage(ERROR_LOADING_ONE, ObjectType.USER.getTranslationSingular(), getUser().getId());
+            }
         }
         return this.user;
     }