The Unified and Autonomous Development Platform
fix issue #119: Send e-mails as HTML and plain text
Robin Shen83ccc2dee03d
diff --git a/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.java b/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.javaindex e63f97e020..902affb85c 100644--- a/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.java+++ b/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.java@@ -304,7 +304,7 @@ public class DefaultDataManager implements DataManager, Serializable {protected void notifyBackupError(Throwable e) {User root = userManager.getRoot();String url = settingManager.getSystemSetting().getServerUrl();- String body = String.format(""+ String htmlBody = String.format(""+ "OneDev url: <a href='%s'>%s</a>"+ "<p style='margin: 16px 0;'>"+ "<b>Error detail:</b>"@@ -312,7 +312,13 @@ public class DefaultDataManager implements DataManager, Serializable {+ "<p style='margin: 16px 0;'>"+ "-- Sent by OneDev",url, url, Throwables.getStackTraceAsString(e));- mailManager.sendMail(Lists.newArrayList(root.getEmail()), "OneDev database auto-backup failed", body);+ String textBody = String.format(""+ + "OneDev url: %s\n\n"+ + "Error detail:\n"+ + "%s",+ url, Throwables.getStackTraceAsString(e));+ mailManager.sendMail(Lists.newArrayList(root.getEmail()),+ "OneDev database auto-backup failed", htmlBody, textBody);}public Object writeReplace() throws ObjectStreamException {diff --git a/server-core/src/main/java/io/onedev/server/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/migration/DataMigrator.javaindex cb0da9b262..b2ba4b4e0d 100644--- a/server-core/src/main/java/io/onedev/server/migration/DataMigrator.java+++ b/server-core/src/main/java/io/onedev/server/migration/DataMigrator.java@@ -2000,4 +2000,20 @@ public class DataMigrator {dom.writeToFile(dataFile, false);}+ private void migrate41(File dataDir, Stack<Integer> versions) {+ for (File file: dataDir.listFiles()) {+ if (file.getName().startsWith("Settings.xml")) {+ VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);+ for (Element element: dom.getRootElement().elements()) {+ if (element.elementTextTrim("key").equals("MAIL")) {+ Element valueElement = element.element("value");+ if (valueElement != null)+ valueElement.addElement("sendAsHtml").setText("true");+ }+ }+ dom.writeToFile(file, false);+ }+ }+ }+}diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/MailSetting.java b/server-core/src/main/java/io/onedev/server/model/support/administration/MailSetting.javaindex d1685778df..77d8bb6826 100644--- a/server-core/src/main/java/io/onedev/server/model/support/administration/MailSetting.java+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/MailSetting.java@@ -18,6 +18,8 @@ public class MailSetting implements Serializable {private boolean enableStartTLS = true;+ private boolean sendAsHtml = true;+private String smtpUser;private String smtpPassword;@@ -56,6 +58,15 @@ public class MailSetting implements Serializable {this.enableStartTLS = enableStartTLS;}+ @Editable(order=260, description="If checked, mail will be sent in html format. Otherwise in plain text format")+ public boolean isSendAsHtml() {+ return sendAsHtml;+ }++ public void setSendAsHtml(boolean sendAsHtml) {+ this.sendAsHtml = sendAsHtml;+ }+@Editable(order=300, name="SMTP User", description="Optionally specify user name here if the SMTP host needs authentication")diff --git a/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.javaindex 5be4ab8194..dbbb9ac1d2 100644--- a/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.java@@ -69,8 +69,9 @@ public class BuildNotificationManager {build.getNumber(), build.getStatus().getDisplayName().toLowerCase());}String url = urlManager.urlFor(build);- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);- mailManager.sendMailAsync(emails, subject, body.toString());+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);+ mailManager.sendMailAsync(emails, subject, htmlBody, textBody);}@Sessionaldiff --git a/server-core/src/main/java/io/onedev/server/notification/CodeCommentNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/CodeCommentNotificationManager.javaindex f7d44a1cb9..c4b29f0378 100644--- a/server-core/src/main/java/io/onedev/server/notification/CodeCommentNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/CodeCommentNotificationManager.java@@ -59,9 +59,10 @@ public class CodeCommentNotificationManager {if (url != null) {String subject = String.format("You are mentioned in a code comment on file '%s'",event.getComment().getMarkPos().getPath());- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);- mailManager.sendMailAsync(Sets.newHashSet(user.getEmail()), subject, body);+ mailManager.sendMailAsync(Sets.newHashSet(user.getEmail()), subject, htmlBody, textBody);}}}diff --git a/server-core/src/main/java/io/onedev/server/notification/CommitNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/CommitNotificationManager.javaindex 928ef10122..54869b2841 100644--- a/server-core/src/main/java/io/onedev/server/notification/CommitNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/CommitNotificationManager.java@@ -88,8 +88,9 @@ public class CommitNotificationManager {if (commit != null) {String subject = String.format("Subscribed commit at ref '%s': %s", event.getRefName(), commit.getShortMessage());String url = urlManager.urlFor(project, commit);- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);- mailManager.sendMailAsync(notifyEmails, subject, body.toString());+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);+ mailManager.sendMailAsync(notifyEmails, subject, htmlBody, textBody);}}}diff --git a/server-core/src/main/java/io/onedev/server/notification/DefaultMailManager.java b/server-core/src/main/java/io/onedev/server/notification/DefaultMailManager.javaindex 8f84a94eca..c53ef9972a 100644--- a/server-core/src/main/java/io/onedev/server/notification/DefaultMailManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/DefaultMailManager.java@@ -9,8 +9,10 @@ import javax.inject.Inject;import javax.inject.Singleton;import org.apache.commons.codec.CharEncoding;+import org.apache.commons.mail.Email;import org.apache.commons.mail.EmailException;import org.apache.commons.mail.HtmlEmail;+import org.apache.commons.mail.SimpleEmail;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -41,7 +43,7 @@ public class DefaultMailManager implements MailManager {@Sessional@Override- public void sendMailAsync(Collection<String> toList, String subject, String body) {+ public void sendMailAsync(Collection<String> toList, String subject, String htmlBody, String textBody) {transactionManager.runAfterCommit(new Runnable() {@Override@@ -51,7 +53,7 @@ public class DefaultMailManager implements MailManager {@Overridepublic void run() {try {- sendMail(toList, subject, body);+ sendMail(toList, subject, htmlBody, textBody);} catch (Exception e) {logger.error("Error sending email (to: " + toList + ", subject: " + subject + ")", e);}@@ -64,7 +66,8 @@ public class DefaultMailManager implements MailManager {}@Override- public void sendMail(MailSetting mailSetting, Collection<String> toList, String subject, String body) {+ public void sendMail(MailSetting mailSetting, Collection<String> toList, String subject,+ String htmlBody, String textBody) {if (toList.isEmpty())return;@@ -72,7 +75,17 @@ public class DefaultMailManager implements MailManager {mailSetting = settingManager.getMailSetting();if (mailSetting != null) {- HtmlEmail email = new HtmlEmail();+ Email email;++ try {+ if (mailSetting.isSendAsHtml())+ email = new HtmlEmail().setHtmlMsg(htmlBody);+ else+ email = new SimpleEmail().setMsg(textBody);+ } catch (EmailException e) {+ throw new RuntimeException(e);+ }+email.setSocketConnectionTimeout(Bootstrap.SOCKET_CONNECT_TIMEOUT);if (mailSetting.getTimeout() != 0)@@ -106,7 +119,6 @@ public class DefaultMailManager implements MailManager {email.setCharset(CharEncoding.UTF_8);email.setSubject(subject);- email.setHtmlMsg(body);logger.debug("Sending email (to: {}, subject: {})... ", toList, subject);email.send();@@ -119,8 +131,8 @@ public class DefaultMailManager implements MailManager {}@Override- public void sendMail(Collection<String> toList, String subject, String body) {- sendMail(settingManager.getMailSetting(), toList, subject, body);+ public void sendMail(Collection<String> toList, String subject, String htmlBody, String textBody) {+ sendMail(settingManager.getMailSetting(), toList, subject, htmlBody, textBody);}}diff --git a/server-core/src/main/java/io/onedev/server/notification/IssueNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/IssueNotificationManager.javaindex 69c004ac39..3e333578bb 100644--- a/server-core/src/main/java/io/onedev/server/notification/IssueNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/IssueNotificationManager.java@@ -147,13 +147,14 @@ public class IssueNotificationManager {for (Map.Entry<String, Group> entry: newGroups.entrySet()) {String subject = String.format("You are now \"%s\" of issue %s", entry.getKey(), issue.describe());- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);Set<String> emails = entry.getValue().getMembers().stream().filter(it->!it.equals(user)).map(it->it.getEmail()).collect(Collectors.toSet());- mailManager.sendMailAsync(emails, subject, body.toString());+ mailManager.sendMailAsync(emails, subject, htmlBody, textBody);for (User member: entry.getValue().getMembers())issueWatchManager.watch(issue, member, true);@@ -162,13 +163,14 @@ public class IssueNotificationManager {}for (Map.Entry<String, Collection<User>> entry: newUsers.entrySet()) {String subject = String.format("You are now \"%s\" of issue %s", entry.getKey(), issue.describe());- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);Set<String> emails = entry.getValue().stream().filter(it->!it.equals(user)).map(it->it.getEmail()).collect(Collectors.toSet());- mailManager.sendMailAsync(emails, subject, body.toString());+ mailManager.sendMailAsync(emails, subject, htmlBody, textBody);for (User each: entry.getValue())issueWatchManager.watch(issue, each, true);@@ -185,9 +187,11 @@ public class IssueNotificationManager {User mentionedUser = userManager.findByName(userName);if (mentionedUser != null) {String subject = String.format("You are mentioned in issue %s", issue.describe());- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);- mailManager.sendMailAsync(Sets.newHashSet(mentionedUser.getEmail()), subject, body);+ mailManager.sendMailAsync(Sets.newHashSet(mentionedUser.getEmail()),+ subject, htmlBody, textBody);issueWatchManager.watch(issue, mentionedUser, true);notifiedUsers.add(mentionedUser);@@ -226,8 +230,11 @@ public class IssueNotificationManager {subject = String.format("%s %s", user.getDisplayName(), event.getActivity(true));elsesubject = event.getActivity(true);- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);- mailManager.sendMailAsync(usersToNotify.stream().map(User::getEmail).collect(Collectors.toList()), subject, body);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);++ mailManager.sendMailAsync(usersToNotify.stream().map(User::getEmail).collect(Collectors.toList()),+ subject, htmlBody, textBody);}}}diff --git a/server-core/src/main/java/io/onedev/server/notification/MailManager.java b/server-core/src/main/java/io/onedev/server/notification/MailManager.javaindex 413b493fa2..3dbe070f1b 100644--- a/server-core/src/main/java/io/onedev/server/notification/MailManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/MailManager.java@@ -6,10 +6,11 @@ import io.onedev.server.model.support.administration.MailSetting;public interface MailManager {- void sendMail(Collection<String> toList, String subject, String body);+ void sendMail(Collection<String> toList, String subject, String htmlBody, String textBody);- void sendMail(MailSetting mailSetting, Collection<String> toList, String subject, String body);+ void sendMail(MailSetting mailSetting, Collection<String> toList, String subject,+ String htmlBody, String textBody);- void sendMailAsync(Collection<String> toList, String subject, String body);+ void sendMailAsync(Collection<String> toList, String subject, String htmlBody, String textBody);}diff --git a/server-core/src/main/java/io/onedev/server/notification/PullRequestNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/PullRequestNotificationManager.javaindex 5dd7449040..005fe08410 100644--- a/server-core/src/main/java/io/onedev/server/notification/PullRequestNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/PullRequestNotificationManager.java@@ -193,8 +193,9 @@ public class PullRequestNotificationManager {else if (changeData instanceof PullRequestDiscardData)subject = String.format(user.getDisplayName() + " discarded pull request %s", request.describe());if (subject != null) {- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);- mailManager.sendMailAsync(Lists.newArrayList(request.getSubmitter().getEmail()), subject, body);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);+ mailManager.sendMailAsync(Lists.newArrayList(request.getSubmitter().getEmail()), subject, htmlBody, textBody);notifiedUsers.add(request.getSubmitter());}}@@ -211,9 +212,10 @@ public class PullRequestNotificationManager {pullRequestWatchManager.watch(request, mentionedUser, true);String subject = String.format("You are mentioned in pull request %s", request.describe());- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);- mailManager.sendMailAsync(Sets.newHashSet(mentionedUser.getEmail()), subject, body);+ mailManager.sendMailAsync(Sets.newHashSet(mentionedUser.getEmail()), subject, htmlBody, textBody);notifiedUsers.add(mentionedUser);}@@ -256,8 +258,10 @@ public class PullRequestNotificationManager {subject = String.format("%s added commits to pull request %s", committer.getDisplayName(), request.describe());elsesubject = event.getActivity(true);- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);- mailManager.sendMailAsync(usersToNotify.stream().map(User::getEmail).collect(Collectors.toList()), subject, body);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url);+ mailManager.sendMailAsync(usersToNotify.stream().map(User::getEmail).collect(Collectors.toList()),+ subject, htmlBody, textBody);}}}@@ -266,8 +270,9 @@ public class PullRequestNotificationManager {PullRequest request = review.getRequest();String url = urlManager.urlFor(request);String subject = String.format("You are invited to review pull request %s", request.describe());- String body = String.format("Visit <a href='%s'>%s</a> for details", url, url);- mailManager.sendMailAsync(Lists.newArrayList(review.getUser().getEmail()), subject, body);+ String htmlBody = String.format("Visit <a href='%s'>%s</a> for details", url, url);+ String textBody = String.format("Visit %s for details", url, url);+ mailManager.sendMailAsync(Lists.newArrayList(review.getUser().getEmail()), subject, htmlBody, textBody);}@Transactionaldiff --git a/server-core/src/main/java/io/onedev/server/web/page/admin/mailsetting/MailSettingPage.java b/server-core/src/main/java/io/onedev/server/web/page/admin/mailsetting/MailSettingPage.javaindex d1195a7064..ad4a0b89c2 100644--- a/server-core/src/main/java/io/onedev/server/web/page/admin/mailsetting/MailSettingPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/admin/mailsetting/MailSettingPage.java@@ -67,9 +67,10 @@ public class MailSettingPage extends AdministrationPage {@Overrideprotected String runTask(JobLogger logger) {User user = SecurityUtils.getUser();++ String body = "Great, your mail setting is working!";OneDev.getInstance(MailManager.class).sendMail(mailSettingHolder.getMailSetting(),- Sets.newHashSet(user.getEmail()),- "Test email from OneDev", "Great, your mail setting is working!");+ Sets.newHashSet(user.getEmail()), "Test email from OneDev", body, body);return "Test mail has been sent to " + user.getEmail() + ", please check your mail box";}diff --git a/server-core/src/main/java/io/onedev/server/web/page/security/ForgetPage.java b/server-core/src/main/java/io/onedev/server/web/page/security/ForgetPage.javaindex 44da535c2b..5bbb80fa93 100644--- a/server-core/src/main/java/io/onedev/server/web/page/security/ForgetPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/security/ForgetPage.java@@ -58,17 +58,24 @@ public class ForgetPage extends BasePage {userManager.save(user);MailManager mailManager = OneDev.getInstance(MailManager.class);- String mailBody = String.format("Dear %s, "++ String serverUrl = settingManager.getSystemSetting().getServerUrl();++ String htmlBody = String.format("Dear %s, "+ "<p style='margin: 16px 0;'>"- + "Per your request, password of your user \"%s\" has been reset to:<br>"+ + "Per your request, password of your login \"%s\" at <a href=\"%s\">%s</a> has been reset to:<br>"+ "%s<br><br>"- + "Please login and change the password in your earliest convenience."- + "<p style='margin: 16px 0;'>"- + "-- Sent by OneDev",- user.getDisplayName(), user.getName(), password);+ + "Please login and change the password in your earliest convenience.",+ user.getDisplayName(), user.getName(), serverUrl, serverUrl, password);+ String textBody = String.format("Dear %s,\n\n"+ + "Per your request, password of your login \"%s\" at %s has been reset to:\n"+ + "%s\n\n"+ + "Please login and change the password in your earliest convenience.",+ user.getDisplayName(), user.getName(), serverUrl, password);+mailManager.sendMail(settingManager.getMailSetting(), Arrays.asList(user.getEmail()),- "Your OneDev password has been reset", mailBody);+ "Your OneDev password has been reset", htmlBody, textBody);return "Please check your email " + user.getEmail() + " for the reset password";} else {throw new OneException("Unable to send password reset email as smtp setting is not defined");