James Moger
2015-11-22 ed552ba47c02779c270ffd62841d6d1048dade70
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());
dac2de 138             html.append(readViewTicketAction(ticket));
5e3521 139             html.append("</head>");
JM 140             html.append("<body>");
141             html.append(MarkdownUtils.transformGFM(settings, markdown, ticket.repository));
142             html.append("</body>");
143
144             Mailing mailing = Mailing.newHtml();
145             mailing.from = getUserModel(ticket.updatedBy == null ? ticket.createdBy : ticket.updatedBy).getDisplayName();
146             mailing.subject = getSubject(ticket);
147             mailing.content = html.toString();
148             mailing.id = "ticket." + ticket.number + "." + StringUtils.getSHA1(ticket.repository + ticket.number);
149
150             setRecipients(ticket, mailing);
151             queue.put(ticket.number, mailing);
152
153             return mailing;
154         } catch (Exception e) {
155             Logger.getLogger(getClass()).error("failed to queue mailing for #" + ticket.number, e);
156         }
157         return null;
158     }
159
160     protected String getSubject(TicketModel ticket) {
161         Change lastChange = ticket.changes.get(ticket.changes.size() - 1);
162         boolean newTicket = lastChange.isStatusChange() && ticket.changes.size() == 1;
163         String re = newTicket ? "" : "Re: ";
164         String subject = MessageFormat.format("{0}[{1}] {2} (#{3,number,0})",
165                 re, StringUtils.stripDotGit(ticket.repository), ticket.title, ticket.number);
166         return subject;
167     }
168
169     protected String formatLastChange(TicketModel ticket) {
170         Change lastChange = ticket.changes.get(ticket.changes.size() - 1);
171         UserModel user = getUserModel(lastChange.author);
172
173         // define the fields we do NOT want to see in an email notification
174         Set<TicketModel.Field> fieldExclusions = new HashSet<TicketModel.Field>();
175         fieldExclusions.addAll(Arrays.asList(Field.watchers, Field.voters));
176
177         StringBuilder sb = new StringBuilder();
1626c6 178         boolean newTicket = lastChange.isStatusChange() && Status.New == lastChange.getStatus();
5e3521 179         boolean isFastForward = true;
JM 180         List<RevCommit> commits = null;
181         DiffStat diffstat = null;
182
183         String pattern;
1626c6 184         if (lastChange.hasPatchset()) {
5e3521 185             // patchset uploaded
JM 186             Patchset patchset = lastChange.patchset;
187             String base = "";
188             // determine the changed paths
189             Repository repo = null;
190             try {
191                 repo = repositoryManager.getRepository(ticket.repository);
192                 if (patchset.isFF() && (patchset.rev > 1)) {
193                     // fast-forward update, just show the new data
194                     isFastForward = true;
195                     Patchset prev = ticket.getPatchset(patchset.number, patchset.rev - 1);
196                     base = prev.tip;
197                 } else {
198                     // proposal OR non-fast-forward update
199                     isFastForward = false;
200                     base = patchset.base;
201                 }
202
203                 diffstat = DiffUtils.getDiffStat(repo, base, patchset.tip);
204                 commits = JGitUtils.getRevLog(repo, base, patchset.tip);
205             } catch (Exception e) {
206                 Logger.getLogger(getClass()).error("failed to get changed paths", e);
207             } finally {
b37af4 208                 if (repo != null) {
JM 209                     repo.close();
210                 }
5e3521 211             }
JM 212
213             String compareUrl = ticketService.getCompareUrl(ticket, base, patchset.tip);
1626c6 214
JM 215             if (newTicket) {
216                 // new proposal
217                 pattern = "**{0}** is proposing a change.";
218                 sb.append(MessageFormat.format(pattern, user.getDisplayName()));
8d11fa 219                 fieldExclusions.add(Field.status);
JM 220                 fieldExclusions.add(Field.title);
221                 fieldExclusions.add(Field.body);
5e3521 222             } else {
1626c6 223                 // describe the patchset
JM 224                 if (patchset.isFF()) {
225                     pattern = "**{0}** added {1} {2} to patchset {3}.";
226                     sb.append(MessageFormat.format(pattern, user.getDisplayName(), patchset.added, patchset.added == 1 ? "commit" : "commits", patchset.number));
227                 } else {
228                     pattern = "**{0}** uploaded patchset {1}. *({2})*";
229                     sb.append(MessageFormat.format(pattern, user.getDisplayName(), patchset.number, patchset.type.toString().toUpperCase()));
230                 }
5e3521 231             }
JM 232             sb.append(HARD_BRK);
1626c6 233
5e3521 234             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 235                     commits.size(), commits.size() == 1 ? "commit" : "commits",
236                     diffstat.paths.size(),
237                     diffstat.paths.size() == 1 ? "file" : "files",
238                     diffstat.getInsertions(),
239                     diffstat.getDeletions(),
240                     isFastForward ? "previous revision" : "merge base",
241                     compareUrl));
242
243             // note commit additions on a rebase,if any
244             switch (lastChange.patchset.type) {
245             case Rebase:
246                 if (lastChange.patchset.added > 0) {
247                     sb.append(SOFT_BRK);
248                     sb.append(MessageFormat.format("{0} {1} added.", lastChange.patchset.added, lastChange.patchset.added == 1 ? "commit" : "commits"));
249                 }
250                 break;
251             default:
252                 break;
253             }
254             sb.append(HARD_BRK);
1626c6 255         } else if (lastChange.isStatusChange()) {
JM 256             if (newTicket) {
257                 fieldExclusions.add(Field.status);
258                 fieldExclusions.add(Field.title);
259                 fieldExclusions.add(Field.body);
260                 pattern = "**{0}** created this ticket.";
261                 sb.append(MessageFormat.format(pattern, user.getDisplayName()));
262             } else if (lastChange.hasField(Field.mergeSha)) {
263                 // closed by merged
264                 pattern = "**{0}** closed this ticket by merging {1} to {2}.";
265
266                 // identify patchset that closed the ticket
267                 String merged = ticket.mergeSha;
268                 for (Patchset patchset : ticket.getPatchsets()) {
269                     if (patchset.tip.equals(ticket.mergeSha)) {
270                         merged = patchset.toString();
271                         break;
272                     }
273                 }
274                 sb.append(MessageFormat.format(pattern, user.getDisplayName(), merged, ticket.mergeTo));
275             } else {
276                 // workflow status change by user
277                 pattern = "**{0}** changed the status of this ticket to **{1}**.";
278                 sb.append(MessageFormat.format(pattern, user.getDisplayName(), lastChange.getStatus().toString().toUpperCase()));
279             }
280             sb.append(HARD_BRK);
5e3521 281         } else if (lastChange.hasReview()) {
JM 282             // review
283             Review review = lastChange.review;
284             pattern = "**{0}** has reviewed patchset {1,number,0} revision {2,number,0}.";
285             sb.append(MessageFormat.format(pattern, user.getDisplayName(), review.patchset, review.rev));
286             sb.append(HARD_BRK);
287
288             String d = settings.getString(Keys.web.datestampShortFormat, "yyyy-MM-dd");
289             String t = settings.getString(Keys.web.timeFormat, "HH:mm");
290             DateFormat df = new SimpleDateFormat(d + " " + t);
291             List<Change> reviews = ticket.getReviews(ticket.getPatchset(review.patchset, review.rev));
292             sb.append("| Date | Reviewer      | Score | Description  |\n");
293             sb.append("| :--- | :------------ | :---: | :----------- |\n");
294             for (Change change : reviews) {
295                 String name = change.author;
296                 UserModel u = userManager.getUserModel(change.author);
297                 if (u != null) {
298                     name = u.getDisplayName();
299                 }
300                 String score;
301                 switch (change.review.score) {
302                 case approved:
303                     score = MessageFormat.format(addPattern, change.review.score.getValue());
304                     break;
305                 case vetoed:
306                     score = MessageFormat.format(delPattern, Math.abs(change.review.score.getValue()));
307                     break;
308                 default:
309                     score = "" + change.review.score.getValue();
310                 }
311                 String date = df.format(change.date);
312                 sb.append(String.format("| %1$s | %2$s | %3$s | %4$s |\n",
313                         date, name, score, change.review.score.toString()));
314             }
315             sb.append(HARD_BRK);
316         } else if (lastChange.hasComment()) {
317             // comment update
318             sb.append(MessageFormat.format("**{0}** commented on this ticket.", user.getDisplayName()));
319             sb.append(HARD_BRK);
320         } else {
321             // general update
322             pattern = "**{0}** has updated this ticket.";
323             sb.append(MessageFormat.format(pattern, user.getDisplayName()));
324             sb.append(HARD_BRK);
325         }
326
327         // ticket link
328         sb.append(MessageFormat.format("[view ticket {0,number,0}]({1})",
329                 ticket.number, ticketService.getTicketUrl(ticket)));
330         sb.append(HARD_BRK);
331
332         if (newTicket) {
333             // ticket title
334             sb.append(MessageFormat.format("### {0}", ticket.title));
335             sb.append(HARD_BRK);
336
337             // ticket description, on state change
338             if (StringUtils.isEmpty(ticket.body)) {
339                 sb.append("<span style=\"color: #888;\">no description entered</span>");
340             } else {
341                 sb.append(ticket.body);
342             }
343             sb.append(HARD_BRK);
344             sb.append(HR);
345         }
346
347         // field changes
348         if (lastChange.hasFieldChanges()) {
349             Map<Field, String> filtered = new HashMap<Field, String>();
350             for (Map.Entry<Field, String> fc : lastChange.fields.entrySet()) {
351                 if (!fieldExclusions.contains(fc.getKey())) {
352                     // field is included
353                     filtered.put(fc.getKey(), fc.getValue());
354                 }
355             }
356
357             // sort by field ordinal
358             List<Field> fields = new ArrayList<Field>(filtered.keySet());
359             Collections.sort(fields);
360
361             if (filtered.size() > 0) {
362                 sb.append(HARD_BRK);
363                 sb.append("| Field Changes               ||\n");
364                 sb.append("| ------------: | :----------- |\n");
365                 for (Field field : fields) {
366                     String value;
367                     if (filtered.get(field) == null) {
368                         value = "";
369                     } else {
370                         value = filtered.get(field).replace("\r\n", "<br/>").replace("\n", "<br/>").replace("|", "&#124;");
371                     }
372                     sb.append(String.format("| **%1$s:** | %2$s |\n", field.name(), value));
373                 }
374                 sb.append(HARD_BRK);
375             }
376         }
377
378         // new comment
379         if (lastChange.hasComment()) {
380             sb.append(HR);
381             sb.append(lastChange.comment.text);
382             sb.append(HARD_BRK);
383         }
384
385         // insert the patchset details and review instructions
386         if (lastChange.hasPatchset() && ticket.isOpen()) {
387             if (commits != null && commits.size() > 0) {
388                 // append the commit list
389                 String title = isFastForward ? "Commits added to previous patchset revision" : "All commits in patchset";
390                 sb.append(MessageFormat.format("| {0} |||\n", title));
391                 sb.append("| SHA | Author | Title |\n");
392                 sb.append("| :-- | :----- | :---- |\n");
393                 for (RevCommit commit : commits) {
394                     sb.append(MessageFormat.format("| {0} | {1} | {2} |\n",
395                             commit.getName(), commit.getAuthorIdent().getName(),
396                             StringUtils.trimString(commit.getShortMessage(), Constants.LEN_SHORTLOG).replace("|", "&#124;")));
397                 }
398                 sb.append(HARD_BRK);
399             }
400
401             if (diffstat != null) {
402                 // append the changed path list
403                 String title = isFastForward ? "Files changed since previous patchset revision" : "All files changed in patchset";
404                 sb.append(MessageFormat.format("| {0} |||\n", title));
405                 sb.append("| :-- | :----------- | :-: |\n");
406                 for (PathChangeModel path : diffstat.paths) {
407                     String add = MessageFormat.format(addPattern, path.insertions);
408                     String del = MessageFormat.format(delPattern, path.deletions);
409                     String diff = null;
410                     switch (path.changeType) {
411                     case ADD:
412                         diff = add;
413                         break;
414                     case DELETE:
415                         diff = del;
416                         break;
417                     case MODIFY:
418                         if (path.insertions > 0 && path.deletions > 0) {
419                             // insertions & deletions
420                             diff = add + "/" + del;
421                         } else if (path.insertions > 0) {
422                             // just insertions
423                             diff = add;
424                         } else {
425                             // just deletions
426                             diff = del;
427                         }
428                         break;
429                     default:
430                         diff = path.changeType.name();
431                         break;
432                     }
433                     sb.append(MessageFormat.format("| {0} | {1} | {2} |\n",
434                             getChangeType(path.changeType), path.name, diff));
435                 }
436                 sb.append(HARD_BRK);
437             }
438
439             sb.append(formatPatchsetInstructions(ticket, lastChange.patchset));
440         }
441
442         return sb.toString();
443     }
444
445     protected String getChangeType(ChangeType type) {
446         String style = null;
447         switch (type) {
448             case ADD:
449                 style = "color:darkgreen;";
450                 break;
451             case COPY:
452                 style = "";
453                 break;
454             case DELETE:
455                 style = "color:darkred;";
456                 break;
457             case MODIFY:
458                 style = "";
459                 break;
460             case RENAME:
461                 style = "";
462                 break;
463             default:
464                 break;
465         }
466         String code = type.name().toUpperCase().substring(0, 1);
467         if (style == null) {
468             return code;
469         } else {
470             return MessageFormat.format("<strong><span style=\"{0}padding:2px;margin:2px;border:1px solid #ddd;\">{1}</span></strong>", style, code);
471         }
472     }
473
474     /**
475      * Generates patchset review instructions for command-line git
476      *
477      * @param patchset
478      * @return instructions
479      */
480     protected String formatPatchsetInstructions(TicketModel ticket, Patchset patchset) {
481         String canonicalUrl = settings.getString(Keys.web.canonicalUrl, "https://localhost:8443");
482         String repositoryUrl = canonicalUrl + Constants.R_PATH + ticket.repository;
483
484         String ticketBranch = Repository.shortenRefName(PatchsetCommand.getTicketBranch(ticket.number));
485         String patchsetBranch  = PatchsetCommand.getPatchsetBranch(ticket.number, patchset.number);
486         String reviewBranch = PatchsetCommand.getReviewBranch(ticket.number);
487
488         String instructions = readResource("commands.md");
489         instructions = instructions.replace("${ticketId}", "" + ticket.number);
490         instructions = instructions.replace("${patchset}", "" + patchset.number);
491         instructions = instructions.replace("${repositoryUrl}", repositoryUrl);
492         instructions = instructions.replace("${ticketRef}", ticketBranch);
493         instructions = instructions.replace("${patchsetRef}", patchsetBranch);
494         instructions = instructions.replace("${reviewBranch}", reviewBranch);
328346 495         instructions = instructions.replace("${ticketBranch}", ticketBranch);
5e3521 496
JM 497         return instructions;
498     }
499
500     /**
501      * Gets the usermodel for the username.  Creates a temp model, if required.
502      *
503      * @param username
504      * @return a usermodel
505      */
506     protected UserModel getUserModel(String username) {
507         UserModel user = userManager.getUserModel(username);
508         if (user == null) {
509             // create a temporary user model (for unit tests)
510             user = new UserModel(username);
511         }
512         return user;
513     }
514
515     /**
516      * Set the proper recipients for a ticket.
517      *
518      * @param ticket
519      * @param mailing
520      */
521     protected void setRecipients(TicketModel ticket, Mailing mailing) {
522         RepositoryModel repository = repositoryManager.getRepositoryModel(ticket.repository);
523
524         //
525         // Direct TO recipients
4261c1 526         // reporter & responsible
5e3521 527         //
4261c1 528         Set<String> tos = new TreeSet<String>();
JM 529         tos.add(ticket.createdBy);
530         if (!StringUtils.isEmpty(ticket.responsible)) {
531             tos.add(ticket.responsible);
532         }
533
5e3521 534         Set<String> toAddresses = new TreeSet<String>();
4261c1 535         for (String name : tos) {
5e3521 536             UserModel user = userManager.getUserModel(name);
d68553 537             if (user != null && !user.disabled) {
5e3521 538                 if (!StringUtils.isEmpty(user.emailAddress)) {
JM 539                     if (user.canView(repository)) {
540                         toAddresses.add(user.emailAddress);
541                     } else {
542                         LoggerFactory.getLogger(getClass()).warn(
543                                 MessageFormat.format("ticket {0}-{1,number,0}: {2} can not receive notification",
544                                         repository.name, ticket.number, user.username));
545                     }
546                 }
547             }
548         }
549
550         //
551         // CC recipients
552         //
553         Set<String> ccs = new TreeSet<String>();
554
4261c1 555         // repository owners
JM 556         if (!ArrayUtils.isEmpty(repository.owners)) {
afbaeb 557             ccs.addAll(repository.owners);
4261c1 558         }
JM 559
5e3521 560         // cc users mentioned in last comment
JM 561         Change lastChange = ticket.changes.get(ticket.changes.size() - 1);
562         if (lastChange.hasComment()) {
563             Pattern p = Pattern.compile("\\s@([A-Za-z0-9-_]+)");
564             Matcher m = p.matcher(lastChange.comment.text);
565             while (m.find()) {
566                 String username = m.group();
567                 ccs.add(username);
568             }
569         }
570
571         // cc users who are watching the ticket
572         ccs.addAll(ticket.getWatchers());
573
574         // TODO cc users who are watching the repository
575
576         Set<String> ccAddresses = new TreeSet<String>();
577         for (String name : ccs) {
578             UserModel user = userManager.getUserModel(name);
d68553 579             if (user != null && !user.disabled) {
5e3521 580                 if (!StringUtils.isEmpty(user.emailAddress)) {
JM 581                     if (user.canView(repository)) {
582                         ccAddresses.add(user.emailAddress);
583                     } else {
584                         LoggerFactory.getLogger(getClass()).warn(
585                                 MessageFormat.format("ticket {0}-{1,number,0}: {2} can not receive notification",
586                                         repository.name, ticket.number, user.username));
587                     }
588                 }
589             }
590         }
591
592         // cc repository mailing list addresses
593         if (!ArrayUtils.isEmpty(repository.mailingLists)) {
594             ccAddresses.addAll(repository.mailingLists);
595         }
596         ccAddresses.addAll(settings.getStrings(Keys.mail.mailingLists));
597
afbaeb 598         // respect the author's email preference
JM 599         UserModel lastAuthor = userManager.getUserModel(lastChange.author);
dac2de 600         if (lastAuthor != null && !lastAuthor.getPreferences().isEmailMeOnMyTicketChanges()) {
afbaeb 601             toAddresses.remove(lastAuthor.emailAddress);
JM 602             ccAddresses.remove(lastAuthor.emailAddress);
603         }
604
605         mailing.setRecipients(toAddresses);
5e3521 606         mailing.setCCs(ccAddresses);
JM 607     }
608
609     protected String readStyle() {
610         StringBuilder sb = new StringBuilder();
611         sb.append("<style>\n");
612         sb.append(readResource("email.css"));
613         sb.append("</style>\n");
614         return sb.toString();
615     }
616
dac2de 617     protected String readViewTicketAction(TicketModel ticket) {
JM 618         String action = readResource("viewTicket.html");
619         action = action.replace("${url}", ticketService.getTicketUrl(ticket));
620         return action;
621     }
622
5e3521 623     protected String readResource(String resource) {
JM 624         StringBuilder sb = new StringBuilder();
625         InputStream is = null;
626         try {
627             is = getClass().getResourceAsStream(resource);
628             List<String> lines = IOUtils.readLines(is);
629             for (String line : lines) {
630                 sb.append(line).append('\n');
631             }
632         } catch (IOException e) {
633
634         } finally {
635             if (is != null) {
636                 try {
637                     is.close();
638                 } catch (IOException e) {
639                 }
640             }
641         }
642         return sb.toString();
643     }
644 }