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

/*
 * 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 java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Optional;

import static de.uapcore.lightpit.Functions.fqn;

@LightPITModule(
        bundleBaseName = "localization.projects",
        modulePath = "projects",
        defaultPriority = 20
)
@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");

    private Project getSelectedProject(HttpServletRequest req, DataAccessObjects dao) throws SQLException {
        final var projectDao = dao.getProjectDao();
        final var session = req.getSession();
        final var projectSelection = getParameter(req, Integer.class, "pid");
        final Project selectedProject;
        if (projectSelection.isPresent()) {
            selectedProject = projectDao.find(projectSelection.get());
        } else {
            final var sessionProject = (Project) session.getAttribute(SESSION_ATTR_SELECTED_PROJECT);
            selectedProject = sessionProject == null ? null : projectDao.find(sessionProject.getId());
        }
        session.setAttribute(SESSION_ATTR_SELECTED_PROJECT, selectedProject);
        return selectedProject;
    }


    /**
     * Creates the breadcrumb menu.
     *
     * @param level           the current active level
     * @param selectedProject the selected project, if any, or null
     * @return a dynamic breadcrumb menu trying to display as many levels as possible
     */
    private List<MenuEntry> getBreadcrumbs(int level,
                                           Project selectedProject) {
        MenuEntry entry;

        final var breadcrumbs = new ArrayList<MenuEntry>();
        entry = new MenuEntry(new ResourceKey("localization.projects", "menuLabel"),
                "projects/", 0);
        breadcrumbs.add(entry);
        if (level == 0) entry.setActive(true);

        if (selectedProject == null)
            return breadcrumbs;

        entry = new MenuEntry(selectedProject.getName(),
                "projects/view?pid=" + selectedProject.getId(), 1);
        if (level == 1) entry.setActive(true);

        breadcrumbs.add(entry);
        return breadcrumbs;
    }

    @RequestMapping(method = HttpMethod.GET)
    public ResponseType index(HttpServletRequest req, DataAccessObjects dao) throws SQLException {

        final var projectList = dao.getProjectDao().list();
        req.setAttribute("projects", projectList);
        setContentPage(req, "projects");
        setStylesheet(req, "projects");

        final var selectedProject = getSelectedProject(req, dao);
        setBreadcrumbs(req, getBreadcrumbs(0, selectedProject));

        return ResponseType.HTML;
    }

    private void configureEditForm(HttpServletRequest req, DataAccessObjects dao, Optional<Project> project) throws SQLException {
        if (project.isPresent()) {
            req.setAttribute("project", project.get());
            setBreadcrumbs(req, getBreadcrumbs(1, project.get()));
        } else {
            req.setAttribute("project", new Project(-1));
            setBreadcrumbs(req, getBreadcrumbs(0, null));
        }

        req.setAttribute("users", dao.getUserDao().list());
        setContentPage(req, "project-form");
    }

    @RequestMapping(requestPath = "edit", method = HttpMethod.GET)
    public ResponseType edit(HttpServletRequest req, DataAccessObjects dao) throws SQLException {

        Optional<Project> project = findByParameter(req, Integer.class, "id", dao.getProjectDao()::find);
        configureEditForm(req, dao, project);
        if (project.isPresent()) {
            req.getSession().setAttribute(SESSION_ATTR_SELECTED_PROJECT, project.get());
        }

        return ResponseType.HTML;
    }

    @RequestMapping(requestPath = "commit", method = HttpMethod.POST)
    public ResponseType commit(HttpServletRequest req, DataAccessObjects dao) throws SQLException {

        Project project = null;
        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 | NumberFormatException | SQLException ex) {
            // TODO: set request attribute with error text
            LOG.warn("Form validation failure: {}", ex.getMessage());
            LOG.debug("Details:", ex);
            configureEditForm(req, dao, Optional.ofNullable(project));
        }

        return ResponseType.HTML;
    }

    @RequestMapping(requestPath = "view", method = HttpMethod.GET)
    public ResponseType view(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws IOException, SQLException {
        final var selectedProject = getSelectedProject(req, dao);
        if (selectedProject == null) {
            resp.sendError(HttpServletResponse.SC_FORBIDDEN);
            return ResponseType.NONE;
        }

        req.setAttribute("versions", dao.getVersionDao().list(selectedProject));
        req.setAttribute("issues", dao.getIssueDao().list(selectedProject));

        // TODO: add more levels depending on last visited location
        setBreadcrumbs(req, getBreadcrumbs(1, selectedProject));

        setContentPage(req, "project-details");

        return ResponseType.HTML;
    }

    private void configureEditVersionForm(HttpServletRequest req, Optional<Version> version, Project selectedProject) {
        req.setAttribute("version", version.orElse(new Version(-1, selectedProject)));
        req.setAttribute("versionStatusEnum", VersionStatus.values());

        setContentPage(req, "version-form");
    }

    @RequestMapping(requestPath = "versions/edit", method = HttpMethod.GET)
    public ResponseType editVersion(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws IOException, SQLException {
        final var selectedProject = getSelectedProject(req, dao);
        if (selectedProject == null) {
            resp.sendError(HttpServletResponse.SC_FORBIDDEN);
            return ResponseType.NONE;
        }

        configureEditVersionForm(req,
                findByParameter(req, Integer.class, "id", dao.getVersionDao()::find),
                selectedProject);

        return ResponseType.HTML;
    }

    @RequestMapping(requestPath = "versions/commit", method = HttpMethod.POST)
    public ResponseType commitVersion(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws IOException, SQLException {
        final var selectedProject = getSelectedProject(req, dao);
        if (selectedProject == null) {
            resp.sendError(HttpServletResponse.SC_FORBIDDEN);
            return ResponseType.NONE;
        }

        Version version = null;
        try {
            version = new Version(getParameter(req, Integer.class, "id").orElseThrow(), selectedProject);
            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);

            setRedirectLocation(req, "./projects/versions/");
            setContentPage(req, Constants.JSP_COMMIT_SUCCESSFUL);
            LOG.debug("Successfully updated version {} for project {}", version.getName(), selectedProject.getName());
        } catch (NoSuchElementException | NumberFormatException | SQLException ex) {
            // TODO: set request attribute with error text
            LOG.warn("Form validation failure: {}", ex.getMessage());
            LOG.debug("Details:", ex);
            configureEditVersionForm(req, Optional.ofNullable(version), selectedProject);
        }

        return ResponseType.HTML;
    }

    private void configureEditIssueForm(HttpServletRequest req, DataAccessObjects dao, Optional<Issue> issue, Project selectedProject) throws SQLException {

        req.setAttribute("issue", issue.orElse(new Issue(-1, selectedProject)));
        req.setAttribute("issueStatusEnum", IssueStatus.values());
        req.setAttribute("issueCategoryEnum", IssueCategory.values());
        req.setAttribute("versions", dao.getVersionDao().list(selectedProject));

        setContentPage(req, "issue-form");
    }

    @RequestMapping(requestPath = "issues/edit", method = HttpMethod.GET)
    public ResponseType editIssue(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws IOException, SQLException {
        final var selectedProject = getSelectedProject(req, dao);
        if (selectedProject == null) {
            resp.sendError(HttpServletResponse.SC_FORBIDDEN);
            return ResponseType.NONE;
        }

        configureEditIssueForm(req, dao,
                findByParameter(req, Integer.class, "id", dao.getIssueDao()::find),
                selectedProject);

        return ResponseType.HTML;
    }

    @RequestMapping(requestPath = "issues/commit", method = HttpMethod.POST)
    public ResponseType commitIssue(HttpServletRequest req, HttpServletResponse resp, DataAccessObjects dao) throws IOException, SQLException {
        final var selectedProject = getSelectedProject(req, dao);
        if (selectedProject == null) {
            resp.sendError(HttpServletResponse.SC_FORBIDDEN);
            return ResponseType.NONE;
        }

        Issue issue = null;
        try {
            issue = new Issue(getParameter(req, Integer.class, "id").orElseThrow(), selectedProject);

            // TODO: implement

            dao.getIssueDao().saveOrUpdate(issue);

            setRedirectLocation(req, "./projects/issues/");
            setContentPage(req, Constants.JSP_COMMIT_SUCCESSFUL);
            LOG.debug("Successfully updated issue {} for project {}", issue.getId(), selectedProject.getName());
        } catch (NoSuchElementException | NumberFormatException | SQLException ex) {
            // TODO: set request attribute with error text
            LOG.warn("Form validation failure: {}", ex.getMessage());
            LOG.debug("Details:", ex);
            configureEditIssueForm(req, dao, Optional.ofNullable(issue), selectedProject);
        }

        return ResponseType.HTML;
    }
}