EmailLogger.m

Go to the documentation of this file.

classdef EmailLogger<handle
    properties (Access=private,Hidden)
        emailDistributionList={};
        emailAttachmentNameList={};
        emailAttachmentZippedNameList={};
        userName='unknown';
        hostName='unknown';
        subjectSuffix='';
        loggerName='';
        isDryRun=false;
        isThrowExceptions=false;
        %
        smtpUserName=''
        smtpPassword=''
        fromEmailAddress=''
        smtpServer='';
        
    end
    methods (Access=private)
        sendmail(self,to,subject,message,attachments)
    end
    methods
        function self=EmailLogger(varargin)
            logger=mxberry.log.log4j.Log4jConfigurator.getLogger();
            [~,prop]=parseparams(varargin);
            nProp=length(prop);
            isZippedSpecified=false;
            isFromAddressSpec=false;
            for k=1:2:nProp
                switch lower(prop{k})
                    case 'emaildistributionlist'
                        self.emailDistributionList=prop{k+1};
                    case 'emailattachmentnamelist'
                        self.emailAttachmentNameList=prop{k+1};
                    case 'emailattachmentzippednamelist'
                        self.emailAttachmentZippedNameList=prop{k+1};
                        isZippedSpecified=true;
                    case 'smtpserver'
                        self.smtpServer=prop{k+1};
                    case 'subjectsuffix'
                        self.subjectSuffix=prop{k+1};
                    case 'smtppassword'
                        self.smtpPassword=prop{k+1};
                    case 'smtpusername'
                        self.smtpUserName=prop{k+1};
                    case 'loggername'
                        self.loggerName=prop{k+1};
                    case 'dryrun'
                        self.isDryRun=prop{k+1};
                    case 'isthrowexceptions'
                        self.isThrowExceptions = prop{k+1};
                    case 'fromemailaddress'
                        self.fromEmailAddress=prop{k+1};
                        isFromAddressSpec=true;
                    otherwise
                        mxberry.core.throwerror('wrongInput',...
                            'unknown property %s',prop{k});
                end
            end
            if isZippedSpecified
                if numel(self.emailAttachmentNameList)~=...
                        numel(self.emailAttachmentZippedNameList)
                    mxberry.core.throwerror('wrongInput',[...
                        'properties emailAttachmentNameList and '...
                        'emailAttachmentZippedNameList are not '...
                        'consistent in length']);
                end
            else
                self.emailAttachmentZippedNameList=...
                    cell(size(self.emailAttachmentNameList));
            end
            %% Configure email notification
            if ~self.isDryRun&&~isFromAddressSpec
                [curUserName,curHostName]=mxberry.system.getuserhost();
                if ~isempty(curUserName)
                    self.userName = curUserName;
                end
                if ~isempty(curHostName)
                    self.hostName = curHostName;
                end
                self.fromEmailAddress=[self.userName,'@',self.hostName];
                logger.info(...
                    ['no dry run mode, configured for smtpServer=',...
                    self.smtpServer]);
            else
                logger.info('configured for dry run');
            end
        end
        function sendMessage(self,subjectMessage,varargin)
            import mxberry.core.throwerror;
            import mxberry.core.parseparext;
            import mxberry.core.cell.cell2tablestr;
            %% Create log4j logger
            logger=mxberry.log.log4j.Log4jConfigurator.getLogger();
            %
            if ~self.isDryRun
                [reg,~,attachNameList]=parseparext(varargin,...
                    {'emailAttachmentNameList';{};'iscellofstring(x)'},...
                    [0 1],'regDefList',{[]});
                bodyMessage=reg{1};
                %
                emailSubjectPrefix=['[',self.loggerName,']:'];
                emailSubjectSuffix=[self.subjectSuffix ,...
                    ', running on host:',self.hostName,'(user:',self.userName,'),',...
                    'matlab:',version('-release'),'(arch:',computer,')'];
                emailSubject=[emailSubjectPrefix,subjectMessage,...
                    emailSubjectSuffix];
                emailAttachNameList=self.emailAttachmentNameList;
                emailAttachZippedNameList=self.emailAttachmentZippedNameList;
                for iElem=1:numel(emailAttachNameList)
                    zippedNameStr=emailAttachZippedNameList{iElem};
                    if ~isempty(zippedNameStr)
                        zip(zippedNameStr,emailAttachNameList{iElem});
                        emailAttachNameList{iElem}=zippedNameStr;
                    end
                end
                attachNameList=[attachNameList,...
                    emailAttachNameList];
                %
                nAttachemments=length(attachNameList);
                for iFile=1:nAttachemments
                    fileName=attachNameList{iFile};
                    if ~mxberry.io.isfile(fileName)
                        throwerror('wrongInput',...
                            'cannot find attachment %s',fileName);
                    end
                end
                %
                logger.info(emailSubject);
                try
                    self.sendmail(self.emailDistributionList,...
                        emailSubject,...
                        bodyMessage,...
                        attachNameList);
                catch causeObj
                    meObj=throwerror('sendEmailFailed',...
                        ['something is wrong with the following data: \n',...
                        'distributionList: %s \n',...
                        'subject: %s\n',...
                        'smtpServer: %s\n',...
                        'emailAttachmentNameList: %s'],...
                        cell2tablestr([],self.emailDistributionList,',',...
                        'isMatlabSyntax',true),...
                        emailSubject,...
                        self.smtpServer,...
                        cell2tablestr([],self.emailAttachmentNameList,',',...
                        'isMatlabSyntax',true));
                    meObj=addCause(meObj,causeObj);
                    logger.fatal(sprintf('%s\nMessage body:\n%s',...
                        mxberry.core.MExceptionUtils.me2PlainString(meObj),...
                        bodyMessage));
                    if self.isThrowExceptions
                        throw(meObj);
                    end
                end
            end
        end
        function fromEmailAddress=getFromEmailAddress(self)
            fromEmailAddress=self.fromEmailAddress;
        end
        function smtpServer=getSMTPServer(self)
            smtpServer=self.smtpServer;
        end
        function suffixStr = getSubjectSuffix(self)
            suffixStr = self.subjectSuffix;
        end
        function setSubjectSuffix(self, suffixStr)
            self.subjectSuffix = suffixStr;
        end
        function addSubjectSuffix(self,suffixStr,isAddedToEnd)
            if nargin<3
                isAddedToEnd=true;
            end
            %
            if isAddedToEnd
                self.subjectSuffix=[self.subjectSuffix,suffixStr];
            else
                self.subjectSuffix=[suffixStr,self.subjectSuffix];
            end
        end
    end
