git.sur5r.net Git - openldap/blob - libldap/result.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 /*---
  11  * This notice applies to changes, created by or for Novell, Inc.,
  12  * to preexisting works for which notices appear elsewhere in this file.
  13  *
  14  * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
  15  *
  16  * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES.
  17  * USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT TO VERSION
  18  * 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS AVAILABLE AT
  19  * HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE" IN THE
  20  * TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION OF THIS
  21  * WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP PUBLIC
  22  * LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT THE
  23  * PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
  24  *---
  25  * Modification to OpenLDAP source by Novell, Inc.
  26  * April 2000 sfs Add code to process V3 referrals and search results
  27  *
  28  *  result.c - wait for an ldap result
  29  */
  30
  31 /*
  32  * LDAPv3 (RFC2251)
  33  *      LDAPResult ::= SEQUENCE {
  34  *              resultCode              ENUMERATED { ... },
  35  *              matchedDN               LDAPDN,
  36  *              errorMessage    LDAPString,
  37  *              referral                Referral OPTIONAL
  38  *      }
  39  *      Referral ::= SEQUENCE OF LDAPURL        (one or more)
  40  *      LDAPURL ::= LDAPString                          (limited to URL chars)
  41  */
  42
  43 #include "portable.h"
  44
  45 #include <stdio.h>
  46
  47 #include <ac/stdlib.h>
  48
  49 #include <ac/errno.h>
  50 #include <ac/socket.h>
  51 #include <ac/string.h>
  52 #include <ac/time.h>
  53 #include <ac/unistd.h>
  54
  55 #include "ldap-int.h"
  56 #include "ldap_log.h"
  57
  58 static int ldap_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
  59 static int ldap_mark_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
  60 static int wait4msg LDAP_P(( LDAP *ld, ber_int_t msgid, int all, struct timeval *timeout,
  61         LDAPMessage **result ));
  62 static ber_tag_t try_read1msg LDAP_P(( LDAP *ld, ber_int_t msgid,
  63         int all, Sockbuf *sb, LDAPConn *lc, LDAPMessage **result ));
  64 static ber_tag_t build_result_ber LDAP_P(( LDAP *ld, BerElement **bp, LDAPRequest *lr ));
  65 static void merge_error_info LDAP_P(( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr ));
  66 static LDAPMessage * chkResponseList LDAP_P(( LDAP *ld, int msgid, int all));
  67
  68
  69 /*
  70  * ldap_result - wait for an ldap result response to a message from the
  71  * ldap server.  If msgid is LDAP_RES_ANY (-1), any message will be
  72  * accepted.  If msgid is LDAP_RES_UNSOLICITED (0), any unsolicited
  73  * message is accepted.  Otherwise ldap_result will wait for a response
  74  * with msgid.  If all is LDAP_MSG_ONE (0) the first message with id
  75  * msgid will be accepted, otherwise, ldap_result will wait for all
  76  * responses with id msgid and then return a pointer to the entire list
  77  * of messages.  In general, this is only useful for search responses,
  78  * which can be of three message types (zero or more entries, zero or
  79  * search references, followed by an ldap result).  An extension to
  80  * LDAPv3 allows partial extended responses to be returned in response
  81  * to any request.  The type of the first message received is returned.
  82  * When waiting, any messages that have been abandoned are discarded.
  83  *
  84  * Example:
  85  *      ldap_result( s, msgid, all, timeout, result )
  86  */
  87 int
  88 ldap_result(
  89         LDAP *ld,
  90         int msgid,
  91         int all,
  92         struct timeval *timeout,
  93         LDAPMessage **result )
  94 {
  95         LDAPMessage     *lm;
  96
  97         assert( ld != NULL );
  98         assert( result != NULL );
  99
 100 #ifdef NEW_LOGGING
 101         LDAP_LOG ( OPERATION, ARGS, "ldap_result msgid %d\n", msgid, 0, 0 );
 102 #else
 103         Debug( LDAP_DEBUG_TRACE, "ldap_result msgid %d\n", msgid, 0, 0 );
 104 #endif
 105
 106     lm = chkResponseList(ld, msgid, all);
 107
 108         if ( lm == NULL ) {
 109                 return( wait4msg( ld, msgid, all, timeout, result ) );
 110         }
 111
 112         *result = lm;
 113         ld->ld_errno = LDAP_SUCCESS;
 114         return( lm->lm_msgtype );
 115 }
 116
 117 static LDAPMessage *
 118 chkResponseList(
 119         LDAP *ld,
 120         int msgid,
 121         int all)
 122 {
 123         LDAPMessage     *lm, *lastlm, *nextlm;
 124     /*
 125          * Look through the list of responses we have received on
 126          * this association and see if the response we're interested in
 127          * is there.  If it is, return it.  If not, call wait4msg() to
 128          * wait until it arrives or timeout occurs.
 129          */
 130
 131 #ifdef NEW_LOGGING
 132         LDAP_LOG ( OPERATION, ARGS, "ldap_chkResponseList for msgid=%d, all=%d\n",
 133                 msgid, all, 0 );
 134 #else
 135         Debug( LDAP_DEBUG_TRACE,
 136                 "ldap_chkResponseList for msgid=%d, all=%d\n",
 137             msgid, all, 0 );
 138 #endif
 139         lastlm = NULL;
 140         for ( lm = ld->ld_responses; lm != NULL; lm = nextlm ) {
 141                 nextlm = lm->lm_next;
 142
 143                 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
 144 #ifdef NEW_LOGGING
 145                         LDAP_LOG ( OPERATION, DETAIL1,
 146                                 "ldap_chkResponseList msg abandoned, msgid %d\n", msgid, 0, 0 );
 147 #else
 148                         Debug( LDAP_DEBUG_TRACE,
 149                                 "ldap_chkResponseList msg abandoned, msgid %d\n",
 150                             msgid, 0, 0 );
 151 #endif
 152                         ldap_mark_abandoned( ld, lm->lm_msgid );
 153
 154                         if ( lastlm == NULL ) {
 155                                 /* Remove first entry in list */
 156                                 ld->ld_responses = lm->lm_next;
 157                         } else {
 158                                 lastlm->lm_next = nextlm;
 159                         }
 160
 161                         ldap_msgfree( lm );
 162
 163                         continue;
 164                 }
 165
 166                 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
 167                         LDAPMessage     *tmp;
 168
 169                         if ( all == LDAP_MSG_ONE || msgid == LDAP_RES_UNSOLICITED ) {
 170                                 break;
 171                         }
 172
 173                         for ( tmp = lm; tmp != NULL; tmp = tmp->lm_chain ) {
 174                                 if ( tmp->lm_msgtype != LDAP_RES_SEARCH_ENTRY
 175                                     && tmp->lm_msgtype != LDAP_RES_SEARCH_REFERENCE
 176                                         && tmp->lm_msgtype != LDAP_RES_EXTENDED_PARTIAL )
 177                                 {
 178                                         break;
 179                                 }
 180                         }
 181
 182                         if ( tmp == NULL ) {
 183                                 lm = NULL;
 184                         }
 185
 186                         break;
 187                 }
 188                 lastlm = lm;
 189         }
 190
 191     if ( lm != NULL ) {
 192                 /* Found an entry, remove it from the list */
 193             if ( lastlm == NULL ) {
 194                     ld->ld_responses = (all == LDAP_MSG_ONE && lm->lm_chain != NULL
 195                         ? lm->lm_chain : lm->lm_next);
 196             } else {
 197                     lastlm->lm_next = (all == LDAP_MSG_ONE && lm->lm_chain != NULL
 198                         ? lm->lm_chain : lm->lm_next);
 199             }
 200             if ( all == LDAP_MSG_ONE && lm->lm_chain != NULL ) {
 201                     lm->lm_chain->lm_next = lm->lm_next;
 202                     lm->lm_chain = NULL;
 203             }
 204             lm->lm_next = NULL;
 205     }
 206
 207 #ifdef LDAP_DEBUG
 208         if( lm == NULL) {
 209 #ifdef NEW_LOGGING
 210                 LDAP_LOG ( OPERATION, RESULTS, "ldap_chkResponseList returns NULL\n",
 211                         0, 0, 0 );
 212 #else
 213                 Debug( LDAP_DEBUG_TRACE,
 214                         "ldap_chkResponseList returns NULL\n", 0, 0, 0);
 215 #endif
 216         } else {
 217 #ifdef NEW_LOGGING
 218                 LDAP_LOG ( OPERATION, RESULTS,
 219                         "ldap_chkResponseList returns msgid %d, type 0x%02lu\n",
 220                         lm->lm_msgid, (unsigned long) lm->lm_msgtype, 0 );
 221 #else
 222                 Debug( LDAP_DEBUG_TRACE,
 223                         "ldap_chkResponseList returns msgid %d, type 0x%02lu\n",
 224                         lm->lm_msgid, (unsigned long) lm->lm_msgtype, 0);
 225 #endif
 226         }
 227 #endif
 228     return lm;
 229 }
 230
 231 static int
 232 wait4msg(
 233         LDAP *ld,
 234         ber_int_t msgid,
 235         int all,
 236         struct timeval *timeout,
 237         LDAPMessage **result )
 238 {
 239         int             rc;
 240         struct timeval  tv, *tvp;
 241         time_t          start_time = 0;
 242         time_t          tmp_time;
 243         LDAPConn        *lc, *nextlc;
 244
 245         assert( ld != NULL );
 246         assert( result != NULL );
 247
 248 #ifdef LDAP_DEBUG
 249         if ( timeout == NULL ) {
 250 #ifdef NEW_LOGGING
 251                 LDAP_LOG ( OPERATION, ARGS,
 252                         "wait4msg (infinite timeout), msgid %d\n", msgid, 0, 0 );
 253 #else
 254                 Debug( LDAP_DEBUG_TRACE, "wait4msg (infinite timeout), msgid %d\n",
 255                     msgid, 0, 0 );
 256 #endif
 257         } else {
 258 #ifdef NEW_LOGGING
 259                 LDAP_LOG ( OPERATION, ARGS,
 260                         "wait4msg (timeout %ld sec, %ld usec), msgid %d\n",
 261                         (long) timeout->tv_sec, (long) timeout->tv_usec, msgid );
 262 #else
 263                 Debug( LDAP_DEBUG_TRACE, "wait4msg (timeout %ld sec, %ld usec), msgid %d\n",
 264                        (long) timeout->tv_sec, (long) timeout->tv_usec, msgid );
 265 #endif
 266         }
 267 #endif /* LDAP_DEBUG */
 268
 269         if ( timeout == NULL ) {
 270                 tvp = NULL;
 271         } else {
 272                 tv = *timeout;
 273                 tvp = &tv;
 274                 start_time = time( NULL );
 275         }
 276
 277         rc = -2;
 278         while ( rc == -2 ) {
 279 #ifdef LDAP_DEBUG
 280 #ifdef NEW_LOGGING
 281                 LDAP_LOG ( OPERATION, ARGS,
 282                         "wait4msg continue, msgid %d, all %d\n", msgid, all, 0 );
 283 #else
 284                 Debug( LDAP_DEBUG_TRACE, "wait4msg continue, msgid %d, all %d\n",
 285                     msgid, all, 0 );
 286 #endif
 287                 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
 288                         ldap_dump_connection( ld, ld->ld_conns, 1 );
 289                         ldap_dump_requests_and_responses( ld );
 290                 }
 291 #endif /* LDAP_DEBUG */
 292
 293         if( (*result = chkResponseList(ld, msgid, all)) != NULL ) {
 294             rc = (*result)->lm_msgtype;
 295         } else {
 296
 297                         for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
 298                                 if ( ber_sockbuf_ctrl( lc->lconn_sb,
 299                                                 LBER_SB_OPT_DATA_READY, NULL ) ) {
 300                                             rc = try_read1msg( ld, msgid, all, lc->lconn_sb,
 301                                                 lc, result );
 302                                     break;
 303                                 }
 304                 }
 305
 306                     if ( lc == NULL ) {
 307                             rc = ldap_int_select( ld, tvp );
 308
 309
 310 #ifdef LDAP_DEBUG
 311                             if ( rc == -1 ) {
 312 #ifdef NEW_LOGGING
 313                                         LDAP_LOG ( OPERATION, ARGS,
 314                                                 "wait4msg: ldap_int_select returned -1: errno %d\n",
 315                                                 errno, 0, 0 );
 316 #else
 317                                 Debug( LDAP_DEBUG_TRACE,
 318                                         "ldap_int_select returned -1: errno %d\n",
 319                                         errno, 0, 0 );
 320 #endif
 321                             }
 322 #endif
 323
 324                             if ( rc == 0 || ( rc == -1 && (
 325                                     !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
 326                                     || errno != EINTR )))
 327                             {
 328                                     ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
 329                                         LDAP_TIMEOUT);
 330                                     return( rc );
 331                             }
 332
 333                             if ( rc == -1 ) {
 334                                     rc = -2;    /* select interrupted: loop */
 335                             } else {
 336                                     rc = -2;
 337                                     if ( ld->ld_requests &&
 338                                                 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
 339                                                 ldap_is_write_ready( ld,
 340                                                         ld->ld_requests->lr_conn->lconn_sb ) ) {
 341                                                 ldap_int_flush_request( ld, ld->ld_requests );
 342                                         }
 343                                     for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
 344                                         lc = nextlc ) {
 345                                             nextlc = lc->lconn_next;
 346                                             if ( lc->lconn_status ==
 347                                                 LDAP_CONNST_CONNECTED &&
 348                                                 ldap_is_read_ready( ld,
 349                                                 lc->lconn_sb )) {
 350                                                     rc = try_read1msg( ld, msgid, all,
 351                                                         lc->lconn_sb, lc, result );
 352                                             }
 353                                     }
 354                             }
 355                     }
 356                 }
 357
 358                 if ( rc == -2 && tvp != NULL ) {
 359                         tmp_time = time( NULL );
 360                         if (( tv.tv_sec -=  ( tmp_time - start_time )) <= 0 ) {
 361                                 rc = 0; /* timed out */
 362                                 ld->ld_errno = LDAP_TIMEOUT;
 363                                 break;
 364                         }
 365
 366 #ifdef NEW_LOGGING
 367                         LDAP_LOG ( OPERATION, DETAIL1,
 368                                 "wait4msg: %ld secs to go\n", (long) tv.tv_sec, 0, 0 );
 369 #else
 370                         Debug( LDAP_DEBUG_TRACE, "wait4msg:  %ld secs to go\n",
 371                                (long) tv.tv_sec, 0, 0 );
 372 #endif
 373                         start_time = tmp_time;
 374                 }
 375         }
 376
 377         return( rc );
 378 }
 379
 380
 381 static ber_tag_t
 382 try_read1msg(
 383         LDAP *ld,
 384         ber_int_t msgid,
 385         int all,
 386         Sockbuf *sb,
 387         LDAPConn *lc,
 388         LDAPMessage **result )
 389 {
 390         BerElement      *ber;
 391         LDAPMessage     *new, *l, *prev, *tmp;
 392         ber_int_t       id;
 393         ber_tag_t       tag;
 394         ber_len_t       len;
 395         int             foundit = 0;
 396         LDAPRequest     *lr, *tmplr;
 397         BerElement      tmpber;
 398         int             rc, refer_cnt, hadref, simple_request;
 399         ber_int_t       lderr;
 400         /*
 401          * v3ref = flag for V3 referral / search reference
 402          * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
 403          */
 404         int     v3ref;
 405
 406         assert( ld != NULL );
 407         assert( lc != NULL );
 408
 409 #ifdef NEW_LOGGING
 410         LDAP_LOG ( OPERATION, ARGS, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
 411 #else
 412         Debug( LDAP_DEBUG_TRACE, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
 413 #endif
 414
 415     if ( lc->lconn_ber == NULL ) {
 416                 lc->lconn_ber = ldap_alloc_ber_with_options(ld);
 417
 418                 if( lc->lconn_ber == NULL ) {
 419                         return -1;
 420                 }
 421     }
 422
 423         ber = lc->lconn_ber;
 424         assert( LBER_VALID (ber) );
 425
 426         /* get the next message */
 427         errno = 0;
 428 #ifdef LDAP_CONNECTIONLESS
 429         if ( LDAP_IS_UDP(ld) ) {
 430                 struct sockaddr from;
 431                 ber_int_sb_read(sb, &from, sizeof(struct sockaddr));
 432         }
 433 #endif
 434         if ( (tag = ber_get_next( sb, &len, ber ))
 435             != LDAP_TAG_MESSAGE ) {
 436                 if ( tag == LBER_DEFAULT) {
 437 #ifdef LDAP_DEBUG
 438 #ifdef NEW_LOGGING
 439                         LDAP_LOG ( OPERATION, DETAIL1,
 440                                 "read1msg: ber_get_next failed\n", 0, 0, 0 );
 441 #else
 442                         Debug( LDAP_DEBUG_CONNS,
 443                               "ber_get_next failed.\n", 0, 0, 0 );
 444 #endif
 445 #endif
 446 #ifdef EWOULDBLOCK
 447                         if (errno==EWOULDBLOCK) return -2;
 448 #endif
 449 #ifdef EAGAIN
 450                         if (errno == EAGAIN) return -2;
 451 #endif
 452                         ld->ld_errno = LDAP_SERVER_DOWN;
 453                         return -1;
 454                 }
 455                 ld->ld_errno = LDAP_LOCAL_ERROR;
 456                 return -1;
 457         }
 458
 459         /*
 460      * We read a complete message.
 461          * The connection should no longer need this ber.
 462          */
 463     lc->lconn_ber = NULL;
 464
 465         /* message id */
 466         if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
 467                 ber_free( ber, 1 );
 468                 ld->ld_errno = LDAP_DECODING_ERROR;
 469                 return( -1 );
 470         }
 471
 472         /* if it's been abandoned, toss it */
 473         if ( ldap_abandoned( ld, id ) ) {
 474                 ber_free( ber, 1 );
 475 #ifdef NEW_LOGGING
 476                 LDAP_LOG ( OPERATION, DETAIL1, "read1msg: abandoned\n", 0, 0, 0 );
 477 #else
 478                 Debug( LDAP_DEBUG_ANY, "abandoned\n", 0, 0, 0);
 479 #endif
 480                 return( -2 );   /* continue looking */
 481         }
 482
 483         if (( lr = ldap_find_request_by_msgid( ld, id )) == NULL ) {
 484 #ifdef NEW_LOGGING
 485                 LDAP_LOG ( OPERATION, DETAIL1,
 486                         "read1msg: no request for response with msgid %ld (tossing)\n",
 487                         (long) id, 0, 0 );
 488 #else
 489                 Debug( LDAP_DEBUG_ANY,
 490                     "no request for response with msgid %ld (tossing)\n",
 491                     (long) id, 0, 0 );
 492 #endif
 493                 ber_free( ber, 1 );
 494                 return( -2 );   /* continue looking */
 495         }
 496 #ifdef LDAP_CONNECTIONLESS
 497         if (LDAP_IS_UDP(ld) && ld->ld_options.ldo_version == LDAP_VERSION2) {
 498                 struct berval blank;
 499                 ber_scanf(ber, "m{", &blank);
 500         }
 501 #endif
 502         /* the message type */
 503         if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
 504                 ld->ld_errno = LDAP_DECODING_ERROR;
 505                 ber_free( ber, 1 );
 506                 return( -1 );
 507         }
 508
 509 #ifdef NEW_LOGGING
 510         LDAP_LOG ( OPERATION, DETAIL1,
 511                 "read1msg: ldap_read: message type %s msgid %ld, original id %ld\n",
 512             ldap_int_msgtype2str( tag ),
 513                 (long) lr->lr_msgid, (long) lr->lr_origid );
 514 #else
 515         Debug( LDAP_DEBUG_TRACE,
 516                 "ldap_read: message type %s msgid %ld, original id %ld\n",
 517             ldap_int_msgtype2str( tag ),
 518                 (long) lr->lr_msgid, (long) lr->lr_origid );
 519 #endif
 520
 521         id = lr->lr_origid;
 522         refer_cnt = 0;
 523         hadref = simple_request = 0;
 524         rc = -2;        /* default is to keep looking (no response found) */
 525         lr->lr_res_msgtype = tag;
 526
 527         /*
 528          * This code figures out if we are going to chase a
 529          * referral / search reference, or pass it back to the application
 530          */
 531         v3ref = 0;      /* Assume not a V3 search reference or referral */
 532         if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
 533                 BerElement      tmpber = *ber;  /* struct copy */
 534                 char **refs = NULL;
 535
 536                 if( tag == LDAP_RES_SEARCH_REFERENCE) {
 537                         /* This is a V3 search reference */
 538                         /* Assume we do not chase the reference, but pass it to application */
 539                         v3ref = -1;
 540                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
 541                                         (lr->lr_parent != NULL) )
 542                         {
 543                                 /* Get the referral list */
 544                                 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
 545                                         rc = LDAP_DECODING_ERROR;
 546                                 } else {
 547                                         /* Note: refs arrary is freed by ldap_chase_v3referrals */
 548                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
 549                                             1, &lr->lr_res_error, &hadref );
 550                                         if ( refer_cnt > 0 ) {  /* sucessfully chased reference */
 551                                                 /* If haven't got end search, set chasing referrals */
 552                                                 if( lr->lr_status != LDAP_REQST_COMPLETED) {
 553                                                         lr->lr_status = LDAP_REQST_CHASINGREFS;
 554 #ifdef NEW_LOGGING
 555                                                         LDAP_LOG ( OPERATION, DETAIL1,
 556                                                                 "read1msg: search ref chased,"
 557                                                                 "mark request chasing refs, id =        %d\n",
 558                                                                 lr->lr_msgid, 0, 0 );
 559 #else
 560                                                         Debug( LDAP_DEBUG_TRACE,
 561                                                             "read1msg:  search ref chased, mark request chasing refs, id = %d\n",
 562                                                             lr->lr_msgid, 0, 0);
 563 #endif
 564                                                 }
 565                                                 v3ref = 1;      /* We sucessfully chased the reference */
 566                                         }
 567                                 }
 568                         }
 569                 } else {
 570                         /* Check for V3 referral */
 571                         ber_len_t len;
 572                         if ( ber_scanf( &tmpber, "{iaa",/*}*/ &lderr,
 573                                     &lr->lr_res_matched, &lr->lr_res_error )
 574                                     != LBER_ERROR ) {
 575                                 /* Check if V3 referral */
 576                                 if( ber_peek_tag( &tmpber, &len) == LDAP_TAG_REFERRAL ) {
 577                                         /* We have a V3 referral, assume we cannot chase it */
 578                                         v3ref = -1;
 579                                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
 580                                                          || (lr->lr_parent != NULL) )
 581                                         {
 582                                                 v3ref = -1;  /* Assume referral not chased and return it to app */
 583                                                 /* Get the referral list */
 584                                                 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
 585                                                         rc = LDAP_DECODING_ERROR;
 586                                                         lr->lr_status = LDAP_REQST_COMPLETED;
 587 #ifdef NEW_LOGGING
 588                                                         LDAP_LOG ( OPERATION, DETAIL1,
 589                                                                 "read1msg: referral decode error,"
 590                                                                 "mark request completed, id =   %d\n",
 591                                                                 lr->lr_msgid, 0, 0 );
 592 #else
 593                                                         Debug( LDAP_DEBUG_TRACE,
 594                                                             "read1msg: referral decode error, mark request completed, id = %d\n",
 595                                                                     lr->lr_msgid, 0, 0);
 596 #endif
 597                                                 } else {
 598                                                         /* Chase the referral
 599                                                          * Note: refs arrary is freed by ldap_chase_v3referrals
 600                                                          */
 601                                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
 602                                                             0, &lr->lr_res_error, &hadref );
 603                                                         lr->lr_status = LDAP_REQST_COMPLETED;
 604 #ifdef NEW_LOGGING
 605                                                         LDAP_LOG ( OPERATION, DETAIL1,
 606                                                                 "read1msg: referral chased,"
 607                                                                 "mark request completed, id =   %d\n",
 608                                                                 lr->lr_msgid, 0, 0 );
 609 #else
 610                                                         Debug( LDAP_DEBUG_TRACE,
 611                                                             "read1msg:  referral chased, mark request completed, id = %d\n",
 612                                                             lr->lr_msgid, 0, 0);
 613 #endif
 614                                                         if( refer_cnt > 0) {
 615                                                                 v3ref = 1;  /* Referral successfully chased */
 616                                                         }
 617                                                 }
 618                                         }
 619                                 }
 620
 621                                 if( lr->lr_res_matched != NULL ) {
 622                                         LDAP_FREE( lr->lr_res_matched );
 623                                         lr->lr_res_matched = NULL;
 624                                 }
 625                                 if( lr->lr_res_error != NULL ) {
 626                                         LDAP_FREE( lr->lr_res_error );
 627                                         lr->lr_res_error = NULL;
 628                                 }
 629                         }
 630                 }
 631         }
 632
 633         /* All results that just return a status, i.e. don't return data
 634          * go through the following code.  This code also chases V2 referrals
 635          * and checks if all referrals have been chased.
 636          */
 637         if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref > -1) ) {
 638                 /* For a v3 search referral/reference, only come here if already chased it */
 639                 if ( ld->ld_version >= LDAP_VERSION2 &&
 640                         ( lr->lr_parent != NULL ||
 641                         LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
 642                 {
 643                         tmpber = *ber;  /* struct copy */
 644                         if ( v3ref == 1 ) {
 645                                 /* V3 search reference or V3 referral
 646                                  * sucessfully chased. If this message
 647                                  * is a search result, then it has no more
 648                                  * outstanding referrals.
 649                                  */
 650                                 if ( tag == LDAP_RES_SEARCH_RESULT )
 651                                         refer_cnt = 0;
 652                         } else if ( ber_scanf( &tmpber, "{iaa}", &lderr,
 653                             &lr->lr_res_matched, &lr->lr_res_error )
 654                             != LBER_ERROR ) {
 655                                 if ( lderr != LDAP_SUCCESS ) {
 656                                         /* referrals are in error string */
 657                                         refer_cnt = ldap_chase_referrals( ld, lr,
 658                                                 &lr->lr_res_error, -1, &hadref );
 659                                         lr->lr_status = LDAP_REQST_COMPLETED;
 660 #ifdef NEW_LOGGING
 661                                         LDAP_LOG ( OPERATION, DETAIL1,
 662                                                 "read1msg: V2 referral chased,"
 663                                                 "mark request completed, id =   %d\n",
 664                                                 lr->lr_msgid, 0, 0 );
 665 #else
 666                                         Debug( LDAP_DEBUG_TRACE,
 667                                             "read1msg:  V2 referral chased, mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
 668 #endif
 669                                 }
 670
 671                                 /* save errno, message, and matched string */
 672                                 if ( !hadref || lr->lr_res_error == NULL ) {
 673                                         lr->lr_res_errno = ( lderr ==
 674                                         LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
 675                                         : lderr;
 676                                 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
 677                                         lr->lr_res_errno = ld->ld_errno;
 678                                 } else {
 679                                         lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
 680                                 }
 681 #ifdef NEW_LOGGING
 682 LDAP_LOG ( OPERATION, DETAIL1,
 683         "read1msg: new result: res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 684     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 685     lr->lr_res_matched ? lr->lr_res_matched : "" );
 686 #else
 687 Debug( LDAP_DEBUG_TRACE,
 688     "new result:  res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 689     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 690     lr->lr_res_matched ? lr->lr_res_matched : "" );
 691 #endif
 692                         }
 693                 }
 694
 695 #ifdef NEW_LOGGING
 696                 LDAP_LOG ( OPERATION, DETAIL1, "read1msg: %d new referrals\n",
 697                         refer_cnt, 0, 0 );
 698 #else
 699                 Debug( LDAP_DEBUG_TRACE,
 700                     "read1msg:  %d new referrals\n", refer_cnt, 0, 0 );
 701 #endif
 702
 703                 if ( refer_cnt != 0 ) { /* chasing referrals */
 704                         ber_free( ber, 1 );
 705                         ber = NULL;
 706                         if ( refer_cnt < 0 ) {
 707                                 return( -1 );   /* fatal error */
 708                         }
 709                         lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
 710                 } else {
 711                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
 712                                 /* request without any referrals */
 713                                 simple_request = ( hadref ? 0 : 1 );
 714                         } else {
 715                                 /* request with referrals or child request */
 716                                 ber_free( ber, 1 );
 717                                 ber = NULL;
 718                         }
 719
 720                         lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
 721 #ifdef NEW_LOGGING
 722                         LDAP_LOG ( OPERATION, DETAIL1,
 723                                 "read1msg: mark request completed, id = %d\n",
 724                                 lr->lr_msgid, 0, 0 );
 725 #else
 726                         Debug( LDAP_DEBUG_TRACE,
 727                             "read1msg:  mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
 728 #endif
 729                         while ( lr->lr_parent != NULL ) {
 730                                 merge_error_info( ld, lr->lr_parent, lr );
 731
 732                                 lr = lr->lr_parent;
 733                                 if ( --lr->lr_outrefcnt > 0 ) {
 734                                         break;  /* not completely done yet */
 735                                 }
 736                         }
 737
 738                         /* Check if all requests are finished, lr is now parent */
 739                         tmplr = lr;
 740                         if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
 741                                 for(tmplr=lr->lr_child; tmplr != NULL; tmplr=tmplr->lr_refnext) {
 742                                 if( tmplr->lr_status != LDAP_REQST_COMPLETED) {
 743                                         break;
 744                                         }
 745                                 }
 746                         }
 747
 748                         /* This is the parent request if the request has referrals */
 749                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL && tmplr == NULL ) {
 750                                 id = lr->lr_msgid;
 751                                 tag = lr->lr_res_msgtype;
 752 #ifdef NEW_LOGGING
 753                         LDAP_LOG ( OPERATION, DETAIL1,
 754                                 "read1msg: request %ld done\n", (long) id, 0, 0 );
 755                         LDAP_LOG ( OPERATION, DETAIL1,
 756                                 "read1msg: res_errno: %d,res_error: <%s>, res_matched: <%s>\n",
 757                                 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 758                                 lr->lr_res_matched ? lr->lr_res_matched : "" );
 759 #else
 760                                 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
 761                                     (long) id, 0, 0 );
 762 Debug( LDAP_DEBUG_TRACE,
 763 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 764 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 765 lr->lr_res_matched ? lr->lr_res_matched : "" );
 766 #endif
 767                                 if ( !simple_request ) {
 768                                         ber_free( ber, 1 );
 769                                         ber = NULL;
 770                                         if ( build_result_ber( ld, &ber, lr )
 771                                             == LBER_ERROR ) {
 772                                                 rc = -1; /* fatal error */
 773                                         }
 774                                 }
 775
 776                                 ldap_free_request( ld, lr );
 777                         }
 778
 779                         if ( lc != NULL ) {
 780                                 ldap_free_connection( ld, lc, 0, 1 );
 781                         }
 782                 }
 783         }
 784
 785         if ( ber == NULL ) {
 786                 return( rc );
 787         }
 788
 789         /* make a new ldap message */
 790         if ( (new = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) ))
 791             == NULL ) {
 792                 ld->ld_errno = LDAP_NO_MEMORY;
 793                 return( -1 );
 794         }
 795         new->lm_msgid = (int)id;
 796         new->lm_msgtype = tag;
 797         new->lm_ber = ber;
 798
 799 #ifndef LDAP_NOCACHE
 800                 if ( ld->ld_cache != NULL ) {
 801                         ldap_add_result_to_cache( ld, new );
 802                 }
 803 #endif /* LDAP_NOCACHE */
 804
 805         /* is this the one we're looking for? */
 806         if ( msgid == LDAP_RES_ANY || id == msgid ) {
 807                 if ( all == LDAP_MSG_ONE
 808                     || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
 809                     && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY
 810                     && new->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
 811                         *result = new;
 812                         ld->ld_errno = LDAP_SUCCESS;
 813                         return( tag );
 814                 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
 815                         foundit = 1;    /* return the chain later */
 816                 }
 817         }
 818
 819         /*
 820          * if not, we must add it to the list of responses.  if
 821          * the msgid is already there, it must be part of an existing
 822          * search response.
 823          */
 824
 825         prev = NULL;
 826         for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
 827                 if ( l->lm_msgid == new->lm_msgid )
 828                         break;
 829                 prev = l;
 830         }
 831
 832         /* not part of an existing search response */
 833         if ( l == NULL ) {
 834                 if ( foundit ) {
 835                         *result = new;
 836                         ld->ld_errno = LDAP_SUCCESS;
 837                         return( tag );
 838                 }
 839
 840                 new->lm_next = ld->ld_responses;
 841                 ld->ld_responses = new;
 842                 return( -2 );   /* continue looking */
 843         }
 844
 845 #ifdef NEW_LOGGING
 846         LDAP_LOG ( OPERATION, DETAIL1,
 847                 "read1msg: adding response id %ld type %ld\n",
 848                 (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
 849 #else
 850         Debug( LDAP_DEBUG_TRACE, "adding response id %ld type %ld:\n",
 851             (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
 852 #endif
 853
 854         /* part of a search response - add to end of list of entries */
 855         for ( tmp = l; (tmp->lm_chain != NULL) &&
 856                 ((tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
 857                  (tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
 858                          (tmp->lm_chain->lm_msgtype == LDAP_RES_EXTENDED_PARTIAL ));
 859             tmp = tmp->lm_chain )
 860                 ;       /* NULL */
 861         tmp->lm_chain = new;
 862
 863         /* return the whole chain if that's what we were looking for */
 864         if ( foundit ) {
 865                 if ( prev == NULL )
 866                         ld->ld_responses = l->lm_next;
 867                 else
 868                         prev->lm_next = l->lm_next;
 869                 *result = l;
 870                 ld->ld_errno = LDAP_SUCCESS;
 871 #ifdef LDAP_WORLD_P16
 872                 /*
 873                  * XXX questionable fix; see text for [P16] on
 874                  * http://www.critical-angle.com/ldapworld/patch/
 875                  *
 876                  * inclusion of this patch causes searchs to hang on
 877                  * multiple platforms
 878                  */
 879                 return( l->lm_msgtype );
 880 #else   /* LDAP_WORLD_P16 */
 881                 return( tag );
 882 #endif  /* !LDAP_WORLD_P16 */
 883         }
 884
 885         return( -2 );   /* continue looking */
 886 }
 887
 888
 889 static ber_tag_t
 890 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
 891 {
 892         ber_len_t       len;
 893         ber_tag_t       tag;
 894         ber_int_t       along;
 895         BerElement *ber;
 896
 897         *bp = NULL;
 898         ber = ldap_alloc_ber_with_options( ld );
 899
 900         if( ber == NULL ) {
 901                 ld->ld_errno = LDAP_NO_MEMORY;
 902                 return LBER_ERROR;
 903         }
 904
 905         if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
 906             lr->lr_res_msgtype, lr->lr_res_errno,
 907             lr->lr_res_matched ? lr->lr_res_matched : "",
 908             lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
 909
 910                 ld->ld_errno = LDAP_ENCODING_ERROR;
 911                 ber_free(ber, 1);
 912                 return( LBER_ERROR );
 913         }
 914
 915         ber_reset( ber, 1 );
 916
 917         if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
 918                 ld->ld_errno = LDAP_DECODING_ERROR;
 919                 ber_free(ber, 1);
 920                 return( LBER_ERROR );
 921         }
 922
 923         if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
 924                 ld->ld_errno = LDAP_DECODING_ERROR;
 925                 ber_free(ber, 1);
 926                 return( LBER_ERROR );
 927         }
 928
 929         tag = ber_peek_tag( ber, &len );
 930
 931         if ( tag == LBER_ERROR ) {
 932                 ld->ld_errno = LDAP_DECODING_ERROR;
 933                 ber_free(ber, 1);
 934                 return( LBER_ERROR );
 935         }
 936
 937         *bp = ber;
 938         return tag;
 939 }
 940
 941
 942 static void
 943 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
 944 {
 945 /*
 946  * Merge error information in "lr" with "parentr" error code and string.
 947  */
 948         if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
 949                 parentr->lr_res_errno = lr->lr_res_errno;
 950                 if ( lr->lr_res_error != NULL ) {
 951                         (void)ldap_append_referral( ld, &parentr->lr_res_error,
 952                             lr->lr_res_error );
 953                 }
 954         } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
 955             parentr->lr_res_errno == LDAP_SUCCESS ) {
 956                 parentr->lr_res_errno = lr->lr_res_errno;
 957                 if ( parentr->lr_res_error != NULL ) {
 958                         LDAP_FREE( parentr->lr_res_error );
 959                 }
 960                 parentr->lr_res_error = lr->lr_res_error;
 961                 lr->lr_res_error = NULL;
 962                 if ( LDAP_NAME_ERROR( lr->lr_res_errno )) {
 963                         if ( parentr->lr_res_matched != NULL ) {
 964                                 LDAP_FREE( parentr->lr_res_matched );
 965                         }
 966                         parentr->lr_res_matched = lr->lr_res_matched;
 967                         lr->lr_res_matched = NULL;
 968                 }
 969         }
 970
 971 #ifdef NEW_LOGGING
 972         LDAP_LOG( OPERATION, DETAIL1, "merged parent (id %d) error info:  ",
 973             parentr->lr_msgid, 0, 0 );
 974         LDAP_LOG( OPERATION, DETAIL1, "result errno %d, error <%s>, matched <%s>\n",
 975             parentr->lr_res_errno, parentr->lr_res_error ?
 976             parentr->lr_res_error : "", parentr->lr_res_matched ?
 977             parentr->lr_res_matched : "" );
 978 #else
 979         Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info:  ",
 980             parentr->lr_msgid, 0, 0 );
 981         Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
 982             parentr->lr_res_errno, parentr->lr_res_error ?
 983             parentr->lr_res_error : "", parentr->lr_res_matched ?
 984             parentr->lr_res_matched : "" );
 985 #endif
 986 }
 987
 988
 989
 990 int
 991 ldap_msgtype( LDAPMessage *lm )
 992 {
 993         assert( lm != NULL );
 994         return ( lm != NULL ) ? lm->lm_msgtype : -1;
 995 }
 996
 997
 998 int
 999 ldap_msgid( LDAPMessage *lm )
