openldap/servers/slapd/filter.c

/* filter.c - routines for parsing and dealing with filters */
/* $OpenLDAP$ */
/*
 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
 */

#include "portable.h"

#include <stdio.h>

#include <ac/socket.h>
#include <ac/string.h>

#include "slap.h"

static int	get_filter_list(
	Connection *conn,
	BerElement *ber,
	Filter **f,
	char **fstr,
	char **text );
static int	get_substring_filter(
	Connection *conn,
	BerElement *ber,
	Filter *f,
	char **fstr,
	char **text );

int
get_filter(
	Connection *conn,
	BerElement *ber,
	Filter **filt,
	char **fstr,
	char **text )
{
	ber_tag_t	tag;
	ber_len_t	len;
	int		err;
	Filter		*f;
	char		*ftmp = NULL;

	Debug( LDAP_DEBUG_FILTER, "begin get_filter\n", 0, 0, 0 );

	/*
	 * A filter looks like this coming in:
	 *	Filter ::= CHOICE {
	 *		and		[0]	SET OF Filter,
	 *		or		[1]	SET OF Filter,
	 *		not		[2]	Filter,
	 *		equalityMatch	[3]	AttributeValueAssertion,
	 *		substrings	[4]	SubstringFilter,
	 *		greaterOrEqual	[5]	AttributeValueAssertion,
	 *		lessOrEqual	[6]	AttributeValueAssertion,
	 *		present		[7]	AttributeType,,
	 *		approxMatch	[8]	AttributeValueAssertion
	 *		extensibleMatch [9] MatchingRuleAssertion
	 *	}
	 *
	 *	SubstringFilter ::= SEQUENCE {
	 *		type               AttributeType,
	 *		SEQUENCE OF CHOICE {
	 *			initial          [0] IA5String,
	 *			any              [1] IA5String,
	 *			final            [2] IA5String
	 *		}
	 *	}
	 *
     *  MatchingRuleAssertion ::= SEQUENCE {
     *          matchingRule    [1] MatchingRuleId OPTIONAL,
     *          type            [2] AttributeDescription OPTIONAL,
     *          matchValue      [3] AssertionValue,
     *          dnAttributes    [4] BOOLEAN DEFAULT FALSE
	 *	}
	 *
	 */

	tag = ber_peek_tag( ber, &len );

	if( tag == LBER_ERROR ) {
		*text = "error decoding filter";
		return SLAPD_DISCONNECT;
	}

	f = (Filter *) ch_malloc( sizeof(Filter) );
	f->f_next = NULL;

	err = LDAP_SUCCESS;
	*fstr = NULL;
	f->f_choice = tag; 

	switch ( f->f_choice ) {
	case LDAP_FILTER_EQUALITY:
		Debug( LDAP_DEBUG_FILTER, "EQUALITY\n", 0, 0, 0 );

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		err = get_ava( ber, &f->f_ava, SLAP_MR_EQUALITY, text );
#else
		err = get_ava( ber, &f->f_ava, text );
#endif
		if ( err != LDAP_SUCCESS ) {
			break;
		}

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		assert( f->f_ava != NULL );

		*fstr = ch_malloc( sizeof("(=)")
			+ f->f_av_desc->ad_cname->bv_len
			+ f->f_av_value->bv_len );

		sprintf( *fstr, "(%s=%s)",
			f->f_av_desc->ad_cname->bv_val,
		    f->f_av_value->bv_val );

#else
		*fstr = ch_malloc( sizeof("(=)")
			+ strlen( f->f_avtype )
			+ f->f_avvalue.bv_len);
		sprintf( *fstr, "(%s=%s)", f->f_avtype,
		    f->f_avvalue.bv_val );
#endif
		break;

	case LDAP_FILTER_SUBSTRINGS:
		Debug( LDAP_DEBUG_FILTER, "SUBSTRINGS\n", 0, 0, 0 );
		err = get_substring_filter( conn, ber, f, fstr, text );
		break;

	case LDAP_FILTER_GE:
		Debug( LDAP_DEBUG_FILTER, "GE\n", 0, 0, 0 );

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		err = get_ava( ber, &f->f_ava, SLAP_MR_ORDERING, text );
#else
		err = get_ava( ber, &f->f_ava, text );
#endif
		if ( err != LDAP_SUCCESS ) {
			break;
		}

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		*fstr = ch_malloc( sizeof("(>=)")
			+ f->f_av_desc->ad_cname->bv_len
			+ f->f_av_value->bv_len );

		sprintf( *fstr, "(%s>=%s)",
			f->f_av_desc->ad_cname->bv_val,
		    f->f_av_value->bv_val );

#else
		*fstr = ch_malloc( sizeof("(>=)")
			+ strlen( f->f_avtype )
			+ f->f_avvalue.bv_len);
		sprintf( *fstr, "(%s>=%s)", f->f_avtype,
		    f->f_avvalue.bv_val );
#endif
		break;

	case LDAP_FILTER_LE:
		Debug( LDAP_DEBUG_FILTER, "LE\n", 0, 0, 0 );

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		err = get_ava( ber, &f->f_ava, SLAP_MR_ORDERING, text );
#else
		err = get_ava( ber, &f->f_ava, text );
#endif
		if ( err != LDAP_SUCCESS ) {
			break;
		}


#ifdef SLAPD_SCHEMA_NOT_COMPAT
		*fstr = ch_malloc( sizeof("(<=)")
			+ f->f_av_desc->ad_cname->bv_len
			+ f->f_av_value->bv_len );

		sprintf( *fstr, "(%s<=%s)",
			f->f_av_desc->ad_cname->bv_val,
		    f->f_av_value->bv_val );

#else
		*fstr = ch_malloc( sizeof("(<=)")
			+ strlen( f->f_avtype )
			+ f->f_avvalue.bv_len);
		sprintf( *fstr, "(%s<=%s)", f->f_avtype,
		    f->f_avvalue.bv_val );
#endif
		break;

	case LDAP_FILTER_PRESENT: {
		struct berval type;

		Debug( LDAP_DEBUG_FILTER, "PRESENT\n", 0, 0, 0 );

		if ( ber_scanf( ber, "o", &type ) == LBER_ERROR ) {
			err = SLAPD_DISCONNECT;
			*text = "error decoding filter";
			break;
		}

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		f->f_desc = NULL;
		err = slap_bv2ad( &type, &f->f_desc, text );

		if( err != LDAP_SUCCESS ) {
			ch_free( type.bv_val );
			break;
		}

		ch_free( type.bv_val );

		*fstr = ch_malloc( sizeof("(=*)")
			+ f->f_desc->ad_cname->bv_len );
		sprintf( *fstr, "(%s=*)",
			f->f_desc->ad_cname->bv_val );

#else
		f->f_type = type.bv_val;
		err = LDAP_SUCCESS;
		attr_normalize( f->f_type );
		*fstr = ch_malloc( sizeof("(=*)")
			+ strlen( f->f_type ) );
		sprintf( *fstr, "(%s=*)", f->f_type );
#endif
		} break;

	case LDAP_FILTER_APPROX:
		Debug( LDAP_DEBUG_FILTER, "APPROX\n", 0, 0, 0 );

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		err = get_ava( ber, &f->f_ava, SLAP_MR_APPROX, text );
#else
		err = get_ava( ber, &f->f_ava, text );
#endif
		if ( err != LDAP_SUCCESS ) {
			break;
		}

#ifdef SLAPD_SCHEMA_NOT_COMPAT
		*fstr = ch_malloc( sizeof("(~=)")
			+ f->f_av_desc->ad_cname->bv_len
			+ f->f_av_value->bv_len );

		sprintf( *fstr, "(%s~=%s)",
			f->f_av_desc->ad_cname->bv_val,
		    f->f_av_value->bv_val );

#else
		*fstr = ch_malloc( sizeof("(~=)")
			+ strlen( f->f_avtype )
			+ f->f_avvalue.bv_len);
		sprintf( *fstr, "(%s~=%s)", f->f_avtype,
		    f->f_avvalue.bv_val );
#endif
		break;

	case LDAP_FILTER_AND:
		Debug( LDAP_DEBUG_FILTER, "AND\n", 0, 0, 0 );
		err = get_filter_list( conn, ber, &f->f_and, &ftmp, text );
		if ( err != LDAP_SUCCESS ) {
			break;
		}
		*fstr = ch_malloc( sizeof("(&)")
			+ ( ftmp == NULL ? 0 : strlen( ftmp ) ) );
		sprintf( *fstr, "(&%s)",
			ftmp == NULL ? "" : ftmp );
		break;

	case LDAP_FILTER_OR:
		Debug( LDAP_DEBUG_FILTER, "OR\n", 0, 0, 0 );
		err = get_filter_list( conn, ber, &f->f_and, &ftmp, text );
		if ( err != LDAP_SUCCESS ) {
			break;
		}
		*fstr = ch_malloc( sizeof("(!)")
			+ ( ftmp == NULL ? 0 : strlen( ftmp ) ) );
		sprintf( *fstr, "(|%s)",
			ftmp == NULL ? "" : ftmp );
		break;

	case LDAP_FILTER_NOT:
		Debug( LDAP_DEBUG_FILTER, "NOT\n", 0, 0, 0 );
		(void) ber_skip_tag( ber, &len );
		err = get_filter( conn, ber, &f->f_not, &ftmp, text );
		if ( err != LDAP_SUCCESS ) {
			break;
		}
		*fstr = ch_malloc( sizeof("(!)")
			+ ( ftmp == NULL ? 0 : strlen( ftmp ) ) );
		sprintf( *fstr, "(!%s)",
			ftmp == NULL ? "" : ftmp );
		break;

	case LDAP_FILTER_EXT:
		/* not yet implemented */
		Debug( LDAP_DEBUG_ANY, "extensible match not yet implemented.\n",
		       f->f_choice, 0, 0 );
		f->f_choice = SLAPD_FILTER_COMPUTED;
		f->f_result = SLAPD_COMPARE_UNDEFINED;
		*fstr = ch_strdup( "(extended)" );
		break;

	default:
		Debug( LDAP_DEBUG_ANY, "get_filter: unknown filter type=%lu\n",
		       f->f_choice, 0, 0 );
		f->f_choice = SLAPD_FILTER_COMPUTED;
		f->f_result = SLAPD_COMPARE_UNDEFINED;
		*fstr = ch_strdup( "(undefined)" );
		break;
	}

	if ( err != LDAP_SUCCESS ) {
		free( (char *) f );
		if ( *fstr != NULL ) {
			free( *fstr );
		}
	} else {
		*filt = f;
	}

	free( ftmp );

	Debug( LDAP_DEBUG_FILTER, "end get_filter %d\n", err, 0, 0 );
	return( err );
}

