feat: move smtp settings to .env

l3s-learnweb · Sep 16, 2024 · 3ac9faf · 3ac9faf
1 parent b9696f8
commit 3ac9faf
Show file tree

Hide file tree

Showing 19 changed files with 293 additions and 190 deletions.
diff --git a/src/main/java/de/l3s/learnweb/app/ConfigProvider.java b/src/main/java/de/l3s/learnweb/app/ConfigProvider.java
@@ -234,6 +234,10 @@ public boolean getPropertyBoolean(final String key) {
         return "true".equalsIgnoreCase(properties.getProperty(key));
     }
 
+    public boolean getPropertyBoolean(final String key, final String defaultValue) {
+        return "true".equalsIgnoreCase(properties.getProperty(key, defaultValue));
+    }
+
     public String getEnvironment() {
         if (environment == null) {
             if (!isDevelopment()) {

diff --git a/src/main/java/de/l3s/learnweb/beans/admin/AdminNotificationBean.java b/src/main/java/de/l3s/learnweb/beans/admin/AdminNotificationBean.java
@@ -24,6 +24,7 @@
 import de.l3s.learnweb.user.UserDao;
 import de.l3s.mail.Mail;
 import de.l3s.mail.MailFactory;
+import de.l3s.mail.MailService;
 import de.l3s.util.bean.BeanHelper;
 
 @Named
@@ -48,6 +49,9 @@ public class AdminNotificationBean extends ApplicationBean {
     @Inject
     private MessageDao messageDao;
 
+    @Inject
+    private MailService mailService;
+
     @PostConstruct
     public void init() {
         user = getUser();
@@ -108,8 +112,8 @@ private void sendMail(final ArrayList<String> recipients) {
         try {
             mail = MailFactory.buildNotificationEmail(title, text, user.getUsername()).build(user.getLocale());
             mail.setReplyTo(user.getEmail());
-            mail.setBccRecipients(recipients);
-            mail.send();
+            mail.setRecipientsBcc(recipients);
+            mailService.send(mail);
 
             addMessage(FacesMessage.SEVERITY_INFO, recipients.size() + " emails send");
         } catch (Exception e) {

diff --git a/src/main/java/de/l3s/learnweb/beans/publicPages/ContactBean.java b/src/main/java/de/l3s/learnweb/beans/publicPages/ContactBean.java
@@ -5,6 +5,7 @@
 
 import jakarta.annotation.PostConstruct;
 import jakarta.enterprise.context.RequestScoped;
+import jakarta.inject.Inject;
 import jakarta.inject.Named;
 import jakarta.mail.MessagingException;
 import jakarta.validation.constraints.Email;
@@ -15,6 +16,7 @@
 import de.l3s.learnweb.user.User;
 import de.l3s.mail.Mail;
 import de.l3s.mail.MailFactory;
+import de.l3s.mail.MailService;
 
 @Named
 @RequestScoped
@@ -32,6 +34,9 @@ public class ContactBean extends ApplicationBean implements Serializable {
     @NotBlank
     private String message;
 
+    @Inject
+    private MailService mailService;
+
     @PostConstruct
     public void init() {
         User user = getUser();
@@ -45,9 +50,9 @@ public void init() {
     public void sendMail() {
         try {
             Mail mail = MailFactory.buildContactFormEmail(name, email, message).build(getLocale());
-            mail.setRecipient(config().getSupportEmail());
+            mail.addRecipient(config().getSupportEmail());
             mail.setReplyTo(email);
-            mail.send();
+            mailService.send(mail);
 
             clearForm();
         } catch (MessagingException e) {

diff --git a/src/main/java/de/l3s/learnweb/forum/ForumNotificator.java b/src/main/java/de/l3s/learnweb/forum/ForumNotificator.java
@@ -20,6 +20,7 @@
 import de.l3s.learnweb.user.UserDao;
 import de.l3s.mail.Mail;
 import de.l3s.mail.MailFactory;
+import de.l3s.mail.MailService;
 import de.l3s.util.HashHelper;
 
 public class ForumNotificator implements Runnable, Serializable {
@@ -33,6 +34,9 @@ public class ForumNotificator implements Runnable, Serializable {
     @Inject
     private ForumTopicDao forumTopicDao;
 
+    @Inject
+    private MailService mailService;
+
     @Override
     public void run() {
         try {
@@ -68,8 +72,8 @@ private void sendMailWithNewTopics(User user, List<ForumTopic> topics) throws Me
         List<ForumTopic> otherTopics = topics.stream().filter(topic -> topic.getUserId() != user.getId()).toList();
 
         Mail mail = MailFactory.buildForumNotificationEmail(user.getUsername(), userTopics, otherTopics, getHash(user)).build(user.getLocale());
-        mail.setRecipient(user.getEmail());
-        mail.send();
+        mail.addRecipient(user.getEmail());
+        mailService.send(mail);
     }
 
     public static String getHash(User user) {

diff --git a/src/main/java/de/l3s/learnweb/user/ConfirmRequiredBean.java b/src/main/java/de/l3s/learnweb/user/ConfirmRequiredBean.java
@@ -27,6 +27,9 @@ public class ConfirmRequiredBean extends ApplicationBean implements Serializable
     @Inject
     private UserDao userDao;
 
+    @Inject
+    private EmailConfirmationBean emailConfirmationBean;
+
     @Override
     public User getUser() {
         if (super.getUser() != null) {
@@ -47,7 +50,7 @@ public void onSubmitNewEmail() {
             userDao.save(user);
         }
 
-        if (user.sendEmailConfirmation()) {
+        if (emailConfirmationBean.sendEmailConfirmation(user)) {
             addMessage(FacesMessage.SEVERITY_INFO, "email_has_been_sent");
         } else {
             addMessage(FacesMessage.SEVERITY_FATAL, "We were not able to send a confirmation mail");

diff --git a/src/main/java/de/l3s/learnweb/user/EmailConfirmationBean.java b/src/main/java/de/l3s/learnweb/user/EmailConfirmationBean.java
@@ -0,0 +1,53 @@
+package de.l3s.learnweb.user;
+
+import java.io.Serial;
+import java.io.Serializable;
+import java.time.LocalDateTime;
+
+import jakarta.enterprise.context.RequestScoped;
+import jakarta.inject.Inject;
+import jakarta.mail.MessagingException;
+
+import org.apache.commons.lang3.RandomStringUtils;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+import de.l3s.learnweb.app.Learnweb;
+import de.l3s.mail.Mail;
+import de.l3s.mail.MailFactory;
+import de.l3s.mail.MailService;
+import de.l3s.util.StringHelper;
+
+@RequestScoped
+public class EmailConfirmationBean implements Serializable {
+    @Serial
+    private static final long serialVersionUID = -1427221214029851844L;
+    private static final Logger log = LogManager.getLogger(EmailConfirmationBean.class);
+
+    @Inject
+    private TokenDao tokenDao;
+
+    @Inject
+    private MailService mailService;
+
+    /**
+     * @return FALSE if an error occurred while sending this message
+     */
+    public boolean sendEmailConfirmation(User user) {
+        try {
+            String token = RandomStringUtils.secure().nextAlphanumeric(32);
+            int tokenId = tokenDao.override(user.getId(), Token.TokenType.EMAIL_CONFIRMATION, token, LocalDateTime.now().plusYears(1));
+
+            String confirmEmailUrl = Learnweb.config().getServerUrl() + "/lw/user/confirm_email.jsf?" +
+                "email=" + StringHelper.urlEncode(user.getEmail()) + "&token=" + tokenId + ":" + token;
+
+            Mail mail = MailFactory.buildConfirmEmail(user.getUsername(), confirmEmailUrl).build(user.getLocale());
+            mail.addRecipient(user.getEmail());
+            mailService.send(mail);
+            return true;
+        } catch (MessagingException e) {
+            log.error("Can't send confirmation mail to {}", this, e);
+        }
+        return false;
+    }
+}
diff --git a/src/main/java/de/l3s/learnweb/user/PasswordBean.java b/src/main/java/de/l3s/learnweb/user/PasswordBean.java
@@ -19,6 +19,7 @@
 import de.l3s.learnweb.exceptions.HttpException;
 import de.l3s.mail.Mail;
 import de.l3s.mail.MailFactory;
+import de.l3s.mail.MailService;
 import de.l3s.util.HashHelper;
 
 @Named
@@ -32,6 +33,9 @@ public class PasswordBean extends ApplicationBean implements Serializable {
     @Inject
     private TokenDao tokenDao;
 
+    @Inject
+    private MailService mailService;
+
     public void submit() {
         try {
             List<User> users = new ArrayList<>();
@@ -50,8 +54,8 @@ public void submit() {
                 String link = url + tokenId + ":" + token;
 
                 Mail mail = MailFactory.buildPasswordChangeEmail(user.getDisplayName(), user.getEmail(), link).build(user.getLocale());
-                mail.setRecipient(user.getEmail());
-                mail.send();
+                mail.addRecipient(user.getEmail());
+                mailService.send(mail);
             }
 
             addMessage(FacesMessage.SEVERITY_INFO, "email_has_been_sent");

diff --git a/src/main/java/de/l3s/learnweb/user/ProfileBean.java b/src/main/java/de/l3s/learnweb/user/ProfileBean.java
@@ -76,6 +76,9 @@ public class ProfileBean extends ApplicationBean implements Serializable {
     @Inject
     private GroupDao groupDao;
 
+    @Inject
+    private EmailConfirmationBean emailConfirmationBean;
+
     public void onLoad() {
         User loggedInUser = getUser();
         BeanAssert.authorized(loggedInUser);
@@ -142,7 +145,7 @@ public void onSaveProfile() {
         if (StringUtils.isNotEmpty(email) && !StringUtils.equals(selectedUser.getEmail(), email)) {
             selectedUser.setEmail(email);
 
-            if (selectedUser.sendEmailConfirmation()) {
+            if (emailConfirmationBean.sendEmailConfirmation(selectedUser)) {
                 addMessage(FacesMessage.SEVERITY_INFO, "email_has_been_sent");
             } else {
                 addMessage(FacesMessage.SEVERITY_FATAL, "We were not able to send a confirmation mail");

diff --git a/src/main/java/de/l3s/learnweb/user/RegistrationBean.java b/src/main/java/de/l3s/learnweb/user/RegistrationBean.java
@@ -79,6 +79,9 @@ public class RegistrationBean extends ApplicationBean implements Serializable {
     @Inject
     private ConfirmRequiredBean confirmRequiredBean;
 
+    @Inject
+    private EmailConfirmationBean emailConfirmationBean;
+
     public String onLoad() {
         if (StringUtils.isNotEmpty(wizard)) {
             course = courseDao.findByWizard(wizard).orElseThrow(() -> new BadRequestHttpException("register_invalid_wizard_error"));
@@ -178,7 +181,7 @@ public String register() {
         }
 
         if ((mailRequired || StringUtils.isNotEmpty(email)) && !user.isEmailConfirmed()) {
-            user.sendEmailConfirmation();
+            emailConfirmationBean.sendEmailConfirmation(user);
 
             if (mailRequired) {
                 confirmRequiredBean.setLoggedInUser(user);

diff --git a/src/main/java/de/l3s/learnweb/user/User.java b/src/main/java/de/l3s/learnweb/user/User.java
@@ -14,12 +14,10 @@
 import java.util.Objects;
 import java.util.Optional;
 
-import jakarta.mail.MessagingException;
 import jakarta.validation.constraints.Email;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Size;
 
-import org.apache.commons.lang3.RandomStringUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -34,13 +32,10 @@
 import de.l3s.learnweb.resource.Resource;
 import de.l3s.learnweb.resource.Tag;
 import de.l3s.learnweb.user.Organisation.Option;
-import de.l3s.mail.Mail;
-import de.l3s.mail.MailFactory;
 import de.l3s.util.Deletable;
 import de.l3s.util.HasId;
 import de.l3s.util.PBKDF2;
 import de.l3s.util.ProfileImageHelper;
-import de.l3s.util.StringHelper;
 
 public class User implements Comparable<User>, Deletable, HasId, Serializable {
     private static final Logger log = LogManager.getLogger(User.class);
@@ -393,27 +388,6 @@ public int compareTo(User o) {
         return getUsername().compareTo(o.getUsername());
     }
 
-    /**
-     * @return FALSE if an error occurred while sending this message
-     */
-    public boolean sendEmailConfirmation() {
-        try {
-            String token = RandomStringUtils.secure().nextAlphanumeric(32);
-            int tokenId = Learnweb.dao().getTokenDao().override(id, Token.TokenType.EMAIL_CONFIRMATION, token, LocalDateTime.now().plusYears(1));
-
-            String confirmEmailUrl = Learnweb.config().getServerUrl() + "/lw/user/confirm_email.jsf?" +
-                "email=" + StringHelper.urlEncode(getEmail()) + "&token=" + tokenId + ":" + token;
-
-            Mail mail = MailFactory.buildConfirmEmail(getUsername(), confirmEmailUrl).build(getLocale());
-            mail.setRecipient(getEmail());
-            mail.send();
-            return true;
-        } catch (MessagingException e) {
-            log.error("Can't send confirmation mail to {}", this, e);
-        }
-        return false;
-    }
-
     public boolean isAdmin() {
         return admin;
     }

diff --git a/src/main/java/de/l3s/learnweb/web/BounceManager.java b/src/main/java/de/l3s/learnweb/web/BounceManager.java
@@ -9,15 +9,18 @@
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.Properties;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 import jakarta.enterprise.context.Dependent;
 import jakarta.inject.Inject;
+import jakarta.mail.Authenticator;
 import jakarta.mail.Flags;
 import jakarta.mail.Folder;
 import jakarta.mail.Message;
 import jakarta.mail.MessagingException;
+import jakarta.mail.Session;
 import jakarta.mail.Store;
 import jakarta.mail.search.ComparisonTerm;
 import jakarta.mail.search.ReceivedDateTerm;
@@ -26,7 +29,8 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
-import de.l3s.mail.Mail;
+import de.l3s.learnweb.app.ConfigProvider;
+import de.l3s.mail.PasswordAuthenticator;
 
 /**
  * Parses the mailbox every sometime and detects whether bounces are present. Bounced emails are
@@ -45,8 +49,26 @@ public class BounceManager {
     @Inject
     private BounceDao bounceDao;
 
+    @Inject
+    private ConfigProvider config;
+
     public Store getStore() throws MessagingException {
-        return Mail.createSession().getStore("imap");
+        Properties props = new Properties();
+        // props.setProperty("mail.debug", "true");
+        props.setProperty("mail.imap.host", config.getProperty("MAIL_IMAP_HOST", config.getProperty("MAIL_SMTP_HOST")));
+        props.setProperty("mail.imap.port", config.getProperty("MAIL_IMAP_PORT", "143"));
+        props.setProperty("mail.imap.socketFactory.port", config.getProperty("MAIL_IMAP_PORT", "143"));
+        props.setProperty("mail.imap.socketFactory.class", "javax.net.ssl.SSLSocketFactory");
+        props.setProperty("mail.imap.auth", "true");
+        if (config.getPropertyBoolean("MAIL_IMAP_STARTTLS", "true")) {
+            props.setProperty("mail.imap.starttls.enable", "true");
+        }
+
+        final Authenticator authenticator = new PasswordAuthenticator(
+            config.getProperty("MAIL_IMAP_USERNAME", config.getProperty("MAIL_SMTP_USERNAME")),
+            config.getProperty("MAIL_IMAP_PASSWORD", config.getProperty("MAIL_SMTP_PASSWORD"))
+        );
+        return Session.getInstance(props, authenticator).getStore("imap");
     }
 
     public void parseInbox() throws MessagingException, IOException {
@@ -102,7 +124,7 @@ private String getText(Message msg) throws MessagingException, IOException {
      * @param msg Message to be examined
      */
     private boolean parseMessage(Message msg) throws MessagingException, IOException {
-        //Return path is checked first, since in bounce messages those are usually empty or contain just "<>"
+        // Return path is checked first, since in bounce messages those are usually empty or contain just "<>"
         String[] returnPaths = msg.getHeader("Return-Path");
 
         if (returnPaths != null && returnPaths.length > 0 && returnPaths[0].length() > 3) {
@@ -111,7 +133,7 @@ private boolean parseMessage(Message msg) throws MessagingException, IOException
 
         log.debug("BOUNCE: {} {}", msg.getSubject(), msg.getReceivedDate());
 
-        //Checks the status code
+        // Checks the status code
         String text = getText(msg);
         Matcher matcherCode = STATUS_CODE_PATTERN.matcher(text);
 
@@ -133,7 +155,7 @@ private boolean parseMessage(Message msg) throws MessagingException, IOException
             originalRecipient = matcherRecipient.group(2);
         }
 
-        //Adds message to database
+        // Adds message to database
         bounceDao.save(originalRecipient, msg.getReceivedDate().toInstant(), code, description);
         return true;
     }
@@ -148,7 +170,7 @@ private String getErrorDescription(String errCode) {
 
         String[] codes = errCode.split("\\.", 2);
 
-        //Transient or permanent
+        // Transient or permanent
         if ("4".equals(codes[0])) {
             description = "Transient Persistent Failure: ";
         } else if ("5".equals(codes[0])) {