/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla 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/MPL/
 *
 * 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 the Initial Developer are Copyright (C) 1998-1999
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
/*
 * psearch.c - Persistent search and "Entry Change Notification" support.
 */
#include "ldap-int.h"


int
LDAP_CALL
ldap_create_persistentsearch_control( LDAP *ld, int changetypes,
    int changesonly, int return_echg_ctls, char ctl_iscritical,
    LDAPControl **ctrlp )
{
    BerElement	*ber;
    int		rc;

    if ( !NSLDAPI_VALID_LDAP_POINTER( ld )) {
	return( LDAP_PARAM_ERROR );
    }

    if ( ctrlp == NULL || ( changetypes & ~LDAP_CHANGETYPE_ANY ) != 0 ) {
	rc = LDAP_PARAM_ERROR;
	goto report_error_and_return;
    }

    /*
     * create a Persistent Search control.  The control value looks like this:
     *
     *	PersistentSearch ::= SEQUENCE {
     *		changeTypes INTEGER,
     *		-- the changeTypes field is the logical OR of 
     *		-- one or more of these values: add (1), delete (2),
     *		-- modify (4), modDN (8).  It specifies which types of
     *		-- changes will cause an entry to be returned.
     *		changesOnly BOOLEAN, -- skip initial search?
     *		returnECs BOOLEAN,   -- return "Entry Change" controls?
     *	}
     */
    if (( nsldapi_alloc_ber_with_options( ld, &ber )) != LDAP_SUCCESS ) {
	rc = LDAP_NO_MEMORY;
	goto report_error_and_return;
    }

    if ( ber_printf( ber, "{ibb}", changetypes, changesonly,
	    return_echg_ctls ) == -1 ) {
	ber_free( ber, 1 );
	rc = LDAP_ENCODING_ERROR;
	goto report_error_and_return;
    }

    rc = nsldapi_build_control( LDAP_CONTROL_PERSISTENTSEARCH, ber, 1,
	    ctl_iscritical, ctrlp );

report_error_and_return:
    LDAP_SET_LDERRNO( ld, rc, NULL, NULL );
    return( rc );
}


int
LDAP_CALL
ldap_parse_entrychange_control( LDAP *ld, LDAPControl **ctrls, int *chgtypep,
    char **prevdnp, int *chgnumpresentp, long *chgnump )
{
    BerElement		*ber;
    int			rc, i, changetype;
    unsigned long	len;
    long		along;
    char		*previousdn;

    if ( !NSLDAPI_VALID_LDAP_POINTER( ld )) {
	return( LDAP_PARAM_ERROR );
    }

    /*
     * find the entry change notification in the list of controls
     */
    for ( i = 0; ctrls != NULL && ctrls[i] != NULL; ++i ) {
	if ( strcmp( ctrls[i]->ldctl_oid, LDAP_CONTROL_ENTRYCHANGE ) == 0 ) {
	    break;
	}
    }

    if ( ctrls == NULL || ctrls[i] == NULL ) {
	rc = LDAP_CONTROL_NOT_FOUND;
	goto report_error_and_return;
    }

    /*
     * allocate a BER element from the control value and parse it.  The control
     * value should look like this:
     *
     *	EntryChangeNotification ::= SEQUENCE {
     *	     changeType ENUMERATED {
     *	 	add             (1),  -- these values match the
     *	 	delete          (2),  -- values used for changeTypes
     *	 	modify          (4),  -- in the PersistentSearch control.
     *	 	modDN           (8),
     *	     },
     *	     previousDN   LDAPDN OPTIONAL,     -- modDN ops. only
     *	     changeNumber INTEGER OPTIONAL,    -- if supported
     *	}
     */
    if (( ber = ber_init( &(ctrls[i]->ldctl_value))) == NULL ) {
	rc = LDAP_NO_MEMORY;
	goto report_error_and_return;
    }		

    if ( ber_scanf( ber, "{e", &along ) == LBER_ERROR ) {
	ber_free( ber, 1 );
	rc = LDAP_DECODING_ERROR;
	goto report_error_and_return;
    }
    changetype = (int)along;	/* XXX lossy cast */

    if ( changetype == LDAP_CHANGETYPE_MODDN ) {
	if ( ber_scanf( ber, "a", &previousdn ) == LBER_ERROR ) {
	    ber_free( ber, 1 );
	    rc = LDAP_DECODING_ERROR;
	    goto report_error_and_return;
	}
    } else {
	previousdn = NULL;
    }

    if ( chgtypep != NULL ) {
	*chgtypep = changetype;
    }
    if ( prevdnp != NULL ) {
	*prevdnp = previousdn;
    } else if ( previousdn != NULL ) {
	NSLDAPI_FREE( previousdn );
    }

    if ( chgnump != NULL ) {	/* check for optional changenumber */
	if ( ber_peek_tag( ber, &len ) == LBER_INTEGER
		&& ber_get_int( ber, chgnump ) != LBER_ERROR ) {
	    if ( chgnumpresentp != NULL ) {
		*chgnumpresentp = 1;
	    }
	} else {
	    if ( chgnumpresentp != NULL ) {
		*chgnumpresentp = 0;
	    }
	}
    }

    ber_free( ber, 1 );
    rc = LDAP_SUCCESS;

report_error_and_return:
    LDAP_SET_LDERRNO( ld, rc, NULL, NULL );
    return( rc );
}