end
function sendmail(self,to,subject,message,attachments)
import mxberry.core.throwerror;
import javax.mail.*
import javax.mail.internet.*
import javax.activation.*
%
if ~usejava('jvm')
    throwerror('wrongState:NoJvm','no Java is running');
end

% Argument parsing.
narginchk(3,5);
if ischar(to)
    to = {to};
end
if (nargin < 3)
    message = '';
end
if (nargin < 4)
    attachments = [];
elseif ischar(attachments)
    attachments = {attachments};
end

% Determine server and from.
[server,from] = getServerAndFrom(self);
if isempty(server)
    throwerror('wrongState:SMTPServerIndeterminate',...
        'Could not determine SMTP server');
end
if isempty(from)
    throwerror('wrongState:FromAddressIndeterminate',...
        'Could not determine FROM address');
end
%
% Use the system properties, but clone them so we don't alter them.
props = java.lang.System.getProperties.clone;
props.put('mail.smtp.host',server);
%
% Create session.
username = self.smtpUserName;
password = self.smtpPassword;
if isempty(username)
    pa = [];
else
    pa = com.mathworks.util.PasswordAuthenticator(username,password);
end
session = Session.getInstance(props,pa);

% Create the message.
msg = MimeMessage(session);

% Set sender.
msg.setFrom(getInternetAddress(from));

% Set recipients.
for i = 1:numel(to)
    msg.addRecipient(getRecipientTypeTo(msg), ...
        getInternetAddress(to{i}));
end

