| | |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.schema; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | | import static org.opends.server.schema.SchemaConstants.*; |
| | | |
| | | |
| | | import java.util.concurrent.ConcurrentHashMap; |
| | | import java.util.concurrent.CopyOnWriteArrayList; |
| | | |
| | | import org.forgerock.opendj.ldap.schema.Schema; |
| | | import org.forgerock.opendj.ldap.schema.Syntax; |
| | | import org.opends.server.admin.std.server.AttributeSyntaxCfg; |
| | | import org.opends.server.api.AttributeSyntax; |
| | | import org.forgerock.opendj.ldap.schema.MatchingRule; |
| | | import org.forgerock.opendj.config.server.ConfigException; |
| | | import org.opends.server.core.DirectoryServer; |
| | | import org.opends.server.types.*; |
| | | import org.forgerock.opendj.ldap.ResultCode; |
| | | import org.forgerock.opendj.ldap.ByteSequence; |
| | | import org.forgerock.i18n.slf4j.LocalizedLogger; |
| | | |
| | | import static org.opends.messages.SchemaMessages.*; |
| | | |
| | | import org.forgerock.i18n.LocalizableMessageBuilder; |
| | | |
| | | 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 |
| | |
| | | public class MatchingRuleSyntax |
| | | extends AttributeSyntax<AttributeSyntaxCfg> |
| | | { |
| | | private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); |
| | | |
| | | /** The default equality matching rule for this syntax. */ |
| | | private MatchingRule defaultEqualityMatchingRule; |
| | | |
| | | /** The default ordering matching rule for this syntax. */ |
| | | private MatchingRule defaultOrderingMatchingRule; |
| | | |
| | | /** The default substring matching rule for this syntax. */ |
| | | private MatchingRule 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 |
| | |
| | | |
| | | /** {@inheritDoc} */ |
| | | @Override |
| | | public void initializeSyntax(AttributeSyntaxCfg configuration) |
| | | throws ConfigException |
| | | public Syntax getSDKSyntax(Schema schema) |
| | | { |
| | | defaultEqualityMatchingRule = |
| | | DirectoryServer.getMatchingRule(EMR_CASE_IGNORE_OID); |
| | | if (defaultEqualityMatchingRule == null) |
| | | { |
| | | logger.error(ERR_ATTR_SYNTAX_UNKNOWN_EQUALITY_MATCHING_RULE, EMR_CASE_IGNORE_OID, SYNTAX_MATCHING_RULE_NAME); |
| | | } |
| | | |
| | | defaultOrderingMatchingRule = |
| | | DirectoryServer.getMatchingRule(OMR_CASE_IGNORE_OID); |
| | | if (defaultOrderingMatchingRule == null) |
| | | { |
| | | logger.error(ERR_ATTR_SYNTAX_UNKNOWN_ORDERING_MATCHING_RULE, OMR_CASE_IGNORE_OID, SYNTAX_MATCHING_RULE_NAME); |
| | | } |
| | | |
| | | defaultSubstringMatchingRule = |
| | | DirectoryServer.getMatchingRule(SMR_CASE_IGNORE_OID); |
| | | if (defaultSubstringMatchingRule == null) |
| | | { |
| | | logger.error(ERR_ATTR_SYNTAX_UNKNOWN_SUBSTRING_MATCHING_RULE, SMR_CASE_IGNORE_OID, SYNTAX_MATCHING_RULE_NAME); |
| | | } |
| | | return schema.getSyntax(SchemaConstants.SYNTAX_MATCHING_RULE_OID); |
| | | } |
| | | |
| | | /** |
| | |
| | | { |
| | | 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. |
| | | */ |
| | | @Override |
| | | public MatchingRule 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. |
| | | */ |
| | | @Override |
| | | public MatchingRule 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. |
| | | */ |
| | | @Override |
| | | public MatchingRule 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. |
| | | */ |
| | | @Override |
| | | public MatchingRule 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. |
| | | */ |
| | | @Override |
| | | public boolean valueIsAcceptable(ByteSequence value, |
| | | LocalizableMessageBuilder invalidReason) |
| | | { |
| | | // Get string representations of the provided value using the provided form |
| | | // and with all lowercase characters. |
| | | String valueStr = value.toString(); |
| | | 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. |
| | | |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_EMPTY_VALUE.get()); |
| | | 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 != '(') |
| | | { |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_EXPECTED_OPEN_PARENTHESIS.get(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. |
| | | |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr)); |
| | | return false; |
| | | } |
| | | |
| | | |
| | | 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) |
| | | { |
| | | invalidReason.append( |
| | | ERR_ATTR_SYNTAX_MR_DOUBLE_PERIOD_IN_NUMERIC_OID.get( |
| | | valueStr, (pos-1))); |
| | | return false; |
| | | } |
| | | else |
| | | { |
| | | lastWasPeriod = true; |
| | | } |
| | | } |
| | | else if (! isDigit(c)) |
| | | { |
| | | // This must have been an illegal character. |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_ILLEGAL_CHAR_IN_NUMERIC_OID.get(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. |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_ILLEGAL_CHAR_IN_STRING_OID.get(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. |
| | | if (pos >= length) |
| | | { |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr)); |
| | | return false; |
| | | } |
| | | |
| | | |
| | | // 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. |
| | | |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(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) |
| | | { |
| | | logger.traceException(de); |
| | | |
| | | invalidReason.append(de.getMessageObject()); |
| | | 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) |
| | | { |
| | | invalidReason.append( |
| | | ERR_ATTR_SYNTAX_MR_UNEXPECTED_CLOSE_PARENTHESIS.get( |
| | | 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) |
| | | { |
| | | logger.traceException(de); |
| | | |
| | | invalidReason.append(de.getMessageObject()); |
| | | 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) |
| | | { |
| | | logger.traceException(de); |
| | | |
| | | invalidReason.append(de.getMessageObject()); |
| | | 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) |
| | | { |
| | | logger.traceException(de); |
| | | |
| | | invalidReason.append(de.getMessageObject()); |
| | | return false; |
| | | } |
| | | |
| | | names.put(lowerBuffer.toString(), userBuffer.toString()); |
| | | } |
| | | } |
| | | } |
| | | else |
| | | { |
| | | // This is an illegal character. |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_ILLEGAL_CHAR.get(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) |
| | | { |
| | | logger.traceException(de); |
| | | |
| | | invalidReason.append(de.getMessageObject()); |
| | | 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) |
| | | { |
| | | logger.traceException(de); |
| | | |
| | | invalidReason.append(de.getMessageObject()); |
| | | return false; |
| | | } |
| | | |
| | | // See if the server recognizes that syntax. If not, then log a |
| | | // warning. |
| | | syntax = DirectoryServer.getSchema().getSyntax(oidBuffer.toString(), false); |
| | | if (syntax == null) |
| | | { |
| | | logger.error(ERR_ATTR_SYNTAX_MR_UNKNOWN_SYNTAX, valueStr, oidBuffer); |
| | | |
| | | 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) |
| | | { |
| | | logger.traceException(de); |
| | | |
| | | invalidReason.append(de.getMessageObject()); |
| | | return false; |
| | | } |
| | | |
| | | extraProperties.put(tokenName, valueList); |
| | | } |
| | | } |
| | | |
| | | |
| | | // Make sure that a syntax was specified. |
| | | if (syntax == null) |
| | | { |
| | | invalidReason.append(ERR_ATTR_SYNTAX_MR_NO_SYNTAX.get(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) |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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) |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // The next character must be a single quote. |
| | | if (c != '\'') |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_EXPECTED_QUOTE_AT_POS.get(valueStr, startPos, c); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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) |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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) |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(lowerStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // The next character must be a single quote. |
| | | if (c != '\'') |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_EXPECTED_QUOTE_AT_POS.get(valueStr, startPos, c); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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) |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(lowerStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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) |
| | | { |
| | | LocalizableMessage message = |
| | | ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(lowerStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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) |
| | | { |
| | | LocalizableMessage message = |
| | | ERR_ATTR_SYNTAX_OBJECTCLASS_DOUBLE_PERIOD_IN_NUMERIC_OID. |
| | | get(lowerStr, (startPos-1)); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, |
| | | message); |
| | | } |
| | | 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. |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_NUMERIC_OID.get( |
| | | lowerStr, c, (startPos - 1)); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | 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. |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_STRING_OID.get( |
| | | lowerStr, c, (startPos - 1)); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | } |
| | | } |
| | | else |
| | | { |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR.get(lowerStr, c, startPos); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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) |
| | | { |
| | | LocalizableMessage message = |
| | | ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(lowerStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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 = '\u0000'; |
| | | while ((startPos < length) && ((c = valueStr.charAt(startPos)) == ' ')) |
| | | { |
| | | startPos++; |
| | | } |
| | | |
| | | if (startPos >= length) |
| | | { |
| | | LocalizableMessage message = |
| | | ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | |
| | | // 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(); |
| | | startPos++; |
| | | while ((startPos < length) && ((c = valueStr.charAt(startPos)) != '\'')) |
| | | { |
| | | valueBuffer.append(c); |
| | | startPos++; |
| | | } |
| | | startPos++; |
| | | valueList.add(valueBuffer.toString()); |
| | | } |
| | | else if (c == '(') |
| | | { |
| | | startPos++; |
| | | // We're expecting a list of values. Quoted, space separated. |
| | | while (true) |
| | | { |
| | | // Skip over any leading spaces; |
| | | while ((startPos < length) && ((c = valueStr.charAt(startPos)) == ' ')) |
| | | { |
| | | startPos++; |
| | | } |
| | | |
| | | if (startPos >= length) |
| | | { |
| | | LocalizableMessage message = |
| | | ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, |
| | | message); |
| | | } |
| | | |
| | | if (c == ')') |
| | | { |
| | | // This is the end of the list. |
| | | startPos++; |
| | | break; |
| | | } |
| | | else if (c == '(') |
| | | { |
| | | // This is an illegal character. |
| | | LocalizableMessage message = ERR_ATTR_SYNTAX_MR_ILLEGAL_CHAR.get(valueStr, c, startPos); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | else if (c == '\'') |
| | | { |
| | | // We have a quoted string |
| | | StringBuilder valueBuffer = new StringBuilder(); |
| | | startPos++; |
| | | while ((startPos < length) && |
| | | ((c = valueStr.charAt(startPos)) != '\'')) |
| | | { |
| | | valueBuffer.append(c); |
| | | startPos++; |
| | | } |
| | | |
| | | valueList.add(valueBuffer.toString()); |
| | | startPos++; |
| | | } |
| | | else |
| | | { |
| | | //Consider unquoted string |
| | | StringBuilder valueBuffer = new StringBuilder(); |
| | | while ((startPos < length) && |
| | | ((c = valueStr.charAt(startPos)) != ' ')) |
| | | { |
| | | valueBuffer.append(c); |
| | | startPos++; |
| | | } |
| | | |
| | | valueList.add(valueBuffer.toString()); |
| | | } |
| | | |
| | | if (startPos >= length) |
| | | { |
| | | LocalizableMessage message = |
| | | ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr); |
| | | throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, |
| | | message); |
| | | } |
| | | } |
| | | } |
| | | else |
| | | { |
| | | // Parse until the next space. |
| | | StringBuilder valueBuffer = new StringBuilder(); |
| | | while ((startPos < length) && ((c = valueStr.charAt(startPos)) != ' ')) |
| | | { |
| | | valueBuffer.append(c); |
| | | startPos++; |
| | | } |
| | | |
| | | valueList.add(valueBuffer.toString()); |
| | | } |
| | | |
| | | // Skip over any trailing spaces. |
| | | while ((startPos < length) && (valueStr.charAt(startPos) == ' ')) |
| | | { |
| | | startPos++; |
| | | } |
| | | |
| | | if (startPos >= length) |
| | | { |
| | | LocalizableMessage message = |
| | | ERR_ATTR_SYNTAX_MR_TRUNCATED_VALUE.get(valueStr); |
| | | throw new DirectoryException( |
| | | ResultCode.INVALID_ATTRIBUTE_SYNTAX, message); |
| | | } |
| | | |
| | | return startPos; |
| | | } |
| | | |
| | | /** {@inheritDoc} */ |
| | | @Override |
| | | public boolean isBEREncodingRequired() |
| | | { |
| | | return false; |
| | | } |
| | | |
| | | /** {@inheritDoc} */ |
| | | public boolean isHumanReadable() |
| | | { |
| | | return true; |
| | | } |
| | | } |
| | | |