git.sur5r.net Git - openldap/blob - libraries/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                                     for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
 338                                         lc = nextlc ) {
 339                                             nextlc = lc->lconn_next;
 340                                             if ( lc->lconn_status ==
 341                                                 LDAP_CONNST_CONNECTED &&
 342                                                 ldap_is_read_ready( ld,
 343                                                 lc->lconn_sb )) {
 344                                                     rc = try_read1msg( ld, msgid, all,
 345                                                         lc->lconn_sb, lc, result );
 346                                             }
 347                                     }
 348                             }
 349                     }
 350                 }
 351
 352                 if ( rc == -2 && tvp != NULL ) {
 353                         tmp_time = time( NULL );
 354                         if (( tv.tv_sec -=  ( tmp_time - start_time )) <= 0 ) {
 355                                 rc = 0; /* timed out */
 356                                 ld->ld_errno = LDAP_TIMEOUT;
 357                                 break;
 358                         }
 359
 360 #ifdef NEW_LOGGING
 361                         LDAP_LOG ( OPERATION, DETAIL1,
 362                                 "wait4msg: %ld secs to go\n", (long) tv.tv_sec, 0, 0 );
 363 #else
 364                         Debug( LDAP_DEBUG_TRACE, "wait4msg:  %ld secs to go\n",
 365                                (long) tv.tv_sec, 0, 0 );
 366 #endif
 367                         start_time = tmp_time;
 368                 }
 369         }
 370
 371         return( rc );
 372 }
 373
 374
 375 static ber_tag_t
 376 try_read1msg(
 377         LDAP *ld,
 378         ber_int_t msgid,
 379         int all,
 380         Sockbuf *sb,
 381         LDAPConn *lc,
 382         LDAPMessage **result )
 383 {
 384         BerElement      *ber;
 385         LDAPMessage     *new, *l, *prev, *tmp;
 386         ber_int_t       id;
 387         ber_tag_t       tag;
 388         ber_len_t       len;
 389         int             foundit = 0;
 390         LDAPRequest     *lr, *tmplr;
 391         BerElement      tmpber;
 392         int             rc, refer_cnt, hadref, simple_request;
 393         ber_int_t       lderr;
 394         /*
 395          * v3ref = flag for V3 referral / search reference
 396          * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
 397          */
 398         int     v3ref;
 399
 400         assert( ld != NULL );
 401         assert( lc != NULL );
 402
 403 #ifdef NEW_LOGGING
 404         LDAP_LOG ( OPERATION, ARGS, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
 405 #else
 406         Debug( LDAP_DEBUG_TRACE, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
 407 #endif
 408
 409     if ( lc->lconn_ber == NULL ) {
 410                 lc->lconn_ber = ldap_alloc_ber_with_options(ld);
 411
 412                 if( lc->lconn_ber == NULL ) {
 413                         return -1;
 414                 }
 415     }
 416
 417         ber = lc->lconn_ber;
 418         assert( LBER_VALID (ber) );
 419
 420         /* get the next message */
 421         errno = 0;
 422 #ifdef LDAP_CONNECTIONLESS
 423         if ( LDAP_IS_UDP(ld) ) {
 424                 struct sockaddr from;
 425                 ber_int_sb_read(sb, &from, sizeof(struct sockaddr));
 426         }
 427 #endif
 428         if ( (tag = ber_get_next( sb, &len, ber ))
 429             != LDAP_TAG_MESSAGE ) {
 430                 if ( tag == LBER_DEFAULT) {
 431 #ifdef LDAP_DEBUG
 432 #ifdef NEW_LOGGING
 433                         LDAP_LOG ( OPERATION, DETAIL1,
 434                                 "read1msg: ber_get_next failed\n", 0, 0, 0 );
 435 #else
 436                         Debug( LDAP_DEBUG_CONNS,
 437                               "ber_get_next failed.\n", 0, 0, 0 );
 438 #endif
 439 #endif
 440 #ifdef EWOULDBLOCK
 441                         if (errno==EWOULDBLOCK) return -2;
 442 #endif
 443 #ifdef EAGAIN
 444                         if (errno == EAGAIN) return -2;
 445 #endif
 446                         ld->ld_errno = LDAP_SERVER_DOWN;
 447                         return -1;
 448                 }
 449                 ld->ld_errno = LDAP_LOCAL_ERROR;
 450                 return -1;
 451         }
 452
 453         /*
 454      * We read a complete message.
 455          * The connection should no longer need this ber.
 456          */
 457     lc->lconn_ber = NULL;
 458
 459         /* message id */
 460         if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
 461                 ber_free( ber, 1 );
 462                 ld->ld_errno = LDAP_DECODING_ERROR;
 463                 return( -1 );
 464         }
 465
 466         /* if it's been abandoned, toss it */
 467         if ( ldap_abandoned( ld, id ) ) {
 468                 ber_free( ber, 1 );
 469 #ifdef NEW_LOGGING
 470                 LDAP_LOG ( OPERATION, DETAIL1, "read1msg: abandoned\n", 0, 0, 0 );
 471 #else
 472                 Debug( LDAP_DEBUG_ANY, "abandoned\n", 0, 0, 0);
 473 #endif
 474                 return( -2 );   /* continue looking */
 475         }
 476
 477         if (( lr = ldap_find_request_by_msgid( ld, id )) == NULL ) {
 478 #ifdef NEW_LOGGING
 479                 LDAP_LOG ( OPERATION, DETAIL1,
 480                         "read1msg: no request for response with msgid %ld (tossing)\n",
 481                         (long) id, 0, 0 );
 482 #else
 483                 Debug( LDAP_DEBUG_ANY,
 484                     "no request for response with msgid %ld (tossing)\n",
 485                     (long) id, 0, 0 );
 486 #endif
 487                 ber_free( ber, 1 );
 488                 return( -2 );   /* continue looking */
 489         }
 490 #ifdef LDAP_CONNECTIONLESS
 491         if (LDAP_IS_UDP(ld) && ld->ld_options.ldo_version == LDAP_VERSION2) {
 492                 struct berval blank;
 493                 ber_scanf(ber, "m{", &blank);
 494         }
 495 #endif
 496         /* the message type */
 497         if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
 498                 ld->ld_errno = LDAP_DECODING_ERROR;
 499                 ber_free( ber, 1 );
 500                 return( -1 );
 501         }
 502
 503 #ifdef NEW_LOGGING
 504         LDAP_LOG ( OPERATION, DETAIL1,
 505                 "read1msg: ldap_read: message type %s msgid %ld, original id %ld\n",
 506             ldap_int_msgtype2str( tag ),
 507                 (long) lr->lr_msgid, (long) lr->lr_origid );
 508 #else
 509         Debug( LDAP_DEBUG_TRACE,
 510                 "ldap_read: message type %s msgid %ld, original id %ld\n",
 511             ldap_int_msgtype2str( tag ),
 512                 (long) lr->lr_msgid, (long) lr->lr_origid );
 513 #endif
 514
 515         id = lr->lr_origid;
 516         refer_cnt = 0;
 517         hadref = simple_request = 0;
 518         rc = -2;        /* default is to keep looking (no response found) */
 519         lr->lr_res_msgtype = tag;
 520
 521         /*
 522          * This code figures out if we are going to chase a
 523          * referral / search reference, or pass it back to the application
 524          */
 525         v3ref = 0;      /* Assume not a V3 search reference or referral */
 526         if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
 527                 BerElement      tmpber = *ber;  /* struct copy */
 528                 char **refs = NULL;
 529
 530                 if( tag == LDAP_RES_SEARCH_REFERENCE) {
 531                         /* This is a V3 search reference */
 532                         /* Assume we do not chase the reference, but pass it to application */
 533                         v3ref = -1;
 534                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
 535                                         (lr->lr_parent != NULL) )
 536                         {
 537                                 /* Get the referral list */
 538                                 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
 539                                         rc = LDAP_DECODING_ERROR;
 540                                 } else {
 541                                         /* Note: refs arrary is freed by ldap_chase_v3referrals */
 542                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
 543                                             1, &lr->lr_res_error, &hadref );
 544                                         if ( refer_cnt > 0 ) {  /* sucessfully chased reference */
 545                                                 /* If haven't got end search, set chasing referrals */
 546                                                 if( lr->lr_status != LDAP_REQST_COMPLETED) {
 547                                                         lr->lr_status = LDAP_REQST_CHASINGREFS;
 548 #ifdef NEW_LOGGING
 549                                                         LDAP_LOG ( OPERATION, DETAIL1,
 550                                                                 "read1msg: search ref chased,"
 551                                                                 "mark request chasing refs, id =        %d\n",
 552                                                                 lr->lr_msgid, 0, 0 );
 553 #else
 554                                                         Debug( LDAP_DEBUG_TRACE,
 555                                                             "read1msg:  search ref chased, mark request chasing refs, id = %d\n",
 556                                                             lr->lr_msgid, 0, 0);
 557 #endif
 558                                                 }
 559                                                 v3ref = 1;      /* We sucessfully chased the reference */
 560                                         }
 561                                 }
 562                         }
 563                 } else {
 564                         /* Check for V3 referral */
 565                         ber_len_t len;
 566                         if ( ber_scanf( &tmpber, "{iaa",/*}*/ &lderr,
 567                                     &lr->lr_res_matched, &lr->lr_res_error )
 568                                     != LBER_ERROR ) {
 569                                 /* Check if V3 referral */
 570                                 if( ber_peek_tag( &tmpber, &len) == LDAP_TAG_REFERRAL ) {
 571                                         /* We have a V3 referral, assume we cannot chase it */
 572                                         v3ref = -1;
 573                                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
 574                                                          || (lr->lr_parent != NULL) )
 575                                         {
 576                                                 v3ref = -1;  /* Assume referral not chased and return it to app */
 577                                                 /* Get the referral list */
 578                                                 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
 579                                                         rc = LDAP_DECODING_ERROR;
 580                                                         lr->lr_status = LDAP_REQST_COMPLETED;
 581 #ifdef NEW_LOGGING
 582                                                         LDAP_LOG ( OPERATION, DETAIL1,
 583                                                                 "read1msg: referral decode error,"
 584                                                                 "mark request completed, id =   %d\n",
 585                                                                 lr->lr_msgid, 0, 0 );
 586 #else
 587                                                         Debug( LDAP_DEBUG_TRACE,
 588                                                             "read1msg: referral decode error, mark request completed, id = %d\n",
 589                                                                     lr->lr_msgid, 0, 0);
 590 #endif
 591                                                 } else {
 592                                                         /* Chase the referral
 593                                                          * Note: refs arrary is freed by ldap_chase_v3referrals
 594                                                          */
 595                                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
 596                                                             0, &lr->lr_res_error, &hadref );
 597                                                         lr->lr_status = LDAP_REQST_COMPLETED;
 598 #ifdef NEW_LOGGING
 599                                                         LDAP_LOG ( OPERATION, DETAIL1,
 600                                                                 "read1msg: referral chased,"
 601                                                                 "mark request completed, id =   %d\n",
 602                                                                 lr->lr_msgid, 0, 0 );
 603 #else
 604                                                         Debug( LDAP_DEBUG_TRACE,
 605                                                             "read1msg:  referral chased, mark request completed, id = %d\n",
 606                                                             lr->lr_msgid, 0, 0);
 607 #endif
 608                                                         if( refer_cnt > 0) {
 609                                                                 v3ref = 1;  /* Referral successfully chased */
 610                                                         }
 611                                                 }
 612                                         }
 613                                 }
 614
 615                                 if( lr->lr_res_matched != NULL ) {
 616                                         LDAP_FREE( lr->lr_res_matched );
 617                                         lr->lr_res_matched = NULL;
 618                                 }
 619                                 if( lr->lr_res_error != NULL ) {
 620                                         LDAP_FREE( lr->lr_res_error );
 621                                         lr->lr_res_error = NULL;
 622                                 }
 623                         }
 624                 }
 625         }
 626
 627         /* All results that just return a status, i.e. don't return data
 628          * go through the following code.  This code also chases V2 referrals
 629          * and checks if all referrals have been chased.
 630          */
 631         if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref > -1) ) {
 632                 /* For a v3 search referral/reference, only come here if already chased it */
 633                 if ( ld->ld_version >= LDAP_VERSION2 &&
 634                         ( lr->lr_parent != NULL ||
 635                         LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
 636                 {
 637                         tmpber = *ber;  /* struct copy */
 638                         if ( v3ref == 1 ) {
 639                                 /* V3 search reference or V3 referral
 640                                  * sucessfully chased. If this message
 641                                  * is a search result, then it has no more
 642                                  * outstanding referrals.
 643                                  */
 644                                 if ( tag == LDAP_RES_SEARCH_RESULT )
 645                                         refer_cnt = 0;
 646                         } else if ( ber_scanf( &tmpber, "{iaa}", &lderr,
 647                             &lr->lr_res_matched, &lr->lr_res_error )
 648                             != LBER_ERROR ) {
 649                                 if ( lderr != LDAP_SUCCESS ) {
 650                                         /* referrals are in error string */
 651                                         refer_cnt = ldap_chase_referrals( ld, lr,
 652                                                 &lr->lr_res_error, -1, &hadref );
 653                                         lr->lr_status = LDAP_REQST_COMPLETED;
 654 #ifdef NEW_LOGGING
 655                                         LDAP_LOG ( OPERATION, DETAIL1,
 656                                                 "read1msg: V2 referral chased,"
 657                                                 "mark request completed, id =   %d\n",
 658                                                 lr->lr_msgid, 0, 0 );
 659 #else
 660                                         Debug( LDAP_DEBUG_TRACE,
 661                                             "read1msg:  V2 referral chased, mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
 662 #endif
 663                                 }
 664
 665                                 /* save errno, message, and matched string */
 666                                 if ( !hadref || lr->lr_res_error == NULL ) {
 667                                         lr->lr_res_errno = ( lderr ==
 668                                         LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
 669                                         : lderr;
 670                                 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
 671                                         lr->lr_res_errno = ld->ld_errno;
 672                                 } else {
 673                                         lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
 674                                 }
 675 #ifdef NEW_LOGGING
 676 LDAP_LOG ( OPERATION, DETAIL1,
 677         "read1msg: new result: res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 678     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 679     lr->lr_res_matched ? lr->lr_res_matched : "" );
 680 #else
 681 Debug( LDAP_DEBUG_TRACE,
 682     "new result:  res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 683     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 684     lr->lr_res_matched ? lr->lr_res_matched : "" );
 685 #endif
 686                         }
 687                 }
 688
 689 #ifdef NEW_LOGGING
 690                 LDAP_LOG ( OPERATION, DETAIL1, "read1msg: %d new referrals\n",
 691                         refer_cnt, 0, 0 );
 692 #else
 693                 Debug( LDAP_DEBUG_TRACE,
 694                     "read1msg:  %d new referrals\n", refer_cnt, 0, 0 );
 695 #endif
 696
 697                 if ( refer_cnt != 0 ) { /* chasing referrals */
 698                         ber_free( ber, 1 );
 699                         ber = NULL;
 700                         if ( refer_cnt < 0 ) {
 701                                 return( -1 );   /* fatal error */
 702                         }
 703                         lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
 704                 } else {
 705                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
 706                                 /* request without any referrals */
 707                                 simple_request = ( hadref ? 0 : 1 );
 708                         } else {
 709                                 /* request with referrals or child request */
 710                                 ber_free( ber, 1 );
 711                                 ber = NULL;
 712                         }
 713
 714                         lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
 715 #ifdef NEW_LOGGING
 716                         LDAP_LOG ( OPERATION, DETAIL1,
 717                                 "read1msg: mark request completed, id = %d\n",
 718                                 lr->lr_msgid, 0, 0 );
 719 #else
 720                         Debug( LDAP_DEBUG_TRACE,
 721                             "read1msg:  mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
 722 #endif
 723                         while ( lr->lr_parent != NULL ) {
 724                                 merge_error_info( ld, lr->lr_parent, lr );
 725
 726                                 lr = lr->lr_parent;
 727                                 if ( --lr->lr_outrefcnt > 0 ) {
 728                                         break;  /* not completely done yet */
 729                                 }
 730                         }
 731
 732                         /* Check if all requests are finished, lr is now parent */
 733                         tmplr = lr;
 734                         if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
 735                                 for(tmplr=lr->lr_child; tmplr != NULL; tmplr=tmplr->lr_refnext) {
 736                                 if( tmplr->lr_status != LDAP_REQST_COMPLETED) {
 737                                         break;
 738                                         }
 739                                 }
 740                         }
 741
 742                         /* This is the parent request if the request has referrals */
 743                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL && tmplr == NULL ) {
 744                                 id = lr->lr_msgid;
 745                                 tag = lr->lr_res_msgtype;
 746 #ifdef NEW_LOGGING
 747                         LDAP_LOG ( OPERATION, DETAIL1,
 748                                 "read1msg: request %ld done\n", (long) id, 0, 0 );
 749                         LDAP_LOG ( OPERATION, DETAIL1,
 750                                 "read1msg: res_errno: %d,res_error: <%s>, res_matched: <%s>\n",
 751                                 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 752                                 lr->lr_res_matched ? lr->lr_res_matched : "" );
 753 #else
 754                                 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
 755                                     (long) id, 0, 0 );
 756 Debug( LDAP_DEBUG_TRACE,
 757 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 758 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 759 lr->lr_res_matched ? lr->lr_res_matched : "" );
 760 #endif
 761                                 if ( !simple_request ) {
 762                                         ber_free( ber, 1 );
 763                                         ber = NULL;
 764                                         if ( build_result_ber( ld, &ber, lr )
 765                                             == LBER_ERROR ) {
 766                                                 rc = -1; /* fatal error */
 767                                         }
 768                                 }
 769
 770                                 ldap_free_request( ld, lr );
 771                         }
 772
 773                         if ( lc != NULL ) {
 774                                 ldap_free_connection( ld, lc, 0, 1 );
 775                         }
 776                 }
 777         }
 778
 779         if ( ber == NULL ) {
 780                 return( rc );
 781         }
 782
 783         /* make a new ldap message */
 784         if ( (new = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) ))
 785             == NULL ) {
 786                 ld->ld_errno = LDAP_NO_MEMORY;
 787                 return( -1 );
 788         }
 789         new->lm_msgid = (int)id;
 790         new->lm_msgtype = tag;
 791         new->lm_ber = ber;
 792
 793 #ifndef LDAP_NOCACHE
 794                 if ( ld->ld_cache != NULL ) {
 795                         ldap_add_result_to_cache( ld, new );
 796                 }
 797 #endif /* LDAP_NOCACHE */
 798
 799         /* is this the one we're looking for? */
 800         if ( msgid == LDAP_RES_ANY || id == msgid ) {
 801                 if ( all == LDAP_MSG_ONE
 802                     || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
 803                     && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY
 804                     && new->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
 805                         *result = new;
 806                         ld->ld_errno = LDAP_SUCCESS;
 807                         return( tag );
 808                 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
 809                         foundit = 1;    /* return the chain later */
 810                 }
 811         }
 812
 813         /*
 814          * if not, we must add it to the list of responses.  if
 815          * the msgid is already there, it must be part of an existing
 816          * search response.
 817          */
 818
 819         prev = NULL;
 820         for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
 821                 if ( l->lm_msgid == new->lm_msgid )
 822                         break;
 823                 prev = l;
 824         }
 825
 826         /* not part of an existing search response */
 827         if ( l == NULL ) {
 828                 if ( foundit ) {
 829                         *result = new;
 830                         ld->ld_errno = LDAP_SUCCESS;
 831                         return( tag );
 832                 }
 833
 834                 new->lm_next = ld->ld_responses;
 835                 ld->ld_responses = new;
 836                 return( -2 );   /* continue looking */
 837         }
 838
 839 #ifdef NEW_LOGGING
 840         LDAP_LOG ( OPERATION, DETAIL1,
 841                 "read1msg: adding response id %ld type %ld\n",
 842                 (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
 843 #else
 844         Debug( LDAP_DEBUG_TRACE, "adding response id %ld type %ld:\n",
 845             (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
 846 #endif
 847
 848         /* part of a search response - add to end of list of entries */
 849         for ( tmp = l; (tmp->lm_chain != NULL) &&
 850                 ((tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
 851                  (tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
 852                          (tmp->lm_chain->lm_msgtype == LDAP_RES_EXTENDED_PARTIAL ));
 853             tmp = tmp->lm_chain )
 854                 ;       /* NULL */
 855         tmp->lm_chain = new;
 856
 857         /* return the whole chain if that's what we were looking for */
 858         if ( foundit ) {
 859                 if ( prev == NULL )
 860                         ld->ld_responses = l->lm_next;
 861                 else
 862                         prev->lm_next = l->lm_next;
 863                 *result = l;
 864                 ld->ld_errno = LDAP_SUCCESS;
 865 #ifdef LDAP_WORLD_P16
 866                 /*
 867                  * XXX questionable fix; see text for [P16] on
 868                  * http://www.critical-angle.com/ldapworld/patch/
 869                  *
 870                  * inclusion of this patch causes searchs to hang on
 871                  * multiple platforms
 872                  */
 873                 return( l->lm_msgtype );
 874 #else   /* LDAP_WORLD_P16 */
 875                 return( tag );
 876 #endif  /* !LDAP_WORLD_P16 */
 877         }
 878
 879         return( -2 );   /* continue looking */
 880 }
 881
 882
 883 static ber_tag_t
 884 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
 885 {
 886         ber_len_t       len;
 887         ber_tag_t       tag;
 888         ber_int_t       along;
 889         BerElement *ber;
 890
 891         *bp = NULL;
 892         ber = ldap_alloc_ber_with_options( ld );
 893
 894         if( ber == NULL ) {
 895                 ld->ld_errno = LDAP_NO_MEMORY;
 896                 return LBER_ERROR;
 897         }
 898
 899         if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
 900             lr->lr_res_msgtype, lr->lr_res_errno,
 901             lr->lr_res_matched ? lr->lr_res_matched : "",
 902             lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
 903
 904                 ld->ld_errno = LDAP_ENCODING_ERROR;
 905                 ber_free(ber, 1);
 906                 return( LBER_ERROR );
 907         }
 908
 909         ber_reset( ber, 1 );
 910
 911         if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
 912                 ld->ld_errno = LDAP_DECODING_ERROR;
 913                 ber_free(ber, 1);
 914                 return( LBER_ERROR );
 915         }
 916
 917         if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
 918                 ld->ld_errno = LDAP_DECODING_ERROR;
 919                 ber_free(ber, 1);
 920                 return( LBER_ERROR );
 921         }
 922
 923         tag = ber_peek_tag( ber, &len );
 924
 925         if ( tag == LBER_ERROR ) {
 926                 ld->ld_errno = LDAP_DECODING_ERROR;
 927                 ber_free(ber, 1);
 928                 return( LBER_ERROR );
 929         }
 930
 931         *bp = ber;
 932         return tag;
 933 }
 934
 935
 936 static void
 937 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
 938 {
 939 /*
 940  * Merge error information in "lr" with "parentr" error code and string.
 941  */
 942         if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
 943                 parentr->lr_res_errno = lr->lr_res_errno;
 944                 if ( lr->lr_res_error != NULL ) {
 945                         (void)ldap_append_referral( ld, &parentr->lr_res_error,
 946                             lr->lr_res_error );
 947                 }
 948         } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
 949             parentr->lr_res_errno == LDAP_SUCCESS ) {
 950                 parentr->lr_res_errno = lr->lr_res_errno;
 951                 if ( parentr->lr_res_error != NULL ) {
 952                         LDAP_FREE( parentr->lr_res_error );
 953                 }
 954                 parentr->lr_res_error = lr->lr_res_error;
 955                 lr->lr_res_error = NULL;
 956                 if ( LDAP_NAME_ERROR( lr->lr_res_errno )) {
 957                         if ( parentr->lr_res_matched != NULL ) {
 958                                 LDAP_FREE( parentr->lr_res_matched );
 959                         }
 960                         parentr->lr_res_matched = lr->lr_res_matched;
 961                         lr->lr_res_matched = NULL;
 962                 }
 963         }
 964
 965 #ifdef NEW_LOGGING
 966         LDAP_LOG( OPERATION, DETAIL1, "merged parent (id %d) error info:  ",
 967             parentr->lr_msgid, 0, 0 );
 968         LDAP_LOG( OPERATION, DETAIL1, "result errno %d, error <%s>, matched <%s>\n",
 969             parentr->lr_res_errno, parentr->lr_res_error ?
 970             parentr->lr_res_error : "", parentr->lr_res_matched ?
 971             parentr->lr_res_matched : "" );
 972 #else
 973         Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info:  ",
 974             parentr->lr_msgid, 0, 0 );
 975         Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
 976             parentr->lr_res_errno, parentr->lr_res_error ?
 977             parentr->lr_res_error : "", parentr->lr_res_matched ?
 978             parentr->lr_res_matched : "" );
 979 #endif
 980 }
 981
 982
 983
 984 int
 985 ldap_msgtype( LDAPMessage *lm )
 986 {
 987         assert( lm != NULL );
 988         return ( lm != NULL ) ? lm->lm_msgtype : -1;
 989 }
 990
 991
 992 int
 993 ldap_msgid( LDAPMessage *lm )
 994 {
 995         assert( lm != NULL );
 996
 997         return ( lm != NULL ) ? lm->lm_msgid : -1;
 998 }
 999
