LightPIT: src/main/java/de/uapcore/lightpit/modules/ProjectsModule.java@24a3596b8f98 (annotated)

src/main/java/de/uapcore/lightpit/modules/ProjectsModule.java@24a3596b8f98 (annotated)

src/main/java/de/uapcore/lightpit/modules/ProjectsModule.java

Sat, 30 May 2020 18:05:06 +0200

author: Mike Becker <universe@uap-core.de>
date: Sat, 30 May 2020 18:05:06 +0200
changeset 83: 24a3596b8f98
parent 81: 1a2e7b5d48f7
child 86: 0a658e53177c
permissions: -rw-r--r--

adds version selection in issue editor

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2018 Mike Becker. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  *
  */
 package de.uapcore.lightpit.modules;
 import de.uapcore.lightpit.*;
 import de.uapcore.lightpit.dao.DataAccessObjects;
 import de.uapcore.lightpit.entities.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import javax.servlet.annotation.WebServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpSession;
 import java.io.IOException;
 import java.sql.Date;
 import java.sql.SQLException;
 import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import static de.uapcore.lightpit.Functions.fqn;
 @WebServlet(
         name = "ProjectsModule",
         urlPatterns = "/projects/*"
 )
 public final class ProjectsModule extends AbstractLightPITServlet {
     private static final Logger LOG = LoggerFactory.getLogger(ProjectsModule.class);
     public static final String SESSION_ATTR_SELECTED_PROJECT = fqn(ProjectsModule.class, "selected_project");
     public static final String SESSION_ATTR_SELECTED_ISSUE = fqn(ProjectsModule.class, "selected_issue");
     public static final String SESSION_ATTR_SELECTED_VERSION = fqn(ProjectsModule.class, "selected_version");
     public static final String SESSION_ATTR_HIDE_ZEROS = fqn(ProjectsModule.class, "stats_hide_zeros");
     private class SessionSelection {
         final HttpSession session;
         Project project;
         Version version;
         Issue issue;
         SessionSelection(HttpServletRequest req, Project project) {
             this.session = req.getSession();
             this.project = project;
             version = null;
             issue = null;
             updateAttributes();
         }
         SessionSelection(HttpServletRequest req, DataAccessObjects dao) throws SQLException {
             this.session = req.getSession();
             final var issueDao = dao.getIssueDao();
             final var projectDao = dao.getProjectDao();
             final var issueSelection = getParameter(req, Integer.class, "issue");
             if (issueSelection.isPresent()) {
                 issue = issueDao.find(issueSelection.get());
             } else {
                 final var issue = (Issue) session.getAttribute(SESSION_ATTR_SELECTED_ISSUE);
                 this.issue = issue == null ? null : issueDao.find(issue.getId());
             }
             if (issue != null) {
                 version = null; // show the issue globally
                 project = projectDao.find(issue.getProject().getId());
             }
             final var projectSelection = getParameter(req, Integer.class, "pid");
             if (projectSelection.isPresent()) {
                 final var selectedProject = projectDao.find(projectSelection.get());
                 if (!Objects.equals(selectedProject, project)) {
                     // reset version and issue if project changed
                     version = null;
                     issue = null;
                 }
                 project = selectedProject;
             } else {
                 final var sessionProject = (Project) session.getAttribute(SESSION_ATTR_SELECTED_PROJECT);
                 project = sessionProject == null ? null : projectDao.find(sessionProject.getId());
             }
             updateAttributes();
         }
         void selectVersion(Version version) {
             this.project = version.getProject();
             this.version = version;
             this.issue = null;
             updateAttributes();
         }
         void selectIssue(Issue issue) {
             this.project = issue.getProject();
             this.issue = issue;
             this.version = null;
             updateAttributes();
         }
         void updateAttributes() {
             session.setAttribute(SESSION_ATTR_SELECTED_PROJECT, project);
             session.setAttribute(SESSION_ATTR_SELECTED_VERSION, version);
             session.setAttribute(SESSION_ATTR_SELECTED_ISSUE, issue);
         }
     }
     private void setAttributeHideZeros(HttpServletRequest req) {
         final Boolean value;
         final var param = getParameter(req, Boolean.class, "reduced");
         if (param.isPresent()) {
             value = param.get();
             req.getSession().setAttribute(SESSION_ATTR_HIDE_ZEROS, value);
         } else {
             final var sessionValue = req.getSession().getAttribute(SESSION_ATTR_HIDE_ZEROS);
             if (sessionValue != null) {
                 value = (Boolean) sessionValue;
             } else {
                 value = false;
                 req.getSession().setAttribute(SESSION_ATTR_HIDE_ZEROS, value);
             }
         }
         req.setAttribute("statsHideZeros", value);
     }
     @Override
     protected String getResourceBundleName() {
         return "localization.projects";
     }
     private static final int BREADCRUMB_LEVEL_ROOT = 0;
     private static final int BREADCRUMB_LEVEL_PROJECT = 1;
     private static final int BREADCRUMB_LEVEL_VERSION = 2;
     private static final int BREADCRUMB_LEVEL_ISSUE_LIST = 3;
     private static final int BREADCRUMB_LEVEL_ISSUE = 4;
     /**
      * Creates the breadcrumb menu.
      *
      * @param level           the current active level (0: root, 1: project, 2: version, 3: issue list, 4: issue)
      * @param sessionSelection the currently selected objects
      * @return a dynamic breadcrumb menu trying to display as many levels as possible
      */
     private List<MenuEntry> getBreadcrumbs(int level, SessionSelection sessionSelection) {
         MenuEntry entry;
         final var breadcrumbs = new ArrayList<MenuEntry>();
         entry = new MenuEntry(new ResourceKey("localization.lightpit", "menu.projects"),
                 "projects/");
         breadcrumbs.add(entry);
         if (level == BREADCRUMB_LEVEL_ROOT) entry.setActive(true);
         if (sessionSelection.project != null) {
             if (sessionSelection.project.getId() < 0) {
                 entry = new MenuEntry(new ResourceKey("localization.projects", "button.create"),
                         "projects/edit");
             } else {
                 entry = new MenuEntry(sessionSelection.project.getName(),
                         "projects/view?pid=" + sessionSelection.project.getId());
             }
             if (level == BREADCRUMB_LEVEL_PROJECT) entry.setActive(true);
             breadcrumbs.add(entry);
         }
         if (sessionSelection.version != null) {
             if (sessionSelection.version.getId() < 0) {
                 entry = new MenuEntry(new ResourceKey("localization.projects", "button.version.create"),
                         "projects/versions/edit");
             } else {
                 entry = new MenuEntry(sessionSelection.version.getName(),
                         // TODO: change link to issue overview for that version
                         "projects/versions/edit?id=" + sessionSelection.version.getId());
             }
             if (level == BREADCRUMB_LEVEL_VERSION) entry.setActive(true);
             breadcrumbs.add(entry);
         }
         if (sessionSelection.project != null) {
             entry = new MenuEntry(new ResourceKey("localization.projects", "menu.issues"),
                     // TODO: maybe also add selected version
                     "projects/issues/?pid=" + sessionSelection.project.getId());
             if (level == BREADCRUMB_LEVEL_ISSUE_LIST) entry.setActive(true);
             breadcrumbs.add(entry);
         }
         if (sessionSelection.issue != null) {
             if (sessionSelection.issue.getId() < 0) {
                 entry = new MenuEntry(new ResourceKey("localization.projects", "button.issue.create"),
                         "projects/issues/edit");
             } else {
                 entry = new MenuEntry("#" + sessionSelection.issue.getId(),
                         // TODO: maybe change link to a view rather than directly opening the editor
                         "projects/issues/edit?id=" + sessionSelection.issue.getId());
             }
             if (level == BREADCRUMB_LEVEL_ISSUE) entry.setActive(true);
             breadcrumbs.add(entry);
         }
         return breadcrumbs;
     }
     @RequestMapping(method = HttpMethod.GET)
     public ResponseType index(HttpServletRequest req, DataAccessObjects dao) throws SQLException {
         final var sessionSelection = new SessionSelection(req, dao);
         final var projectList = dao.getProjectDao().list();
         req.setAttribute("projects", projectList);
         setContentPage(req, "projects");
         setStylesheet(req, "projects");
         setBreadcrumbs(req, getBreadcrumbs(BREADCRUMB_LEVEL_ROOT, sessionSelection));
         return ResponseType.HTML;
     }
     private void configureEditForm(HttpServletRequest req, DataAccessObjects dao, SessionSelection selection) throws SQLException {
         req.setAttribute("project", selection.project);
         req.setAttribute("users", dao.getUserDao().list());
         setContentPage(req, "project-form");
         setBreadcrumbs(req, getBreadcrumbs(BREADCRUMB_LEVEL_PROJECT, selection));
     }
     @RequestMapping(requestPath = "edit", method = HttpMethod.GET)
     public ResponseType edit(HttpServletRequest req, DataAccessObjects dao) throws SQLException {
         final var selection = new SessionSelection(req, findByParameter(req, Integer.class, "id",
                 dao.getProjectDao()::find).orElse(new Project(-1)));
         configureEditForm(req, dao, selection);
         return ResponseType.HTML;
     }
     @RequestMapping(requestPath = "commit", method = HttpMethod.POST)
     public ResponseType commit(HttpServletRequest req, DataAccessObjects dao) throws SQLException {
         Project project = new Project(-1);
         try {
             project = new Project(getParameter(req, Integer.class, "id").orElseThrow());
             project.setName(getParameter(req, String.class, "name").orElseThrow());
             getParameter(req, String.class, "description").ifPresent(project::setDescription);
             getParameter(req, String.class, "repoUrl").ifPresent(project::setRepoUrl);
             getParameter(req, Integer.class, "owner").map(
                     ownerId -> ownerId >= 0 ? new User(ownerId) : null
             ).ifPresent(project::setOwner);
             dao.getProjectDao().saveOrUpdate(project);
             setRedirectLocation(req, "./projects/");
             setContentPage(req, Constants.JSP_COMMIT_SUCCESSFUL);
             LOG.debug("Successfully updated project {}", project.getName());
         } catch (NoSuchElementException | IllegalArgumentException | SQLException ex) {
             // TODO: set request attribute with error text
             LOG.warn("Form validation failure: {}", ex.getMessage());
             LOG.debug("Details:", ex);
             configureEditForm(req, dao, new SessionSelection(req, project));
         }
         return ResponseType.HTML;
     }
     @RequestMapping(requestPath = "view", method = HttpMethod.GET)
     public ResponseType view(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws SQLException, IOException {
         final var sessionSelection = new SessionSelection(req, dao);
         if (sessionSelection.project == null) {
             resp.sendError(HttpServletResponse.SC_NOT_FOUND, "No project selected.");
             return ResponseType.NONE;
         }
         final var versionDao = dao.getVersionDao();
         final var versions = versionDao.list(sessionSelection.project);
         final var statsAffected = new ArrayList<VersionStatistics>();
         final var statsScheduled = new ArrayList<VersionStatistics>();
         final var statsResolved = new ArrayList<VersionStatistics>();
         for (Version version : versions) {
             statsAffected.add(versionDao.statsOpenedIssues(version));
             statsScheduled.add(versionDao.statsScheduledIssues(version));
             statsResolved.add(versionDao.statsResolvedIssues(version));
         }
         setAttributeHideZeros(req);
         req.setAttribute("project", sessionSelection.project);
         req.setAttribute("versions", versions);
         req.setAttribute("statsAffected", statsAffected);
         req.setAttribute("statsScheduled", statsScheduled);
         req.setAttribute("statsResolved", statsResolved);
         req.setAttribute("issueStatusEnum", IssueStatus.values());
         req.setAttribute("issueCategoryEnum", IssueCategory.values());
         setBreadcrumbs(req, getBreadcrumbs(BREADCRUMB_LEVEL_PROJECT, sessionSelection));
         setContentPage(req, "project-details");
         setStylesheet(req, "projects");
         return ResponseType.HTML;
     }
     private void configureEditVersionForm(HttpServletRequest req, DataAccessObjects dao, SessionSelection selection) throws SQLException {
         final var versionDao = dao.getVersionDao();
         req.setAttribute("projects", dao.getProjectDao().list());
         req.setAttribute("version", selection.version);
         req.setAttribute("versionStatusEnum", VersionStatus.values());
         req.setAttribute("issueStatusEnum", IssueStatus.values());
         req.setAttribute("issueCategoryEnum", IssueCategory.values());
         req.setAttribute("statsAffected", versionDao.statsOpenedIssues(selection.version));
         req.setAttribute("statsScheduled", versionDao.statsScheduledIssues(selection.version));
         req.setAttribute("statsResolved", versionDao.statsResolvedIssues(selection.version));
         setAttributeHideZeros(req);
         setContentPage(req, "version-form");
         setBreadcrumbs(req, getBreadcrumbs(BREADCRUMB_LEVEL_VERSION, selection));
     }
     @RequestMapping(requestPath = "versions/edit", method = HttpMethod.GET)
     public ResponseType editVersion(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws SQLException {
         final var sessionSelection = new SessionSelection(req, dao);
         sessionSelection.selectVersion(findByParameter(req, Integer.class, "id", dao.getVersionDao()::find)
                 .orElse(new Version(-1, sessionSelection.project)));
         configureEditVersionForm(req, dao, sessionSelection);
         return ResponseType.HTML;
     }
     @RequestMapping(requestPath = "versions/commit", method = HttpMethod.POST)
     public ResponseType commitVersion(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws SQLException {
         final var sessionSelection = new SessionSelection(req, dao);
         var version = new Version(-1, sessionSelection.project);
         try {
             version = new Version(getParameter(req, Integer.class, "id").orElseThrow(), sessionSelection.project);
             version.setName(getParameter(req, String.class, "name").orElseThrow());
             getParameter(req, Integer.class, "ordinal").ifPresent(version::setOrdinal);
             version.setStatus(VersionStatus.valueOf(getParameter(req, String.class, "status").orElseThrow()));
             dao.getVersionDao().saveOrUpdate(version);
             // specifying the pid parameter will purposely reset the session selected version!
             setRedirectLocation(req, "./projects/view?pid="+sessionSelection.project.getId());
             setContentPage(req, Constants.JSP_COMMIT_SUCCESSFUL);
             LOG.debug("Successfully updated version {} for project {}", version.getName(), sessionSelection.project.getName());
         } catch (NoSuchElementException | IllegalArgumentException | SQLException ex) {
             // TODO: set request attribute with error text
             LOG.warn("Form validation failure: {}", ex.getMessage());
             LOG.debug("Details:", ex);
             sessionSelection.selectVersion(version);
             configureEditVersionForm(req, dao, sessionSelection);
         }
         return ResponseType.HTML;
     }
     private void configureEditIssueForm(HttpServletRequest req, DataAccessObjects dao, SessionSelection selection) throws SQLException {
         if (selection.issue.getProject() == null || selection.issue.getProject().getId() < 0) {
             req.setAttribute("projects", dao.getProjectDao().list());
             req.setAttribute("versions", Collections.<Version>emptyList());
         } else {
             req.setAttribute("projects", Collections.<Project>emptyList());
             req.setAttribute("versions", dao.getVersionDao().list(selection.issue.getProject()));
         }
         dao.getIssueDao().joinVersionInformation(selection.issue);
         req.setAttribute("issue", selection.issue);
         req.setAttribute("issueStatusEnum", IssueStatus.values());
         req.setAttribute("issueCategoryEnum", IssueCategory.values());
         req.setAttribute("users", dao.getUserDao().list());
         setContentPage(req, "issue-form");
         setBreadcrumbs(req, getBreadcrumbs(BREADCRUMB_LEVEL_ISSUE, selection));
     }
     @RequestMapping(requestPath = "issues/", method = HttpMethod.GET)
     public ResponseType issues(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws SQLException, IOException {
         final var sessionSelection = new SessionSelection(req, dao);
         if (sessionSelection.project == null) {
             resp.sendError(HttpServletResponse.SC_NOT_FOUND, "No project selected.");
             return ResponseType.NONE;
         }
         req.setAttribute("issues", dao.getIssueDao().list(sessionSelection.project));
         setBreadcrumbs(req, getBreadcrumbs(BREADCRUMB_LEVEL_ISSUE_LIST, sessionSelection));
         setContentPage(req, "issues");
         setStylesheet(req, "projects");
         return ResponseType.HTML;
     }
     @RequestMapping(requestPath = "issues/edit", method = HttpMethod.GET)
     public ResponseType editIssue(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws SQLException {
         final var sessionSelection = new SessionSelection(req, dao);
         sessionSelection.selectIssue(findByParameter(req, Integer.class, "id",
                 dao.getIssueDao()::find).orElse(new Issue(-1, sessionSelection.project)));
         configureEditIssueForm(req, dao, sessionSelection);
         return ResponseType.HTML;
     }
     @RequestMapping(requestPath = "issues/commit", method = HttpMethod.POST)
     public ResponseType commitIssue(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws SQLException {
         final var sessionSelection = new SessionSelection(req, dao);
         Issue issue = new Issue(-1, sessionSelection.project);
         try {
             issue = new Issue(getParameter(req, Integer.class, "id").orElseThrow(), sessionSelection.project);
             getParameter(req, String.class, "category").map(IssueCategory::valueOf).ifPresent(issue::setCategory);
             getParameter(req, String.class, "status").map(IssueStatus::valueOf).ifPresent(issue::setStatus);
             issue.setSubject(getParameter(req, String.class, "subject").orElseThrow());
             getParameter(req, Integer.class, "assignee").map(
                     userid -> userid >= 0 ? new User(userid) : null
             ).ifPresent(issue::setAssignee);
             getParameter(req, String.class, "description").ifPresent(issue::setDescription);
             getParameter(req, Date.class, "eta").ifPresent(issue::setEta);
             getParameter(req, Integer[].class, "affected")
                     .map(Stream::of)
                     .map(stream ->
                         stream.map(id -> new Version(id, sessionSelection.project)).collect(Collectors.toList())
                     ).ifPresent(issue::setAffectedVersions);
             getParameter(req, Integer[].class, "scheduled")
                     .map(Stream::of)
                     .map(stream ->
                             stream.map(id -> new Version(id, sessionSelection.project)).collect(Collectors.toList())
                     ).ifPresent(issue::setScheduledVersions);
             getParameter(req, Integer[].class, "resolved")
                     .map(Stream::of)
                     .map(stream ->
                             stream.map(id -> new Version(id, sessionSelection.project)).collect(Collectors.toList())
                     ).ifPresent(issue::setResolvedVersions);
             dao.getIssueDao().saveOrUpdate(issue);
             // specifying the issue parameter keeps the edited issue as breadcrumb
             setRedirectLocation(req, "./projects/issues/?issue="+issue.getId());
             setContentPage(req, Constants.JSP_COMMIT_SUCCESSFUL);
             LOG.debug("Successfully updated issue {} for project {}", issue.getId(), sessionSelection.project.getName());
         } catch (NoSuchElementException | IllegalArgumentException | SQLException ex) {
             // TODO: set request attribute with error text
             LOG.warn("Form validation failure: {}", ex.getMessage());
             LOG.debug("Details:", ex);
             sessionSelection.selectIssue(issue);
             configureEditIssueForm(req, dao, sessionSelection);
         }
         return ResponseType.HTML;
     }
 }

Mercurial > hg > LightPIT / annotate

src/main/java/de/uapcore/lightpit/modules/ProjectsModule.java@24a3596b8f98 (annotated)

src/main/java/de/uapcore/lightpit/modules/ProjectsModule.java