/*
Copyright (C) 2005-2012, by the President and Fellows of Harvard College.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dataverse Network - A web application to share, preserve and analyze research data.
Developed at the Institute for Quantitative Social Science, Harvard University.
Version 3.0.
*/
/*
* MailServiceBean.java
*
* Created on November 15, 2006, 8:21 AM
*
* To change this template, choose Tools | Template Manager
* and open the template in the editor.
*/
package edu.harvard.iq.dvn.core.mail;
import edu.harvard.iq.dvn.core.study.StudyFile;
import edu.harvard.iq.dvn.core.study.StudyFileEditBean;
import edu.harvard.iq.dvn.core.study.StudyServiceLocal;
import edu.harvard.iq.dvn.core.vdc.VDC;
import edu.harvard.iq.dvn.core.vdc.VDCNetworkServiceLocal;
import edu.harvard.iq.dvn.ingest.dsb.DSBIngestMessage;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.Map;
import java.util.HashMap;
import javax.annotation.Resource;
import javax.ejb.EJB;
import javax.ejb.Stateless;
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.AddressException;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
/**
*
* @author roberttreacy
*/
@Stateless
public class MailServiceBean implements edu.harvard.iq.dvn.core.mail.MailServiceLocal, java.io.Serializable {
@EJB VDCNetworkServiceLocal vdcNetworkService;
@EJB StudyServiceLocal studyService;
/**
* Creates a new instance of MailServiceBean
*/
public MailServiceBean() {
}
public void sendMail(String host, String from, String to, String subject, String messageText) {
Properties props = System.getProperties( );
props.put("mail.smtp.host", host);
Session session = Session.getDefaultInstance(props, null);
try {
Message msg = new MimeMessage(session);
msg.setFrom(new InternetAddress(from));
msg.setRecipients(Message.RecipientType.TO,
InternetAddress.parse(to, false));
msg.setSubject(subject);
msg.setText(messageText);
Transport.send(msg);
} catch (AddressException ae) {
ae.printStackTrace(System.out);
} catch (MessagingException me) {
me.printStackTrace(System.out);
}
}
@Resource(name="mail/notifyMailSession")
private Session session;
public void sendDoNotReplyMail(String to, String subject, String messageText){
try {
System.out.print(to);
Message msg = new MimeMessage(session);
msg.setFrom();
msg.setRecipients(Message.RecipientType.TO,
InternetAddress.parse(to, false));
msg.setSubject(subject);
msg.setText(messageText+"\n\nPlease do not reply to this email.\nThank you,\nThe Dataverse Network Project");
Transport.send(msg);
} catch (AddressException ae) {
ae.printStackTrace(System.out);
} catch (MessagingException me) {
me.printStackTrace(System.out);
}
}
// @Resource(name="mail/notifyMailSession")
public void sendMail(String from, String to, String subject, String messageText){
sendMail(from, to, subject, messageText, new HashMap());
}
public void sendMail(String from, String to, String subject, String messageText, Map extraHeaders) {
try {
Message msg = new MimeMessage(session);
msg.setFrom(new InternetAddress(from));
msg.setRecipients(Message.RecipientType.TO,
InternetAddress.parse(to, false));
msg.setSubject(subject);
msg.setText(messageText);
if (extraHeaders != null) {
for (Object key : extraHeaders.keySet()) {
String headerName = key.toString();
String headerValue = extraHeaders.get(key).toString();
msg.addHeader(headerName, headerValue);
}
}
Transport.send(msg);
} catch (AddressException ae) {
ae.printStackTrace(System.out);
} catch (MessagingException me) {
me.printStackTrace(System.out);
}
}
public void sendPasswordUpdateNotification(String userEmail, String userFirstName,String userName, String newPassword) {
String subject = "Dataverse Network: New Password Request";
String msgText ="Hello "+userFirstName+",\n";
msgText+="Here is the new password information that you requested for the Dataverse Network:\n";
msgText+="Username: "+userName+"\n";
msgText+="Password: "+newPassword+"\n";
msgText+="After logging in, change your password by clicking the username displayed on the top right of the menubar.\n";
msgText+="If you continue to have problems logging in, send us an e-mail through the Dataverse Network Contact form.\n";
sendDoNotReplyMail(userEmail,subject,msgText);
}
public void sendCreatorAccountNotification(String adminEmail, String userName) {
String msgText="A new account has been created with Dataverse Creator privileges";
msgText+=" (user name: "+userName+").";
sendDoNotReplyMail(adminEmail,"Dataverse Network: New Creator Account",msgText);
}
public void sendContributorAccountNotification(String adminEmail, String userName, String dataverseName) {
String msgText="A new account has been created with Contributor privileges in "+dataverseName+" dataverse";
msgText+=" (user name: "+userName+").";
sendDoNotReplyMail(adminEmail,"Dataverse Network: New Contributor Account",msgText);
}
private String getIngestMessagePrefix(DSBIngestMessage ingestMessage) {
String messagePrefix = "";
messagePrefix += "Dataverse: " + ingestMessage.getDataverseName() + "\n";
messagePrefix += "Study Global Id: " + ingestMessage.getStudyGlobalId() + " (v" + ingestMessage.getStudyVersionNumber() + ")\n";
messagePrefix += "Study Title: " + ingestMessage.getStudyTitle() + "\n";
return messagePrefix;
}
public void sendIngestRequestedNotification(DSBIngestMessage ingestMessage, List subsettableFiles) {
String msgSubject = "Dataverse Network: The upload of your subsettable file(s) is in progress";
String msgText = getIngestMessagePrefix(ingestMessage);
msgText += "\nYou have requested the following subsettable files to be uploaded: \n";
Iterator iter = subsettableFiles.iterator();
while (iter.hasNext()) {
StudyFileEditBean fileBean = (StudyFileEditBean) iter.next();
msgText += " " + fileBean.getFileMetadata().getLabel() + "\n";
}
msgText +="\nUpload in progress ...";
sendDoNotReplyMail(ingestMessage.getIngestEmail(), msgSubject, msgText );
}
public void sendIngestCompletedNotification(DSBIngestMessage ingestMessage, List successfulFiles, List problemFiles) {
String msgSubject = "Dataverse Network: Upload request complete";
String msgText = getIngestMessagePrefix( ingestMessage );
msgText += "\nYour upload request has completed.\n";
if (successfulFiles != null && successfulFiles.size() != 0) {
msgText += "\nThe following subsettable files were successfully uploaded: \n";
Iterator iter = successfulFiles.iterator();
while (iter.hasNext()) {
StudyFileEditBean fileBean = (StudyFileEditBean) iter.next();
msgText += " " + fileBean.getFileMetadata().getLabel() +"\n";
}
}
if (problemFiles != null && problemFiles.size() != 0) {
msgSubject += " (with failures)";
msgText += "\nThe following subsettable files failed to upload: \n";
Iterator iter = problemFiles.iterator();
while (iter.hasNext()) {
StudyFileEditBean fileBean = (StudyFileEditBean) iter.next();
msgText += " " + fileBean.getFileMetadata().getLabel() +" (File Type: " + fileBean.getStudyFile().getFileType() + "; File Size: " + fileBean.getSizeFormatted() +")\n";
}
}
sendDoNotReplyMail(ingestMessage.getIngestEmail(), msgSubject, msgText);
}
public void sendFileAccessRequestNotification(String sendToEmail, String userName, String studyTitle, String globalId) {
sendDoNotReplyMail(sendToEmail,"Dataverse Network: New request to access restricted files",
"User '"+userName+"' has requested access to restricted files in study '"+studyTitle+"' ("+globalId+"). ");
}
public void sendFileAccessRequestNotification(String sendToEmail, String userName, String studyTitle, String globalId, String fileNameList) {
sendDoNotReplyMail(sendToEmail,"Dataverse Network: New request to access restricted file",
"User '"+userName+"' has requested access to restricted files '"+fileNameList+"' in study '"+studyTitle+"' ("+globalId+"). ");
}
public void sendFileAccessRequestNotification(String sendToEmail, String userName, String studyTitle, String globalId, List<String> fileNameList) {
String subject = "Dataverse Network: New request to access restricted file";
String messageText = "\nUser '"+userName+"' has requested access to restricted files: \n";
for (String fileName : fileNameList) {
messageText += "\t" + fileName + "\n";;
}
messageText += "\nin study '"+studyTitle+"' ("+globalId+").\n";
sendDoNotReplyMail(sendToEmail, subject, messageText);
}
public void sendFileAccessRequestConfirmation(String userEmail, String studyTitle, String globalId) {
sendDoNotReplyMail(userEmail,"Dataverse Network: Your Request to access restricted files has been received",
"Thanks for your interest in the study '"+studyTitle+"' ("+globalId+"). You will be notified as soon as your request is approved.");
}
public void sendFileAccessRequestConfirmation(String userEmail, String studyTitle, String globalId, String fileNameList) {
sendDoNotReplyMail(userEmail,"Dataverse Network: Your Request to access restricted files has been received",
"Thanks for your interest in the files '"+fileNameList+"' in the study '"+studyTitle+"' ("+globalId+"). You will be notified as soon as your request is approved.");
}
public void sendFileAccessRequestConfirmation(String userEmail, String studyTitle, String globalId, List<String> fileNameList) {
String subject = "Dataverse Network: Your Request to access restricted files has been received";
String messageText = "\nThanks for your interest in the files: \n";
for (String fileName : fileNameList) {
messageText += "\t" + fileName + "\n";;
}
messageText += "\nin study '"+studyTitle+"' ("+globalId+"). You will be notified as soon as your request is approved.\n";
sendDoNotReplyMail(userEmail, subject, messageText);
}
public void sendFileAccessApprovalNotification(String userEmail, String studyTitle, String globalId, String url) {
String msgText= "You now have access to restricted files in study '"+studyTitle+"' ("+globalId+"). \n"+
" Please follow this link "+
"to view the study files: "+url;
sendDoNotReplyMail(userEmail,"Dataverse Network: Your request to access restricted files has been approved",msgText);
}
public void sendFileAccessApprovalNotification(String userEmail, String studyTitle, String globalId, String fileLabel, String fileId, String url) {
String msgText= "You now have access to restricted file '"+fileLabel+"' ("+fileId+") in study '"+studyTitle+"' ("+globalId+"). \n"+
" Please follow this link "+
"to view the study files: "+url;
sendDoNotReplyMail(userEmail,"Dataverse Network: Your request to access restricted files has been approved",msgText);
}
public void sendAddSiteNotification(String dataverseCreatorEmail, String siteName, String siteAddress){
String dvnGuidesUrl = siteAddress;
if (siteAddress.indexOf('/') != -1) {
dvnGuidesUrl = dvnGuidesUrl.substring(0, siteAddress.indexOf('/'));
dvnGuidesUrl = "http://" + dvnGuidesUrl + "/guides";
}
String subject = "Dataverse Network: Your dataverse has been created";
String messageText = "Hello, \nYour new dataverse named '"+siteName+"' was"
+ " created in the " + vdcNetworkService.find().getName() + " Dataverse Network. You can access your dataverse"
+ " directly by entering this URL:\n"
+ "http://"+siteAddress+"\n"
+ "Your dataverse is set to Not Released by default. You can do the"
+" following as a Dataverse Admin: \n"
+" -Click Options to administer your dataverse.\n"
+ " -Begin creating your own studies and uploading files or adding collections of data from other dataverses\n"
+ " -Customize the layout, and then you are ready to release your dataverse to others.\n"
+ "For detailed information about how to use your dataverse options, click User Guides on the Dataverse Network menu bar, or go to " + dvnGuidesUrl + ".";
sendDoNotReplyMail(dataverseCreatorEmail,subject,messageText);
}
public void sendReleaseSiteNotification(String dataverseCreatorEmail, String siteName, String siteAddress){
String dvnGuidesUrl = siteAddress;
if (siteAddress.indexOf('/') != -1) {
dvnGuidesUrl = dvnGuidesUrl.substring(0, siteAddress.indexOf('/'));
dvnGuidesUrl = "http://" + dvnGuidesUrl + "/guides";
}
String subject = "Dataverse Network: Your dataverse has been released";
String messageText = "Hello, \nYour new dataverse named '"+siteName+"' was"
+ " released to the " + vdcNetworkService.find().getName() + " Dataverse Network. You can access your dataverse"
+ " directly by entering this URL:\n"
+ "http://"+siteAddress+"\n"
+ "For detailed information about how to use your dataverse options, click User Guides on the Dataverse Network menu bar, or go to " + dvnGuidesUrl + ".";
sendDoNotReplyMail(dataverseCreatorEmail,subject,messageText);
}
public void sendReleaseSiteNotificationNetwork(String networkAdminEmail, String siteName, String siteAddress){
String subject = "Dataverse Network: Dataverse has been released";
String messageText = "Hello, \nThe dataverse named '"+siteName+"' was"
+ " released to the " + vdcNetworkService.find().getName() + " Dataverse Network. You can access it"
+ " directly by entering this URL:\n"
+ "http://"+siteAddress+"\n";
sendDoNotReplyMail(networkAdminEmail,subject,messageText);
}
public void sendStudyInReviewNotification(String userEmail, String studyName){
String subject = "Dataverse Network: Your Study is in Review";
String messageText = "Your study '"+ studyName + "' is now under review. You will be notified when the study is released.";
sendDoNotReplyMail(userEmail,subject,messageText);
}
public void sendStudyReleasedNotification(String userEmail, String studyName, String dataverseName){
String subject = "Dataverse Network: Your Study has been released";
String messageText = "Your study '" + studyName + " has been released to '" + dataverseName + "' dataverse.";
sendDoNotReplyMail(userEmail,subject,messageText);
}
public void sendStudyAddedNotification(String userEmail, String studyName, String dataverseName){
String subject = "Dataverse Network: Your New Study has been set to ready for review";
String messageText = "Your study '" + studyName + "' has been uploaded to '" + dataverseName + "' dataverse. and is ready for review."+
"Your study will go under review before it is released. You will be notified when the status of your study changes. You may also go to 'Options > Study Options > Manage Studies' to check on the status of your study.";
sendDoNotReplyMail(userEmail,subject,messageText);
}
public void sendStudyEditedNotification(String userEmail, String studyName, String dataverseName){
String subject = "Dataverse Network: Your Study has been updated";
String messageText = "Your study '" + studyName + "' has been updated in the '" + dataverseName + "' dataverse. "+
"Your study will go under review before it is released. You will be notified when the status of your study changes. You may also go to 'Options > Study Options > Manage Studies' to check on the status or edit your study.";
sendDoNotReplyMail(userEmail,subject,messageText);
}
public void sendStudyAddedCuratorNotification(String curatorEmail, String contributorName, String studyName, String dataverseName){
String subject = "Dataverse Network: A New Study has been uploaded and is ready for review";
String messageText = "A new Study '" + studyName + "' has been uploaded to '" + dataverseName +"'"+
" by contributor '"+contributorName+"'.";
sendDoNotReplyMail(curatorEmail,subject,messageText);
}
public void sendStudyEditedCuratorNotification(String curatorEmail, String contributorName, String studyName, String dataverseName){
String subject = "Dataverse Network: A Study has been updated";
String messageText = "Changes to Study '" + studyName + "' have been saved to '" + dataverseName+"' dataverse "+
" by contributor '"+contributorName+"'.";
sendDoNotReplyMail(curatorEmail,subject,messageText);
}
public void sendFileAccessRejectNotification(String userEmail, String studyTitle,String globalId, String fileLabel, String fileId, String adminEmail) {
String subject = "Dataverse Network: Your Request to access restricted files was denied";
String messageText = "Your request to access the restricted file '"+fileLabel+"' ("+fileId+") in study '"+studyTitle+"' ("+globalId+") was denied. \n"+
"Please contact the dataverse Administrator at "+adminEmail+
" for more information as to why your request did not go through. ";
sendDoNotReplyMail(userEmail,subject,messageText);
}
public void sendFileAccessRejectNotification(String userEmail, String studyTitle,String globalId,String adminEmail) {
String subject = "Dataverse Network: Your Request to access restricted files was denied";
String messageText = "Your request to access the restricted files in study '"+studyTitle+"' ("+globalId+") was denied. \n"+
"Please contact the dataverse Administrator at "+adminEmail+
" for more information as to why your request did not go through. ";
sendDoNotReplyMail(userEmail,subject,messageText);
}
public void sendFileAccessResolvedNotification(String userEmail, String studyTitle,String globalId, List<String> acceptedFiles, List<String> rejectedFiles, String url, String adminEmail) {
String subject = "Dataverse Network: Your File Access Request";
String messageText = "Study File Access Requests for study '" + studyTitle + "' (" + globalId + ")\n";
if (acceptedFiles != null && acceptedFiles.size() > 0) {
messageText += "\nYour request to access the following files have been accepted:\n";
for (String fileName : acceptedFiles) {
messageText += "\t" + fileName + "\n";;
messageText += "\nPlease follow this link to view the study files: "+url+"\n";
}
}
if (rejectedFiles != null && rejectedFiles.size() > 0) {
messageText += "\nYour request to access the following files have been denied:\n";
for (String fileName : rejectedFiles) {
messageText += "\t" + fileName + "\n";
}
messageText += "\nPlease contact the dataverse Administrator at " + adminEmail + " for more information as to why your request did not go through. ";
}
sendDoNotReplyMail(userEmail,subject,messageText);
}
public void sendHarvestErrorNotification(String email,VDC vdc) {
String subject = "Dataverse Network: Harvesting error notification";
String messageText = "An exception occurred while harvesting from "+vdc.getName()+" dataverse. See harvest_"+vdc.getAlias()+" log and server.log for more details. ";
sendDoNotReplyMail(email,subject,messageText);
}
public void sendHarvestErrorNotification(String email, String vdcNetworkName) {
String subject = "Dataverse Network: Harvesting error notification";
String messageText = "An exception occurred during harvesting in DVN "+vdcNetworkName+". See server.log for more details. ";
sendDoNotReplyMail(email,subject,messageText);
}
public void sendHarvestNotification(String email, String vdcName, String logFileName, String logTimestamp, boolean harvestError, int harvestedStudyCount, List<String> failedIdentifiers) {
// in 3.1 we've decided to only send e-mails when a harvest has a failure
// TODO: we should make this configurable at the DVN level for all messages, all non-zero messages, only error messages
boolean sendMail = false;
String subject = null;
String messageText=null;
String messageSuffix = null;
if (harvestError) {
sendMail = true;
subject="Harvest Error Notification";
messageText = "A harvest has run for "+vdcName+" Dataverse, with errors.\n";
messageSuffix = "Please see "+logFileName+" and server.log for details of harvest errors.";
}else {
subject="Harvest Success Notification";
messageText = "A harvest has successfully completed for "+vdcName+" Dataverse. \n";
messageSuffix = "Please see "+logFileName+" for more details.";
}
subject +=" ("+vdcName+","+logTimestamp+")";
if (!harvestError && harvestedStudyCount==0) {
messageText += " No studies have been harvested (no updates found since last harvest). ";
} else {
messageText += ""+harvestedStudyCount+" studies were successfully harvested.\n";
}
if (failedIdentifiers.size()>0) {
sendMail = true;
messageText+= "Harvest failed for the following identifiers - \n";
Iterator iter = failedIdentifiers.iterator();
while (iter.hasNext()) {
messageText += " "+(String)iter.next() +"\n";
}
}
if (sendMail) {
sendDoNotReplyMail(email,subject,messageText + messageSuffix);
}
}
public void sendExportErrorNotification(String email, String vdcNetworkName) {
String subject = "Dataverse Network: Export error notification";
String messageText = "An exception occurred during exporting in DVN " + vdcNetworkName + ". See server.log for more details. ";
sendDoNotReplyMail(email, subject, messageText);
}
public void sendIndexUpdateErrorNotification(String email, String vdcNetworkName) {
String subject = "Dataverse Network: Index update error notification";
String messageText = "An exception occurred during index update in DVN " + vdcNetworkName + ". See server.log for more details. ";
sendDoNotReplyMail(email, subject, messageText);
}
public void sendIndexErrorNotification(String email, String vdcNetworkName, int howMany) {
String subject = "Dataverse Network: Index update error notification";
String messageText = howMany + " exceptions occurred during index update in DVN " + vdcNetworkName + ". See server.log for more details. \n You can use the index update utility or wait for the scheduled overnight update";
sendDoNotReplyMail(email, subject, messageText);
}
}