com.gitblit.wicket.pages.EditTicketPage.java Source code

Java tutorial

Introduction

Here is the source code for com.gitblit.wicket.pages.EditTicketPage.java

Source

/*
 * Copyright 2014 gitblit.com.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.gitblit.wicket.pages;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.markup.html.form.AjaxButton;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.Button;
import org.apache.wicket.markup.html.form.DropDownChoice;
import org.apache.wicket.markup.html.form.Form;
import org.apache.wicket.markup.html.form.TextField;
import org.apache.wicket.markup.html.panel.Fragment;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.eclipse.jgit.lib.Repository;

import com.gitblit.Constants;
import com.gitblit.Constants.AccessPermission;
import com.gitblit.Constants.AuthorizationControl;
import com.gitblit.models.RegistrantAccessPermission;
import com.gitblit.models.TicketModel;
import com.gitblit.models.TicketModel.Change;
import com.gitblit.models.TicketModel.Field;
import com.gitblit.models.TicketModel.Status;
import com.gitblit.models.TicketModel.Type;
import com.gitblit.models.UserModel;
import com.gitblit.tickets.TicketMilestone;
import com.gitblit.tickets.TicketNotifier;
import com.gitblit.tickets.TicketResponsible;
import com.gitblit.utils.StringUtils;
import com.gitblit.wicket.GitBlitWebSession;
import com.gitblit.wicket.WicketUtils;
import com.gitblit.wicket.panels.MarkdownTextArea;
import com.google.common.base.Optional;

/**
 * Page for editing a ticket.
 *
 * @author James Moger
 *
 */
public class EditTicketPage extends RepositoryPage {

    private static final long serialVersionUID = 1L;

    static final String NIL = "<nil>";

    static final String ESC_NIL = StringUtils.escapeForHtml(NIL, false);

    private IModel<TicketModel.Type> typeModel;

    private IModel<String> titleModel;

    private MarkdownTextArea descriptionEditor;

    private IModel<String> topicModel;

    private IModel<String> mergeToModel;

    private IModel<Status> statusModel;

    private IModel<TicketResponsible> responsibleModel;

    private IModel<TicketMilestone> milestoneModel;

    private Label descriptionPreview;

    private IModel<TicketModel.Priority> priorityModel;

    private IModel<TicketModel.Severity> severityModel;