1000
1001 char * ldap_int_msgtype2str( ber_tag_t tag )
1002 {
1003         switch( tag ) {
1004         case LDAP_RES_ADD: return "add";
1005         case LDAP_RES_BIND: return "bind";
1006         case LDAP_RES_COMPARE: return "compare";
1007         case LDAP_RES_DELETE: return "delete";
1008         case LDAP_RES_EXTENDED: return "extended-result";
1009         case LDAP_RES_EXTENDED_PARTIAL: return "extended-partial";
1010         case LDAP_RES_MODIFY: return "modify";
1011         case LDAP_RES_RENAME: return "rename";
1012         case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1013         case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1014         case LDAP_RES_SEARCH_RESULT: return "search-result";
1015         }
1016         return "unknown";
1017 }
1018
1019 int
1020 ldap_msgfree( LDAPMessage *lm )
1021 {
1022         LDAPMessage     *next;
1023         int             type = 0;
1024
1025 #ifdef NEW_LOGGING
1026         LDAP_LOG ( OPERATION, ENTRY, "ldap_msgfree\n", 0, 0, 0 );
1027 #else
1028         Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1029 #endif
1030
1031         for ( ; lm != NULL; lm = next ) {
1032                 next = lm->lm_chain;
1033                 type = lm->lm_msgtype;
1034                 ber_free( lm->lm_ber, 1 );
1035                 LDAP_FREE( (char *) lm );
1036         }
1037
1038         return( type );
1039 }
1040
1041 /*
1042  * ldap_msgdelete - delete a message.  It returns:
1043  *      0       if the entire message was deleted
1044  *      -1      if the message was not found, or only part of it was found
1045  */
1046 int
1047 ldap_msgdelete( LDAP *ld, int msgid )
1048 {
1049         LDAPMessage     *lm, *prev;
1050
1051         assert( ld != NULL );
1052
1053 #ifdef NEW_LOGGING
1054         LDAP_LOG ( OPERATION, ENTRY, "ldap_msgdelete\n", 0, 0, 0 );
1055 #else
1056         Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1057 #endif
1058
1059         prev = NULL;
1060         for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1061                 if ( lm->lm_msgid == msgid )
1062                         break;
1063                 prev = lm;
1064         }
1065
1066         if ( lm == NULL )
1067                 return( -1 );
1068
1069         if ( prev == NULL )
1070                 ld->ld_responses = lm->lm_next;
1071         else
1072                 prev->lm_next = lm->lm_next;
1073
1074         if ( ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1075                 return( -1 );
1076
1077         return( 0 );
1078 }
1079
1080
1081 /*
1082  * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1083  */
1084 static int
1085 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1086 {
1087         int     i;
1088
1089         if ( ld->ld_abandoned == NULL )
1090                 return( 0 );
1091
1092         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1093                 if ( ld->ld_abandoned[i] == msgid )
1094                         return( 1 );
1095
1096         return( 0 );
1097 }
1098
1099
1100 static int
1101 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1102 {
1103         int     i;
1104
1105         if ( ld->ld_abandoned == NULL )
1106                 return( -1 );
1107
1108         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1109                 if ( ld->ld_abandoned[i] == msgid )
1110                         break;
1111
1112         if ( ld->ld_abandoned[i] == -1 )
1113                 return( -1 );
1114
1115         for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1116                 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
1117         }
1118
1119         return( 0 );
1120 }