1000 {
1001         assert( lm != NULL );
1002
1003         return ( lm != NULL ) ? lm->lm_msgid : -1;
1004 }
1005
1006
1007 char * ldap_int_msgtype2str( ber_tag_t tag )
1008 {
1009         switch( tag ) {
1010         case LDAP_RES_ADD: return "add";
1011         case LDAP_RES_BIND: return "bind";
1012         case LDAP_RES_COMPARE: return "compare";
1013         case LDAP_RES_DELETE: return "delete";
1014         case LDAP_RES_EXTENDED: return "extended-result";
1015         case LDAP_RES_EXTENDED_PARTIAL: return "extended-partial";
1016         case LDAP_RES_MODIFY: return "modify";
1017         case LDAP_RES_RENAME: return "rename";
1018         case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1019         case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1020         case LDAP_RES_SEARCH_RESULT: return "search-result";
1021         }
1022         return "unknown";
1023 }
1024
1025 int
1026 ldap_msgfree( LDAPMessage *lm )
1027 {
1028         LDAPMessage     *next;
1029         int             type = 0;
1030
1031 #ifdef NEW_LOGGING
1032         LDAP_LOG ( OPERATION, ENTRY, "ldap_msgfree\n", 0, 0, 0 );
1033 #else
1034         Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1035 #endif
1036
1037         for ( ; lm != NULL; lm = next ) {
1038                 next = lm->lm_chain;
1039                 type = lm->lm_msgtype;
1040                 ber_free( lm->lm_ber, 1 );
1041                 LDAP_FREE( (char *) lm );
1042         }
1043
1044         return( type );
1045 }
1046
1047 /*
1048  * ldap_msgdelete - delete a message.  It returns:
1049  *      0       if the entire message was deleted
1050  *      -1      if the message was not found, or only part of it was found
1051  */
1052 int
1053 ldap_msgdelete( LDAP *ld, int msgid )
1054 {
1055         LDAPMessage     *lm, *prev;
1056
1057         assert( ld != NULL );
1058
1059 #ifdef NEW_LOGGING
1060         LDAP_LOG ( OPERATION, ENTRY, "ldap_msgdelete\n", 0, 0, 0 );
1061 #else
1062         Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1063 #endif
1064
1065         prev = NULL;
1066         for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1067                 if ( lm->lm_msgid == msgid )
1068                         break;
1069                 prev = lm;
1070         }
1071
1072         if ( lm == NULL )
1073                 return( -1 );
1074
1075         if ( prev == NULL )
1076                 ld->ld_responses = lm->lm_next;
1077         else
1078                 prev->lm_next = lm->lm_next;
1079
1080         if ( ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1081                 return( -1 );
1082
1083         return( 0 );
1084 }
1085
1086
1087 /*
1088  * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1089  */
1090 static int
1091 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1092 {
1093         int     i;
1094
1095         if ( ld->ld_abandoned == NULL )
1096                 return( 0 );
1097
1098         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1099                 if ( ld->ld_abandoned[i] == msgid )
1100                         return( 1 );
1101
1102         return( 0 );
1103 }
1104
1105
1106 static int
1107 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1108 {
1109         int     i;
1110
1111         if ( ld->ld_abandoned == NULL )
1112                 return( -1 );
1113
1114         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1115                 if ( ld->ld_abandoned[i] == msgid )
1116                         break;
1117
1118         if ( ld->ld_abandoned[i] == -1 )
1119                 return( -1 );
1120
1121         for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1122                 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
1123         }
1124
1125         return( 0 );
1126 }