    public EditTicketPage(PageParameters params) {
        super(params);

        UserModel currentUser = GitBlitWebSession.get().getUser();
        if (currentUser == null) {
            currentUser = UserModel.ANONYMOUS;
        }

        long ticketId = 0L;
        try {
            String h = WicketUtils.getObject(params);
            ticketId = Long.parseLong(h);
        } catch (Exception e) {
            setResponsePage(TicketsPage.class, WicketUtils.newRepositoryParameter(repositoryName));
        }

        TicketModel ticket = app().tickets().getTicket(getRepositoryModel(), ticketId);
        if (ticket == null || !currentUser.canEdit(ticket, getRepositoryModel())
                || !app().tickets().isAcceptingTicketUpdates(getRepositoryModel())) {
            setResponsePage(TicketsPage.class, WicketUtils.newObjectParameter(repositoryName, "" + ticketId));

            // create a placeholder object so we don't trigger NPEs
            ticket = new TicketModel();
        }

        typeModel = Model.of(ticket.type);
        titleModel = Model.of(ticket.title);
        topicModel = Model.of(ticket.topic == null ? "" : ticket.topic);
        responsibleModel = Model.of();
        milestoneModel = Model.of();
        mergeToModel = Model.of(ticket.mergeTo == null ? getRepositoryModel().mergeTo : ticket.mergeTo);
        statusModel = Model.of(ticket.status);
        priorityModel = Model.of(ticket.priority);
        severityModel = Model.of(ticket.severity);

        setStatelessHint(false);
        setOutputMarkupId(true);

        Form<Void> form = new Form<Void>("editForm");
        add(form);

        List<Type> typeChoices;
        if (ticket.isProposal()) {
            typeChoices = Arrays.asList(Type.Proposal);
        } else {
            typeChoices = Arrays.asList(TicketModel.Type.choices());
        }
        form.add(new DropDownChoice<TicketModel.Type>("type", typeModel, typeChoices));

        form.add(new TextField<String>("title", titleModel));
        form.add(new TextField<String>("topic", topicModel));

        final IModel<String> markdownPreviewModel = Model.of(ticket.body == null ? "" : ticket.body);
        descriptionPreview = new Label("descriptionPreview", markdownPreviewModel);
        descriptionPreview.setEscapeModelStrings(false);
        descriptionPreview.setOutputMarkupId(true);
        form.add(descriptionPreview);

        descriptionEditor = new MarkdownTextArea("description", markdownPreviewModel, descriptionPreview);
        descriptionEditor.setRepository(repositoryName);
        descriptionEditor.setText(ticket.body);
        form.add(descriptionEditor);

        // status
        List<Status> statusChoices;
        if (ticket.isClosed()) {
            statusChoices = Arrays.asList(ticket.status, Status.Open);
        } else if (ticket.isProposal()) {
            statusChoices = Arrays.asList(TicketModel.Status.proposalWorkflow);
        } else if (ticket.isBug()) {
            statusChoices = Arrays.asList(TicketModel.Status.bugWorkflow);
        } else {
            statusChoices = Arrays.asList(TicketModel.Status.requestWorkflow);
        }
        Fragment status = new Fragment("status", "statusFragment", EditTicketPage.this);
        status.add(new DropDownChoice<TicketModel.Status>("status", statusModel, statusChoices));
        form.add(status);

        List<TicketModel.Severity> severityChoices = Arrays.asList(TicketModel.Severity.choices());
        form.add(new DropDownChoice<TicketModel.Severity>("severity", severityModel, severityChoices));

        if (currentUser.canAdmin(ticket, getRepositoryModel())) {
            // responsible
            Set<String> userlist = new TreeSet<String>(ticket.getParticipants());

            if (UserModel.ANONYMOUS.canPush(getRepositoryModel())
                    || AuthorizationControl.AUTHENTICATED == getRepositoryModel().authorizationControl) {
                //    authorization is ANONYMOUS or AUTHENTICATED (i.e. all users can be set responsible)
                userlist.addAll(app().users().getAllUsernames());
            } else {
                // authorization is by NAMED users (users with PUSH permission can be set responsible)
                for (RegistrantAccessPermission rp : app().repositories()
                        .getUserAccessPermissions(getRepositoryModel())) {
                    if (rp.permission.atLeast(AccessPermission.PUSH)) {
                        userlist.add(rp.registrant);
                    }
                }
            }

            List<TicketResponsible> responsibles = new ArrayList<TicketResponsible>();
            for (String username : userlist) {
                UserModel user = app().users().getUserModel(username);
                if (user != null && !user.disabled) {
                    TicketResponsible responsible = new TicketResponsible(user);
                    responsibles.add(responsible);
                    if (user.username.equals(ticket.responsible)) {
                        responsibleModel.setObject(responsible);
                    }
                }
            }
            Collections.sort(responsibles);
            responsibles.add(new TicketResponsible(NIL, "", ""));
            Fragment responsible = new Fragment("responsible", "responsibleFragment", EditTicketPage.this);
            responsible.add(new DropDownChoice<TicketResponsible>("responsible", responsibleModel, responsibles));
            form.add(responsible.setVisible(!responsibles.isEmpty()));

            // milestone
            List<TicketMilestone> milestones = app().tickets().getMilestones(getRepositoryModel(), Status.Open);
            for (TicketMilestone milestone : milestones) {
                if (milestone.name.equals(ticket.milestone)) {
                    milestoneModel.setObject(milestone);
                    break;
                }
            }
            if (milestoneModel.getObject() == null && !StringUtils.isEmpty(ticket.milestone)) {
                // ensure that this unrecognized milestone is listed
                // so that we get the <nil> selection.
                TicketMilestone tms = new TicketMilestone(ticket.milestone);
                milestones.add(tms);
                milestoneModel.setObject(tms);
            }
            if (!milestones.isEmpty()) {
                milestones.add(new TicketMilestone(NIL));
            }

            // milestone
            Fragment milestone = new Fragment("milestone", "milestoneFragment", EditTicketPage.this);
            milestone.add(new DropDownChoice<TicketMilestone>("milestone", milestoneModel, milestones));
            form.add(milestone.setVisible(!milestones.isEmpty()));

            // priority
            Fragment priority = new Fragment("priority", "priorityFragment", EditTicketPage.this);
            List<TicketModel.Priority> priorityChoices = Arrays.asList(TicketModel.Priority.choices());
            priority.add(new DropDownChoice<TicketModel.Priority>("priority", priorityModel, priorityChoices));
            form.add(priority);

            // mergeTo (integration branch)
            List<String> branches = new ArrayList<String>();
            for (String branch : getRepositoryModel().getLocalBranches()) {
                // exclude ticket branches
                if (!branch.startsWith(Constants.R_TICKET)) {
                    branches.add(Repository.shortenRefName(branch));
                }
            }
            branches.remove(Repository.shortenRefName(getRepositoryModel().mergeTo));
            branches.add(0, Repository.shortenRefName(getRepositoryModel().mergeTo));

            Fragment mergeto = new Fragment("mergeto", "mergeToFragment", EditTicketPage.this);
            mergeto.add(new DropDownChoice<String>("mergeto", mergeToModel, branches));
            form.add(mergeto.setVisible(!branches.isEmpty()));
        } else {
            // user can not admin this ticket
            form.add(new Label("responsible").setVisible(false));
            form.add(new Label("milestone").setVisible(false));
            form.add(new Label("mergeto").setVisible(false));
            form.add(new Label("priority").setVisible(false));
        }

        form.add(new AjaxButton("update") {

            private static final long serialVersionUID = 1L;

            @Override
            protected void onSubmit(AjaxRequestTarget target) {
                long ticketId = 0L;
                try {
                    String h = WicketUtils.getObject(getPageParameters());
                    ticketId = Long.parseLong(h);
                } catch (Exception e) {
                    setResponsePage(TicketsPage.class, WicketUtils.newRepositoryParameter(repositoryName));
                }

                TicketModel ticket = app().tickets().getTicket(getRepositoryModel(), ticketId);

                String createdBy = GitBlitWebSession.get().getUsername();
                Change change = new Change(createdBy);

                String title = titleModel.getObject();
                if (StringUtils.isEmpty(title)) {
                    return;
                }

                if (!ticket.title.equals(title)) {
                    // title change
                    change.setField(Field.title, title);
                }

                String description = Optional.fromNullable(descriptionEditor.getText()).or("");
                if ((StringUtils.isEmpty(ticket.body) && !StringUtils.isEmpty(description))
                        || (!StringUtils.isEmpty(ticket.body) && !ticket.body.equals(description))) {
                    // description change
                    change.setField(Field.body, description);
                }

                Status status = statusModel.getObject();
                if (!ticket.status.equals(status)) {
                    // status change
                    change.setField(Field.status, status);
                }

                Type type = typeModel.getObject();
                if (!ticket.type.equals(type)) {
                    // type change
                    change.setField(Field.type, type);
                }

                String topic = Optional.fromNullable(topicModel.getObject()).or("");
                if ((StringUtils.isEmpty(ticket.topic) && !StringUtils.isEmpty(topic))
                        || (!StringUtils.isEmpty(ticket.topic) && !ticket.topic.equals(topic))) {
                    // topic change
                    change.setField(Field.topic, topic);
                }

                TicketResponsible responsible = responsibleModel == null ? null : responsibleModel.getObject();
                if (responsible != null && !responsible.username.equals(ticket.responsible)) {
                    // responsible change
                    change.setField(Field.responsible, responsible.username);
                    if (!StringUtils.isEmpty(responsible.username)) {
                        if (!ticket.isWatching(responsible.username)) {
                            change.watch(responsible.username);
                        }
                    }
                }

                TicketMilestone milestone = milestoneModel == null ? null : milestoneModel.getObject();
                if (milestone != null && !milestone.name.equals(ticket.milestone)) {
                    // milestone change
                    if (NIL.equals(milestone.name)) {
                        change.setField(Field.milestone, "");
                    } else {
                        change.setField(Field.milestone, milestone.name);
                    }
                }

                TicketModel.Priority priority = priorityModel.getObject();
                if (!ticket.priority.equals(priority)) {
                    change.setField(Field.priority, priority);
                }

                TicketModel.Severity severity = severityModel.getObject();
                if (!ticket.severity.equals(severity)) {
                    change.setField(Field.severity, severity);
                }

                String mergeTo = mergeToModel.getObject();
                if ((StringUtils.isEmpty(ticket.mergeTo) && !StringUtils.isEmpty(mergeTo))
                        || (!StringUtils.isEmpty(mergeTo) && !mergeTo.equals(ticket.mergeTo))) {
                    // integration branch change
                    change.setField(Field.mergeTo, mergeTo);
                }

                if (change.hasFieldChanges()) {
                    if (!ticket.isWatching(createdBy)) {
                        change.watch(createdBy);
                    }
                    ticket = app().tickets().updateTicket(getRepositoryModel(), ticket.number, change);
                    if (ticket != null) {
                        TicketNotifier notifier = app().tickets().createNotifier();
                        notifier.sendMailing(ticket);
                        redirectTo(TicketsPage.class,
                                WicketUtils.newObjectParameter(getRepositoryModel().name, "" + ticket.number));
                    } else {
                        // TODO error
                    }
                } else {
                    // nothing to change?!
                    redirectTo(TicketsPage.class,
                            WicketUtils.newObjectParameter(getRepositoryModel().name, "" + ticket.number));
                }
            }
        });

        Button cancel = new Button("cancel") {
            private static final long serialVersionUID = 1L;

            @Override
            public void onSubmit() {
                setResponsePage(TicketsPage.class, getPageParameters());
            }
        };
        cancel.setDefaultFormProcessing(false);
        form.add(cancel);
    }

    @Override
    protected String getPageName() {
        return getString("gb.editTicket");
    }

    @Override
    protected Class<? extends BasePage> getRepoNavPageClass() {
        return TicketsPage.class;
    }
}