Refactored common code out of My Tickets and Tickets

James Moger

2014-05-01 fdd82f02dddd2d4211e9df4239f3be6c8595b2dd

 src/main/java/com/gitblit/wicket/pages/MyTicketsPage.java

@@ -1,72 +1,74 @@
/*
 * 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.io.Serializable;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.apache.wicket.PageParameters;
import org.apache.wicket.behavior.SimpleAttributeModifier;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.TextField;
import org.apache.wicket.markup.html.link.BookmarkablePageLink;
import org.apache.wicket.markup.html.panel.Fragment;
import org.apache.wicket.markup.repeater.Item;
import org.apache.wicket.markup.repeater.data.DataView;
import org.apache.wicket.markup.repeater.data.ListDataProvider;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.request.target.basic.RedirectRequestTarget;
import org.eclipse.jgit.lib.Repository;

import com.gitblit.Constants;
import com.gitblit.Keys;
import com.gitblit.models.RepositoryModel;
import com.gitblit.models.TicketModel;
import com.gitblit.models.TicketModel.Status;
import com.gitblit.models.TicketModel.Type;
import com.gitblit.models.UserModel;
import com.gitblit.tickets.ITicketService;
import com.gitblit.tickets.QueryBuilder;
import com.gitblit.tickets.QueryResult;
import com.gitblit.tickets.TicketIndexer.Lucene;
import com.gitblit.tickets.TicketLabel;
import com.gitblit.utils.ArrayUtils;
import com.gitblit.utils.BugtraqProcessor;
import com.gitblit.utils.StringUtils;
import com.gitblit.wicket.GitBlitWebApp;
import com.gitblit.wicket.GitBlitWebSession;
import com.gitblit.wicket.SessionlessForm;
import com.gitblit.wicket.TicketsUI;
import com.gitblit.wicket.TicketsUI.TicketSort;
import com.gitblit.wicket.WicketUtils;
import com.gitblit.wicket.panels.GravatarImage;
import com.gitblit.wicket.panels.LinkPanel;
import com.gitblit.wicket.panels.TicketListPanel;
import com.gitblit.wicket.panels.TicketSearchForm;
import com.gitblit.wicket.panels.UserTitlePanel;

/**
 * My Tickets page
 *
 * @author Christian Buisson
 * @author James Moger
 */
public class MyTicketsPage extends RootPage {

   public static final String [] openStatii = new String [] { Status.New.name().toLowerCase(), Status.Open.name().toLowerCase() };

   public static final String [] closedStatii = new String [] { "!" + Status.New.name().toLowerCase(), "!" + Status.Open.name().toLowerCase() };

