root/usr/src/lib/libldap5/sources/ldap/common/compare.c
/*
 * The contents of this file are subject to the Netscape Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/NPL/
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code is Mozilla Communicator client code, released
 * March 31, 1998.
 *
 * The Initial Developer of the Original Code is Netscape
 * Communications Corporation. Portions created by Netscape are
 * Copyright (C) 1998-1999 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s):
 */
/*
 *  Copyright (c) 1990 Regents of the University of Michigan.
 *  All rights reserved.
 */
/*
 *  compare.c
 */

#if 0
#ifndef lint
static char copyright[] = "@(#) Copyright (c) 1990 Regents of the University of Michigan.\nAll rights reserved.\n";
#endif
#endif

#include "ldap-int.h"

/*
 * ldap_compare - perform an ldap compare operation.  The dn
 * of the entry to compare to and the attribute and value to compare (in
 * attr and value) are supplied.  The msgid of the response is returned.
 *
 * Example:
 *      ldap_compare( ld, "c=us@cn=bob", "userPassword", "secret" )
 */
int
LDAP_CALL
ldap_compare( LDAP *ld, const char *dn, const char *attr, const char *value )
{
        int             msgid;
        struct berval   bv;

        LDAPDebug( LDAP_DEBUG_TRACE, "ldap_compare\n", 0, 0, 0 );

        bv.bv_val = (char *)value;
        bv.bv_len = ( value == NULL ) ? 0 : strlen( value );

        if ( ldap_compare_ext( ld, dn, attr, &bv, NULL, NULL, &msgid )
            == LDAP_SUCCESS ) {
                return( msgid );
        } else {
                return( -1 );   /* error is in ld handle */
        }
}

int
LDAP_CALL
ldap_compare_ext( LDAP *ld, const char *dn, const char *attr,
    const struct berval *bvalue, LDAPControl **serverctrls,
    LDAPControl **clientctrls, int *msgidp )
{
        BerElement      *ber;
        int             rc, lderr;

        /* The compare request looks like this:
         *      CompareRequest ::= SEQUENCE {
         *              entry   DistinguishedName,
         *              ava     SEQUENCE {
         *                      type    AttributeType,
         *                      value   AttributeValue
         *              }
         *      }
         * and must be wrapped in an LDAPMessage.
         */

        LDAPDebug( LDAP_DEBUG_TRACE, "ldap_compare_ext\n", 0, 0, 0 );

        if ( !NSLDAPI_VALID_LDAP_POINTER( ld )) {
                return( LDAP_PARAM_ERROR );
        }
        if ( attr == NULL || bvalue == NULL || bvalue->bv_len == 0
            || msgidp == NULL ) {
                lderr = LDAP_PARAM_ERROR;
                LDAP_SET_LDERRNO( ld, lderr, NULL, NULL );
                return( lderr );
        }

        if ( dn == NULL ) {
                dn = "";
        }

        LDAP_MUTEX_LOCK( ld, LDAP_MSGID_LOCK );
        *msgidp = ++ld->ld_msgid;
        LDAP_MUTEX_UNLOCK( ld, LDAP_MSGID_LOCK );

        /* check the cache */
        if ( ld->ld_cache_on && ld->ld_cache_compare != NULL ) {
                LDAP_MUTEX_LOCK( ld, LDAP_CACHE_LOCK );
                if ( (rc = (ld->ld_cache_compare)( ld, *msgidp,
                    LDAP_REQ_COMPARE, dn, attr, bvalue )) != 0 ) {
                        *msgidp = rc;
                        LDAP_MUTEX_UNLOCK( ld, LDAP_CACHE_LOCK );
                        return( LDAP_SUCCESS );
                }
                LDAP_MUTEX_UNLOCK( ld, LDAP_CACHE_LOCK );
        }

        /* create a message to send */
        if (( lderr = nsldapi_alloc_ber_with_options( ld, &ber ))
            != LDAP_SUCCESS ) {
                return( lderr );
        }

        if ( ber_printf( ber, "{it{s{so}}", *msgidp, LDAP_REQ_COMPARE, dn,
            attr, bvalue->bv_val, (int)bvalue->bv_len /* XXX lossy cast */ )
            == -1 ) {
                lderr = LDAP_ENCODING_ERROR;
                LDAP_SET_LDERRNO( ld, lderr, NULL, NULL );
                ber_free( ber, 1 );
                return( lderr );
        }

        if (( lderr = nsldapi_put_controls( ld, serverctrls, 1, ber ))
            != LDAP_SUCCESS ) {
                ber_free( ber, 1 );
                return( lderr );
        }

        /* send the message */
        rc = nsldapi_send_initial_request( ld, *msgidp, LDAP_REQ_COMPARE,
                (char *)dn, ber );
        *msgidp = rc;
        return( rc < 0 ? LDAP_GET_LDERRNO( ld, NULL, NULL ) : LDAP_SUCCESS );
}

int
LDAP_CALL
ldap_compare_s( LDAP *ld, const char *dn, const char *attr,
    const char *value )
{
        struct berval   bv;

        bv.bv_val = (char *)value;
        bv.bv_len = ( value == NULL ) ? 0 : strlen( value );

        return( ldap_compare_ext_s( ld, dn, attr, &bv, NULL, NULL ));
}

int
LDAP_CALL
ldap_compare_ext_s( LDAP *ld, const char *dn, const char *attr,
    const struct berval *bvalue, LDAPControl **serverctrls,
    LDAPControl **clientctrls )
{
        int             err, msgid;
        LDAPMessage     *res;

        if (( err = ldap_compare_ext( ld, dn, attr, bvalue, serverctrls,
            clientctrls, &msgid )) != LDAP_SUCCESS ) {
                return( err );
        }

        if ( ldap_result( ld, msgid, 1, (struct timeval *)NULL, &res )
            == -1 ) {
                return( LDAP_GET_LDERRNO( ld, NULL, NULL ) );
        }

        return( ldap_result2error( ld, res, 1 ) );
}