external-software/github_OpenIdentityPlatform_OpenDJ.git

			@@ -6,17 +6,16 @@
			* (the "License"). You may not use this file except in compliance
			* with the License.
			*
			* You can obtain a copy of the license at
			* trunk/opendj3/legal-notices/CDDLv1_0.txt
			* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
			* or http://forgerock.org/license/CDDLv1.0.html.
			* 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/opendj3/legal-notices/CDDLv1_0.txt. If applicable,
			* add the following below this CDDL HEADER, with the fields enclosed
			* by brackets "[]" replaced with your own identifying information:
			* file and include the License file at legal-notices/CDDLv1_0.txt.
			* 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
			@@ -28,8 +27,6 @@

			package org.forgerock.opendj.ldap.schema;



			import static com.forgerock.opendj.util.StaticUtils.toLowerCase;
			import static org.forgerock.opendj.ldap.CoreMessages.*;
			import static org.forgerock.opendj.ldap.schema.SchemaConstants.EMR_OCTET_STRING_OID;
			@@ -42,394 +39,297 @@

			import com.forgerock.opendj.util.SubstringReader;



			/**
			* This class implements the guide attribute syntax, which may be used to
			* provide criteria for generating search filters for entries, optionally tied
			* to a specified objectclass.
			*/
			final class GuideSyntaxImpl extends AbstractSyntaxImpl
			{
			/**
			* Determines whether the provided string represents a valid criteria
			* according to the guide syntax.
			*
			* @param schema
			* The schema in which this syntax is defined.
			* @param criteria
			* The portion of the criteria for which to make the determination.
			* @param valueStr
			* The complete guide value provided by the client.
			* @param invalidReason
			* The buffer to which to append the reason that the criteria is
			* invalid if a problem is found.
			* @return <CODE>true</CODE> if the provided string does contain a valid
			* criteria, or <CODE>false</CODE> if not.
			*/
			static boolean criteriaIsValid(final Schema schema,
			final String criteria, final String valueStr,
			final LocalizableMessageBuilder invalidReason)
			{
			// See if the criteria starts with a '!'. If so, then just evaluate
			// everything after that as a criteria.
			char c = criteria.charAt(0);
			if (c == '!')
			{
			return criteriaIsValid(schema, criteria.substring(1), valueStr,
			invalidReason);
			}
			final class GuideSyntaxImpl extends AbstractSyntaxImpl {
			/**
			* Determines whether the provided string represents a valid criteria
			* according to the guide syntax.
			*
			* @param schema
			* The schema in which this syntax is defined.
			* @param criteria
			* The portion of the criteria for which to make the
			* determination.
			* @param valueStr
			* The complete guide value provided by the client.
			* @param invalidReason
			* The buffer to which to append the reason that the criteria is
			* invalid if a problem is found.
			* @return <CODE>true</CODE> if the provided string does contain a valid
			* criteria, or <CODE>false</CODE> if not.
			*/
			static boolean criteriaIsValid(final Schema schema, final String criteria,
			final String valueStr, final LocalizableMessageBuilder invalidReason) {
			// See if the criteria starts with a '!'. If so, then just evaluate
			// everything after that as a criteria.
			char c = criteria.charAt(0);
			if (c == '!') {
			return criteriaIsValid(schema, criteria.substring(1), valueStr, invalidReason);
			}

			// See if the criteria starts with a '('. If so, then find the
			// corresponding ')' and parse what's in between as a criteria.
			if (c == '(')
			{
			final int length = criteria.length();
			int depth = 1;
			// See if the criteria starts with a '('. If so, then find the
			// corresponding ')' and parse what's in between as a criteria.
			if (c == '(') {
			final int length = criteria.length();
			int depth = 1;

			for (int i = 1; i < length; i++)
			{
			c = criteria.charAt(i);
			if (c == ')')
			{
			depth--;
			if (depth == 0)
			{
			final String subCriteria = criteria.substring(1, i);
			if (!criteriaIsValid(schema, subCriteria, valueStr, invalidReason))
			{
			return false;
			for (int i = 1; i < length; i++) {
			c = criteria.charAt(i);
			if (c == ')') {
			depth--;
			if (depth == 0) {
			final String subCriteria = criteria.substring(1, i);
			if (!criteriaIsValid(schema, subCriteria, valueStr, invalidReason)) {
			return false;
			}

			// If we are at the end of the value, then it was valid.
			// Otherwise, the next character must be a pipe or an
			// ampersand followed by another set of criteria.
			if (i == length - 1) {
			return true;
			} else {
			c = criteria.charAt(i + 1);
			if (c == '\|' \|\| c == '&') {
			return criteriaIsValid(schema, criteria.substring(i + 2), valueStr,
			invalidReason);
			} else {

			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(
			valueStr, criteria, c, (i + 1)));
			return false;
			}
			}
			}
			} else if (c == '(') {
			depth++;
			}
			}

			// If we are at the end of the value, then it was valid.
			// Otherwise, the next character must be a pipe or an
			// ampersand followed by another set of criteria.
			if (i == length - 1)
			{
			return true;
			}
			else
			{
			c = criteria.charAt(i + 1);
			if (c == '\|' \|\| c == '&')
			{
			return criteriaIsValid(schema,
			criteria.substring(i + 2), valueStr,
			invalidReason);
			}
			else
			{
			// If we've gotten here, then we went through the entire value
			// without finding the appropriate closing parenthesis.

			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(
			valueStr, criteria, c, (i + 1)));
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_MISSING_CLOSE_PAREN.get(valueStr, criteria));
			return false;
			}

			// See if the criteria starts with a '?'. If so, then it must be
			// either "?true" or "?false".
			if (c == '?') {
			if (criteria.startsWith("?true")) {
			if (criteria.length() == 5) {
			return true;
			} else {
			// The only characters allowed next are a pipe or an
			// ampersand.
			c = criteria.charAt(5);
			if (c == '\|' \|\| c == '&') {
			return criteriaIsValid(schema, criteria.substring(6), valueStr,
			invalidReason);
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(valueStr,
			criteria, c, 5));
			return false;
			}
			}
			} else if (criteria.startsWith("?false")) {
			if (criteria.length() == 6) {
			return true;
			} else {
			// The only characters allowed next are a pipe or an
			// ampersand.
			c = criteria.charAt(6);
			if (c == '\|' \|\| c == '&') {
			return criteriaIsValid(schema, criteria.substring(7), valueStr,
			invalidReason);
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(valueStr,
			criteria, c, 6));
			return false;
			}
			}
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_QUESTION_MARK.get(valueStr,
			criteria));
			return false;
			}
			}
			}
			}
			else if (c == '(')
			{
			depth++;

			// See if the criteria is either "true" or "false". If so, then it
			// is valid.
			if (criteria.equals("true") \|\| criteria.equals("false")) {
			return true;
			}
			}

			// If we've gotten here, then we went through the entire value
			// without finding the appropriate closing parenthesis.

			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_MISSING_CLOSE_PAREN.get(
			valueStr, criteria));
			return false;
			}

			// See if the criteria starts with a '?'. If so, then it must be
			// either "?true" or "?false".
			if (c == '?')
			{
			if (criteria.startsWith("?true"))
			{
			if (criteria.length() == 5)
			{
			return true;
			}
			else
			{
			// The only characters allowed next are a pipe or an
			// ampersand.
			c = criteria.charAt(5);
			if (c == '\|' \|\| c == '&')
			{
			return criteriaIsValid(schema, criteria.substring(6), valueStr,
			invalidReason);
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(
			valueStr, criteria, c, 5));
			// The only thing that will be allowed is an attribute type name or
			// OID followed by a dollar sign and a match type. Find the dollar
			// sign and verify whether the value before it is a valid attribute
			// type name or OID.
			final int dollarPos = criteria.indexOf('$');
			if (dollarPos < 0) {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_DOLLAR.get(valueStr, criteria));
			return false;
			}
			}
			}
			else if (criteria.startsWith("?false"))
			{
			if (criteria.length() == 6)
			{
			return true;
			}
			else
			{
			// The only characters allowed next are a pipe or an
			// ampersand.
			c = criteria.charAt(6);
			if (c == '\|' \|\| c == '&')
			{
			return criteriaIsValid(schema, criteria.substring(7), valueStr,
			invalidReason);
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(
			valueStr, criteria, c, 6));
			} else if (dollarPos == 0) {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_ATTR.get(valueStr, criteria));
			return false;
			}
			} else if (dollarPos == criteria.length() - 1) {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_MATCH_TYPE.get(valueStr, criteria));
			return false;
			} else {
			try {
			SchemaUtils.readOID(new SubstringReader(criteria.substring(0, dollarPos)), schema
			.allowMalformedNamesAndOptions());
			} catch (final DecodeException de) {
			invalidReason.append(de.getMessageObject());
			return false;
			}
			}
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_QUESTION_MARK.get(
			valueStr, criteria));
			return false;
			}

			// The substring immediately after the dollar sign must be one of
			// "eq", "substr", "ge", "le", or "approx". It may be followed by
			// the end of the value, a pipe, or an ampersand.
			int endPos;
			c = criteria.charAt(dollarPos + 1);
			switch (c) {
			case 'e':
			if (criteria.startsWith("eq", dollarPos + 1)) {
			endPos = dollarPos + 3;
			break;
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(valueStr,
			criteria, dollarPos + 1));
			return false;
			}

			case 's':
			if (criteria.startsWith("substr", dollarPos + 1)) {
			endPos = dollarPos + 7;
			break;
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(valueStr,
			criteria, dollarPos + 1));
			return false;
			}

			case 'g':
			if (criteria.startsWith("ge", dollarPos + 1)) {
			endPos = dollarPos + 3;
			break;
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(valueStr,
			criteria, dollarPos + 1));
			return false;
			}

			case 'l':
			if (criteria.startsWith("le", dollarPos + 1)) {
			endPos = dollarPos + 3;
			break;
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(valueStr,
			criteria, dollarPos + 1));
			return false;
			}

			case 'a':
			if (criteria.startsWith("approx", dollarPos + 1)) {
			endPos = dollarPos + 7;
			break;
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(valueStr,
			criteria, dollarPos + 1));
			return false;
			}

			default:
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(valueStr, criteria,
			dollarPos + 1));
			return false;
			}

			// See if we are at the end of the value. If so, then it is valid.
			// Otherwise, the next character must be a pipe or an ampersand.
			if (endPos >= criteria.length()) {
			return true;
			} else {
			c = criteria.charAt(endPos);
			if (c == '\|' \|\| c == '&') {
			return criteriaIsValid(schema, criteria.substring(endPos + 1), valueStr,
			invalidReason);
			} else {
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(valueStr, criteria, c,
			endPos));
			return false;
			}
			}
			}

			// See if the criteria is either "true" or "false". If so, then it
			// is valid.
			if (criteria.equals("true") \|\| criteria.equals("false"))
			{
			return true;
			@Override
			public String getEqualityMatchingRule() {
			return EMR_OCTET_STRING_OID;
			}

			// The only thing that will be allowed is an attribute type name or
			// OID followed by a dollar sign and a match type. Find the dollar
			// sign and verify whether the value before it is a valid attribute
			// type name or OID.
			final int dollarPos = criteria.indexOf('$');
			if (dollarPos < 0)
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_DOLLAR.get(valueStr,
			criteria));
			return false;
			}
			else if (dollarPos == 0)
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_ATTR
			.get(valueStr, criteria));
			return false;
			}
			else if (dollarPos == criteria.length() - 1)
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_MATCH_TYPE.get(valueStr,
			criteria));
			return false;
			}
			else
			{
			try
			{
			SchemaUtils.readOID(new SubstringReader(criteria
			.substring(0, dollarPos)),
			schema.allowMalformedNamesAndOptions());
			}
			catch (final DecodeException de)
			{
			invalidReason.append(de.getMessageObject());
			return false;
			}
			public String getName() {
			return SYNTAX_GUIDE_NAME;
			}

			// The substring immediately after the dollar sign must be one of
			// "eq", "substr", "ge", "le", or "approx". It may be followed by
			// the end of the value, a pipe, or an ampersand.
			int endPos;
			c = criteria.charAt(dollarPos + 1);
			switch (c)
			{
			case 'e':
			if (criteria.startsWith("eq", dollarPos + 1))
			{
			endPos = dollarPos + 3;
			break;
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(
			valueStr, criteria, dollarPos + 1));
			return false;
			}

			case 's':
			if (criteria.startsWith("substr", dollarPos + 1))
			{
			endPos = dollarPos + 7;
			break;
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(
			valueStr, criteria, dollarPos + 1));
			return false;
			}

			case 'g':
			if (criteria.startsWith("ge", dollarPos + 1))
			{
			endPos = dollarPos + 3;
			break;
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(
			valueStr, criteria, dollarPos + 1));
			return false;
			}

			case 'l':
			if (criteria.startsWith("le", dollarPos + 1))
			{
			endPos = dollarPos + 3;
			break;
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(
			valueStr, criteria, dollarPos + 1));
			return false;
			}

			case 'a':
			if (criteria.startsWith("approx", dollarPos + 1))
			{
			endPos = dollarPos + 7;
			break;
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(
			valueStr, criteria, dollarPos + 1));
			return false;
			}

			default:
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_INVALID_MATCH_TYPE.get(
			valueStr, criteria, dollarPos + 1));
			return false;
			@Override
			public String getOrderingMatchingRule() {
			return OMR_OCTET_STRING_OID;
			}

			// See if we are at the end of the value. If so, then it is valid.
			// Otherwise, the next character must be a pipe or an ampersand.
			if (endPos >= criteria.length())
			{
			return true;
			}
			else
			{
			c = criteria.charAt(endPos);
			if (c == '\|' \|\| c == '&')
			{
			return criteriaIsValid(schema,
			criteria.substring(endPos + 1), valueStr, invalidReason);
			}
			else
			{
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(valueStr,
			criteria, c, endPos));
			return false;
			}
			}
			}



			@Override
			public String getEqualityMatchingRule()
			{
			return EMR_OCTET_STRING_OID;
			}



			public String getName()
			{
			return SYNTAX_GUIDE_NAME;
			}



			@Override
			public String getOrderingMatchingRule()
			{
			return OMR_OCTET_STRING_OID;
			}



			public boolean isHumanReadable()
			{
			return true;
			}



			/**
			* 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 schema
			* The schema in which this syntax is defined.
			* @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(final Schema schema,
			final ByteSequence value, final LocalizableMessageBuilder invalidReason)
			{
			// Get a lowercase string version of the provided value.
			final String valueStr = toLowerCase(value.toString());

			// Find the position of the octothorpe. If there isn't one, then the
			// entire value should be the criteria.
			final int sharpPos = valueStr.indexOf('#');
			if (sharpPos < 0)
			{
			return criteriaIsValid(schema, valueStr, valueStr, invalidReason);
			public boolean isHumanReadable() {
			return true;
			}

			// Get the objectclass and see if it is a valid name or OID.
			final String ocName = valueStr.substring(0, sharpPos).trim();
			final int ocLength = ocName.length();
			if (ocLength == 0)
			{
			/**
			* 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 schema
			* The schema in which this syntax is defined.
			* @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(final Schema schema, final ByteSequence value,
			final LocalizableMessageBuilder invalidReason) {
			// Get a lowercase string version of the provided value.
			final String valueStr = toLowerCase(value.toString());

			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_OC1.get(valueStr));
			return false;
			}
			// Find the position of the octothorpe. If there isn't one, then the
			// entire value should be the criteria.
			final int sharpPos = valueStr.indexOf('#');
			if (sharpPos < 0) {
			return criteriaIsValid(schema, valueStr, valueStr, invalidReason);
			}

			try
			{
			SchemaUtils.readOID(new SubstringReader(ocName.substring(0, ocLength)),
			schema.allowMalformedNamesAndOptions());
			}
			catch (final DecodeException de)
			{
			invalidReason.append(de.getMessageObject());
			return false;
			}
			// Get the objectclass and see if it is a valid name or OID.
			final String ocName = valueStr.substring(0, sharpPos).trim();
			final int ocLength = ocName.length();
			if (ocLength == 0) {

			// The rest of the value must be the criteria.
			return criteriaIsValid(schema, valueStr.substring(sharpPos + 1),
			valueStr, invalidReason);
			}
			invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_NO_OC1.get(valueStr));
			return false;
			}

			try {
			SchemaUtils.readOID(new SubstringReader(ocName.substring(0, ocLength)), schema
			.allowMalformedNamesAndOptions());
			} catch (final DecodeException de) {
			invalidReason.append(de.getMessageObject());
			return false;
			}

			// The rest of the value must be the criteria.
			return criteriaIsValid(schema, valueStr.substring(sharpPos + 1), valueStr, invalidReason);
			}
			}