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