ldap/common/vlistctrl.c

/*
 * Copyright 2002 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident   "%Z%%M% %I% %E% SMI"

/*
 * 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):
 */

/* vlistctrl.c - virtual list control implementation. */
#include "ldap-int.h"


/*
 * function to create a VirtualListViewRequest control that can be passed
 * to ldap_search_ext() or ldap_search_ext_s().  *ctrlp will be set to a
 * freshly allocated LDAPControl structure.  Returns an LDAP error code
 * (LDAP_SUCCESS if all goes well).
 *
 *  Parameters
 *   ld              LDAP pointer to the desired connection
 *
 *   ldvlistp        the control structure.
 *
 *   ctrlp           the address of a place to put the constructed control

  The controlValue is an OCTET STRING
  whose value is the BER-encoding of the following SEQUENCE:

       VirtualListViewRequest ::= SEQUENCE {
               beforeCount    INTEGER (0 .. maxInt),
               afterCount     INTEGER (0 .. maxInt),
               CHOICE {
                       byIndex [0] SEQUENCE {
                       index           INTEGER (0 .. maxInt),
                       contentCount    INTEGER (0 .. maxInt) }
                       byValue [1] greaterThanOrEqual assertionValue }

  beforeCount indicates how many  entries  before  the  target  entry  the
  client  wants  the  server  to  send. afterCount indicates the number of
  entries after the target entry the client  wants  the  server  to  send.
  index  and contentCount identify the target entry
  greaterThanOrEqual  is  an  attribute  assertion  value  defined  in
  [LDAPv3].  If  present, the value supplied in greaterThanOrEqual is used
  to determine the target entry by  comparison  with  the  values  of  the
  attribute  specified as the primary sort key. The first list entry who's
  value is no less than the supplied value is the target entry.

 */

int
LDAP_CALL
ldap_create_virtuallist_control(
    LDAP *ld,
    LDAPVirtualList *ldvlistp,
    LDAPControl **ctrlp
)
{
    BerElement *ber;
    int rc;

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


    if ( NULL == ctrlp || NULL == ldvlistp ) {
        LDAP_SET_LDERRNO( ld, LDAP_PARAM_ERROR, NULL, NULL );
        return ( LDAP_PARAM_ERROR );
    }

    /* create a ber package to hold the controlValue */
    if ( LDAP_SUCCESS != nsldapi_alloc_ber_with_options( ld, &ber )  )
    {
        LDAP_SET_LDERRNO( ld, LDAP_NO_MEMORY, NULL, NULL );
        return( LDAP_NO_MEMORY );
    }

    if ( LBER_ERROR == ber_printf( ber,
                                   "{ii",
                                   (int)ldvlistp->ldvlist_before_count,
                                   (int)ldvlistp->ldvlist_after_count ))
                    /* XXX lossy casts */
    {
        LDAP_SET_LDERRNO( ld, LDAP_ENCODING_ERROR, NULL, NULL );
        ber_free( ber, 1 );
        return( LDAP_ENCODING_ERROR );
    }

    if (NULL == ldvlistp->ldvlist_attrvalue)
    {
        if ( LBER_ERROR == ber_printf( ber,
                                       "t{ii}}",
                       LDAP_TAG_VLV_BY_INDEX,
                                       (int)ldvlistp->ldvlist_index,
                                       (int)ldvlistp->ldvlist_size ) )
                       /* XXX lossy casts */
        {
            LDAP_SET_LDERRNO( ld, LDAP_ENCODING_ERROR, NULL, NULL );
            ber_free( ber, 1 );
            return( LDAP_ENCODING_ERROR );
        }
    }
    else
    {
        if ( LBER_ERROR == ber_printf( ber,
                                      "to}",
                       LDAP_TAG_VLV_BY_VALUE,
                                      ldvlistp->ldvlist_attrvalue,
                       (int)strlen( ldvlistp->ldvlist_attrvalue )) ) {
            LDAP_SET_LDERRNO( ld, LDAP_ENCODING_ERROR, NULL, NULL );
            ber_free( ber, 1 );
            return( LDAP_ENCODING_ERROR );
        }
    }


    rc = nsldapi_build_control( LDAP_CONTROL_VLVREQUEST ,
                                ber,
                                1,
                                1,
                                ctrlp );

    LDAP_SET_LDERRNO( ld, rc, NULL, NULL );
    return( rc );

}


