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.qualityprofile;
  21
  22 import java.io.UnsupportedEncodingException;
  23 import java.net.URLEncoder;
  24 import java.util.Comparator;
  25 import java.util.Date;
  26 import org.sonar.api.notifications.Notification;
  27 import org.sonar.api.platform.Server;
  28 import org.sonar.plugins.emailnotifications.api.EmailMessage;
  29 import org.sonar.plugins.emailnotifications.api.EmailTemplate;
  30
  31 import static java.nio.charset.StandardCharsets.UTF_8;
  32 import static org.sonar.api.utils.DateUtils.formatDate;
  33 import static org.sonar.server.qualityprofile.BuiltInQualityProfilesNotification.Profile;
  34 import static org.sonar.server.qualityprofile.BuiltInQualityProfilesNotification.parse;
  35 import static org.sonar.server.qualityprofile.BuiltInQualityProfilesUpdateListener.BUILT_IN_QUALITY_PROFILES;
  36
  37 public class BuiltInQualityProfilesNotificationTemplate extends EmailTemplate {
  38
  39   private final Server server;
  40
  41   public BuiltInQualityProfilesNotificationTemplate(Server server) {
  42     this.server = server;
  43   }
  44
  45   @Override
  46   public EmailMessage format(Notification notification) {
  47     if (!BUILT_IN_QUALITY_PROFILES.equals(notification.getType())) {
  48       return null;
  49     }
  50
  51     BuiltInQualityProfilesNotification profilesNotification = parse(notification);
  52
  53     StringBuilder message = new StringBuilder("Built-in quality profiles have been updated:\n");
  54     profilesNotification.getProfiles().stream()
  55       .sorted(Comparator.comparing(Profile::getLanguageName).thenComparing(Profile::getProfileName))
  56       .forEach(profile -> {
  57         message.append("\"")
  58           .append(profile.getProfileName())
  59           .append("\" - ")
  60           .append(profile.getLanguageName())
  61           .append(": ")
  62           .append(server.getPublicRootUrl()).append("/profiles/changelog?language=")
  63           .append(profile.getLanguageKey())
  64           .append("&name=")
  65           .append(encode(profile.getProfileName()))
  66           .append("&since=")
  67           .append(formatDate(new Date(profile.getStartDate())))
  68           .append("&to=")
  69           .append(formatDate(new Date(profile.getEndDate())))
  70           .append("\n");
  71         int newRules = profile.getNewRules();
  72         if (newRules > 0) {
  73           message.append(" ").append(newRules).append(" new rules\n");
  74         }
  75         int updatedRules = profile.getUpdatedRules();
  76         if (updatedRules > 0) {
  77           message.append(" ").append(updatedRules).append(" rules have been updated\n");
  78         }
  79         int removedRules = profile.getRemovedRules();
  80         if (removedRules > 0) {
  81           message.append(" ").append(removedRules).append(" rules removed\n");
  82         }
  83       });
  84
  85     message.append("This is a good time to review your quality profiles and update them to benefit from the latest evolutions: ");
  86     message.append(server.getPublicRootUrl()).append("/profiles");
  87
  88     // And finally return the email that will be sent
  89     return new EmailMessage()
  90       .setMessageId(BUILT_IN_QUALITY_PROFILES)
  91       .setSubject("Built-in quality profiles have been updated")
  92       .setMessage(message.toString());
  93   }
  94
  95   public String encode(String text) {
  96     try {
  97       return URLEncoder.encode(text, UTF_8.name());
  98     } catch (UnsupportedEncodingException e) {
  99       throw new IllegalStateException(String.format("Cannot encode %s", text), e);
 100     }
 101   }
 102 }