% Try to do the right thing on Japanese machines.
isJapanese = ispc && strncmpi(get(0,'Language'),'ja',2);

% Set subject.
if any(subject == char(10)) || any(subject == char(13))
    throwerror('wrongInput:InvalidSubject',  ...
        'Subjects cannot contain newline characters');
end
if isJapanese
    msg.setSubject(subject,'SJIS')
else
    msg.setSubject(subject)
end

% Set other headers.
msg.setHeader('X-Mailer', ['MATLAB ' version])
msg.setSentDate(java.util.Date);

% Construct the body of the message and attachments.
body = formatText(message);
if numel(attachments) == 0
    if isJapanese
        msg.setText(body,'SJIS');
    else
        msg.setText(body);
    end
else
    % Add body text.
    messageBodyPart = MimeBodyPart;
    if isJapanese
        messageBodyPart.setText(body,'SJIS');
    else
        messageBodyPart.setText(body);
    end
    multipart = MimeMultipart;
    multipart.addBodyPart(messageBodyPart);
    
    % Add attachments.
    for iAttachments = 1:numel(attachments)
        file = attachments{iAttachments};
        messageBodyPart = MimeBodyPart;
        fullName = locateFile(file);
        if isempty(fullName)
            throwerror('wrongState:CannotOpenFile', ...
                'Cannot open file "%s".',file);
        end
        source = FileDataSource(fullName);
        messageBodyPart.setDataHandler(DataHandler(source));
        
        % Remove the directory, if any, from the attachement name.
        [~,fileName,fileExt] = fileparts(fullName);
        messageBodyPart.setFileName([fileName fileExt]);
        multipart.addBodyPart(messageBodyPart);
    end
    
    % Put parts in message
    msg.setContent(multipart);
    
end

% Send the message.
try
    Transport.send(msg);
catch exception
    % Try to make the Java error friendlier.
    niceError = stripJavaError(exception.message);
    if isempty(niceError)
        throw(exception);
    else
        throwerror('wrongState:SmtpError','%s',niceError);
    end
end

function [server,from] = getServerAndFrom(self)

% Check preferences.
server = self.smtpServer;
from = self.fromEmailAddress;

% Check Java properties.
if isempty(server)
    props = java.lang.System.getProperties;
    server = char(props.getProperty('mail.smtp.host'));
end

% Determine defaultMailAccountRegistry.
if (ispc && (isempty(server) || isempty(from)))
    try
        defaultMailAccount = winqueryreg('HKEY_CURRENT_USER', ...
            'Software\Microsoft\Internet Account Manager', ...
            'Default Mail Account');
        defaultMailAccountRegistry = ...
            ['Software\Microsoft\Internet Account Manager\Accounts\' ...
            defaultMailAccount];
    catch exception %#ok
        defaultMailAccountRegistry = '';
    end
end

% Determine SERVER
if ispc && isempty(server) && ~isempty(defaultMailAccountRegistry)
    try
        server = winqueryreg('HKEY_CURRENT_USER',defaultMailAccountRegistry, ...
            'SMTP Server');
    catch exception %#ok
    end
end
if isempty(server)
    server = getenv('MAILHOST');
end

% Determine FROM
if ispc && isempty(from)
    try
        from = winqueryreg('HKEY_CURRENT_USER',defaultMailAccountRegistry, ...
            'SMTP Email Address');
    catch exception %#ok
    end
end
if isempty(from)
    from = getenv('LOGNAME');
end


function internetAddress = getInternetAddress(from)
import mxberry.core.throwerror;
try
    internetAddress = javax.mail.internet.InternetAddress(from);
catch meObj
    throwerror('wrongInput:AddressError','%s',...
        stripJavaError(meObj.message));
end



function recipientTypeTo = getRecipientTypeTo(msg)

% Get the class loader for the Message class.
cl = msg.getClass.getClassLoader;
% Returns a Class object pointing to RecipientType using that ClassLoader.
rt = java.lang.Class.forName('javax.mail.Message$RecipientType', false, cl);
% Returns a Field object pointint to TO.
field = rt.getField('TO');
% Gets the static instance of TO.
recipientTypeTo = field.get([]);