/*
 * function to find and parse a VirtualListViewResponse control contained in
 * "ctrls"  *target_posp, *list_sizep, and *errcodep are set based on its
 * contents.  Returns an LDAP error code that indicates whether the parsing
 * itself was successful (LDAP_SUCCESS if all goes well).

  The controlValue is an OCTET STRING, whose value
  is the BER encoding of a value of the following SEQUENCE:

       VirtualListViewResponse ::= SEQUENCE {
               targetPosition    INTEGER (0 .. maxInt),
               contentCount     INTEGER (0 .. maxInt),
               virtualListViewResult ENUMERATED {
                       success (0),
                       operatonsError (1),
                       unwillingToPerform (53),
                       insufficientAccessRights (50),
                       busy (51),
                       timeLimitExceeded (3),
                       adminLimitExceeded (11),
                       sortControlMissing (60),
                       indexRangeError (61),
                       other (80) }  }

 */
int
LDAP_CALL
ldap_parse_virtuallist_control
(
    LDAP *ld,
    LDAPControl **ctrls,
    unsigned long *target_posp,
    unsigned long *list_sizep,
    int *errcodep
)
{
    BerElement      *ber;
    int         i, foundListControl, errcode;
    LDAPControl     *listCtrlp;
    unsigned long   target_pos, list_size;
    int         target_pos_int, list_size_int;

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

    /* only ldapv3 or higher can do virtual lists. */
    if ( NSLDAPI_LDAP_VERSION( ld ) < LDAP_VERSION3 ) {
        LDAP_SET_LDERRNO( ld, LDAP_NOT_SUPPORTED, NULL, NULL );
        return( LDAP_NOT_SUPPORTED );
    }

    /* find the listControl in the list of controls if it exists */
    if ( ctrls == NULL ) {
        LDAP_SET_LDERRNO( ld, LDAP_CONTROL_NOT_FOUND, NULL, NULL );
        return ( LDAP_CONTROL_NOT_FOUND );
    }

    foundListControl = 0;
    for ( i = 0; (( ctrls[i] != NULL ) && ( !foundListControl )); i++ ) {
        foundListControl = !strcmp( ctrls[i]->ldctl_oid,
                                    LDAP_CONTROL_VLVRESPONSE );
    }
    if ( !foundListControl ) {
        LDAP_SET_LDERRNO( ld, LDAP_CONTROL_NOT_FOUND, NULL, NULL );
        return ( LDAP_CONTROL_NOT_FOUND );
    } else {
        /* let local var point to the listControl */
        listCtrlp = ctrls[i-1];
    }

    /*  allocate a Ber element with the contents of the list_control's struct berval */
    if ( ( ber = ber_init( &listCtrlp->ldctl_value ) ) == NULL ) {
        LDAP_SET_LDERRNO( ld, LDAP_NO_MEMORY, NULL, NULL );
        return( LDAP_NO_MEMORY );
    }

    /* decode the result from the Berelement */
    if (  LBER_ERROR == ber_scanf( ber, "{iie}", &target_pos_int, &list_size_int,
        &errcode ) ) {
        LDAP_SET_LDERRNO( ld, LDAP_DECODING_ERROR, NULL, NULL );
        ber_free( ber, 1 );
        return( LDAP_DECODING_ERROR );
    }

    target_pos = target_pos_int;
    list_size = list_size_int;

    if ( target_posp != NULL ) {
    *target_posp = target_pos;
    }
    if ( list_sizep != NULL ) {
    *list_sizep = list_size;
    }
    if ( errcodep != NULL ) {
    *errcodep = errcode;
    }

    /* the ber encoding is no longer needed */
    ber_free(ber,1);

    return(LDAP_SUCCESS);

}