org.imixs.marty.profile.MailPlugin Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 *  Imixs Workflow 
 *  Copyright (C) 2001, 2011 Imixs Software Solutions GmbH,  
 *  http://www.imixs.com
 *  
 *  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 2 
 *  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 can receive a copy of the GNU General Public
 *  License at http://www.gnu.org/licenses/gpl.html
 *  
 *  Project: 
 *  	http://www.imixs.org
 *  	http://java.net/projects/imixs-workflow
 *  
 *  Contributors:  
 *  	Imixs Software Solutions GmbH - initial API and implementation
 *  	Ralph Soika - Software Developer
 *******************************************************************************/

package org.imixs.marty.profile;

import java.io.IOException;
import java.util.Collection;
import java.util.List;
import java.util.logging.Logger;
import java.util.regex.Pattern;

import jakarta.activation.DataHandler;
import jakarta.activation.DataSource;
import jakarta.ejb.EJB;
import jakarta.mail.MessagingException;
import jakarta.mail.Multipart;
import jakarta.mail.internet.AddressException;
import jakarta.mail.internet.InternetAddress;
import jakarta.mail.internet.MimeBodyPart;
import jakarta.mail.internet.MimeMessage;
import jakarta.mail.util.ByteArrayDataSource;
import javax.naming.NamingException;

import org.imixs.workflow.FileData;
import org.imixs.workflow.ItemCollection;
import org.imixs.workflow.engine.DocumentService;
import org.imixs.workflow.exceptions.PluginException;
import org.imixs.workflow.exceptions.QueryException;
import org.imixs.workflow.util.XMLParser;

/**
 * This Plugin extends the Imixs Workflow MailPlugin.
 * 
 * The Plugin translates recipient addresses with the mail address stored in the
 * users profile
 * 

 * In addition this plugin adds the attachments from a snapshot workItem into
 * the mail body if the tag  was found. A attachment can be named:
 * 

 * 
 * 
 * {@code
 *     order.pdf
 *  
 *  _ordernumber.pdf
 * 
 * }
 * 
 * 
 * 
 * An Attachment can also be taken from a textblock. *
 * 
 * 
 * {@code
 *  
 *     
 * }
 * 
 * 
 * @author rsoika
 * @version 2.0
 */
public class MailPlugin extends org.imixs.workflow.engine.plugins.MailPlugin {

    public static String SNAPSHOTID = "$snapshotid";
    public static String PROFILESERVICE_NOT_BOUND = "PROFILESERVICE_NOT_BOUND";
    public static String PROPERTYSERVICE_NOT_BOUND = "PROPERTYSERVICE_NOT_BOUND";
    public static String INVALID_EMAIL = "INVALID_EMAIL";

    private static Logger logger = Logger.getLogger(MailPlugin.class.getName());

    @EJB
    DocumentService documentService;

    @EJB
    ProfileService profileService;

