/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */
/*
 *  referral.c - routines for handling LDAPv3 referrals and references.
 */

#include "ldap-int.h"


LDAPMessage *
LDAP_CALL
ldap_first_reference( LDAP *ld, LDAPMessage *res )
{
	if ( !NSLDAPI_VALID_LDAP_POINTER( ld ) || res == NULLMSG ) {
		return( NULLMSG );
	}

	if ( res->lm_msgtype == LDAP_RES_SEARCH_REFERENCE ) {
		return( res );
	}

	return( ldap_next_reference( ld, res ));
}


LDAPMessage *
LDAP_CALL
ldap_next_reference( LDAP *ld, LDAPMessage *ref )
{
	if ( !NSLDAPI_VALID_LDAP_POINTER( ld ) || ref == NULLMSG ) {
		return( NULLMSG );		/* punt */
	}

	for ( ref = ref->lm_chain; ref != NULLMSG; ref = ref->lm_chain ) {
		if ( ref->lm_msgtype == LDAP_RES_SEARCH_REFERENCE ) {
			return( ref );
		}
	}

	return( NULLMSG );
}


int
LDAP_CALL
ldap_count_references( LDAP *ld, LDAPMessage *res )
{
	int	i;

	if ( !NSLDAPI_VALID_LDAP_POINTER( ld )) {
		return( -1 );
	}

	for ( i = 0; res != NULL; res = res->lm_chain ) {
		if ( res->lm_msgtype == LDAP_RES_SEARCH_REFERENCE ) {
			++i;
		}
	}

	return( i );
}


/*
 * returns an LDAP error code.
 */
int
LDAP_CALL
ldap_parse_reference( LDAP *ld, LDAPMessage *ref, char ***referralsp,
    LDAPControl ***serverctrlsp, int freeit )
{
	int		err;

	if ( !NSLDAPI_VALID_LDAP_POINTER( ld ) ||
	    !NSLDAPI_VALID_LDAPMESSAGE_REFERENCE_POINTER( ref )) {
		return( LDAP_PARAM_ERROR );
	}

	err = nsldapi_parse_reference( ld, ref->lm_ber, referralsp,
		serverctrlsp );

	LDAP_SET_LDERRNO( ld, err, NULL, NULL );

	if ( freeit ) {
		ldap_msgfree( ref );
	}

	return( err );
}


/*
 * returns an LDAP error code indicating success or failure of parsing
 * does NOT set any error information inside "ld"
 */
int
nsldapi_parse_reference( LDAP *ld, BerElement *rber, char ***referralsp,
    LDAPControl ***serverctrlsp )
{
	int		err;
	BerElement	ber;
	char		**refs;

	/*
	 * Parse a searchResultReference message.  These are used in LDAPv3
	 * and beyond and look like this:
	 *
	 *	SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL
	 *
	 * all wrapped up in an LDAPMessage sequence which looks like this:
	 *
	 *	LDAPMessage ::= SEQUENCE {
	 *		messageID	MessageID,
	 *		SearchResultReference
	 *		controls	[0] Controls OPTIONAL
	 *	}
	 *
	 * ldap_result() pulls out the message id, so by the time a result
	 * message gets here we are conveniently sitting at the start of the
	 * SearchResultReference itself.
	 */
	err = LDAP_SUCCESS;	/* optimistic */
	ber = *rber;		/* struct copy */

	if ( ber_scanf( &ber, "{v", &refs ) == LBER_ERROR ) {
	    err = LDAP_DECODING_ERROR;
	} else if ( serverctrlsp != NULL ) {
	    /* pull out controls (if requested and any are present) */
	    if ( ber_scanf( &ber, "}" ) == LBER_ERROR ) {
		err = LDAP_DECODING_ERROR;
	    } else {
		err = nsldapi_get_controls( &ber, serverctrlsp );
	    }
	}

	if ( referralsp == NULL ) {
	    ldap_value_free( refs );
	} else {
	    *referralsp = refs;
	}

	return( err );
}