/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
* add the following below this CDDL HEADER, with the fields enclosed
|
* by brackets "[]" replaced with your own identifying information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.schema;
|
|
|
|
import java.util.concurrent.ConcurrentHashMap;
|
import java.util.concurrent.CopyOnWriteArrayList;
|
|
import org.opends.server.admin.std.server.AttributeSyntaxCfg;
|
import org.opends.server.api.ApproximateMatchingRule;
|
import org.opends.server.api.AttributeSyntax;
|
import org.opends.server.api.EqualityMatchingRule;
|
import org.opends.server.api.OrderingMatchingRule;
|
import org.opends.server.api.SubstringMatchingRule;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.types.ByteString;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.ErrorLogCategory;
|
import org.opends.server.types.ErrorLogSeverity;
|
import org.opends.server.types.ResultCode;
|
|
import org.opends.server.types.DebugLogLevel;
|
import static org.opends.server.loggers.ErrorLogger.*;
|
import static org.opends.server.loggers.debug.DebugLogger.*;
|
import org.opends.server.loggers.debug.DebugTracer;
|
import static org.opends.server.messages.MessageHandler.*;
|
import static org.opends.server.messages.SchemaMessages.*;
|
import static org.opends.server.schema.SchemaConstants.*;
|
import static org.opends.server.util.StaticUtils.*;
|
|
|
|
/**
|
* This class implements the matching rule description syntax, which is used to
|
* hold matching rule definitions in the server schema. The format of this
|
* syntax is defined in RFC 2252.
|
*/
|
public class MatchingRuleSyntax
|
extends AttributeSyntax<AttributeSyntaxCfg>
|
{
|
/**
|
* The tracer object for the debug logger.
|
*/
|
private static final DebugTracer TRACER = getTracer();
|
|
|
|
// The default equality matching rule for this syntax.
|
private EqualityMatchingRule defaultEqualityMatchingRule;
|
|
// The default ordering matching rule for this syntax.
|
private OrderingMatchingRule defaultOrderingMatchingRule;
|
|
// The default substring matching rule for this syntax.
|
private SubstringMatchingRule defaultSubstringMatchingRule;
|
|
|
|
/**
|
* Creates a new instance of this syntax. Note that the only thing that
|
* should be done here is to invoke the default constructor for the
|
* superclass. All initialization should be performed in the
|
* <CODE>initializeSyntax</CODE> method.
|
*/
|
public MatchingRuleSyntax()
|
{
|
super();
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void initializeSyntax(AttributeSyntaxCfg configuration)
|
throws ConfigException
|
{
|
defaultEqualityMatchingRule =
|
DirectoryServer.getEqualityMatchingRule(EMR_CASE_IGNORE_OID);
|
if (defaultEqualityMatchingRule == null)
|
{
|
logError(ErrorLogCategory.SCHEMA, ErrorLogSeverity.SEVERE_ERROR,
|
MSGID_ATTR_SYNTAX_UNKNOWN_EQUALITY_MATCHING_RULE,
|
EMR_CASE_IGNORE_OID, SYNTAX_MATCHING_RULE_NAME);
|
}
|
|
defaultOrderingMatchingRule =
|
DirectoryServer.getOrderingMatchingRule(OMR_CASE_IGNORE_OID);
|
if (defaultOrderingMatchingRule == null)
|
{
|
logError(ErrorLogCategory.SCHEMA, ErrorLogSeverity.SEVERE_ERROR,
|
MSGID_ATTR_SYNTAX_UNKNOWN_ORDERING_MATCHING_RULE,
|
OMR_CASE_IGNORE_OID, SYNTAX_MATCHING_RULE_NAME);
|
}
|
|
defaultSubstringMatchingRule =
|
DirectoryServer.getSubstringMatchingRule(SMR_CASE_IGNORE_OID);
|
if (defaultSubstringMatchingRule == null)
|
{
|
logError(ErrorLogCategory.SCHEMA, ErrorLogSeverity.SEVERE_ERROR,
|
MSGID_ATTR_SYNTAX_UNKNOWN_SUBSTRING_MATCHING_RULE,
|
SMR_CASE_IGNORE_OID, SYNTAX_MATCHING_RULE_NAME);
|
}
|
}
|
|
|
|
/**
|
* Retrieves the common name for this attribute syntax.
|
*
|
* @return The common name for this attribute syntax.
|
*/
|
public String getSyntaxName()
|
{
|
return SYNTAX_MATCHING_RULE_NAME;
|
}
|
|
|
|
/**
|
* Retrieves the OID for this attribute syntax.
|
*
|
* @return The OID for this attribute syntax.
|
*/
|
public String getOID()
|
{
|
return SYNTAX_MATCHING_RULE_OID;
|
}
|
|
|
|
/**
|
* Retrieves a description for this attribute syntax.
|
*
|
* @return A description for this attribute syntax.
|
*/
|
public String getDescription()
|
{
|
return SYNTAX_MATCHING_RULE_DESCRIPTION;
|
}
|
|
|
|
/**
|
* Retrieves the default equality matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default equality matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if equality
|
* matches will not be allowed for this type by default.
|
*/
|
public EqualityMatchingRule getEqualityMatchingRule()
|
{
|
return defaultEqualityMatchingRule;
|
}
|
|
|
|
/**
|
* Retrieves the default ordering matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default ordering matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if ordering
|
* matches will not be allowed for this type by default.
|
*/
|
public OrderingMatchingRule getOrderingMatchingRule()
|
{
|
return defaultOrderingMatchingRule;
|
}
|
|
|
|
/**
|
* Retrieves the default substring matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default substring matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if substring
|
* matches will not be allowed for this type by default.
|
*/
|
public SubstringMatchingRule getSubstringMatchingRule()
|
{
|
return defaultSubstringMatchingRule;
|
}
|
|
|
|
/**
|
* Retrieves the default approximate matching rule that will be used for
|
* attributes with this syntax.
|
*
|
* @return The default approximate matching rule that will be used for
|
* attributes with this syntax, or <CODE>null</CODE> if approximate
|
* matches will not be allowed for this type by default.
|
*/
|
public ApproximateMatchingRule getApproximateMatchingRule()
|
{
|
// There is no approximate matching rule by default.
|
return null;
|
}
|
|
|
|
/**
|
* Indicates whether the provided value is acceptable for use in an attribute
|
* with this syntax. If it is not, then the reason may be appended to the
|
* provided buffer.
|
*
|
* @param value The value for which to make the determination.
|
* @param invalidReason The buffer to which the invalid reason should be
|
* appended.
|
*
|
* @return <CODE>true</CODE> if the provided value is acceptable for use with
|
* this syntax, or <CODE>false</CODE> if not.
|
*/
|
public boolean valueIsAcceptable(ByteString value,
|
StringBuilder invalidReason)
|
{
|
// Get string representations of the provided value using the provided form
|
// and with all lowercase characters.
|
String valueStr = value.stringValue();
|
String lowerStr = toLowerCase(valueStr);
|
|
|
// We'll do this a character at a time. First, skip over any leading
|
// whitespace.
|
int pos = 0;
|
int length = valueStr.length();
|
while ((pos < length) && (valueStr.charAt(pos) == ' '))
|
{
|
pos++;
|
}
|
|
if (pos >= length)
|
{
|
// This means that the value was empty or contained only whitespace. That
|
// is illegal.
|
int msgID = MSGID_ATTR_SYNTAX_MR_EMPTY_VALUE;
|
invalidReason.append(getMessage(msgID));
|
return false;
|
}
|
|
|
// The next character must be an open parenthesis. If it is not, then that
|
// is an error.
|
char c = valueStr.charAt(pos++);
|
if (c != '(')
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_EXPECTED_OPEN_PARENTHESIS;
|
invalidReason.append(getMessage(msgID, valueStr, (pos-1), c));
|
return false;
|
}
|
|
|
// Skip over any spaces immediately following the opening parenthesis.
|
while ((pos < length) && ((c = valueStr.charAt(pos)) == ' '))
|
{
|
pos++;
|
}
|
|
if (pos >= length)
|
{
|
// This means that the end of the value was reached before we could find
|
// the OID. Ths is illegal.
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
invalidReason.append(getMessage(msgID, valueStr));
|
return false;
|
}
|
|
|
// The next set of characters must be the OID. Strictly speaking, this
|
// should only be a numeric OID, but we'll also allow for the
|
// "ocname-oid" case as well. Look at the first character to figure out
|
// which we will be using.
|
int oidStartPos = pos;
|
if (isDigit(c))
|
{
|
// This must be a numeric OID. In that case, we will accept only digits
|
// and periods, but not consecutive periods.
|
boolean lastWasPeriod = false;
|
while ((pos < length) && ((c = valueStr.charAt(pos++)) != ' '))
|
{
|
if (c == '.')
|
{
|
if (lastWasPeriod)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_DOUBLE_PERIOD_IN_NUMERIC_OID;
|
invalidReason.append(getMessage(msgID, valueStr, (pos-1)));
|
return false;
|
}
|
else
|
{
|
lastWasPeriod = true;
|
}
|
}
|
else if (! isDigit(c))
|
{
|
// This must have been an illegal character.
|
int msgID = MSGID_ATTR_SYNTAX_MR_ILLEGAL_CHAR_IN_NUMERIC_OID;
|
invalidReason.append(getMessage(msgID, valueStr, c, (pos-1)));
|
return false;
|
}
|
else
|
{
|
lastWasPeriod = false;
|
}
|
}
|
}
|
else
|
{
|
// This must be a "fake" OID. In this case, we will only accept
|
// alphabetic characters, numeric digits, and the hyphen.
|
while ((pos < length) && ((c = valueStr.charAt(pos++)) != ' '))
|
{
|
if (isAlpha(c) || isDigit(c) || (c == '-') ||
|
((c == '_') && DirectoryServer.allowAttributeNameExceptions()))
|
{
|
// This is fine. It is an acceptable character.
|
}
|
else
|
{
|
// This must have been an illegal character.
|
int msgID = MSGID_ATTR_SYNTAX_MR_ILLEGAL_CHAR_IN_STRING_OID;
|
invalidReason.append(getMessage(msgID, valueStr, c, (pos-1)));
|
return false;
|
}
|
}
|
}
|
|
|
// If we're at the end of the value, then it isn't a valid matching rule
|
// description. Otherwise, parse out the OID.
|
String oid;
|
if (pos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
invalidReason.append(getMessage(msgID, valueStr));
|
return false;
|
}
|
else
|
{
|
oid = lowerStr.substring(oidStartPos, (pos-1));
|
}
|
|
|
// Skip over the space(s) after the OID.
|
while ((pos < length) && ((c = valueStr.charAt(pos)) == ' '))
|
{
|
pos++;
|
}
|
|
if (pos >= length)
|
{
|
// This means that the end of the value was reached before we could find
|
// the OID. Ths is illegal.
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
invalidReason.append(getMessage(msgID, valueStr));
|
return false;
|
}
|
|
|
// At this point, we should have a pretty specific syntax that describes
|
// what may come next, but some of the components are optional and it would
|
// be pretty easy to put something in the wrong order, so we will be very
|
// flexible about what we can accept. Just look at the next token, figure
|
// out what it is and how to treat what comes after it, then repeat until
|
// we get to the end of the value. But before we start, set default values
|
// for everything else we might need to know.
|
ConcurrentHashMap<String,String> names =
|
new ConcurrentHashMap<String,String>();
|
AttributeSyntax syntax = null;
|
ConcurrentHashMap<String,CopyOnWriteArrayList<String>> extraProperties =
|
new ConcurrentHashMap<String,CopyOnWriteArrayList<String>>();
|
|
|
while (true)
|
{
|
StringBuilder tokenNameBuffer = new StringBuilder();
|
|
try
|
{
|
pos = readTokenName(valueStr, tokenNameBuffer, pos);
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
invalidReason.append(de.getErrorMessage());
|
return false;
|
}
|
|
String tokenName = tokenNameBuffer.toString();
|
String lowerTokenName = toLowerCase(tokenName);
|
if (tokenName.equals(")"))
|
{
|
// We must be at the end of the value. If not, then that's a problem.
|
if (pos < length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_UNEXPECTED_CLOSE_PARENTHESIS;
|
invalidReason.append(getMessage(msgID, valueStr, (pos-1)));
|
return false;
|
}
|
|
break;
|
}
|
else if (lowerTokenName.equals("name"))
|
{
|
// This specifies the set of names for the matching rule. It may be a
|
// single name in single quotes, or it may be an open parenthesis
|
// followed by one or more names in single quotes separated by spaces.
|
c = valueStr.charAt(pos++);
|
if (c == '\'')
|
{
|
StringBuilder userBuffer = new StringBuilder();
|
StringBuilder lowerBuffer = new StringBuilder();
|
|
try
|
{
|
pos = readQuotedString(valueStr, lowerStr, userBuffer, lowerBuffer,
|
(pos-1));
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
invalidReason.append(de.getErrorMessage());
|
return false;
|
}
|
|
names.put(lowerBuffer.toString(), userBuffer.toString());
|
}
|
else if (c == '(')
|
{
|
StringBuilder userBuffer = new StringBuilder();
|
StringBuilder lowerBuffer = new StringBuilder();
|
|
try
|
{
|
pos = readQuotedString(valueStr, lowerStr, userBuffer, lowerBuffer,
|
pos);
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
invalidReason.append(de.getErrorMessage());
|
return false;
|
}
|
|
names.put(lowerBuffer.toString(), userBuffer.toString());
|
|
|
while (true)
|
{
|
if (valueStr.charAt(pos) == ')')
|
{
|
// Skip over any spaces after the parenthesis.
|
pos++;
|
while ((pos < length) && ((c = valueStr.charAt(pos)) == ' '))
|
{
|
pos++;
|
}
|
|
break;
|
}
|
else
|
{
|
userBuffer = new StringBuilder();
|
lowerBuffer = new StringBuilder();
|
|
try
|
{
|
pos = readQuotedString(valueStr, lowerStr, userBuffer,
|
lowerBuffer, pos);
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
invalidReason.append(de.getErrorMessage());
|
return false;
|
}
|
|
names.put(lowerBuffer.toString(), userBuffer.toString());
|
}
|
}
|
}
|
else
|
{
|
// This is an illegal character.
|
int msgID = MSGID_ATTR_SYNTAX_MR_ILLEGAL_CHAR;
|
invalidReason.append(getMessage(msgID, valueStr, c, (pos-1)));
|
return false;
|
}
|
}
|
else if (lowerTokenName.equals("desc"))
|
{
|
// This specifies the description for the matching rule. It is an
|
// arbitrary string of characters enclosed in single quotes.
|
StringBuilder descriptionBuffer = new StringBuilder();
|
|
try
|
{
|
pos = readQuotedString(valueStr, descriptionBuffer, pos);
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
invalidReason.append(de.getErrorMessage());
|
return false;
|
}
|
}
|
else if (lowerTokenName.equals("obsolete"))
|
{
|
// This indicates whether the matching rule should be considered
|
// obsolete. We do not need to do any more parsing for this token.
|
}
|
else if (lowerTokenName.equals("syntax"))
|
{
|
// This specifies the syntax for the matching rule. Read the next
|
// token, which should be the OID of the associated syntax.
|
StringBuilder oidBuffer = new StringBuilder();
|
|
try
|
{
|
pos = readWOID(lowerStr, oidBuffer, pos);
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
invalidReason.append(de.getErrorMessage());
|
return false;
|
}
|
|
// See if the server recognizes that syntax. If not, then log a
|
// warning.
|
syntax = DirectoryServer.getAttributeSyntax(oidBuffer.toString(),
|
false);
|
if (syntax == null)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_UNKNOWN_SYNTAX;
|
String message = getMessage(msgID, valueStr, oidBuffer.toString());
|
logError(ErrorLogCategory.SCHEMA, ErrorLogSeverity.SEVERE_WARNING,
|
message, msgID);
|
|
syntax = DirectoryServer.getDefaultAttributeSyntax();
|
}
|
}
|
else
|
{
|
// This must be a non-standard property and it must be followed by
|
// either a single value in single quotes or an open parenthesis
|
// followed by one or more values in single quotes separated by spaces
|
// followed by a close parenthesis.
|
CopyOnWriteArrayList<String> valueList =
|
new CopyOnWriteArrayList<String>();
|
|
try
|
{
|
pos = readExtraParameterValues(valueStr, valueList, pos);
|
}
|
catch (DirectoryException de)
|
{
|
if (debugEnabled())
|
{
|
TRACER.debugCaught(DebugLogLevel.ERROR, de);
|
}
|
|
invalidReason.append(de.getErrorMessage());
|
return false;
|
}
|
|
extraProperties.put(tokenName, valueList);
|
}
|
}
|
|
|
// Make sure that a syntax was specified.
|
if (syntax == null)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_NO_SYNTAX;
|
invalidReason.append(getMessage(msgID, valueStr));
|
return false;
|
}
|
|
|
// If we've gotten here, then the value is acceptable.
|
return true;
|
}
|
|
|
|
/**
|
* Reads the next token name from the matching rule definition, skipping over
|
* any leading or trailing spaces, and appends it to the provided buffer.
|
*
|
* @param valueStr The string representation of the matching rule
|
* definition.
|
* @param tokenName The buffer into which the token name will be written.
|
* @param startPos The position in the provided string at which to start
|
* reading the token name.
|
*
|
* @return The position of the first character that is not part of the token
|
* name or one of the trailing spaces after it.
|
*
|
* @throws DirectoryException If a problem is encountered while reading the
|
* token name.
|
*/
|
private static int readTokenName(String valueStr, StringBuilder tokenName,
|
int startPos)
|
throws DirectoryException
|
{
|
// Skip over any spaces at the beginning of the value.
|
char c = '\u0000';
|
int length = valueStr.length();
|
while ((startPos < length) && ((c = valueStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, valueStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Read until we find the next space.
|
while ((startPos < length) && ((c = valueStr.charAt(startPos++)) != ' '))
|
{
|
tokenName.append(c);
|
}
|
|
|
// Skip over any trailing spaces after the value.
|
while ((startPos < length) && ((c = valueStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
|
// Return the position of the first non-space character after the token.
|
return startPos;
|
}
|
|
|
|
/**
|
* Reads the value of a string enclosed in single quotes, skipping over the
|
* quotes and any leading or trailing spaces, and appending the string to the
|
* provided buffer.
|
*
|
* @param valueStr The user-provided representation of the matching rule
|
* definition.
|
* @param valueBuffer The buffer into which the user-provided representation
|
* of the value will be placed.
|
* @param startPos The position in the provided string at which to start
|
* reading the quoted string.
|
*
|
* @return The position of the first character that is not part of the quoted
|
* string or one of the trailing spaces after it.
|
*
|
* @throws DirectoryException If a problem is encountered while reading the
|
* quoted string.
|
*/
|
private static int readQuotedString(String valueStr,
|
StringBuilder valueBuffer, int startPos)
|
throws DirectoryException
|
{
|
// Skip over any spaces at the beginning of the value.
|
char c = '\u0000';
|
int length = valueStr.length();
|
while ((startPos < length) && ((c = valueStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, valueStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// The next character must be a single quote.
|
if (c != '\'')
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_EXPECTED_QUOTE_AT_POS;
|
String message = getMessage(msgID, valueStr, startPos, c);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Read until we find the closing quote.
|
startPos++;
|
while ((startPos < length) && ((c = valueStr.charAt(startPos)) != '\''))
|
{
|
valueBuffer.append(c);
|
startPos++;
|
}
|
|
|
// Skip over any trailing spaces after the value.
|
startPos++;
|
while ((startPos < length) && ((c = valueStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
|
// If we're at the end of the value, then that's illegal.
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, valueStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Return the position of the first non-space character after the token.
|
return startPos;
|
}
|
|
|
|
/**
|
* Reads the value of a string enclosed in single quotes, skipping over the
|
* quotes and any leading or trailing spaces, and appending the string to the
|
* provided buffer.
|
*
|
* @param valueStr The user-provided representation of the matching rule
|
* definition.
|
* @param lowerStr The all-lowercase representation of the matching rule
|
* definition.
|
* @param userBuffer The buffer into which the user-provided representation
|
* of the value will be placed.
|
* @param lowerBuffer The buffer into which the all-lowercase representation
|
* of the value will be placed.
|
* @param startPos The position in the provided string at which to start
|
* reading the quoted string.
|
*
|
* @return The position of the first character that is not part of the quoted
|
* string or one of the trailing spaces after it.
|
*
|
* @throws DirectoryException If a problem is encountered while reading the
|
* quoted string.
|
*/
|
private static int readQuotedString(String valueStr, String lowerStr,
|
StringBuilder userBuffer,
|
StringBuilder lowerBuffer, int startPos)
|
throws DirectoryException
|
{
|
// Skip over any spaces at the beginning of the value.
|
char c = '\u0000';
|
int length = lowerStr.length();
|
while ((startPos < length) && ((c = lowerStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, lowerStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// The next character must be a single quote.
|
if (c != '\'')
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_EXPECTED_QUOTE_AT_POS;
|
String message = getMessage(msgID, valueStr, startPos, c);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Read until we find the closing quote.
|
startPos++;
|
while ((startPos < length) && ((c = lowerStr.charAt(startPos)) != '\''))
|
{
|
lowerBuffer.append(c);
|
userBuffer.append(valueStr.charAt(startPos));
|
startPos++;
|
}
|
|
|
// Skip over any trailing spaces after the value.
|
startPos++;
|
while ((startPos < length) && ((c = lowerStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
|
// If we're at the end of the value, then that's illegal.
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, lowerStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Return the position of the first non-space character after the token.
|
return startPos;
|
}
|
|
|
|
/**
|
* Reads the attribute type/objectclass description or numeric OID from the
|
* provided string, skipping over any leading or trailing spaces, and
|
* appending the value to the provided buffer.
|
*
|
* @param lowerStr The string from which the name or OID is to be read.
|
* @param woidBuffer The buffer into which the name or OID should be
|
* appended.
|
* @param startPos The position at which to start reading.
|
*
|
* @return The position of the first character after the name or OID that is
|
* not a space.
|
*
|
* @throws DirectoryException If a problem is encountered while reading the
|
* name or OID.
|
*/
|
private static int readWOID(String lowerStr, StringBuilder woidBuffer,
|
int startPos)
|
throws DirectoryException
|
{
|
// Skip over any spaces at the beginning of the value.
|
char c = '\u0000';
|
int length = lowerStr.length();
|
while ((startPos < length) && ((c = lowerStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE;
|
String message = getMessage(msgID, lowerStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// The next character must be either numeric (for an OID) or alphabetic (for
|
// an objectclass description).
|
if (isDigit(c))
|
{
|
// This must be a numeric OID. In that case, we will accept only digits
|
// and periods, but not consecutive periods.
|
boolean lastWasPeriod = false;
|
while ((startPos < length) && ((c = lowerStr.charAt(startPos++)) != ' '))
|
{
|
if (c == '.')
|
{
|
if (lastWasPeriod)
|
{
|
int msgID =
|
MSGID_ATTR_SYNTAX_OBJECTCLASS_DOUBLE_PERIOD_IN_NUMERIC_OID;
|
String message = getMessage(msgID, lowerStr, (startPos-1));
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
|
message, msgID);
|
}
|
else
|
{
|
woidBuffer.append(c);
|
lastWasPeriod = true;
|
}
|
}
|
else if (! isDigit(c))
|
{
|
// Technically, this must be an illegal character. However, it is
|
// possible that someone just got sloppy and did not include a space
|
// between the name/OID and a closing parenthesis. In that case,
|
// we'll assume it's the end of the value. What's more, we'll have
|
// to prematurely return to nasty side effects from stripping off
|
// additional characters.
|
if (c == ')')
|
{
|
return (startPos-1);
|
}
|
|
// This must have been an illegal character.
|
int msgID = MSGID_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_NUMERIC_OID;
|
String message = getMessage(msgID, lowerStr, c, (startPos-1));
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
|
message, msgID);
|
}
|
else
|
{
|
woidBuffer.append(c);
|
lastWasPeriod = false;
|
}
|
}
|
}
|
else if (isAlpha(c))
|
{
|
// This must be an objectclass description. In this case, we will only
|
// accept alphabetic characters, numeric digits, and the hyphen.
|
while ((startPos < length) && ((c = lowerStr.charAt(startPos++)) != ' '))
|
{
|
if (isAlpha(c) || isDigit(c) || (c == '-') ||
|
((c == '_') && DirectoryServer.allowAttributeNameExceptions()))
|
{
|
woidBuffer.append(c);
|
}
|
else
|
{
|
// Technically, this must be an illegal character. However, it is
|
// possible that someone just got sloppy and did not include a space
|
// between the name/OID and a closing parenthesis. In that case,
|
// we'll assume it's the end of the value. What's more, we'll have
|
// to prematurely return to nasty side effects from stripping off
|
// additional characters.
|
if (c == ')')
|
{
|
return (startPos-1);
|
}
|
|
// This must have been an illegal character.
|
int msgID = MSGID_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_STRING_OID;
|
String message = getMessage(msgID, lowerStr, c, (startPos-1));
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
|
message, msgID);
|
}
|
}
|
}
|
else
|
{
|
int msgID = MSGID_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR;
|
String message = getMessage(msgID, lowerStr, c, startPos);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Skip over any trailing spaces after the value.
|
while ((startPos < length) && ((c = lowerStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
|
// If we're at the end of the value, then that's illegal.
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE;
|
String message = getMessage(msgID, lowerStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Return the position of the first non-space character after the token.
|
return startPos;
|
}
|
|
|
|
/**
|
* Reads the value for an "extra" parameter. It will handle a single unquoted
|
* word (which is technically illegal, but we'll allow it), a single quoted
|
* string, or an open parenthesis followed by a space-delimited set of quoted
|
* strings or unquoted words followed by a close parenthesis.
|
*
|
* @param valueStr The string containing the information to be read.
|
* @param valueList The list of "extra" parameter values read so far.
|
* @param startPos The position in the value string at which to start
|
* reading.
|
*
|
* @return The "extra" parameter value that was read.
|
*
|
* @throws DirectoryException If a problem occurs while attempting to read
|
* the value.
|
*/
|
private static int readExtraParameterValues(String valueStr,
|
CopyOnWriteArrayList<String> valueList, int startPos)
|
throws DirectoryException
|
{
|
// Skip over any leading spaces.
|
int length = valueStr.length();
|
char c = valueStr.charAt(startPos++);
|
while ((startPos < length) && (c == ' '))
|
{
|
c = valueStr.charAt(startPos++);
|
}
|
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, valueStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
// Look at the next character. If it is a quote, then parse until the next
|
// quote and end. If it is an open parenthesis, then parse individual
|
// values until the close parenthesis and end. Otherwise, parse until the
|
// next space and end.
|
if (c == '\'')
|
{
|
// Parse until the closing quote.
|
StringBuilder valueBuffer = new StringBuilder();
|
while ((startPos < length) && ((c = valueStr.charAt(startPos++)) != '\''))
|
{
|
valueBuffer.append(c);
|
}
|
|
valueList.add(valueBuffer.toString());
|
}
|
else if (c == '(')
|
{
|
while (true)
|
{
|
// Skip over any leading spaces;
|
startPos++;
|
while ((startPos < length) && ((c = valueStr.charAt(startPos)) == ' '))
|
{
|
startPos++;
|
}
|
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, valueStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
|
message, msgID);
|
}
|
|
|
if (c == ')')
|
{
|
// This is the end of the list.
|
break;
|
}
|
else if (c == '(')
|
{
|
// This is an illegal character.
|
int msgID = MSGID_ATTR_SYNTAX_MR_ILLEGAL_CHAR;
|
String message = getMessage(msgID, valueStr, c, startPos);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
|
message, msgID);
|
}
|
else
|
{
|
// We'll recursively call this method to deal with this.
|
startPos = readExtraParameterValues(valueStr, valueList, startPos);
|
}
|
}
|
}
|
else
|
{
|
// Parse until the next space.
|
StringBuilder valueBuffer = new StringBuilder();
|
while ((startPos < length) && ((c = valueStr.charAt(startPos++)) != ' '))
|
{
|
valueBuffer.append(c);
|
}
|
|
valueList.add(valueBuffer.toString());
|
}
|
|
|
|
// Skip over any trailing spaces.
|
while ((startPos < length) && (valueStr.charAt(startPos) == ' '))
|
{
|
startPos++;
|
}
|
|
if (startPos >= length)
|
{
|
int msgID = MSGID_ATTR_SYNTAX_MR_TRUNCATED_VALUE;
|
String message = getMessage(msgID, valueStr);
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message,
|
msgID);
|
}
|
|
|
return startPos;
|
}
|
}
|