static int
get_filter_list( Connection *conn, BerElement *ber, Filter **f, char **fstr, char **text )
{
	Filter		**new;
	int		err;
	ber_tag_t	tag;
	ber_len_t	len;
	char		*last, *ftmp;

	Debug( LDAP_DEBUG_FILTER, "begin get_filter_list\n", 0, 0, 0 );

	*fstr = NULL;
	new = f;
	for ( tag = ber_first_element( ber, &len, &last ); tag != LBER_DEFAULT;
	    tag = ber_next_element( ber, &len, last ) )
	{
		err = get_filter( conn, ber, new, &ftmp, text );
		if ( err != LDAP_SUCCESS )
			return( err );

		if ( *fstr == NULL ) {
			*fstr = ftmp;
		} else {
			*fstr = ch_realloc( *fstr, strlen( *fstr ) +
			    strlen( ftmp ) + 1 );
			strcat( *fstr, ftmp );
			free( ftmp );
		}
		new = &(*new)->f_next;
	}
	*new = NULL;

	Debug( LDAP_DEBUG_FILTER, "end get_filter_list\n", 0, 0, 0 );
	return( LDAP_SUCCESS );
}

static int
get_substring_filter(
    Connection	*conn,
    BerElement	*ber,
    Filter	*f,
    char	**fstr,
	char	**text
)
{
	ber_tag_t	tag;
	ber_len_t	len;
	ber_tag_t	rc;
	struct berval *val;
	char		*last;
	struct berval type;
#ifndef SLAPD_SCHEMA_NOT_COMPAT
	int		syntax;
#endif
	*text = "error decoding filter";

	Debug( LDAP_DEBUG_FILTER, "begin get_substring_filter\n", 0, 0, 0 );

	if ( ber_scanf( ber, "{o" /*}*/, &type ) == LBER_ERROR ) {
		return SLAPD_DISCONNECT;
	}

#ifdef SLAPD_SCHEMA_NOT_COMPAT
	f->f_sub_desc = NULL;
	rc = slap_bv2ad( &type, &f->f_sub_desc, text );

	ch_free( type.bv_val );

	if( rc != LDAP_SUCCESS ) {
		text = NULL;
		f->f_choice = SLAPD_FILTER_COMPUTED;
		f->f_result = SLAPD_COMPARE_UNDEFINED;
		*fstr = ch_strdup( "(undefined)" );
		return LDAP_SUCCESS;
	}
#else
	f->f_sub_type = type.bv_val;
	attr_normalize( f->f_sub_type );

	/* should get real syntax and see if we have a substring matching rule */
	syntax = attr_syntax( f->f_sub_type );
#endif

	f->f_sub_initial = NULL;
	f->f_sub_any = NULL;
	f->f_sub_final = NULL;

#ifdef SLAPD_SCHEMA_NOT_COMPAT
	if( fstr ) {
		*fstr = ch_malloc( sizeof("(=" /*)*/) +
			f->f_sub_desc->ad_cname->bv_len );
		sprintf( *fstr, "(%s=" /*)*/, f->f_sub_desc->ad_cname->bv_val );
	}
#else
	if( fstr ) {
		*fstr = ch_malloc( strlen( f->f_sub_type ) + 3 );
		sprintf( *fstr, "(%s=" /*)*/, f->f_sub_type );
	}
#endif

	for ( tag = ber_first_element( ber, &len, &last ); tag != LBER_DEFAULT;
	    tag = ber_next_element( ber, &len, last ) )
	{
		rc = ber_scanf( ber, "O", &val );
		if ( rc == LBER_ERROR ) {
			rc = SLAPD_DISCONNECT;
			goto return_error;
		}

		if ( val == NULL || val->bv_len == 0 ) {
			ber_bvfree( val );
			rc = LDAP_INVALID_SYNTAX;
			goto return_error;
		} 

		rc = LDAP_PROTOCOL_ERROR;

#ifndef SLAPD_SCHEMA_NOT_COMPAT
		/* we should call a substring syntax normalization routine */
		value_normalize( val->bv_val, syntax );
		/* this is bogus, value_normalize should take a berval */
		val->bv_len = strlen( val->bv_val );
#endif

		switch ( tag ) {
		case LDAP_SUBSTRING_INITIAL:
			Debug( LDAP_DEBUG_FILTER, "  INITIAL\n", 0, 0, 0 );
			if ( f->f_sub_initial != NULL ) {
				ber_bvfree( val );
				goto return_error;
			}
			f->f_sub_initial = val;

			if( fstr ) {
				*fstr = ch_realloc( *fstr,
					strlen( *fstr ) + val->bv_len + 1 );
				strcat( *fstr, val->bv_val );
			}
			break;

		case LDAP_SUBSTRING_ANY:
			Debug( LDAP_DEBUG_FILTER, "  ANY\n", 0, 0, 0 );
			if( ber_bvecadd( &f->f_sub_any, val ) < 0 ) {
				ber_bvfree( val );
				goto return_error;
			}

			if( fstr ) {
				*fstr = ch_realloc( *fstr,
					strlen( *fstr ) + val->bv_len + 2 );
				strcat( *fstr, "*" );
				strcat( *fstr, val->bv_val );
			}
			break;

		case LDAP_SUBSTRING_FINAL:
			Debug( LDAP_DEBUG_FILTER, "  FINAL\n", 0, 0, 0 );
			if ( f->f_sub_final != NULL ) {
				ber_bvfree( val );
				goto return_error;
			}
			f->f_sub_final = val;

			if( fstr ) {
				*fstr = ch_realloc( *fstr,
					strlen( *fstr ) + val->bv_len + 2 );
				strcat( *fstr, "*" );
				strcat( *fstr, val->bv_val );
			}
			break;

		default:
			Debug( LDAP_DEBUG_FILTER,
				"  unknown substring type=%ld\n",
				(long) tag, 0, 0 );

			ber_bvfree( val );

return_error:
			Debug( LDAP_DEBUG_FILTER, "  error=%ld\n",
				(long) rc, 0, 0 );

			if( fstr ) {
				free( *fstr );
				*fstr = NULL;
			}

#ifdef SLAPD_SCHEMA_NOT_COMPAT
			ad_free( f->f_sub_desc, 1 );
#else
			ch_free( f->f_sub_type );
#endif
			ber_bvfree( f->f_sub_initial );
			ber_bvecfree( f->f_sub_any );
			ber_bvfree( f->f_sub_final );
			return rc;
		}
	}

	if( fstr ) {
		*fstr = ch_realloc( *fstr, strlen( *fstr ) + 3 );
		if ( f->f_sub_final == NULL ) {
			strcat( *fstr, "*" );
		}
		strcat( *fstr, /*(*/ ")" );
	}

	Debug( LDAP_DEBUG_FILTER, "end get_substring_filter\n", 0, 0, 0 );
	return( LDAP_SUCCESS );
}

