GenPlayEmail.java

/*******************************************************************************
 * GenPlay, Einstein Genome Analyzer
 * Copyright (C) 2009, 2014 Albert Einstein College of Medicine
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * 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 General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * Authors: Julien Lajugie <julien.lajugie@einstein.yu.edu>
 *          Nicolas Fourel <nicolas.fourel@einstein.yu.edu>
 *          Eric Bouhassira <eric.bouhassira@einstein.yu.edu>
 * 
 * Website: <http://genplay.einstein.yu.edu>
 ******************************************************************************/
package edu.yu.einstein.genplay.core.email;

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Properties;

import javax.mail.Authenticator;
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.PasswordAuthentication;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import javax.swing.JOptionPane;

import edu.yu.einstein.genplay.core.crypto.Crypto;
import edu.yu.einstein.genplay.exception.ExceptionManager;

/**
 * The {@link GenPlayEmail} offers the possibility to send an email to the official GenPlay Mailbox.
 * There is only one method: send, which has a subject and a message.
 * This is anonymous, the sender is not the user.
 * 
 * @author Nicolas Fourel
 */
public class GenPlayEmail {

	/** Path to the mail key resource file */
	public static final String KEY_PATH = "edu/yu/einstein/genplay/resource/email/key";

	/** Path to the mail user resource file */
	public static final String USER_PATH = "edu/yu/einstein/genplay/resource/email/usr";

	/** Path to the mail password resource file */
	public static final String PASSWORD_PATH = "edu/yu/einstein/genplay/resource/email/pwd";

	/** SMTP host */
	//private static final String SMTP_HOST = "owa.yu.edu";
	private static final String SMTP_HOST = "smtp.aecom.yu.edu";

	/** SMTP port */
	private static final int SMTP_PORT = 587;

	/** Sender email */
	private static final String SENDER_EMAIL = "genplay@einstein.yu.edu";

	/**  Sender alias */
	private static final String SENDER_ALIAS = "GenPlay Mailbox Admin";

	/** Reply email */
	private static final String REPLY_EMAIL = "genplay@einstein.yu.edu";

	/**  Reply alias */
	private static final String REPLY_ALIAS = "GenPlay Mailbox";

	/**
	 * @return the {@link Authenticator} of the sender
	 * @throws IOException
	 * @throws ClassNotFoundException
	 */
	private static Authenticator getAuthenticator () throws IOException, ClassNotFoundException {
		Crypto crypto = new Crypto();
		final String username = crypto.getUserName();
		final String password = crypto.getPassword();
		if ((username != null) && (password != null)) {
			Authenticator authenticator = new Authenticator() {
				private final PasswordAuthentication pa = new PasswordAuthentication(username, password);
				@Override
				public PasswordAuthentication getPasswordAuthentication() {
					return pa;
				}
			};
			return authenticator;
		}
		return null;
	}


	/**
	 * @param session the {@link Session} to send the email
	 * @param subject the subject of the email
	 * @param message the content of the email
	 * @return the {@link Message} of the email
	 * @throws UnsupportedEncodingException
	 * @throws MessagingException
	 */
	private static Message getMessage (Session session, String subject, String message) throws UnsupportedEncodingException, MessagingException {
		Message msg = new MimeMessage(session);
		msg.setFrom(new InternetAddress(SENDER_EMAIL, SENDER_ALIAS));
		msg.addRecipient(Message.RecipientType.TO, new InternetAddress(REPLY_EMAIL, REPLY_ALIAS));
		msg.setSubject(subject);
		msg.setText(message);
		return msg;
	}


	/**
	 * @return the {@link Properties} of the email
	 */
	private static Properties getProperties () {
		Properties properties = new Properties();
		properties.setProperty("mail.smtp.host", SMTP_HOST);
		properties.setProperty("mail.smtp.port", "" + SMTP_PORT);
		properties.put("mail.smtp.auth", true);
		return properties;
	}


	/**
	 * @return true if GenPlay can connect to the GenPlay website, false otherwise
	 */
	private static boolean isInternetReachable() {
		try {
			// Make a URL to a known source
			URL url = new URL("http://www.genplay.net");

			// Open a connection to that source
			HttpURLConnection urlConnect = (HttpURLConnection)url.openConnection();

			// Trying to retrieve data from the source. If there is no connection, this line will fail.
			urlConnect.getContent();
		} catch (Exception e) {
			ExceptionManager.getInstance().caughtException(e);
			return false;
		}
		return true;
	}


	/**
	 * @return true if the email feature is available, false otherwise
	 */
	private static boolean isMailEnabled () {
		boolean isKey = GenPlayEmail.class.getClassLoader().getResourceAsStream(KEY_PATH) != null;
		boolean isUser = GenPlayEmail.class.getClassLoader().getResourceAsStream(USER_PATH) != null;
		boolean isPassword = GenPlayEmail.class.getClassLoader().getResourceAsStream(PASSWORD_PATH) != null;
		if (isKey && isUser && isPassword) {
			return true;
		}
		return false;
	}


	/**
	 * Send an anonymous email with the name of Nicolas Fourel as GenPlay Mailbox admin to the GenPlay Mailbox.
	 * @param subject the subject of the email
	 * @param content the content of the email
	 * @return true if the sending operation was successful, false otherwise
	 */
	public static boolean send (String subject, String content) {
		boolean hasBeenSent = false;
		boolean canSend = true;

		// Test if the internet connection is working
		if (!isInternetReachable()) {
			canSend = false;
			JOptionPane.showMessageDialog(null, "No internet connection has been found.", "Could not send the email", JOptionPane.INFORMATION_MESSAGE);
		}

		// Test if the mail connection can be used (and if the internet is working testing canSend)
		if (canSend && !isMailEnabled()) {
			canSend = false;
			JOptionPane.showMessageDialog(null, "The email feature is not available on this current version.", "Could not send the email", JOptionPane.INFORMATION_MESSAGE);
		}

		// Start the sending process if everything seems ok
		if (canSend) {
			try {
				Properties properties = getProperties();
				Authenticator authenticator = getAuthenticator();
				Session session = Session.getDefaultInstance(properties, authenticator);
				Message message = getMessage(session, subject, content);
				Transport.send(message);
				hasBeenSent = true;
			} catch (Exception e) {
				ExceptionManager.getInstance().caughtException(e);
			}
		}

		return hasBeenSent;
	}

}