ste.xtest.mail.FileTransport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xtest Show documentation
A TDD framework to make coding drven by specifications easier
There is a newer version: 3.8.2
/*
 * xTest
 * Copyright (C) 2015 Stefano Fornari
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY Stefano Fornari, Stefano Fornari
 * DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 */
package ste.xtest.mail;

import javax.mail.*;
import java.io.FileOutputStream;
import java.io.IOException;
import org.apache.commons.lang3.StringUtils;

/**
 *
 * @author ste
 */
public class FileTransport extends Transport {
    
    private PasswordAuthentication auth;
    
    public static final String MAIL_FILE_PATH = "mail.file.path";
    public static final String MAIL_FILE_REQUIRE_SSL = "mail.file.require.ssl";
    public static final String MAIL_FILE_ALLOWED = "mail.file.allowed";

    public FileTransport(Session session, URLName urlname) {
        super(session, urlname);
        auth = session.requestPasswordAuthentication(null, 0, "file:", "", "");
    }

    @Override
    public void sendMessage(Message message, Address[] addresses) throws MessagingException {
        String path = getProperty(MAIL_FILE_PATH);
        
        protocolConnect(null, -1, (auth != null) ? auth.getUserName() : null, (auth != null) ? auth.getPassword() : null);
                
        //
        // if path is still missing, let's give up
        //
        if (StringUtils.isEmpty(path)) {
            throw new MessagingException(
                String.format("missing message path; make sure %s is set in either the session or System properties", MAIL_FILE_PATH)
            );
        }
        
        //
        // We append multiple messages to the same output file
        //
        try (FileOutputStream out = new FileOutputStream(path, true)) {
            message.writeTo(out);
        } catch (IOException x) {
            throw new MessagingException(
                String.format("failed to write %s: %s", path, x.getMessage().toLowerCase()), x
            );
        }
    }
    
    @Override
    protected boolean protocolConnect(
        final String host, final int port, 
        final String givenUser,
        final String givenPassword
    ) throws MessagingException {
        if (Boolean.valueOf(getProperty(MAIL_FILE_REQUIRE_SSL))) {
            if (!Boolean.valueOf(session.getProperty("mail.smtp.ssl.enable"))) {
                throw new MessagingException("invalid connection request (ssl not enabled), check mail.smtp.ssl.enable");
            }
        }
        if (Boolean.valueOf(session.getProperty("mail.smtp.auth"))) {
            String allowedPassword = getAllowedPassword(givenUser);
            return (givenPassword != null) ? givenPassword.equals(allowedPassword)
                                      : (allowedPassword == null);
        }
	return true;
    }
    
    public String getUsername() {
        return (auth != null) ? auth.getUserName() : null;
    }
    
    public String getPassword() {
        return (auth != null) ? auth.getPassword() : null;
    }
    
    /**
     * Returns the property value of the provided property; the property can be
     * set as system property or session configuration property. The latter 
     * overrides the former.
     * 
     * @param name the parameter value - NOT BLANK
     * 
     * @return he property value of the provided property
     */
    public String getProperty(final String name) {
        if (StringUtils.isBlank(name)) {
            throw new IllegalArgumentException("name can not be empty");
        }
        
        String value = session.getProperty(name);
        
        if (value == null) {
            value = System.getProperty(name);
        }
        
        return value;
    }
    
    // ---------------------------------------------------------- private methos
    
    private String getAllowedPassword(final String username) {
        //
        // check if new style (mail.file.allowed=user:password)
        //
        String allowedUsers = getProperty(MAIL_FILE_ALLOWED);
        if (allowedUsers != null) {
            String[] users = StringUtils.split(allowedUsers, ",");
            for (String user: users) {
                if (user.startsWith(username + ':')) {
                    return user.substring(username.length()+1);
                }
            }
        }
        
        //
        // old style (mail.file.allowed.user=password)
        //
        return getProperty("mail.file.allowed."+ username);
    }
    
}