void
filter_free( Filter *f )
{
	Filter	*p, *next;

	if ( f == NULL ) {
		return;
	}

	switch ( f->f_choice ) {
	case LDAP_FILTER_PRESENT:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		ad_free( f->f_desc, 1 );
#else
		if ( f->f_type != NULL ) {
			free( f->f_type );
		}
#endif
		break;

	case LDAP_FILTER_EQUALITY:
	case LDAP_FILTER_GE:
	case LDAP_FILTER_LE:
	case LDAP_FILTER_APPROX:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		ava_free( f->f_ava, 1 );
#else
		ava_free( &f->f_ava, 0 );
#endif
		break;

	case LDAP_FILTER_SUBSTRINGS:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		ad_free( f->f_sub_desc, 1 );
		if ( f->f_sub_initial != NULL ) {
			ber_bvfree( f->f_sub_initial );
		}
		ber_bvecfree( f->f_sub_any );
		if ( f->f_sub_final != NULL ) {
			ber_bvfree( f->f_sub_final );
		}
#else
		if ( f->f_sub_type != NULL ) {
			free( f->f_sub_type );
		}
		if ( f->f_sub_initial != NULL ) {
			ber_bvfree( f->f_sub_initial );
		}
		ber_bvecfree( f->f_sub_any );
		if ( f->f_sub_final != NULL ) {
			ber_bvfree( f->f_sub_final );
		}
#endif
		break;

	case LDAP_FILTER_AND:
	case LDAP_FILTER_OR:
	case LDAP_FILTER_NOT:
		for ( p = f->f_list; p != NULL; p = next ) {
			next = p->f_next;
			filter_free( p );
		}
		break;

	case SLAPD_FILTER_COMPUTED:
		break;

	default:
		Debug( LDAP_DEBUG_ANY, "filter_free: unknown filter type=%lu\n",
		       f->f_choice, 0, 0 );
		break;
	}

	free( f );
}

