/****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one *
* or more contributor license agreements. See the NOTICE file *
* distributed with this work for additional information *
* regarding copyright ownership. The ASF licenses this file *
* to you 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. *
****************************************************************/
package org.apache.jsieve.tests;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import org.apache.jsieve.Arguments;
import org.apache.jsieve.SieveContext;
import org.apache.jsieve.StringListArgument;
import org.apache.jsieve.TagArgument;
import org.apache.jsieve.comparators.ComparatorNames;
import org.apache.jsieve.comparators.MatchTypeTags;
import org.apache.jsieve.exception.SieveException;
import org.apache.jsieve.exception.SyntaxException;
import org.apache.jsieve.mail.MailAdapter;
import org.apache.jsieve.mail.SieveMailException;
public abstract class AbstractCompatatorTest extends AbstractTest implements
AddressPartTags, ComparatorTags, MatchTypeTags, ComparatorNames {
public AbstractCompatatorTest() {
super();
}
/**
* <p>
* From RFC 3028, Section 5.1...
* </p>
* <code>
* Syntax: address [ADDRESS-PART] [COMPARATOR] [MATCH-TYPE]
* <header-list: string-list> <key-list: string-list>
* </code>
* <p>
* Note that the spec. then goes on to give an example where the order of
* the optional parts is different, so I am assuming that the order of the
* optional parts is optional too!
* </p>
*
* @see org.apache.jsieve.tests.AbstractTest#executeBasic(MailAdapter,
* Arguments, SieveContext)
*/
protected boolean executeBasic(MailAdapter mail, Arguments arguments,
SieveContext context) throws SieveException {
String addressPart = null;
String comparator = null;
String matchType = null;
List headerNames = null;
List keys = null;
ListIterator argumentsIter = arguments.getArgumentList().listIterator();
boolean stop = false;
// Tag processing
while (!stop && argumentsIter.hasNext()) {
Object argument = argumentsIter.next();
if (argument instanceof TagArgument) {
String tag = ((TagArgument) argument).getTag();
// [ADDRESS-PART]?
if (null == addressPart
&& (tag.equals(LOCALPART_TAG) || tag.equals(DOMAIN_TAG) || tag
.equals(ALL_TAG)))
addressPart = tag;
// [COMPARATOR]?
else if (null == comparator && tag.equals(COMPARATOR_TAG)) {
// The next argument must be a stringlist
if (argumentsIter.hasNext()) {
argument = argumentsIter.next();
if (argument instanceof StringListArgument) {
List stringList = ((StringListArgument) argument)
.getList();
if (stringList.size() != 1)
throw new SyntaxException(
"Expecting exactly one String");
comparator = (String) stringList.get(0);
} else
throw new SyntaxException("Expecting a StringList");
}
}
// [MATCH-TYPE]?
else if (null == matchType
&& (tag.equals(IS_TAG) || tag.equals(CONTAINS_TAG) || tag
.equals(MATCHES_TAG)))
matchType = tag;
else
throw context.getCoordinate().syntaxException(
"Found unexpected TagArgument");
} else {
// Stop when a non-tag argument is encountered
argumentsIter.previous();
stop = true;
}
}
// The next argument MUST be a string-list of header names
if (argumentsIter.hasNext()) {
Object argument = argumentsIter.next();
if (argument instanceof StringListArgument)
headerNames = ((StringListArgument) argument).getList();
}
if (null == headerNames)
throw context.getCoordinate().syntaxException(
"Expecting a StringList of header names");
// The next argument MUST be a string-list of keys
if (argumentsIter.hasNext()) {
Object argument = argumentsIter.next();
if (argument instanceof StringListArgument)
keys = ((StringListArgument) argument).getList();
} else if (null == keys)
throw context.getCoordinate().syntaxException(
"Expecting a StringList of keys");
if (argumentsIter.hasNext())
throw context.getCoordinate().syntaxException(
"Found unexpected arguments");
return match(mail, (addressPart == null ? ALL_TAG : addressPart),
(comparator == null ? ASCII_CASEMAP_COMPARATOR : comparator),
(matchType == null ? IS_TAG : matchType), headerNames, keys);
}
/**
* Method match.
*
* @param mail
* @param addressPart
* @param comparator
* @param matchType
* @param headerNames
* @param keys
* @return boolean
* @throws SieveMailException
*/
protected boolean match(MailAdapter mail, String addressPart,
String comparator, String matchType, List headerNames, List keys)
throws SieveException {
// Iterate over the header names looking for a match
boolean isMatched = false;
Iterator headerNamesIter = headerNames.iterator();
while (!isMatched && headerNamesIter.hasNext()) {
isMatched = match(mail, addressPart, comparator, matchType,
(String) headerNamesIter.next(), keys);
}
return isMatched;
}
/**
* Method match.
*
* @param mail
* @param addressPart
* @param comparator
* @param matchType
* @param headerName
* @param keys
* @return boolean
* @throws SieveMailException
*/
protected boolean match(MailAdapter mail, String addressPart,
String comparator, String matchType, String headerName, List keys)
throws SieveException {
// Iterate over the keys looking for a match
boolean isMatched = false;
Iterator keysIter = keys.iterator();
while (!isMatched && keysIter.hasNext()) {
isMatched = match(mail, addressPart, comparator, matchType,
headerName, (String) keysIter.next());
}
return isMatched;
}
/**
* Method match.
*
* @param mail
* @param addressPart
* @param comparator
* @param matchType
* @param headerName
* @param key
* @return boolean
* @throws SieveMailException
*/
protected abstract boolean match(MailAdapter mail, String addressPart,
String comparator, String matchType, String headerName, String key)
throws SieveException;
/**
* @see org.apache.jsieve.tests.AbstractTest#validateArguments(Arguments,
* SieveContext)
*/
protected void validateArguments(Arguments arguments, SieveContext context)
throws SieveException {
if (arguments.hasTests())
throw context.getCoordinate().syntaxException(
"Found unexpected tests");
}
}