source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2017 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.issue.notification;
  21
  22 import com.google.common.base.Strings;
  23 import java.io.UnsupportedEncodingException;
  24 import javax.annotation.CheckForNull;
  25 import javax.annotation.Nullable;
  26 import org.apache.commons.lang.StringUtils;
  27 import org.sonar.api.config.EmailSettings;
  28 import org.sonar.api.notifications.Notification;
  29 import org.sonar.db.DbClient;
  30 import org.sonar.db.DbSession;
  31 import org.sonar.db.user.UserDto;
  32 import org.sonar.plugins.emailnotifications.api.EmailMessage;
  33 import org.sonar.plugins.emailnotifications.api.EmailTemplate;
  34
  35 import static java.net.URLEncoder.encode;
  36
  37 /**
  38  * Creates email message for notification "issue-changes".
  39  */
  40 public class IssueChangesEmailTemplate extends EmailTemplate {
  41
  42   private static final char NEW_LINE = '\n';
  43   private final DbClient dbClient;
  44   private final EmailSettings settings;
  45
  46   public IssueChangesEmailTemplate(DbClient dbClient, EmailSettings settings) {
  47     this.dbClient = dbClient;
  48     this.settings = settings;
  49   }
  50
  51   @Override
  52   public EmailMessage format(Notification notif) {
  53     if (!IssueChangeNotification.TYPE.equals(notif.getType())) {
  54       return null;
  55     }
  56
  57     StringBuilder sb = new StringBuilder();
  58     appendHeader(notif, sb);
  59     sb.append(NEW_LINE);
  60     appendChanges(notif, sb);
  61     sb.append(NEW_LINE);
  62     appendFooter(sb, notif);
  63
  64     String projectName = notif.getFieldValue("projectName");
  65     String issueKey = notif.getFieldValue("key");
  66     String author = notif.getFieldValue("changeAuthor");
  67
  68     EmailMessage message = new EmailMessage()
  69       .setMessageId("issue-changes/" + issueKey)
  70       .setSubject(projectName + ", change on issue #" + issueKey)
  71       .setMessage(sb.toString());
  72     if (author != null) {
  73       message.setFrom(getUserFullName(author));
  74     }
  75     return message;
  76   }
  77
  78   private static void appendChanges(Notification notif, StringBuilder sb) {
  79     appendField(sb, "Comment", null, notif.getFieldValue("comment"));
  80     appendFieldWithoutHistory(sb, "Assignee", notif.getFieldValue("old.assignee"), notif.getFieldValue("new.assignee"));
  81     appendField(sb, "Severity", notif.getFieldValue("old.severity"), notif.getFieldValue("new.severity"));
  82     appendField(sb, "Type", notif.getFieldValue("old.type"), notif.getFieldValue("new.type"));
  83     appendField(sb, "Resolution", notif.getFieldValue("old.resolution"), notif.getFieldValue("new.resolution"));
  84     appendField(sb, "Status", notif.getFieldValue("old.status"), notif.getFieldValue("new.status"));
  85     appendField(sb, "Message", notif.getFieldValue("old.message"), notif.getFieldValue("new.message"));
  86     appendField(sb, "Author", notif.getFieldValue("old.author"), notif.getFieldValue("new.author"));
  87     appendFieldWithoutHistory(sb, "Action Plan", notif.getFieldValue("old.actionPlan"), notif.getFieldValue("new.actionPlan"));
  88     appendField(sb, "Tags", formatTagChange(notif.getFieldValue("old.tags")), formatTagChange(notif.getFieldValue("new.tags")));
  89   }
  90
  91   @CheckForNull
  92   private static String formatTagChange(@Nullable String tags) {
  93     if (tags == null) {
  94       return null;
  95     } else {
  96       return "[" + tags + "]";
  97     }
  98   }
  99
 100   private static void appendHeader(Notification notif, StringBuilder sb) {
 101     appendLine(sb, StringUtils.defaultString(notif.getFieldValue("componentName"), notif.getFieldValue("componentKey")));
 102     appendField(sb, "Rule", null, notif.getFieldValue("ruleName"));
 103     appendField(sb, "Message", null, notif.getFieldValue("message"));
 104   }
 105
 106   private void appendFooter(StringBuilder sb, Notification notification){
 107     String issueKey = notification.getFieldValue("key");
 108     try {
 109       sb.append("More details at: ").append(settings.getServerBaseURL())
 110         .append("/project/issues?id=").append(encode(notification.getFieldValue("projectKey"), "UTF-8"))
 111         .append("&issues=").append(issueKey)
 112         .append("&open=").append(issueKey);
 113       String branchName = notification.getFieldValue("branch");
 114       if (branchName != null) {
 115         sb.append("&branch=").append(branchName);
 116       }
 117       sb.append(NEW_LINE);
 118     } catch (UnsupportedEncodingException e) {
 119       throw new IllegalStateException("Encoding not supported", e);
 120     }
 121   }
 122
 123   private static void appendLine(StringBuilder sb, @Nullable String line) {
 124     if (!Strings.isNullOrEmpty(line)) {
 125       sb.append(line).append(NEW_LINE);
 126     }
 127   }
 128
 129   private static void appendField(StringBuilder sb, String name, @Nullable String oldValue, @Nullable String newValue) {
 130     if (oldValue != null || newValue != null) {
 131       sb.append(name).append(": ");
 132       if (newValue != null) {
 133         sb.append(newValue);
 134       }
 135       if (oldValue != null) {
 136         sb.append(" (was ").append(oldValue).append(")");
 137       }
 138       sb.append(NEW_LINE);
 139     }
 140   }
 141
 142   private static void appendFieldWithoutHistory(StringBuilder sb, String name, @Nullable String oldValue, @Nullable String newValue) {
 143     if (oldValue != null || newValue != null) {
 144       sb.append(name);
 145       if (newValue != null) {
 146         sb.append(" changed to ");
 147         sb.append(newValue);
 148       } else {
 149         sb.append(" removed");
 150       }
 151       sb.append(NEW_LINE);
 152     }
 153   }
 154
 155   private String getUserFullName(@Nullable String login) {
 156     if (login == null) {
 157       return null;
 158     }
 159     try (DbSession dbSession = dbClient.openSession(false)) {
 160       UserDto userDto = dbClient.userDao().selectByLogin(dbSession, login);
 161       if (userDto == null || !userDto.isActive()) {
 162         // most probably user was deleted
 163         return login;
 164       }
 165       return StringUtils.defaultIfBlank(userDto.getName(), login);
 166     }
 167   }
 168
 169 }