/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache", "Jakarta", "JAMES" and "Apache Software Foundation"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* Portions of this software are based upon public domain software
* originally written at the National Center for Supercomputing Applications,
* University of Illinois, Urbana-Champaign.
*/
package org.apache.james.transport.matchers;
import org.apache.james.util.RFC2822Headers;
import org.apache.mailet.GenericMatcher;
import org.apache.mailet.Mail;
import org.apache.oro.text.regex.MalformedPatternException;
import org.apache.oro.text.regex.Pattern;
import org.apache.oro.text.regex.Perl5Compiler;
import org.apache.oro.text.regex.Perl5Matcher;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.util.Collection;
/**
* This is a generic matcher that uses regular expressions. If any of
* the regular expressions match, the matcher is considered to have
* matched. This is an abstract class that must be subclassed to feed
* patterns. Patterns are provided by calling the compile method. A
* subclass will generally call compile() once during init(), but it
* could subclass match(), and call it as necessary during message
* processing (e.g., if a file of expressions changed).
*
* @author Serge Knystautas <sergek@lokitech.com>
* @author Noel J. Bergman <noel@devtech.com>
* @
*/
abstract public class GenericRegexMatcher extends GenericMatcher {
protected Perl5Matcher matcher;
protected Object[][] patterns;
public void compile(Object[][] patterns) throws MalformedPatternException {
// compile a bunch of regular expressions
this.patterns = patterns;
matcher = new Perl5Matcher();
for (int i = 0; i < patterns.length; i++) {
String pattern = (String)patterns[i][1];
patterns[i][1] = new Perl5Compiler().compile(pattern);
}
}
abstract public void init() throws MessagingException;
public Collection match(Mail mail) throws MessagingException {
MimeMessage message = mail.getMessage();
//Loop through all the patterns
if (patterns != null) for (int i = 0; i < patterns.length; i++) {
//Get the header name
String headerName = (String)patterns[i][0];
//Get the patterns for that header
Pattern pattern = (Pattern)patterns[i][1];
//Get the array of header values that match that
String headers[] = message.getHeader(headerName);
//Loop through the header values
if (headers != null) for (int j = 0; j < headers.length; j++) {
if (matcher.matches(headers[j], pattern)) {
return mail.getRecipients();
}
}
}
return null;
}
}