   public MyTicketsPage()
   {
   public MyTicketsPage() {
      this(null);
   }

   public MyTicketsPage(PageParameters params)
   {
   public MyTicketsPage(PageParameters params)   {
      super(params);
      setupPage("", getString("gb.myTickets"));

      UserModel currentUser = GitBlitWebSession.get().getUser();
      if (currentUser == null) {
      if (currentUser == null || UserModel.ANONYMOUS.equals(currentUser)) {
         setRedirect(true);
         setResponsePage(getApplication().getHomePage());
         return;
      }

      final String username = currentUser.getName();
      final String[] statiiParam = (params == null) ? openStatii : params.getStringArray(Lucene.status.name());
      final String[] statiiParam = (params == null) ? TicketsUI.openStatii : params.getStringArray(Lucene.status.name());
      final String assignedToParam = (params == null) ? "" : params.getString(Lucene.responsible.name(), null);
      final String milestoneParam = (params == null) ? "" : params.getString(Lucene.milestone.name(), null);
      final String queryParam = (params == null || StringUtils.isEmpty(params.getString("q", null))) ? "watchedby:" + username : params.getString("q", null);
@@ -74,13 +76,11 @@
      final String sortBy = (params == null) ? "" : Lucene.fromString(params.getString("sort", Lucene.created.name())).name();
      final boolean desc = (params == null) ? true : !"asc".equals(params.getString("direction", "desc"));

      add(new GravatarImage("userGravatar", currentUser, "gravatar", 36, false));
      add(new Label("userDisplayName", currentUser.getDisplayName()));
      // add the user title panel
      add(new UserTitlePanel("userTitlePanel", currentUser, getString("gb.myTickets")));

      // add search form
      TicketSearchForm searchForm = new TicketSearchForm("ticketSearchForm", searchParam);
      add(searchForm);
      searchForm.setTranslatedAttributes();
      add(new TicketSearchForm("ticketSearchForm", null, searchParam, getClass(), params));

      // standard queries
      add(new BookmarkablePageLink<Void>("changesQuery", MyTicketsPage.class,
@@ -137,7 +137,7 @@
            queryParameters(
                  null,
                  milestoneParam,
                  openStatii,
                  TicketsUI.openStatii,
                  null,
                  null,
                  true,
@@ -188,8 +188,8 @@
      } else {
         add(new Label("selectedStatii", StringUtils.flattenStrings(Arrays.asList(statiiParam), ",")));
      }
      add(new BookmarkablePageLink<Void>("openTickets", MyTicketsPage.class, queryParameters(queryParam, milestoneParam, openStatii, assignedToParam, sortBy, desc, 1)));
      add(new BookmarkablePageLink<Void>("closedTickets", MyTicketsPage.class, queryParameters(queryParam, milestoneParam, closedStatii, assignedToParam, sortBy, desc, 1)));
      add(new BookmarkablePageLink<Void>("openTickets", MyTicketsPage.class, queryParameters(queryParam, milestoneParam, TicketsUI.openStatii, assignedToParam, sortBy, desc, 1)));
      add(new BookmarkablePageLink<Void>("closedTickets", MyTicketsPage.class, queryParameters(queryParam, milestoneParam, TicketsUI.closedStatii, assignedToParam, sortBy, desc, 1)));
      add(new BookmarkablePageLink<Void>("allTickets", MyTicketsPage.class, queryParameters(queryParam, milestoneParam, null, assignedToParam, sortBy, desc, 1)));

      // by status
@@ -203,7 +203,7 @@
         public void populateItem(final Item<Status> item) {
            final Status status = item.getModelObject();
            PageParameters p = queryParameters(queryParam, milestoneParam, new String [] { status.name().toLowerCase() }, assignedToParam, sortBy, desc, 1);
            String css = getStatusClass(status);
            String css = TicketsUI.getStatusClass(status);
            item.add(new LinkPanel("statusLink", css, status.toString(), MyTicketsPage.class, p).setRenderBodyOnly(true));
         }
      };
@@ -284,342 +284,18 @@
      int page = (params != null) ? Math.max(1, WicketUtils.getPage(params)) : 1;
      int pageSize = app().settings().getInteger(Keys.tickets.perPage, 25);

      ITicketService tickets = GitBlitWebApp.get().tickets();
      List<QueryResult> results;
      if(StringUtils.isEmpty(searchParam))
      {
         results = tickets.queryFor(luceneQuery, page, pageSize, sortBy, desc);
      if(StringUtils.isEmpty(searchParam)) {
         results = app().tickets().queryFor(luceneQuery, page, pageSize, sortBy, desc);
      } else {
         results = app().tickets().searchFor(null, searchParam, page, pageSize);
      }
      else
      {
         results = tickets.searchFor(null, searchParam, page, pageSize);
      }

      int totalResults = results.size() == 0 ? 0 : results.get(0).totalResults;
      buildPager(queryParam, milestoneParam, statiiParam, assignedToParam, sortBy, desc, page, pageSize, results.size(), totalResults);

      final boolean showSwatch = app().settings().getBoolean(Keys.web.repositoryListSwatches, true);
      final ListDataProvider<QueryResult> dp = new ListDataProvider<QueryResult>(results);

      DataView<QueryResult> dataView = new DataView<QueryResult>("row", dp) {
         private static final long serialVersionUID = 1L;

         @Override
         protected void populateItem(Item<QueryResult> item) {
            final QueryResult ticket = item.getModelObject();
            final RepositoryModel repository = app().repositories().getRepositoryModel(ticket.repository);

            if (showSwatch) {
               // set repository color
               String color = StringUtils.getColor(StringUtils.stripDotGit(repository.name));
               WicketUtils.setCssStyle(item, MessageFormat.format("border-left: 2px solid {0};", color));
            }

            PageParameters rp = WicketUtils.newRepositoryParameter(ticket.repository);
            PageParameters tp = WicketUtils.newObjectParameter(ticket.repository, "" + ticket.number);
            item.add(new LinkPanel("repositoryLink", null, StringUtils.stripDotGit(ticket.repository), SummaryPage.class, rp));

            item.add(getStateIcon("state", ticket.type, ticket.status));
            item.add(new Label("id", "" + ticket.number));
            UserModel creator = app().users().getUserModel(ticket.createdBy);
            if (creator != null) {
               item.add(new LinkPanel("createdBy", null, creator.getDisplayName(),
                  UserPage.class, WicketUtils.newUsernameParameter(ticket.createdBy)));
            } else {
               item.add(new Label("createdBy", ticket.createdBy));
            }
            item.add(WicketUtils.createDateLabel("createDate", ticket.createdAt, GitBlitWebSession
                  .get().getTimezone(), getTimeUtils(), false));

            if (ticket.updatedAt == null) {
               item.add(new Label("updated").setVisible(false));
            } else {
               Fragment updated = new Fragment("updated", "updatedFragment", this);
               UserModel updater = app().users().getUserModel(ticket.updatedBy);
               if (updater != null) {
                  updated.add(new LinkPanel("updatedBy", null, updater.getDisplayName(),
                        UserPage.class, WicketUtils.newUsernameParameter(ticket.updatedBy)));
               } else {
                  updated.add(new Label("updatedBy", ticket.updatedBy));
               }
               updated.add(WicketUtils.createDateLabel("updateDate", ticket.updatedAt, GitBlitWebSession
                     .get().getTimezone(), getTimeUtils(), false));
               item.add(updated);
            }

            item.add(new LinkPanel("title", "list subject", StringUtils.trimString(
                  ticket.title, Constants.LEN_SHORTLOG), TicketsPage.class, tp));

            ListDataProvider<String> labelsProvider = new ListDataProvider<String>(ticket.getLabels());
            DataView<String> labelsView = new DataView<String>("labels", labelsProvider) {
               private static final long serialVersionUID = 1L;

               @Override
               public void populateItem(final Item<String> labelItem) {
                  BugtraqProcessor btp  = new BugtraqProcessor(app().settings());
                  Repository db = app().repositories().getRepository(repository.name);
                  String content = btp.processPlainCommitMessage(db, repository.name, labelItem.getModelObject());
                  db.close();
                  Label label = new Label("label", content);
                  label.setEscapeModelStrings(false);
                  TicketLabel tLabel = app().tickets().getLabel(repository, labelItem.getModelObject());
                  String background = MessageFormat.format("background-color:{0};", tLabel.color);
                  label.add(new SimpleAttributeModifier("style", background));
                  labelItem.add(label);
               }
            };
            item.add(labelsView);

            if (StringUtils.isEmpty(ticket.responsible)) {
               item.add(new Label("responsible").setVisible(false));
            } else {
               UserModel responsible = app().users().getUserModel(ticket.responsible);
               if (responsible == null) {
                  responsible = new UserModel(ticket.responsible);
               }
               GravatarImage avatar = new GravatarImage("responsible", responsible.getDisplayName(),
                     responsible.emailAddress, null, 16, true);
               avatar.setTooltip(getString("gb.responsible") + ": " + responsible.getDisplayName());
               item.add(avatar);
            }

            // votes indicator
            Label v = new Label("votes", "" + ticket.votesCount);
            WicketUtils.setHtmlTooltip(v, getString("gb.votes"));
            item.add(v.setVisible(ticket.votesCount > 0));

            // watching indicator
            item.add(new Label("watching").setVisible(ticket.isWatching(GitBlitWebSession.get().getUsername())));

            // status indicator
            String css = getLozengeClass(ticket.status, true);
            Label l = new Label("status", ticket.status.toString());
            WicketUtils.setCssClass(l, css);
            item.add(l);

            // add the ticket indicators/icons
            List<Indicator> indicators = new ArrayList<Indicator>();

            // comments
            if (ticket.commentsCount > 0) {
               int count = ticket.commentsCount;
               String pattern = "gb.nComments";
               if (count == 1) {
                  pattern = "gb.oneComment";
               }
               indicators.add(new Indicator("fa fa-comment", count, pattern));
            }

            // participants
            if (!ArrayUtils.isEmpty(ticket.participants)) {
               int count = ticket.participants.size();
               if (count > 1) {
                  String pattern = "gb.nParticipants";
                  indicators.add(new Indicator("fa fa-user", count, pattern));
               }
            }

            // attachments
            if (!ArrayUtils.isEmpty(ticket.attachments)) {
               int count = ticket.attachments.size();
               String pattern = "gb.nAttachments";
               if (count == 1) {
                  pattern = "gb.oneAttachment";
               }
               indicators.add(new Indicator("fa fa-file", count, pattern));
            }

            // patchset revisions
            if (ticket.patchset != null) {
               int count = ticket.patchset.commits;
               String pattern = "gb.nCommits";
               if (count == 1) {
                  pattern = "gb.oneCommit";
               }
               indicators.add(new Indicator("fa fa-code", count, pattern));
            }

            // milestone
            if (!StringUtils.isEmpty(ticket.milestone)) {
               indicators.add(new Indicator("fa fa-bullseye", ticket.milestone));
            }

            ListDataProvider<Indicator> indicatorsDp = new ListDataProvider<Indicator>(indicators);
            DataView<Indicator> indicatorsView = new DataView<Indicator>("indicators", indicatorsDp) {
               private static final long serialVersionUID = 1L;

               @Override
               public void populateItem(final Item<Indicator> item) {
                  Indicator indicator = item.getModelObject();
                  String tooltip = indicator.getTooltip();

                  Label icon = new Label("icon");
                  WicketUtils.setCssClass(icon, indicator.css);
                  item.add(icon);

                  if (indicator.count > 0) {
                     Label count = new Label("count", "" + indicator.count);
                     item.add(count.setVisible(!StringUtils.isEmpty(tooltip)));
                  } else {
                     item.add(new Label("count").setVisible(false));
                  }

                  WicketUtils.setHtmlTooltip(item, tooltip);
               }
            };
            item.add(indicatorsView);
         }
      };

      add(dataView);
   }

   protected Label getStateIcon(String wicketId, TicketModel ticket) {
      return getStateIcon(wicketId, ticket.type, ticket.status);
   }

   protected Label getStateIcon(String wicketId, Type type, Status state) {
      Label label = new Label(wicketId);
      if (type == null) {
         type = Type.defaultType;
      }
      switch (type) {
      case Proposal:
         WicketUtils.setCssClass(label, "fa fa-code-fork");
         break;
      case Bug:
         WicketUtils.setCssClass(label, "fa fa-bug");
         break;
      case Enhancement:
         WicketUtils.setCssClass(label, "fa fa-magic");
         break;
      case Question:
         WicketUtils.setCssClass(label, "fa fa-question");
         break;
      default:
         // standard ticket
         WicketUtils.setCssClass(label, "fa fa-ticket");
      }
      WicketUtils.setHtmlTooltip(label, getTypeState(type, state));
      return label;
   }

   protected String getTypeState(Type type, Status state) {
      return state.toString() + " " + type.toString();
   }

   protected String getLozengeClass(Status status, boolean subtle) {
      if (status == null) {
         status = Status.New;
      }
      String css = "";
      switch (status) {
      case Declined:
      case Duplicate:
      case Invalid:
      case Wontfix:
      case Abandoned:
         css = "aui-lozenge-error";
         break;
      case Fixed:
      case Merged:
      case Resolved:
         css = "aui-lozenge-success";
         break;
      case New:
         css = "aui-lozenge-complete";
         break;
      case On_Hold:
         css = "aui-lozenge-current";
         break;
      default:
         css = "";
         break;
      }

      return "aui-lozenge" + (subtle ? " aui-lozenge-subtle": "") + (css.isEmpty() ? "" : " ") + css;
   }

   protected String getStatusClass(Status status) {
      String css = "";
      switch (status) {
      case Declined:
      case Duplicate:
      case Invalid:
      case Wontfix:
      case Abandoned:
         css = "resolution-error";
         break;
      case Fixed:
      case Merged:
      case Resolved:
         css = "resolution-success";
         break;
      case New:
         css = "resolution-complete";
         break;
      case On_Hold:
         css = "resolution-current";
         break;
      default:
         css = "";
         break;
      }

      return "resolution" + (css.isEmpty() ? "" : " ") + css;
   }

   private class TicketSort implements Serializable {

      private static final long serialVersionUID = 1L;

      final String name;
      final String sortBy;
      final boolean desc;

      TicketSort(String name, String sortBy, boolean desc) {
         this.name = name;
         this.sortBy = sortBy;
         this.desc = desc;
      }
   }

   private class TicketSearchForm extends SessionlessForm<Void> implements Serializable {
      private static final long serialVersionUID = 1L;

      private final IModel<String> searchBoxModel;;

      public TicketSearchForm(String id, String text) {
         super(id, MyTicketsPage.this.getClass(), MyTicketsPage.this.getPageParameters());

         this.searchBoxModel = new Model<String>(text == null ? "" : text);

         TextField<String> searchBox = new TextField<String>("ticketSearchBox", searchBoxModel);
         add(searchBox);
      }

      void setTranslatedAttributes() {
         WicketUtils.setHtmlTooltip(get("ticketSearchBox"),
               MessageFormat.format(getString("gb.searchTicketsTooltip"), ""));
         WicketUtils.setInputPlaceholder(get("ticketSearchBox"), getString("gb.searchTickets"));
      }

      @Override
      public void onSubmit() {
         String searchString = searchBoxModel.getObject();
         if (StringUtils.isEmpty(searchString)) {
            // redirect to self to avoid wicket page update bug
            String absoluteUrl = getCanonicalUrl();
            getRequestCycle().setRequestTarget(new RedirectRequestTarget(absoluteUrl));
            return;
         }

         // use an absolute url to workaround Wicket-Tomcat problems with
         // mounted url parameters (issue-111)
         PageParameters params = WicketUtils.newRepositoryParameter("");
         params.add("s", searchString);
         String absoluteUrl = getCanonicalUrl(MyTicketsPage.class, params);
         getRequestCycle().setRequestTarget(new RedirectRequestTarget(absoluteUrl));
      }
      add(new TicketListPanel("ticketList", results, showSwatch, true));
   }

   protected PageParameters queryParameters(
@@ -712,30 +388,5 @@
         }
      };
      add(pagesView);
   }

   private class Indicator implements Serializable {

      private static final long serialVersionUID = 1L;

      final String css;
      final int count;
      final String tooltip;

      Indicator(String css, String tooltip) {
         this.css = css;
         this.tooltip = tooltip;
         this.count = 0;
      }

      Indicator(String css, int count, String pattern) {
         this.css = css;
         this.count = count;
         this.tooltip = StringUtils.isEmpty(pattern) ? "" : MessageFormat.format(getString(pattern), count);
      }

      String getTooltip() {
         return tooltip;
      }
   }
}