MailUtil.java

/*
 * Copyright Siemens AG, 2016. Part of the SW360 Portal Project.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
 package org.eclipse.sw360.mail;

import org.eclipse.sw360.datahandler.common.CommonUtils;
import org.eclipse.sw360.datahandler.thrift.ThriftClients;
import org.eclipse.sw360.datahandler.thrift.users.User;
import org.apache.log4j.Logger;
import org.apache.thrift.TException;

import javax.mail.*;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import java.util.Properties;
import java.util.Set;

/**
 * Provides the possiblity to send mail from SW360
 *
 * @author birgit.heydenreich@tngtech.com
 */
public class MailUtil {

    private static final Logger log = Logger.getLogger(MailUtil.class);

    private Properties loadedProperties;
    private Session session;

    private String from;
    private String host;
    private String port;
    private String isAuthenticationNecessary;
    private String enableStarttls;
    private String login;
    private String password;
    private String enableSsl;
    private String enableDebug;
    private String supportMailAddress;


    public MailUtil() {
        loadedProperties = CommonUtils.loadProperties(MailUtil.class, MailConstants.MAIL_PROPERTIES_FILE_PATH);
        setBasicProperties();
        setSession();
    }

    private void setBasicProperties() {
        from = loadedProperties.getProperty("MailUtil_from", "");
        host = loadedProperties.getProperty("MailUtil_host", "");
        port = loadedProperties.getProperty("MailUtil_port", "25");
        enableStarttls = loadedProperties.getProperty("MailUtil_enableStarttls", "false");
        enableSsl = loadedProperties.getProperty("MailUtil_enableSsl", "false");
        isAuthenticationNecessary = loadedProperties.getProperty("MailUtil_isAuthenticationNecessary", "true");
        login = loadedProperties.getProperty("MailUtil_login", "");
        password = loadedProperties.getProperty("MailUtil_password", "");
        enableDebug = loadedProperties.getProperty("MailUtil_enableDebug", "false");
        supportMailAddress = loadedProperties.getProperty("MailUtil_supportMailAddress","");
    }

    private void setSession() {
        // Get system properties
        Properties properties = System.getProperties();

        // Setup mail server
        properties.setProperty("mail.transport.protocol", "smtp");
        properties.setProperty("mail.smtp.host", host);
        properties.setProperty("mail.smtp.port", port);
        properties.setProperty("mail.smtp.auth", isAuthenticationNecessary);
        properties.setProperty("mail.smtp.starttls.enable", enableStarttls);
        properties.setProperty("mail.smtp.ssl.enable", enableSsl);

        properties.setProperty("mail.debug", enableDebug);

        if (!"false".equals(isAuthenticationNecessary)) {
            Authenticator auth = new SMTPAuthenticator(login, password);
            session = Session.getInstance(properties, auth);
        } else {
            session = Session.getDefaultInstance(properties);
        }
    }

    public void sendMail(String recipient, String subjectNameInPropertiesFile, String textNameInPropertiesFile, boolean checkWantsNotifications) {
        if (isMailingEnabledAndValid() && (!checkWantsNotifications || isMailWantedBy(recipient))) {
            MimeMessage messageWithSubjectAndText = makeMessageWithSubjectAndText(subjectNameInPropertiesFile, textNameInPropertiesFile);
            sendMailWithSubjectAndText(recipient, messageWithSubjectAndText);
        }
    }

    public void sendMail(Set<String> recipients, String subjectNameInPropertiesFile, String textNameInPropertiesFile) {
        if (isMailingEnabledAndValid()) {
            MimeMessage messageWithSubjectAndText = makeMessageWithSubjectAndText(subjectNameInPropertiesFile, textNameInPropertiesFile);
            for (String recipient : recipients) {
                if(isMailWantedBy(recipient)) {
                    sendMailWithSubjectAndText(recipient, messageWithSubjectAndText);
                }
            }
        }
    }

    private boolean isMailWantedBy(String userEmail){
        User user;
        try {
            user = (new ThriftClients()).makeUserClient().getByEmail(userEmail);
        } catch (TException e){
            log.info("Problem fetching user:" + e);
            return false;
        }
        if(user != null) {
            if(!user.isSetWantsMailNotification()) {
                return true;
            }
            return user.wantsMailNotification;
        }
        return false;
    }

    private boolean isMailingEnabledAndValid() {
        if ("".equals(host)) {
            return false; //e-mailing is disabled
        }
        if (!"false".equals(isAuthenticationNecessary) && "".equals(login)) {
            log.error("Cannot send emails: authentication necessary, but login is not set.");
            return false;
        }
        return true;

    }

    private MimeMessage makeMessageWithSubjectAndText(String subjectKeyInPropertiesFile, String textKeyInPropertiesFile) {
        MimeMessage message = new MimeMessage(session);
        String subject = loadedProperties.getProperty(subjectKeyInPropertiesFile, "");

        StringBuffer text = new StringBuffer();
        text.append(loadedProperties.getProperty("defaultBegin", ""));
        text.append(loadedProperties.getProperty(textKeyInPropertiesFile, ""));
        text.append(loadedProperties.getProperty("defaultEnd", ""));
        if (!supportMailAddress.equals("")) {
            text.append(loadedProperties.getProperty("unsubscribeNoticeBefore", ""));
            text.append(" ");
            text.append(supportMailAddress);
            text.append(loadedProperties.getProperty("unsubscribeNoticeAfter", ""));
        }
        try {
            message.setSubject(subject);
            message.setText(text.toString());
        } catch (MessagingException mex) {
            log.error(mex.getMessage());
        }

        return message;
    }

    private void sendMailWithSubjectAndText(String recipient, MimeMessage message) {
        try {
            message.setFrom(new InternetAddress(from));
            message.addRecipient(Message.RecipientType.TO, new InternetAddress(recipient));

            Transport.send(message);

            log.info("Sent message successfully to user "+recipient+".");

        } catch (MessagingException mex) {
            log.error(mex.getMessage(), mex);
        }
    }

    private class SMTPAuthenticator extends Authenticator {
        private PasswordAuthentication authentication;

        public SMTPAuthenticator(String login, String password) {
            authentication = new PasswordAuthentication(login, password);
        }

        @Override
        protected PasswordAuthentication getPasswordAuthentication() {
            return authentication;
        }
    }
}