function fullPathToFile = locateFile(file)

% Matthew J. Simoneau, November 2003

% Checking that the length is exactly one in the first two checks automatically
% excludes directories, since directory listings always include '.' and '..'.

if (length(dir(fullfile(pwd,file))) == 1)
    % Relative path.
    fullPathToFile = fullfile(pwd,file);
elseif (length(dir(file)) == 1)
    % Absolute path.
    fullPathToFile = file;
elseif ~isempty(which(file))
    % A file on the path.
    fullPathToFile = which(file);
elseif ~isempty(which([file '.']))
    % A file on the path without extension.
    fullPathToFile = which([file '.']);
else
    fullPathToFile = '';
end


function toSend = formatText(msgText)

cr = char(10);

% For a cell array, send each cell as one line.
if iscell(msgText)
    toSend = strjoin(msgText,cr);
    return
end

% For a char array, break each line at a char(10) or try to wrap to 75
% characters.
lines = {};
maxLineLength = 75;
msgText = [cr msgText cr];
crList = find(msgText == cr);

for i = 1:length(crList)-1
    nextLine = msgText(crList(i)+1 : crList(i+1)-1);
    lineLength = length(nextLine);
    
    nextStart = 1;
    moreOnLine = true;
    while moreOnLine
        start = nextStart;
        if (lineLength-start+1 <= maxLineLength)
            % The rest fits on one line.
            stop = lineLength;
            moreOnLine = false;
        else
            % Whole line doesn't fit.  Needs to be broken up.
            spaces = find(nextLine == ' ');
            spaces = spaces(spaces >= start);
            nonSpaces = find(nextLine ~= ' ');
            nonSpaces = nonSpaces(nonSpaces >= start);
            if isempty(spaces)
                %                 % No spaces anywhere.  Chop!
                %                 stop = start+maxLineLength-1;
                % No spaces anywhere.  Preserve.
                stop = lineLength;
            elseif isempty(nonSpaces)
                % Nothing but spaces.  Send an empty line.
                stop = start-1;
            elseif (min(spaces) > (start+maxLineLength))
                %                 % The first space doesn't show up soon enough to help.  Chop!
                %                 stop = start+maxLineLength-1;
                % No spaces anywhere.  Preserve.
                stop = lineLength;
            elseif isempty(spaces( ...
                    spaces > min(nonSpaces) & spaces < start+maxLineLength ...
                    ))
                %                 % There are only leading spaces, which we respect.  Chop!
                %                 stop = start+maxLineLength-1;
                % No spaces anywhere.  Preserve.
                stop = lineLength;
            else
                % Break on the last space that will make the line fit.
                stop = max(spaces(spaces <= (start+maxLineLength)))-1;
            end
            % After a break, start the next line on the next non-space.
            nonSpaces = find(nextLine ~= ' ');
            nextStart = min(nonSpaces(nonSpaces > stop));
            if isempty(nextStart)
                moreOnLine = false;
            end
        end
        lines{end+1,1} = nextLine(start:stop); %#ok<AGROW>
    end
end

toSend = strjoin(lines,cr);


function niceError = stripJavaError(err)

% Two nice error messages.  Pull them out and stick them together.
pat = 'Java exception occurred:\s*\S+: (.*?)\n\s*nested exception is:\s*\S+: (.*?)\n';
m = regexp(err,pat,'tokens','once');
if ~isempty(m)
    niceError = sprintf('%s\n%s',m{:});
    return
end

% One nice error message.  Strip it off.
pat = 'Java exception occurred:\s*\S+: (.*?)\n';
m = regexp(err,pat,'tokens','once');
if ~isempty(m)
    niceError = m{1};
    return
end

% Only exceptions.  Special-case popular ones.
pat = 'Java exception occurred:\s*(\S+)\s*\n';
m = regexp(err,pat,'tokens','once');
if ~isempty(m)
    switch m{1}
        case 'javax.mail.AuthenticationFailedException'
            niceError = 'Authentication failed.';
            return
    end
end

% Can't find a nice message.
niceError = '';