    /**
     * This method adds the attachments of the blob workitem to the MimeMessage
     */
    @Override
    public ItemCollection run(ItemCollection documentContext, ItemCollection documentActivity) throws PluginException {
        // run default functionality
        ItemCollection result = super.run(documentContext, documentActivity);

        // now get the Mail Session object
        MimeMessage mailMessage = (MimeMessage) super.getMailMessage();
        if (mailMessage != null) {

            // run only if we have a message body with a  -1)
            return super.getInternetAddress(aAddr);

        // try to get email from the users profile
        try {
            aAddr = fetchEmail(aAddr);
            if (aAddr.indexOf('@') == -1) {
                logger.warning("smtp mail address for '" + aAddr + "' could not be resolved!");
                return null;
            }
        } catch (NamingException e) {
            // no valid email was found!
            logger.warning("smtp mail address for '" + aAddr + "' could not be resolved - " + e.getMessage());
            // e.printStackTrace();
            // avoid sending mail to this address!
            return null;
        }
        return super.getInternetAddress(aAddr);
    }

    /**
     * This method lookups the emailadress for a given user account through the
     * ProfileService. If no profile is found or email is not valid the method
     * throws a NamingException.
     * 
     * @param aUserID
     * @return
     * @throws NamingException
     */
    private String fetchEmail(String aUserID) throws NamingException {

        ItemCollection itemColProfile = profileService.findProfileById(aUserID);

        if (itemColProfile == null)
            throw new NamingException("No Profile found for: " + aUserID);

        String sEmail = itemColProfile.getItemValueString("txtEmail");

        logger.fine("ProfileService - EmailLookup =" + sEmail);

        if (sEmail != null && !"".equals(sEmail)) {
            if (sEmail.indexOf("http") > -1 || sEmail.indexOf("//") > -1)
                throw new NamingException("Invalid Email: ID=" + aUserID + " Email=" + sEmail);
            return sEmail;
        }

        // test if account contains protokoll information - this
        if (aUserID.indexOf("http") > -1 || aUserID.indexOf("//") > -1)
            throw new NamingException("Invalid Email: ID=" + aUserID);

        return aUserID;
    }

    /**
     * This method adds all files defined in the mail body with the 
     * tag. The files are lookuped either in the workitem or from a textblock.
     * 
     * 
     * @param workitem
     * @return - the new content
     * @throws MessagingException
     */
    private String attachFiles(ItemCollection workitem, String content) throws MessagingException {
        logger.finest("......attaching files");
        ItemCollection attachmentContext = null;

        if (content == null || content.isEmpty())
            return content;

        // get all attachment tags.
        List tags = XMLParser.findTags(content, "attachments");

        for (String _tag : tags) {
            attachmentContext = null;
            logger.finest("......attachments tag=" + _tag);
            // check if the tag contains a textblock attribute.
            if (_tag.contains("textblock")) {
                String textblockName = XMLParser.findAttribute(_tag, "textblock");
                logger.finest("......attaching textblock " + textblockName);
                // 
                if (textblockName != null && !textblockName.isEmpty()) {
                    // it's a textblock file
                    ItemCollection textBlockDocument = loadTextBlock(textblockName);
                    if (textBlockDocument == null) {
                        logger.warning("textblock '" + textblockName + "' is not defined!");
                        // remove the tag
                        content = content.replace(_tag, "");
                        continue;
                    }
                    if (!"FILE".equals(textBlockDocument.getItemValueString("txtmode"))) {
                        logger.warning("textblock '" + textblockName + "' is not defined as type FILE!");
                        // remove the tag
                        content = content.replace(_tag, "");
                        continue;
                    }
                    attachmentContext = textBlockDocument;
                } else {
                    // no attribute value !
                    logger.warning("wrong or empty attribute  'textblock' in tag " + _tag + " - please verify model!");
                    continue;
                }

            } else {
                // default
                attachmentContext = workitem;
            }

            // fetch the snapshot for the current attachmentContext
            ItemCollection snapshotWorkitem = this.getWorkflowService().getDocumentService()
                    .load(attachmentContext.getItemValueString(SNAPSHOTID));
            if (snapshotWorkitem != null) {
                // attachmentContext = snapshotWorkitem;
            }

            // get the value of attachments
            String sFilePattern = XMLParser.findTagValue(_tag, "attachments");
            sFilePattern = sFilePattern.trim();

            logger.finest("......MailPlugin attach file pattern: \"" + sFilePattern + "\"");
            // get all fileNames....
            List fileNames = attachmentContext.getFileNames();

            // build a regex pattern if a pattern exists....
            Pattern pattern = null;
            if (!sFilePattern.isEmpty()) {
                pattern = Pattern.compile(sFilePattern);
            }
            logger.finest("......total count of file=" + fileNames.size());
            // iterate over all files ....
            for (String aFileName : fileNames) {
                // test if aFilename matches the pattern or the pattern is null
                if (pattern == null || pattern.matcher(aFileName).find()) {

                    // fetch the file
                    FileData fileData = attachmentContext.getFileData(aFileName);
                    if (fileData != null) {
                        // it might be that the content of the file is already part of the snapshot
                        if (fileData.getContent().length < 4) {
                            logger.finest("......file found, but we need a snapshot....");
                            // no content - so we can try the snapshot
                            if (snapshotWorkitem != null) {
                                fileData = snapshotWorkitem.getFileData(aFileName);
                                if (fileData == null) {
                                    continue;
                                }
                            } else {
                                logger.warning("Snapshot is missing - can not attache file!!");
                            }
                        }

                        logger.finest("......MailPlugin - attach : " + aFileName);
                        // get Mulitpart Message
                        Multipart multipart = super.getMultipart();
                        // now attache the file
                        MimeBodyPart attachmentPart = new MimeBodyPart();
                        // construct the body part from the byte array
                        DataSource dataSource = new ByteArrayDataSource(fileData.getContent(),
                                fileData.getContentType());
                        attachmentPart.setDataHandler(new DataHandler(dataSource));
                        attachmentPart.setFileName(aFileName);
                        attachmentPart.setDescription("");
                        multipart.addBodyPart(attachmentPart);
                    } else {
                        // no op!
                    }
                }
            }

            // remove the tag
            content = content.replace(_tag, "");
        }

        return content;

    }

    /**
     * Helper method to load a text-block workitem
     * 
     * @see Imixs-Office-Workflow
     * 
     * @param name
     * @return
     */
    public ItemCollection loadTextBlock(String name) {
        ItemCollection textBlockItemCollection = null;
        // check cache...

        // try to load by ID....
        textBlockItemCollection = documentService.load(name);
        if (textBlockItemCollection == null) {
            // not found by ID so lets try to load it by txtname.....
            // load text-block....
            String sQuery = "(type:\"" + "textblock" + "\" AND txtname:\"" + name + "\")";
            Collection col;
            try {
                col = documentService.find(sQuery, 1, 0);

                if (col.size() > 0) {
                    textBlockItemCollection = col.iterator().next();
                } else {
                    logger.warning("Missing text-block : '" + name + "'");
                }
            } catch (QueryException e) {
                logger.warning("getTextBlock - invalid query: " + e.getMessage());
            }

        }

        return textBlockItemCollection;
    }

}