#ifdef LDAP_DEBUG

void
filter_print( Filter *f )
{
	int	i;
	Filter	*p;

	if ( f == NULL ) {
		fprintf( stderr, "No filter!" );
	}

	switch ( f->f_choice ) {
	case LDAP_FILTER_EQUALITY:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		fprintf( stderr, "(%s=%s)",
			f->f_av_desc->ad_cname->bv_val,
		    f->f_av_value->bv_val );
#else
		fprintf( stderr, "(%s=%s)",
			f->f_ava.ava_type,
		    f->f_ava.ava_value.bv_val );
#endif
		break;

	case LDAP_FILTER_GE:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		fprintf( stderr, "(%s>=%s)",
			f->f_av_desc->ad_cname->bv_val,
		    f->f_av_value->bv_val );
#else
		fprintf( stderr, "(%s>=%s)",
			f->f_ava.ava_type,
		    f->f_ava.ava_value.bv_val );
#endif
		break;

	case LDAP_FILTER_LE:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		fprintf( stderr, "(%s<=%s)",
			f->f_ava->aa_desc->ad_cname->bv_val,
		    f->f_ava->aa_value->bv_val );
#else
		fprintf( stderr, "(%s<=%s)",
			f->f_ava.ava_type,
		    f->f_ava.ava_value.bv_val );
#endif
		break;

	case LDAP_FILTER_APPROX:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		fprintf( stderr, "(%s~=%s)",
			f->f_ava->aa_desc->ad_cname->bv_val,
		    f->f_ava->aa_value->bv_val );
#else
		fprintf( stderr, "(%s~=%s)",
			f->f_ava.ava_type,
		    f->f_ava.ava_value.bv_val );
#endif
		break;

	case LDAP_FILTER_SUBSTRINGS:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		fprintf( stderr, "(%s=" /*)*/,
			f->f_sub_desc->ad_cname->bv_val );
#else
		fprintf( stderr, "(%s=" /*)*/,
			f->f_sub_type );
#endif
		if ( f->f_sub_initial != NULL ) {
			fprintf( stderr, "%s",
				f->f_sub_initial->bv_val );
		}
		if ( f->f_sub_any != NULL ) {
			for ( i = 0; f->f_sub_any[i] != NULL; i++ ) {
				fprintf( stderr, "*%s",
					f->f_sub_any[i]->bv_val );
			}
		}
		if ( f->f_sub_final != NULL ) {
			fprintf( stderr,
				"*%s", f->f_sub_final->bv_val );
		}
		fprintf( stderr, /*(*/ ")" );
		break;

	case LDAP_FILTER_PRESENT:
#ifdef SLAPD_SCHEMA_NOT_COMPAT
		fprintf( stderr, "(%s=*)",
			f->f_desc->ad_cname->bv_val );
#else
		fprintf( stderr, "(%s=*)",
			f->f_type );
#endif
		break;

	case LDAP_FILTER_AND:
	case LDAP_FILTER_OR:
	case LDAP_FILTER_NOT:
		fprintf( stderr, "(%c" /*)*/,
			f->f_choice == LDAP_FILTER_AND ? '&' :
		    f->f_choice == LDAP_FILTER_OR ? '|' : '!' );
		for ( p = f->f_list; p != NULL; p = p->f_next ) {
			filter_print( p );
		}
		fprintf( stderr, /*(*/ ")" );
		break;

	case SLAPD_FILTER_COMPUTED:
		fprintf( stderr, "(?=%s)",
			f->f_result == LDAP_COMPARE_FALSE ? "false" :
			f->f_result == LDAP_COMPARE_TRUE ? "true" :
			f->f_result == SLAPD_COMPARE_UNDEFINED ? "undefined" :
			"error" );
		break;

	default:
		fprintf( stderr, "(unknown-filter=%lu)", f->f_choice );
		break;
	}
}

#endif /* ldap_debug */