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

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