James Moger
2014-10-13 70250d8ff53081eaccac24517ea96b89d27507b9
commit | author | age
5e3521 1 /*
JM 2  * Copyright 2014 gitblit.com.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.gitblit.tickets;
17
18 import java.io.IOException;
19 import java.io.InputStream;
20 import java.text.DateFormat;
21 import java.text.MessageFormat;
22 import java.text.SimpleDateFormat;
23 import java.util.ArrayList;
24 import java.util.Arrays;
25 import java.util.Collections;
26 import java.util.HashMap;
27 import java.util.HashSet;
28 import java.util.List;
29 import java.util.Map;
30 import java.util.Set;
31 import java.util.TreeMap;
32 import java.util.TreeSet;
33 import java.util.regex.Matcher;
34 import java.util.regex.Pattern;
35
36 import org.apache.commons.io.IOUtils;
37 import org.apache.log4j.Logger;
38 import org.eclipse.jgit.diff.DiffEntry.ChangeType;
39 import org.eclipse.jgit.lib.Repository;
40 import org.eclipse.jgit.revwalk.RevCommit;
41 import org.slf4j.LoggerFactory;
42
43 import com.gitblit.Constants;
44 import com.gitblit.IStoredSettings;
45 import com.gitblit.Keys;
46 import com.gitblit.git.PatchsetCommand;
47 import com.gitblit.manager.INotificationManager;
48 import com.gitblit.manager.IRepositoryManager;
49 import com.gitblit.manager.IRuntimeManager;
50 import com.gitblit.manager.IUserManager;
51 import com.gitblit.models.Mailing;
52 import com.gitblit.models.PathModel.PathChangeModel;
53 import com.gitblit.models.RepositoryModel;
54 import com.gitblit.models.TicketModel;
55 import com.gitblit.models.TicketModel.Change;
56 import com.gitblit.models.TicketModel.Field;
57 import com.gitblit.models.TicketModel.Patchset;
58 import com.gitblit.models.TicketModel.Review;
59 import com.gitblit.models.TicketModel.Status;
60 import com.gitblit.models.UserModel;
61 import com.gitblit.utils.ArrayUtils;
62 import com.gitblit.utils.DiffUtils;
63 import com.gitblit.utils.DiffUtils.DiffStat;
64 import com.gitblit.utils.JGitUtils;
65 import com.gitblit.utils.MarkdownUtils;
66 import com.gitblit.utils.StringUtils;
67
68 /**
69  * Formats and queues ticket/patch notifications for dispatch to the
70  * mail executor upon completion of a push or a ticket update.  Messages are
71  * created as Markdown and then transformed to html.
72  *
73  * @author James Moger
74  *
75  */
76 public class TicketNotifier {
77
78     protected final Map<Long, Mailing> queue = new TreeMap<Long, Mailing>();
79
80     private final String SOFT_BRK = "\n";
81
82     private final String HARD_BRK = "\n\n";
83
84     private final String HR = "----\n\n";
85
86     private final IStoredSettings settings;
87
88     private final INotificationManager notificationManager;
89
90     private final IUserManager userManager;
91
92     private final IRepositoryManager repositoryManager;
93
94     private final ITicketService ticketService;
95
96     private final String addPattern = "<span style=\"color:darkgreen;\">+{0}</span>";
97     private final String delPattern = "<span style=\"color:darkred;\">-{0}</span>";
98
99     public TicketNotifier(
100             IRuntimeManager runtimeManager,
101             INotificationManager notificationManager,
102             IUserManager userManager,
103             IRepositoryManager repositoryManager,
104             ITicketService ticketService) {
105
106         this.settings = runtimeManager.getSettings();
107         this.notificationManager = notificationManager;
108         this.userManager = userManager;
109         this.repositoryManager = repositoryManager;
110         this.ticketService = ticketService;
111     }
112
113     public void sendAll() {
114         for (Mailing mail : queue.values()) {
115             notificationManager.send(mail);
116         }
117     }
118
119     public void sendMailing(TicketModel ticket) {
120         queueMailing(ticket);
121         sendAll();
122     }
123
124     /**
125      * Queues an update notification.
126      *
127      * @param ticket
128      * @return a notification object used for testing
129      */
130     public Mailing queueMailing(TicketModel ticket) {
131         try {
132             // format notification message
133             String markdown = formatLastChange(ticket);
134
135             StringBuilder html = new StringBuilder();
136             html.append("<head>");
137             html.append(readStyle());
138             html.append("</head>");
139             html.append("<body>");
140             html.append(MarkdownUtils.transformGFM(settings, markdown, ticket.repository));
141             html.append("</body>");
142
143             Mailing mailing = Mailing.newHtml();
144             mailing.from = getUserModel(ticket.updatedBy == null ? ticket.createdBy : ticket.updatedBy).getDisplayName();
145             mailing.subject = getSubject(ticket);
146             mailing.content = html.toString();
147             mailing.id = "ticket." + ticket.number + "." + StringUtils.getSHA1(ticket.repository + ticket.number);
148
149             setRecipients(ticket, mailing);
150             queue.put(ticket.number, mailing);
151
152             return mailing;
153         } catch (Exception e) {
154             Logger.getLogger(getClass()).error("failed to queue mailing for #" + ticket.number, e);
155         }
156         return null;
157     }
158
159     protected String getSubject(TicketModel ticket) {
160         Change lastChange = ticket.changes.get(ticket.changes.size() - 1);
161         boolean newTicket = lastChange.isStatusChange() && ticket.changes.size() == 1;
162         String re = newTicket ? "" : "Re: ";
163         String subject = MessageFormat.format("{0}[{1}] {2} (#{3,number,0})",
164                 re, StringUtils.stripDotGit(ticket.repository), ticket.title, ticket.number);
165         return subject;
166     }
167
168     protected String formatLastChange(TicketModel ticket) {
169         Change lastChange = ticket.changes.get(ticket.changes.size() - 1);
170         UserModel user = getUserModel(lastChange.author);
171
172         // define the fields we do NOT want to see in an email notification
173         Set<TicketModel.Field> fieldExclusions = new HashSet<TicketModel.Field>();
174         fieldExclusions.addAll(Arrays.asList(Field.watchers, Field.voters));
175
176         StringBuilder sb = new StringBuilder();
1626c6 177         boolean newTicket = lastChange.isStatusChange() && Status.New == lastChange.getStatus();
5e3521 178         boolean isFastForward = true;
JM 179         List<RevCommit> commits = null;
180         DiffStat diffstat = null;
181
182         String pattern;
1626c6 183         if (lastChange.hasPatchset()) {
5e3521 184             // patchset uploaded
JM 185             Patchset patchset = lastChange.patchset;
186             String base = "";
187             // determine the changed paths
188             Repository repo = null;
189             try {
190                 repo = repositoryManager.getRepository(ticket.repository);
191                 if (patchset.isFF() && (patchset.rev > 1)) {
192                     // fast-forward update, just show the new data
193                     isFastForward = true;
194                     Patchset prev = ticket.getPatchset(patchset.number, patchset.rev - 1);
195                     base = prev.tip;
196                 } else {
197                     // proposal OR non-fast-forward update
198                     isFastForward = false;
199                     base = patchset.base;
200                 }
201
202                 diffstat = DiffUtils.getDiffStat(repo, base, patchset.tip);
203                 commits = JGitUtils.getRevLog(repo, base, patchset.tip);
204             } catch (Exception e) {
205                 Logger.getLogger(getClass()).error("failed to get changed paths", e);
206             } finally {
b37af4 207                 if (repo != null) {
JM 208                     repo.close();
209                 }
5e3521 210             }
JM 211
212             String compareUrl = ticketService.getCompareUrl(ticket, base, patchset.tip);
1626c6 213
JM 214             if (newTicket) {
215                 // new proposal
216                 pattern = "**{0}** is proposing a change.";
217                 sb.append(MessageFormat.format(pattern, user.getDisplayName()));
8d11fa 218                 fieldExclusions.add(Field.status);
JM 219                 fieldExclusions.add(Field.title);
220                 fieldExclusions.add(Field.body);
5e3521 221             } else {
1626c6 222                 // describe the patchset
JM 223                 if (patchset.isFF()) {
224                     pattern = "**{0}** added {1} {2} to patchset {3}.";
225                     sb.append(MessageFormat.format(pattern, user.getDisplayName(), patchset.added, patchset.added == 1 ? "commit" : "commits", patchset.number));
226                 } else {
227                     pattern = "**{0}** uploaded patchset {1}. *({2})*";
228                     sb.append(MessageFormat.format(pattern, user.getDisplayName(), patchset.number, patchset.type.toString().toUpperCase()));
229                 }
5e3521 230             }
JM 231             sb.append(HARD_BRK);
1626c6 232
5e3521 233             sb.append(MessageFormat.format("{0} {1}, {2} {3}, <span style=\"color:darkgreen;\">+{4} insertions</span>, <span style=\"color:darkred;\">-{5} deletions</span> from {6}. [compare]({7})",
JM 234                     commits.size(), commits.size() == 1 ? "commit" : "commits",
235                     diffstat.paths.size(),
236                     diffstat.paths.size() == 1 ? "file" : "files",
237                     diffstat.getInsertions(),
238                     diffstat.getDeletions(),
239                     isFastForward ? "previous revision" : "merge base",
240                     compareUrl));
241
242             // note commit additions on a rebase,if any
243             switch (lastChange.patchset.type) {
244             case Rebase:
245                 if (lastChange.patchset.added > 0) {
246                     sb.append(SOFT_BRK);
247                     sb.append(MessageFormat.format("{0} {1} added.", lastChange.patchset.added, lastChange.patchset.added == 1 ? "commit" : "commits"));
248                 }
249                 break;
250             default:
251                 break;
252             }
253             sb.append(HARD_BRK);
1626c6 254         } else if (lastChange.isStatusChange()) {
JM 255             if (newTicket) {
256                 fieldExclusions.add(Field.status);
257                 fieldExclusions.add(Field.title);
258                 fieldExclusions.add(Field.body);
259                 pattern = "**{0}** created this ticket.";
260                 sb.append(MessageFormat.format(pattern, user.getDisplayName()));
261             } else if (lastChange.hasField(Field.mergeSha)) {
262                 // closed by merged
263                 pattern = "**{0}** closed this ticket by merging {1} to {2}.";
264
265                 // identify patchset that closed the ticket
266                 String merged = ticket.mergeSha;
267                 for (Patchset patchset : ticket.getPatchsets()) {
268                     if (patchset.tip.equals(ticket.mergeSha)) {
269                         merged = patchset.toString();
270                         break;
271                     }
272                 }
273                 sb.append(MessageFormat.format(pattern, user.getDisplayName(), merged, ticket.mergeTo));
274             } else {
275                 // workflow status change by user
276                 pattern = "**{0}** changed the status of this ticket to **{1}**.";
277                 sb.append(MessageFormat.format(pattern, user.getDisplayName(), lastChange.getStatus().toString().toUpperCase()));
278             }
279             sb.append(HARD_BRK);
5e3521 280         } else if (lastChange.hasReview()) {
JM 281             // review
282             Review review = lastChange.review;
283             pattern = "**{0}** has reviewed patchset {1,number,0} revision {2,number,0}.";
284             sb.append(MessageFormat.format(pattern, user.getDisplayName(), review.patchset, review.rev));
285             sb.append(HARD_BRK);
286
287             String d = settings.getString(Keys.web.datestampShortFormat, "yyyy-MM-dd");
288             String t = settings.getString(Keys.web.timeFormat, "HH:mm");
289             DateFormat df = new SimpleDateFormat(d + " " + t);
290             List<Change> reviews = ticket.getReviews(ticket.getPatchset(review.patchset, review.rev));
291             sb.append("| Date | Reviewer      | Score | Description  |\n");
292             sb.append("| :--- | :------------ | :---: | :----------- |\n");
293             for (Change change : reviews) {
294                 String name = change.author;
295                 UserModel u = userManager.getUserModel(change.author);
296                 if (u != null) {
297                     name = u.getDisplayName();
298                 }
299                 String score;
300                 switch (change.review.score) {
301                 case approved:
302                     score = MessageFormat.format(addPattern, change.review.score.getValue());
303                     break;
304                 case vetoed:
305                     score = MessageFormat.format(delPattern, Math.abs(change.review.score.getValue()));
306                     break;
307                 default:
308                     score = "" + change.review.score.getValue();
309                 }
310                 String date = df.format(change.date);
311                 sb.append(String.format("| %1$s | %2$s | %3$s | %4$s |\n",
312                         date, name, score, change.review.score.toString()));
313             }
314             sb.append(HARD_BRK);
315         } else if (lastChange.hasComment()) {
316             // comment update
317             sb.append(MessageFormat.format("**{0}** commented on this ticket.", user.getDisplayName()));
318             sb.append(HARD_BRK);
319         } else {
320             // general update
321             pattern = "**{0}** has updated this ticket.";
322             sb.append(MessageFormat.format(pattern, user.getDisplayName()));
323             sb.append(HARD_BRK);
324         }
325
326         // ticket link
327         sb.append(MessageFormat.format("[view ticket {0,number,0}]({1})",
328                 ticket.number, ticketService.getTicketUrl(ticket)));
329         sb.append(HARD_BRK);
330
331         if (newTicket) {
332             // ticket title
333             sb.append(MessageFormat.format("### {0}", ticket.title));
334             sb.append(HARD_BRK);
335
336             // ticket description, on state change
337             if (StringUtils.isEmpty(ticket.body)) {
338                 sb.append("<span style=\"color: #888;\">no description entered</span>");
339             } else {
340                 sb.append(ticket.body);
341             }
342             sb.append(HARD_BRK);
343             sb.append(HR);
344         }
345
346         // field changes
347         if (lastChange.hasFieldChanges()) {
348             Map<Field, String> filtered = new HashMap<Field, String>();
349             for (Map.Entry<Field, String> fc : lastChange.fields.entrySet()) {
350                 if (!fieldExclusions.contains(fc.getKey())) {
351                     // field is included
352                     filtered.put(fc.getKey(), fc.getValue());
353                 }
354             }
355
356             // sort by field ordinal
357             List<Field> fields = new ArrayList<Field>(filtered.keySet());
358             Collections.sort(fields);
359
360             if (filtered.size() > 0) {
361                 sb.append(HARD_BRK);
362                 sb.append("| Field Changes               ||\n");
363                 sb.append("| ------------: | :----------- |\n");
364                 for (Field field : fields) {
365                     String value;
366                     if (filtered.get(field) == null) {
367                         value = "";
368                     } else {
369                         value = filtered.get(field).replace("\r\n", "<br/>").replace("\n", "<br/>").replace("|", "&#124;");
370                     }
371                     sb.append(String.format("| **%1$s:** | %2$s |\n", field.name(), value));
372                 }
373                 sb.append(HARD_BRK);
374             }
375         }
376
377         // new comment
378         if (lastChange.hasComment()) {
379             sb.append(HR);
380             sb.append(lastChange.comment.text);
381             sb.append(HARD_BRK);
382         }
383
384         // insert the patchset details and review instructions
385         if (lastChange.hasPatchset() && ticket.isOpen()) {
386             if (commits != null && commits.size() > 0) {
387                 // append the commit list
388                 String title = isFastForward ? "Commits added to previous patchset revision" : "All commits in patchset";
389                 sb.append(MessageFormat.format("| {0} |||\n", title));
390                 sb.append("| SHA | Author | Title |\n");
391                 sb.append("| :-- | :----- | :---- |\n");
392                 for (RevCommit commit : commits) {
393                     sb.append(MessageFormat.format("| {0} | {1} | {2} |\n",
394                             commit.getName(), commit.getAuthorIdent().getName(),
395                             StringUtils.trimString(commit.getShortMessage(), Constants.LEN_SHORTLOG).replace("|", "&#124;")));
396                 }
397                 sb.append(HARD_BRK);
398             }
399
400             if (diffstat != null) {
401                 // append the changed path list
402                 String title = isFastForward ? "Files changed since previous patchset revision" : "All files changed in patchset";
403                 sb.append(MessageFormat.format("| {0} |||\n", title));
404                 sb.append("| :-- | :----------- | :-: |\n");
405                 for (PathChangeModel path : diffstat.paths) {
406                     String add = MessageFormat.format(addPattern, path.insertions);
407                     String del = MessageFormat.format(delPattern, path.deletions);
408                     String diff = null;
409                     switch (path.changeType) {
410                     case ADD:
411                         diff = add;
412                         break;
413                     case DELETE:
414                         diff = del;
415                         break;
416                     case MODIFY:
417                         if (path.insertions > 0 && path.deletions > 0) {
418                             // insertions & deletions
419                             diff = add + "/" + del;
420                         } else if (path.insertions > 0) {
421                             // just insertions
422                             diff = add;
423                         } else {
424                             // just deletions
425                             diff = del;
426                         }
427                         break;
428                     default:
429                         diff = path.changeType.name();
430                         break;
431                     }
432                     sb.append(MessageFormat.format("| {0} | {1} | {2} |\n",
433                             getChangeType(path.changeType), path.name, diff));
434                 }
435                 sb.append(HARD_BRK);
436             }
437
438             sb.append(formatPatchsetInstructions(ticket, lastChange.patchset));
439         }
440
441         return sb.toString();
442     }
443
444     protected String getChangeType(ChangeType type) {
445         String style = null;
446         switch (type) {
447             case ADD:
448                 style = "color:darkgreen;";
449                 break;
450             case COPY:
451                 style = "";
452                 break;
453             case DELETE:
454                 style = "color:darkred;";
455                 break;
456             case MODIFY:
457                 style = "";
458                 break;
459             case RENAME:
460                 style = "";
461                 break;
462             default:
463                 break;
464         }
465         String code = type.name().toUpperCase().substring(0, 1);
466         if (style == null) {
467             return code;
468         } else {
469             return MessageFormat.format("<strong><span style=\"{0}padding:2px;margin:2px;border:1px solid #ddd;\">{1}</span></strong>", style, code);
470         }
471     }
472
473     /**
474      * Generates patchset review instructions for command-line git
475      *
476      * @param patchset
477      * @return instructions
478      */
479     protected String formatPatchsetInstructions(TicketModel ticket, Patchset patchset) {
480         String canonicalUrl = settings.getString(Keys.web.canonicalUrl, "https://localhost:8443");
481         String repositoryUrl = canonicalUrl + Constants.R_PATH + ticket.repository;
482
483         String ticketBranch = Repository.shortenRefName(PatchsetCommand.getTicketBranch(ticket.number));
484         String patchsetBranch  = PatchsetCommand.getPatchsetBranch(ticket.number, patchset.number);
485         String reviewBranch = PatchsetCommand.getReviewBranch(ticket.number);
486
487         String instructions = readResource("commands.md");
488         instructions = instructions.replace("${ticketId}", "" + ticket.number);
489         instructions = instructions.replace("${patchset}", "" + patchset.number);
490         instructions = instructions.replace("${repositoryUrl}", repositoryUrl);
491         instructions = instructions.replace("${ticketRef}", ticketBranch);
492         instructions = instructions.replace("${patchsetRef}", patchsetBranch);
493         instructions = instructions.replace("${reviewBranch}", reviewBranch);
328346 494         instructions = instructions.replace("${ticketBranch}", ticketBranch);
5e3521 495
JM 496         return instructions;
497     }
498
499     /**
500      * Gets the usermodel for the username.  Creates a temp model, if required.
501      *
502      * @param username
503      * @return a usermodel
504      */
505     protected UserModel getUserModel(String username) {
506         UserModel user = userManager.getUserModel(username);
507         if (user == null) {
508             // create a temporary user model (for unit tests)
509             user = new UserModel(username);
510         }
511         return user;
512     }
513
514     /**
515      * Set the proper recipients for a ticket.
516      *
517      * @param ticket
518      * @param mailing
519      */
520     protected void setRecipients(TicketModel ticket, Mailing mailing) {
521         RepositoryModel repository = repositoryManager.getRepositoryModel(ticket.repository);
522
523         //
524         // Direct TO recipients
4261c1 525         // reporter & responsible
5e3521 526         //
4261c1 527         Set<String> tos = new TreeSet<String>();
JM 528         tos.add(ticket.createdBy);
529         if (!StringUtils.isEmpty(ticket.responsible)) {
530             tos.add(ticket.responsible);
531         }
532
5e3521 533         Set<String> toAddresses = new TreeSet<String>();
4261c1 534         for (String name : tos) {
5e3521 535             UserModel user = userManager.getUserModel(name);
d68553 536             if (user != null && !user.disabled) {
5e3521 537                 if (!StringUtils.isEmpty(user.emailAddress)) {
JM 538                     if (user.canView(repository)) {
539                         toAddresses.add(user.emailAddress);
540                     } else {
541                         LoggerFactory.getLogger(getClass()).warn(
542                                 MessageFormat.format("ticket {0}-{1,number,0}: {2} can not receive notification",
543                                         repository.name, ticket.number, user.username));
544                     }
545                 }
546             }
547         }
548
549         //
550         // CC recipients
551         //
552         Set<String> ccs = new TreeSet<String>();
553
4261c1 554         // repository owners
JM 555         if (!ArrayUtils.isEmpty(repository.owners)) {
afbaeb 556             ccs.addAll(repository.owners);
4261c1 557         }
JM 558
5e3521 559         // cc users mentioned in last comment
JM 560         Change lastChange = ticket.changes.get(ticket.changes.size() - 1);
561         if (lastChange.hasComment()) {
562             Pattern p = Pattern.compile("\\s@([A-Za-z0-9-_]+)");
563             Matcher m = p.matcher(lastChange.comment.text);
564             while (m.find()) {
565                 String username = m.group();
566                 ccs.add(username);
567             }
568         }
569
570         // cc users who are watching the ticket
571         ccs.addAll(ticket.getWatchers());
572
573         // TODO cc users who are watching the repository
574
575         Set<String> ccAddresses = new TreeSet<String>();
576         for (String name : ccs) {
577             UserModel user = userManager.getUserModel(name);
d68553 578             if (user != null && !user.disabled) {
5e3521 579                 if (!StringUtils.isEmpty(user.emailAddress)) {
JM 580                     if (user.canView(repository)) {
581                         ccAddresses.add(user.emailAddress);
582                     } else {
583                         LoggerFactory.getLogger(getClass()).warn(
584                                 MessageFormat.format("ticket {0}-{1,number,0}: {2} can not receive notification",
585                                         repository.name, ticket.number, user.username));
586                     }
587                 }
588             }
589         }
590
591         // cc repository mailing list addresses
592         if (!ArrayUtils.isEmpty(repository.mailingLists)) {
593             ccAddresses.addAll(repository.mailingLists);
594         }
595         ccAddresses.addAll(settings.getStrings(Keys.mail.mailingLists));
596
afbaeb 597         // respect the author's email preference
JM 598         UserModel lastAuthor = userManager.getUserModel(lastChange.author);
70250d 599         if (lastAuthor != null && !lastAuthor.getPreferences().isEmailMeOnMyTicketChanges()) {
afbaeb 600             toAddresses.remove(lastAuthor.emailAddress);
JM 601             ccAddresses.remove(lastAuthor.emailAddress);
602         }
603
604         mailing.setRecipients(toAddresses);
5e3521 605         mailing.setCCs(ccAddresses);
JM 606     }
607
608     protected String readStyle() {
609         StringBuilder sb = new StringBuilder();
610         sb.append("<style>\n");
611         sb.append(readResource("email.css"));
612         sb.append("</style>\n");
613         return sb.toString();
614     }
615
616     protected String readResource(String resource) {
617         StringBuilder sb = new StringBuilder();
618         InputStream is = null;
619         try {
620             is = getClass().getResourceAsStream(resource);
621             List<String> lines = IOUtils.readLines(is);
622             for (String line : lines) {
623                 sb.append(line).append('\n');
624             }
625         } catch (IOException e) {
626
627         } finally {
628             if (is != null) {
629                 try {
630                     is.close();
631                 } catch (IOException e) {
632                 }
633             }
634         }
635         return sb.toString();
636     }
637 }