edu.stanford.protege.webprotege.mail.MailPropertiesProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-service Show documentation
The newest version!
package edu.stanford.protege.webprotege.mail;

import edu.stanford.protege.webprotege.filemanager.ConfigInputStreamSupplier;
import edu.stanford.protege.webprotege.init.WebProtegeConfigurationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nonnull;
import javax.inject.Inject;
import javax.inject.Provider;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.util.Properties;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Matthew Horridge
 * Stanford Center for Biomedical Informatics Research
 * 06/02/15
 */
public class MailPropertiesProvider implements Provider {

    public static final String MAIL_PROPERTIES_FILE_NAME = "mail.properties";

    public static final String MAIL_PROPERTIES_PREFIX = "mail.smtp";

    public static final String MAIL_SMTP_USER_MISSING_MESSAGE = "Mail properties are not configured correctly.  The mail.smtp.auth has been specified, which means that authentication will be used to send emails, but the mail.smtp.user property has not been specified.  Please specify a user name for the smtp mail webprotege by using this property.  Mail properties may be specified using a mail.properties file placed in the root directory of the WebProtégé web-app directory.";

    public static final String MAIL_SMTP_PASSWORD_MISSING_MESSAGE = "Mail properties are not configured correctly.  The mail.smtp.auth has been specified, which means that authentication will be used to send emails, but the mail.smtp.password property has not been specified.  Please specify a password for the smtp mail webprotege by using this property.  Mail properties may be specified using a mail.properties file placed in the root directory of the WebProtégé web-app directory.";

    private static final Logger logger = LoggerFactory.getLogger(MailPropertiesProvider.class);

    @Nonnull
    private final ConfigInputStreamSupplier configInputStreamSupplier;

    @Inject
    public MailPropertiesProvider(@Nonnull ConfigInputStreamSupplier configInputStreamSupplier) {
        this.configInputStreamSupplier = checkNotNull(configInputStreamSupplier);
    }

    @Override
    public Properties get() {
        return getProperties();
    }


    private Properties getProperties() {
        Properties mailProperties = new Properties(System.getProperties());
        try (BufferedInputStream bufferedInputStream = createBufferedInputStream()) {
            mailProperties.load(bufferedInputStream);
            bufferedInputStream.close();
        } catch (IOException e) {
            throw new WebProtegeConfigurationException("Could not read mail.properties. Message: " + e.getMessage());
        }
        overridePropertiesWithSystemProperties(mailProperties);
        if ("true".equals(mailProperties.getProperty(SendMailImpl.MAIL_SMTP_AUTH))) {
            if (mailProperties.getProperty(SendMailImpl.MAIL_SMTP_USER) == null) {
                throw new WebProtegeConfigurationException(MAIL_SMTP_USER_MISSING_MESSAGE);
            }
            if (mailProperties.getProperty(SendMailImpl.MAIL_SMTP_PASSWORD) == null) {
                throw new WebProtegeConfigurationException(MAIL_SMTP_PASSWORD_MISSING_MESSAGE);
            }
        }
        return mailProperties;
    }

    private BufferedInputStream createBufferedInputStream() throws IOException {
        return configInputStreamSupplier.getConfigFileInputStream(MAIL_PROPERTIES_FILE_NAME);
    }

    /**
     * Overrides any property values in the specified {@link Properties} object with property values that are specified
     * via the command line (with a -D argument) or via environment variables.
     *
     * @param properties The properties object whose property values should be replaced.  Not {@code null}.
     */
    private void overridePropertiesWithSystemProperties(Properties properties) {
        checkNotNull(properties);
        Properties systemProperties = getSystemProperties();
        for (String systemPropertyName : systemProperties.stringPropertyNames()) {
            if (systemPropertyName.startsWith(MAIL_PROPERTIES_PREFIX)) {
                String propertyValue = systemProperties.getProperty(systemPropertyName);
                properties.setProperty(systemPropertyName, propertyValue);
            }
        }
    }

    private Properties getSystemProperties() {
        try {
            return System.getProperties();
        } catch (SecurityException e) {
            System.err.println("A security exception was thrown while asking for the system properties: "
                                       + e.getMessage());
            return new Properties();
        }
    }
}