git.sur5r.net Git - openldap/blob - libraries/libldap/abandon.c

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6 /*  Portions
   7  *  Copyright (c) 1990 Regents of the University of Michigan.
   8  *  All rights reserved.
   9  *
  10  *  abandon.c
  11  */
  12
  13 /*
  14  * An abandon request looks like this:
  15  *      AbandonRequest ::= MessageID
  16  */
  17
  18 #include "portable.h"
  19
  20 #include <stdio.h>
  21
  22 #include <ac/stdlib.h>
  23
  24 #include <ac/socket.h>
  25 #include <ac/string.h>
  26 #include <ac/time.h>
  27
  28 #include "ldap-int.h"
  29
  30 static int do_abandon LDAP_P((
  31         LDAP *ld,
  32         ber_int_t origid,
  33         ber_int_t msgid,
  34         LDAPControl **sctrls,
  35         LDAPControl **cctrls));
  36
  37 /*
  38  * ldap_abandon_ext - perform an ldap extended abandon operation.
  39  *
  40  * Parameters:
  41  *      ld                      LDAP descriptor
  42  *      msgid           The message id of the operation to abandon
  43  *      scntrls         Server Controls
  44  *      ccntrls         Client Controls
  45  *
  46  * ldap_abandon_ext returns a LDAP error code.
  47  *              (LDAP_SUCCESS if everything went ok)
  48  *
  49  * Example:
  50  *      ldap_abandon_ext( ld, msgid, scntrls, ccntrls );
  51  */
  52 int
  53 ldap_abandon_ext(
  54         LDAP *ld,
  55         int msgid,
  56         LDAPControl **sctrls,
  57         LDAPControl **cctrls )
  58 {
  59         int rc;
  60 #ifdef NEW_LOGGING
  61         LDAP_LOG ( OPERATION, ARGS, "ldap_abandon_ext %d\n", msgid, 0, 0 );
  62 #else
  63         Debug( LDAP_DEBUG_TRACE, "ldap_abandon_ext %d\n", msgid, 0, 0 );
  64 #endif
  65
  66         /* check client controls */
  67         rc = ldap_int_client_controls( ld, cctrls );
  68         if( rc != LDAP_SUCCESS ) return rc;
  69
  70         return do_abandon( ld, msgid, msgid, sctrls, cctrls );
  71 }
  72
  73
  74 /*
  75  * ldap_abandon - perform an ldap abandon operation. Parameters:
  76  *
  77  *      ld              LDAP descriptor
  78  *      msgid           The message id of the operation to abandon
  79  *
  80  * ldap_abandon returns 0 if everything went ok, -1 otherwise.
  81  *
  82  * Example:
  83  *      ldap_abandon( ld, msgid );
  84  */
  85 int
  86 ldap_abandon( LDAP *ld, int msgid )
  87 {
  88 #ifdef NEW_LOGGING
  89         LDAP_LOG ( OPERATION, ARGS, "ldap_abandon %d\n", msgid, 0, 0 );
  90 #else
  91         Debug( LDAP_DEBUG_TRACE, "ldap_abandon %d\n", msgid, 0, 0 );
  92 #endif
  93         return ldap_abandon_ext( ld, msgid, NULL, NULL ) == LDAP_SUCCESS
  94                 ? 0 : -1;
  95 }
  96
  97
  98 static int
  99 do_abandon(
 100         LDAP *ld,
 101         ber_int_t origid,
 102         ber_int_t msgid,
 103         LDAPControl **sctrls,
 104         LDAPControl **cctrls)
 105 {
 106         BerElement      *ber;
 107         int             i, err, sendabandon;
 108         ber_int_t *old_abandon;
 109         Sockbuf         *sb;
 110         LDAPRequest     *lr;
 111
 112 #ifdef NEW_LOGGING
 113         LDAP_LOG ( OPERATION, ARGS, "do_abandon %d, msgid %d\n", origid, msgid, 0 );
 114 #else
 115         Debug( LDAP_DEBUG_TRACE, "do_abandon origid %d, msgid %d\n",
 116                 origid, msgid, 0 );
 117 #endif
 118
 119         sendabandon = 1;
 120
 121         /* find the request that we are abandoning */
 122         for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
 123                 if ( lr->lr_msgid == msgid ) {  /* this message */
 124                         break;
 125                 }
 126                 if ( lr->lr_origid == msgid ) {/* child:  abandon it */
 127                         (void) do_abandon( ld,
 128                                 msgid, lr->lr_msgid, sctrls, cctrls );
 129                 }
 130         }
 131
 132         if ( lr != NULL ) {
 133                 if ( origid == msgid && lr->lr_parent != NULL ) {
 134                         /* don't let caller abandon child requests! */
 135                         ld->ld_errno = LDAP_PARAM_ERROR;
 136                         return( LDAP_PARAM_ERROR );
 137                 }
 138                 if ( lr->lr_status != LDAP_REQST_INPROGRESS ) {
 139                         /* no need to send abandon message */
 140                         sendabandon = 0;
 141                 }
 142         }
 143
 144         if ( ldap_msgdelete( ld, msgid ) == 0 ) {
 145                 ld->ld_errno = LDAP_SUCCESS;
 146                 return LDAP_SUCCESS;
 147         }
 148
 149         err = 0;
 150         if ( sendabandon ) {
 151                 if( ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, NULL ) == -1 ) {
 152                         /* not connected */
 153                         err = -1;
 154                         ld->ld_errno = LDAP_SERVER_DOWN;
 155
 156                 } else if ( (ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
 157                         /* BER element alocation failed */
 158                         err = -1;
 159                         ld->ld_errno = LDAP_NO_MEMORY;
 160
 161                 } else {
 162 #ifdef LDAP_CONNECTIONLESS
 163                         if ( LDAP_IS_UDP(ld) ) {
 164                             err = ber_write( ber, ld->ld_options.ldo_peer,
 165                                 sizeof(struct sockaddr), 0);
 166                         }
 167                         if ( LDAP_IS_UDP(ld) && ld->ld_options.ldo_version ==
 168                                 LDAP_VERSION2) {
 169                             char *dn = ld->ld_options.ldo_cldapdn;
 170                             if (!dn) dn = "";
 171                             err = ber_printf( ber, "{isti",  /* '}' */
 172                                 ++ld->ld_msgid, dn,
 173                                 LDAP_REQ_ABANDON, msgid );
 174                         } else
 175 #endif
 176                         {
 177                             /* create a message to send */
 178                             err = ber_printf( ber, "{iti",  /* '}' */
 179                                 ++ld->ld_msgid,
 180                                 LDAP_REQ_ABANDON, msgid );
 181                         }
 182
 183                         if( err == -1 ) {
 184                                 /* encoding error */
 185                                 ld->ld_errno = LDAP_ENCODING_ERROR;
 186
 187                         } else {
 188                                 /* Put Server Controls */
 189                                 if ( ldap_int_put_controls( ld, sctrls, ber )
 190                                         != LDAP_SUCCESS )
 191                                 {
 192                                         err = -1;
 193
 194                                 } else {
 195                                         /* close '{' */
 196                                         err = ber_printf( ber, /*{*/ "N}" );
 197
 198                                         if( err == -1 ) {
 199                                                 /* encoding error */
 200                                                 ld->ld_errno = LDAP_ENCODING_ERROR;
 201                                         }
 202                                 }
 203                         }
 204
 205                         if ( err == -1 ) {
 206                                 ber_free( ber, 1 );
 207
 208                         } else {
 209                                 /* send the message */
 210                                 if ( lr != NULL ) {
 211                                         sb = lr->lr_conn->lconn_sb;
 212                                 } else {
 213                                         sb = ld->ld_sb;
 214                                 }
 215
 216                                 if ( ber_flush( sb, ber, 1 ) != 0 ) {
 217                                         ld->ld_errno = LDAP_SERVER_DOWN;
 218                                         err = -1;
 219                                 } else {
 220                                         err = 0;
 221                                 }
 222                         }
 223                 }
 224         }
 225
 226         if ( lr != NULL ) {
 227                 if ( sendabandon ) {
 228                         ldap_free_connection( ld, lr->lr_conn, 0, 1 );
 229                 }
 230                 if ( origid == msgid ) {
 231                         ldap_free_request( ld, lr );
 232                 }
 233         }
 234
 235         i = 0;
 236         if ( ld->ld_abandoned != NULL ) {
 237                 for ( ; ld->ld_abandoned[i] != -1; i++ )
 238                         ;       /* NULL */
 239         }
 240
 241         old_abandon = ld->ld_abandoned;
 242
 243         ld->ld_abandoned = (ber_int_t *) LDAP_REALLOC( (char *)
 244                 ld->ld_abandoned, (i + 2) * sizeof(ber_int_t) );
 245
 246         if ( ld->ld_abandoned == NULL ) {
 247                 ld->ld_abandoned = old_abandon;
 248                 ld->ld_errno = LDAP_NO_MEMORY;
 249                 return( ld->ld_errno );
 250         }
 251
 252         ld->ld_abandoned[i] = msgid;
 253         ld->ld_abandoned[i + 1] = -1;
 254
 255         if ( err != -1 ) {
 256                 ld->ld_errno = LDAP_SUCCESS;
 257         }
 258
 259         return( ld->ld_errno );
 260 }