Ticket #69: RcptMatcher.java

/*
 * 
 * Jsmtpd, Java SMTP daemon
 * Copyright (C) 2005  Jean-Francois POUX, jf.poux@laposte.net
 *
 * 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 should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
package org.jsmtpd.plugins.filters.builtin;

import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jsmtpd.core.common.PluginInitException;
import org.jsmtpd.core.common.filter.FilterTreeFailureException;
import org.jsmtpd.core.common.filter.FilterTreeSuccesException;
import org.jsmtpd.core.common.filter.IFilter;
import org.jsmtpd.core.mail.Email;
import org.jsmtpd.core.mail.EmailAddress;
import org.jsmtpd.core.mail.InvalidAddress;
import org.jsmtpd.core.mail.Rcpt;

/**
 * This filter returns true if the RCPTS specified are present.
 * If multiple RCPTS are present, you can configure the logical operator between the matches
 * by default all rcpt are required to validate the filter. set the properet orOperator to true
 * will return true at the first rcpt found.
 * 
 * Additionnally, you can set failOnError to true if you wish to break the tree when rcpt are not found.
 * You can also validate the whole tree is the filter is passed successfully by setting validateOnSucces to true.
 * 
 * @author Jean-Francois POUX
 */
public class RcptMatcher implements IFilter {

    private boolean orOperator = false;

    private List<EmailAddress> rcptToMatch = new LinkedList<EmailAddress>();
    private Log log = LogFactory.getLog(RcptMatcher.class);
    private boolean failOnError = false;
    private boolean validateOnSucces = false;

    /* (non-Javadoc)
     * @see org.jsmtpd.core.common.filter.IFilter#doFilter(org.jsmtpd.core.mail.Email)
     */
    public boolean doFilter(Email input) throws FilterTreeFailureException, FilterTreeSuccesException {
        List<Rcpt> rcptInMail = input.getRcpt();
        boolean res = false;
        boolean found = false;
        if (orOperator) {
            for (Iterator iterator = rcptInMail.iterator(); iterator.hasNext();) {
                Rcpt element = (Rcpt) iterator.next();
                EmailAddress oneRcptInMail = element.getEmailAddress();
                for (Iterator iter = rcptToMatch.iterator(); iter.hasNext();) {
                    EmailAddress oneRcptToMatch = (EmailAddress) iter.next();
                    if (oneRcptToMatch.isEqual(oneRcptInMail)) {
                        found = true;
                        break;
                    }
                }
                if (found) {
                    break;
                }
            }
        } else {
            log.debug("Plugin: " + getPluginName() + " Start validating without orOperator");
            for (Iterator iterator = rcptInMail.iterator(); iterator.hasNext();) {
                Rcpt element = (Rcpt) iterator.next();
                EmailAddress oneRcptInMail = element.getEmailAddress();
                found = false;
                for (Iterator iter = rcptToMatch.iterator(); iter.hasNext();) {
                    EmailAddress oneRcptToMatch = (EmailAddress) iter.next();
                    if (oneRcptToMatch.isEqual(oneRcptInMail)) {
                        found = true;
                        break;
                    }
                }
                if (!found) {
                    break;
                }
            }
        }
        if (found) {
            res = true;
        }
        if (failOnError && (!res)) {
            throw new FilterTreeFailureException();
        }

        if (validateOnSucces && res)
            throw new FilterTreeSuccesException();

        return res;
    }

    /* (non-Javadoc)
     * @see org.jsmtpd.core.common.IGenericPlugin#getPluginName()
     */
    public String getPluginName() {
        return "Recipient filter matcher for Jsmtp";
    }

    /* (non-Javadoc)
     * @see org.jsmtpd.core.common.IGenericPlugin#initPlugin()
     */
    public void initPlugin() throws PluginInitException {

    }

    /* (non-Javadoc)
     * @see org.jsmtpd.core.common.IGenericPlugin#shutdownPlugin()
     */
    public void shutdownPlugin() {

    }

    public void setRcpt(String rcpt) {
        try {
            EmailAddress rcptToAdd = EmailAddress.parseAddress(rcpt);
            rcptToMatch.add(rcptToAdd);
        } catch (InvalidAddress e) {
            log.error("Plugin: " + getPluginName() + " can't add rcpt to matching list, " + rcpt + " is not a valid email adress");
        }
    }

    public void setOrOperator(boolean cond) {
        orOperator = cond;
    }

    public void setFailOnError(boolean op) {
        failOnError = op;
    }

    public void setValidateOnSucces(boolean op) {
        validateOnSucces = op;
    }
}