/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2006-2008 Sun Microsystems, Inc.
|
* Portions Copyright 2012-2016 ForgeRock AS.
|
*/
|
package org.opends.server.schema;
|
|
import org.forgerock.opendj.server.config.server.AttributeSyntaxCfg;
|
import org.forgerock.opendj.ldap.schema.Schema;
|
import org.forgerock.opendj.ldap.schema.Syntax;
|
import org.opends.server.api.AttributeSyntax;
|
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 guide attribute syntax, which may be used to
|
* provide criteria for generating search filters for entries, optionally tied
|
* to a specified objectclass.
|
*/
|
public class GuideSyntax
|
extends AttributeSyntax<AttributeSyntaxCfg>
|
{
|
|
/**
|
* 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 GuideSyntax()
|
{
|
super();
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public Syntax getSDKSyntax(Schema schema)
|
{
|
return schema.getSyntax(SchemaConstants.SYNTAX_GUIDE_OID);
|
}
|
|
/**
|
* Retrieves the common name for this attribute syntax.
|
*
|
* @return The common name for this attribute syntax.
|
*/
|
@Override
|
public String getName()
|
{
|
return SYNTAX_GUIDE_NAME;
|
}
|
|
/**
|
* Retrieves the OID for this attribute syntax.
|
*
|
* @return The OID for this attribute syntax.
|
*/
|
@Override
|
public String getOID()
|
{
|
return SYNTAX_GUIDE_OID;
|
}
|
|
/**
|
* Retrieves a description for this attribute syntax.
|
*
|
* @return A description for this attribute syntax.
|
*/
|
@Override
|
public String getDescription()
|
{
|
return SYNTAX_GUIDE_DESCRIPTION;
|
}
|
|
/**
|
* Determines whether the provided string represents a valid criteria
|
* according to the guide syntax.
|
*
|
* @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.
|
*/
|
public static boolean criteriaIsValid(String criteria, String valueStr,
|
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(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 == '(')
|
{
|
int length = criteria.length();
|
int depth = 1;
|
|
for (int i=1; i < length; i++)
|
{
|
c = criteria.charAt(i);
|
if (c == ')')
|
{
|
depth--;
|
if (depth == 0)
|
{
|
String subCriteria = criteria.substring(1, i);
|
if (! criteriaIsValid(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(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'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(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(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;
|
}
|
}
|
|
|
// See if the criteria is either "true" or "false". If so, then it is
|
// valid.
|
if (criteria.equals("true") || criteria.equals("false"))
|
{
|
return true;
|
}
|
|
|
// 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.
|
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
|
{
|
if (! isValidSchemaElement(criteria, 0, dollarPos, invalidReason))
|
{
|
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(criteria.substring(endPos+1), valueStr,
|
invalidReason);
|
}
|
else
|
{
|
invalidReason.append(ERR_ATTR_SYNTAX_GUIDE_ILLEGAL_CHAR.get(
|
valueStr, criteria, c, endPos));
|
return false;
|
}
|
}
|
}
|
}
|
