]> git.sur5r.net Git - openldap/blob - libraries/libldap/result.c
Sync with HEAD
[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 ld %p msgid %d\n", ld, msgid, 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 ld %p msgid %d all %d\n",
150             ld, msgid, all );
151         lastlm = &ld->ld_responses;
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                         /* Remove this entry from list */
162                         *lastlm = nextlm;
163
164                         ldap_msgfree( lm );
165
166                         continue;
167                 }
168
169                 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
170                         LDAPMessage     *tmp;
171
172                         if ( all == LDAP_MSG_ONE || all == LDAP_MSG_RECEIVED ||
173                                 msgid == LDAP_RES_UNSOLICITED ) {
174                                 break;
175                         }
176
177                         tmp = lm->lm_chain_tail;
178                         if ((tmp->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
179                                 (tmp->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
180                                 (tmp->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
181                                 tmp = NULL;
182                         }
183
184                         if ( tmp == NULL ) {
185                                 lm = NULL;
186                         }
187
188                         break;
189                 }
190                 lastlm = &lm->lm_next;
191         }
192
193     if ( lm != NULL ) {
194                 /* Found an entry, remove it from the list */
195             if ( all == LDAP_MSG_ONE && lm->lm_chain != NULL ) {
196                         *lastlm = lm->lm_chain;
197                         lm->lm_chain->lm_next = lm->lm_next;
198                         lm->lm_chain->lm_chain_tail = ( lm->lm_chain_tail != lm ) ? lm->lm_chain_tail : lm->lm_chain;
199                         lm->lm_chain = NULL;
200                         lm->lm_chain_tail = NULL;
201             } else {
202                         *lastlm = lm->lm_next;
203                 }
204             lm->lm_next = NULL;
205     }
206
207 #ifdef LDAP_DEBUG
208         if( lm == NULL) {
209                 Debug( LDAP_DEBUG_TRACE,
210                         "ldap_chkResponseList returns ld %p NULL\n", ld, 0, 0);
211         } else {
212                 Debug( LDAP_DEBUG_TRACE,
213                         "ldap_chkResponseList returns ld %p msgid %d, type 0x%02lu\n",
214                         ld, lm->lm_msgid, (unsigned long) lm->lm_msgtype);
215         }
216 #endif
217     return lm;
218 }
219
220 static int
221 wait4msg(
222         LDAP *ld,
223         ber_int_t msgid,
224         int all,
225         struct timeval *timeout,
226         LDAPMessage **result )
227 {
228         int             rc;
229         struct timeval  tv = { 0 },
230                         tv0 = { 0 },
231                         *tvp;
232         time_t          start_time = 0;
233         time_t          tmp_time;
234         LDAPConn        *lc, *nextlc;
235
236         assert( ld != NULL );
237         assert( result != NULL );
238
239 #ifdef LDAP_DEBUG
240         if ( timeout == NULL ) {
241                 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (infinite timeout)\n",
242                     ld, msgid, 0 );
243         } else {
244                 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (timeout %ld usec)\n",
245                     ld, msgid, (long)timeout->tv_sec * 1000000 + timeout->tv_usec );
246         }
247 #endif /* LDAP_DEBUG */
248
249         if ( timeout == NULL ) {
250                 tvp = NULL;
251         } else {
252                 tv0 = *timeout;
253                 tv = *timeout;
254                 tvp = &tv;
255                 start_time = time( NULL );
256         }
257                     
258         rc = -2;
259         while ( rc == -2 ) {
260 #ifdef LDAP_DEBUG
261                 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
262                         Debug( LDAP_DEBUG_TRACE, "wait4msg continue ld %p msgid %d all %d\n",
263                                 ld, msgid, all );
264                         ldap_dump_connection( ld, ld->ld_conns, 1 );
265                         ldap_dump_requests_and_responses( ld );
266                 }
267 #endif /* LDAP_DEBUG */
268
269                 if ( (*result = chkResponseList(ld, msgid, all)) != NULL ) {
270                         rc = (*result)->lm_msgtype;
271
272                 } else {
273                         int lc_ready = 0;
274
275 #ifdef LDAP_R_COMPILE
276                         ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
277 #endif
278                         for ( lc = ld->ld_conns; lc != NULL; lc = nextlc ) {
279                                 nextlc = lc->lconn_next;
280                                 if ( ber_sockbuf_ctrl( lc->lconn_sb,
281                                                 LBER_SB_OPT_DATA_READY, NULL ) ) {
282 #ifdef LDAP_R_COMPILE
283                                         ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
284 #endif
285                                         rc = try_read1msg( ld, msgid, all, lc->lconn_sb,
286                                                 &lc, result );
287 #ifdef LDAP_R_COMPILE
288                                         ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
289 #endif
290                                         lc_ready = 1;
291                                         break;
292                                 }
293                         }
294 #ifdef LDAP_R_COMPILE
295                         ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
296 #endif
297
298                         if ( !lc_ready ) {
299                                 rc = ldap_int_select( ld, tvp );
300 #ifdef LDAP_DEBUG
301                                 if ( rc == -1 ) {
302                                         Debug( LDAP_DEBUG_TRACE,
303                                                 "ldap_int_select returned -1: errno %d\n",
304                                                 errno, 0, 0 );
305                                 }
306 #endif
307
308                                 if ( rc == 0 || ( rc == -1 && (
309                                         !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
310                                                 || errno != EINTR )))
311                                 {
312                                         ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
313                                                 LDAP_TIMEOUT);
314                                         return( rc );
315                                 }
316
317                                 if ( rc == -1 ) {
318                                         rc = -2;        /* select interrupted: loop */
319                                 } else {
320                                         rc = -2;
321 #ifdef LDAP_R_COMPILE
322                                         ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
323 #endif
324                                         if ( ld->ld_requests &&
325                                                 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
326                                                 ldap_is_write_ready( ld,
327                                                         ld->ld_requests->lr_conn->lconn_sb ) )
328                                         {
329                                                 ldap_int_flush_request( ld, ld->ld_requests );
330                                         }
331 #ifdef LDAP_R_COMPILE
332                                         ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
333                                         ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
334 #endif
335                                         for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
336                                                 lc = nextlc )
337                                         {
338                                                 nextlc = lc->lconn_next;
339                                                 if ( lc->lconn_status == LDAP_CONNST_CONNECTED &&
340                                                         ldap_is_read_ready( ld, lc->lconn_sb ))
341                                                 {
342 #ifdef LDAP_R_COMPILE
343                                                         ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
344 #endif
345                                                         rc = try_read1msg( ld, msgid, all,
346                                                                 lc->lconn_sb, &lc, result );
347                                                                 if ( lc == NULL ) lc = nextlc;
348 #ifdef LDAP_R_COMPILE
349                                                         ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
350 #endif
351                                                 }
352                                         }
353 #ifdef LDAP_R_COMPILE
354                                         ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
355 #endif
356                                 }
357                         }
358                 }
359
360                 if ( rc == -2 && tvp != NULL ) {
361                         tmp_time = time( NULL );
362                         tv0.tv_sec -= ( tmp_time - start_time );
363                         if ( tv0.tv_sec <= 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 %p %ld secs to go\n",
371                                ld, (long) tv.tv_sec, 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             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: ld %p msgid %d all %d\n", ld, msgid, all );
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 ld %p msgid %ld\n",
483                          ld, (long) id, 0);
484 retry_ber:
485                 ber_free( ber, 1 );
486                 if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
487                         goto retry;
488                 }
489                 return( -2 );   /* continue looking */
490         }
491
492         lr = ldap_find_request_by_msgid( ld, id );
493         if ( lr == NULL ) {
494                 Debug( LDAP_DEBUG_ANY,
495                     "no request for response on ld %p msgid %ld (tossing)\n",
496                     ld, (long) id, 0 );
497                 goto retry_ber;
498         }
499 #ifdef LDAP_CONNECTIONLESS
500         if (LDAP_IS_UDP(ld) && isv2) {
501                 ber_scanf(ber, "x{");
502         }
503 nextresp2:
504 #endif
505         /* the message type */
506         if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
507                 ld->ld_errno = LDAP_DECODING_ERROR;
508                 ber_free( ber, 1 );
509                 return( -1 );
510         }
511
512         Debug( LDAP_DEBUG_TRACE,
513                 "read1msg: ld %p msgid %ld message type %s\n",
514                 ld, (long) lr->lr_msgid, ldap_int_msgtype2str( tag ));
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, ld %p msgid %d\n",
598                                                                     ld, lr->lr_msgid, 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, ld %p msgid %d\n",
608                                                             ld, lr->lr_msgid, 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                                         lr_res_error = NULL;
664                                 }
665
666                                 switch ( lderr ) {
667                                 case LDAP_SUCCESS:
668                                 case LDAP_COMPARE_TRUE:
669                                 case LDAP_COMPARE_FALSE:
670                                         break;
671
672                                 default:
673                                         if ( lr->lr_res_error == NULL
674                                                 || lr->lr_res_error[ 0 ] == '\0' )
675                                         {
676                                                 break;
677                                         }
678
679                                         /* referrals are in error string */
680                                         refer_cnt = ldap_chase_referrals( ld, lr,
681                                                 &lr->lr_res_error, -1, &hadref );
682                                         lr->lr_status = LDAP_REQST_COMPLETED;
683                                         Debug( LDAP_DEBUG_TRACE,
684                                                 "read1msg:  V2 referral chased, "
685                                                 "mark request completed, id = %d\n",
686                                                 lr->lr_msgid, 0, 0 );
687                                         break;
688                                 }
689
690                                 /* save errno, message, and matched string */
691                                 if ( !hadref || lr->lr_res_error == NULL ) {
692                                         lr->lr_res_errno = ( lderr ==
693                                         LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
694                                         : lderr;
695                                 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
696                                         lr->lr_res_errno = ld->ld_errno;
697                                 } else {
698                                         lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
699                                 }
700 Debug( LDAP_DEBUG_TRACE,
701     "new result:  res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
702     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
703     lr->lr_res_matched ? lr->lr_res_matched : "" );
704                         }
705                 }
706
707                 Debug( LDAP_DEBUG_TRACE,
708                     "read1msg: ld %p %d new referrals\n", ld, refer_cnt, 0 );
709
710                 if ( refer_cnt != 0 ) { /* chasing referrals */
711                         ber_free( ber, 1 );
712                         ber = NULL;
713                         if ( refer_cnt < 0 ) {
714                                 return( -1 );   /* fatal error */
715                         }
716                         lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
717                 } else {
718                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
719                                 /* request without any referrals */
720                                 simple_request = ( hadref ? 0 : 1 );
721                         } else {
722                                 /* request with referrals or child request */
723                                 ber_free( ber, 1 );
724                                 ber = NULL;
725                         }
726
727                         lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
728                         Debug( LDAP_DEBUG_TRACE,
729                             "read1msg:  mark request completed, ld %p msgid %d\n", ld, lr->lr_msgid, 0);
730                         while ( lr->lr_parent != NULL ) {
731                                 merge_error_info( ld, lr->lr_parent, lr );
732
733                                 lr = lr->lr_parent;
734                                 if ( --lr->lr_outrefcnt > 0 ) {
735                                         break;  /* not completely done yet */
736                                 }
737                         }
738
739                         /* Check if all requests are finished, lr is now parent */
740                         tmplr = lr;
741                         if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
742                                 for ( tmplr=lr->lr_child;
743                                         tmplr != NULL;
744                                         tmplr=tmplr->lr_refnext)
745                                 {
746                                         if( tmplr->lr_status != LDAP_REQST_COMPLETED) break;
747                                 }
748                         }
749
750                         /* This is the parent request if the request has referrals */
751                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
752                                 tmplr == NULL )
753                         {
754                                 id = lr->lr_msgid;
755                                 tag = lr->lr_res_msgtype;
756                                 Debug( LDAP_DEBUG_ANY, "request done: ld %p msgid %ld\n",
757                                     ld, (long) id, 0 );
758 Debug( LDAP_DEBUG_TRACE,
759 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
760 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
761 lr->lr_res_matched ? lr->lr_res_matched : "" );
762                                 if ( !simple_request ) {
763                                         ber_free( ber, 1 );
764                                         ber = NULL;
765                                         if ( build_result_ber( ld, &ber, lr )
766                                             == LBER_ERROR ) {
767                                                 rc = -1; /* fatal error */
768                                         }
769                                 }
770
771 #ifdef LDAP_R_COMPILE
772                                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
773 #endif
774                                 ldap_free_request( ld, lr );
775 #ifdef LDAP_R_COMPILE
776                                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
777 #endif
778                         }
779
780                         if ( lc != NULL ) {
781 #ifdef LDAP_R_COMPILE
782                                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
783 #endif
784                                 ldap_free_connection( ld, lc, 0, 1 );
785 #ifdef LDAP_R_COMPILE
786                                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
787 #endif
788                                 *lcp = NULL;
789                         }
790                 }
791         }
792
793         if ( ber == NULL ) {
794                 return( rc );
795         }
796
797         /* make a new ldap message */
798         newmsg = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) );
799         if ( newmsg == NULL ) {
800                 ld->ld_errno = LDAP_NO_MEMORY;
801                 return( -1 );
802         }
803         newmsg->lm_msgid = (int)id;
804         newmsg->lm_msgtype = tag;
805         newmsg->lm_ber = ber;
806         newmsg->lm_chain_tail = newmsg;
807
808 #ifdef LDAP_CONNECTIONLESS
809         /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
810          * the responses are all a sequence wrapped in one message. In
811          * LDAPv3 each response is in its own message. The datagram must
812          * end with a SearchResult. We can't just parse each response in
813          * separate calls to try_read1msg because the header info is only
814          * present at the beginning of the datagram, not at the beginning
815          * of each response. So parse all the responses at once and queue
816          * them up, then pull off the first response to return to the
817          * caller when all parsing is complete.
818          */
819         if ( LDAP_IS_UDP(ld) ) {
820                 /* If not a result, look for more */
821                 if ( tag != LDAP_RES_SEARCH_RESULT ) {
822                         int ok = 0;
823                         moremsgs = 1;
824                         if (isv2) {
825                                 /* LDAPv2: dup the current ber, skip past the current
826                                  * response, and see if there are any more after it.
827                                  */
828                                 ber = ber_dup( ber );
829                                 ber_scanf( ber, "x" );
830                                 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
831                                         /* There's more - dup the ber buffer so they can all be
832                                          * individually freed by ldap_msgfree.
833                                          */
834                                         struct berval bv;
835                                         ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
836                                         bv.bv_val = LDAP_MALLOC(len);
837                                         if (bv.bv_val) {
838                                                 ok=1;
839                                                 ber_read(ber, bv.bv_val, len);
840                                                 bv.bv_len = len;
841                                                 ber_init2(ber, &bv, ld->ld_lberoptions );
842                                         }
843                                 }
844                         } else {
845                                 /* LDAPv3: Just allocate a new ber. Since this is a buffered
846                                  * datagram, if the sockbuf is readable we still have data
847                                  * to parse.
848                                  */
849                                 ber = ldap_alloc_ber_with_options(ld);
850                                 if (ber_sockbuf_ctrl(sb, LBER_SB_OPT_DATA_READY, NULL)) ok=1;
851                         }
852                         /* set up response chain */
853                         if ( tmp == NULL ) {
854                                 newmsg->lm_next = ld->ld_responses;
855                                 ld->ld_responses = newmsg;
856                                 chain_head = newmsg;
857                         } else {
858                                 tmp->lm_chain = newmsg;
859                         }
860                         chain_head->lm_chain_tail = newmsg;
861                         tmp = newmsg;
862                         /* "ok" means there's more to parse */
863                         if (ok) {
864                                 if (isv2) goto nextresp2;
865                                 else goto nextresp3;
866                         } else {
867                                 /* got to end of datagram without a SearchResult. Free
868                                  * our dup'd ber, but leave any buffer alone. For v2 case,
869                                  * the previous response is still using this buffer. For v3,
870                                  * the new ber has no buffer to free yet.
871                                  */
872                                 ber_free(ber, 0);
873                                 return -1;
874                         }
875                 } else if ( moremsgs ) {
876                 /* got search result, and we had multiple responses in 1 datagram.
877                  * stick the result onto the end of the chain, and then pull the
878                  * first response off the head of the chain.
879                  */
880                         tmp->lm_chain = newmsg;
881                         chain_head->lm_chain_tail = newmsg;
882                         *result = chkResponseList( ld, msgid, all );
883                         ld->ld_errno = LDAP_SUCCESS;
884                         return( (*result)->lm_msgtype );
885                 }
886         }
887 #endif /* LDAP_CONNECTIONLESS */
888
889         /* is this the one we're looking for? */
890         if ( msgid == LDAP_RES_ANY || id == msgid ) {
891                 if ( all == LDAP_MSG_ONE
892                     || (newmsg->lm_msgtype != LDAP_RES_SEARCH_RESULT
893                     && newmsg->lm_msgtype != LDAP_RES_SEARCH_ENTRY
894                     && newmsg->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
895                         *result = newmsg;
896                         ld->ld_errno = LDAP_SUCCESS;
897                         return( tag );
898                 } else if ( newmsg->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
899                         foundit = 1;    /* return the chain later */
900                 }
901         }
902
903         /* 
904          * if not, we must add it to the list of responses.  if
905          * the msgid is already there, it must be part of an existing
906          * search response.
907          */
908
909         prev = NULL;
910         for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
911                 if ( l->lm_msgid == newmsg->lm_msgid )
912                         break;
913                 prev = l;
914         }
915
916         /* not part of an existing search response */
917         if ( l == NULL ) {
918                 if ( foundit ) {
919                         *result = newmsg;
920                         goto exit;
921                 }
922
923                 newmsg->lm_next = ld->ld_responses;
924                 ld->ld_responses = newmsg;
925                 goto exit;
926         }
927
928         Debug( LDAP_DEBUG_TRACE, "adding response ld %p msgid %ld type %ld:\n",
929             ld, (long) newmsg->lm_msgid, (long) newmsg->lm_msgtype );
930
931         /* part of a search response - add to end of list of entries */
932         l->lm_chain_tail->lm_chain = newmsg;
933         l->lm_chain_tail = newmsg;
934
935         /* return the whole chain if that's what we were looking for */
936         if ( foundit ) {
937                 if ( prev == NULL )
938                         ld->ld_responses = l->lm_next;
939                 else
940                         prev->lm_next = l->lm_next;
941                 *result = l;
942         }
943
944 exit:
945         if ( foundit ) {
946                 ld->ld_errno = LDAP_SUCCESS;
947                 return( tag );
948         }
949         if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
950                 goto retry;
951         }
952         return( -2 );   /* continue looking */
953 }
954
955
956 static ber_tag_t
957 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
958 {
959         ber_len_t       len;
960         ber_tag_t       tag;
961         ber_int_t       along;
962         BerElement *ber;
963
964         *bp = NULL;
965         ber = ldap_alloc_ber_with_options( ld );
966
967         if( ber == NULL ) {
968                 ld->ld_errno = LDAP_NO_MEMORY;
969                 return LBER_ERROR;
970         }
971
972         if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
973                 lr->lr_res_msgtype, lr->lr_res_errno,
974                 lr->lr_res_matched ? lr->lr_res_matched : "",
975                 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 )
976         {
977                 ld->ld_errno = LDAP_ENCODING_ERROR;
978                 ber_free(ber, 1);
979                 return( LBER_ERROR );
980         }
981
982         ber_reset( ber, 1 );
983
984         if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
985                 ld->ld_errno = LDAP_DECODING_ERROR;
986                 ber_free(ber, 1);
987                 return( LBER_ERROR );
988         }
989
990         if ( ber_get_enum( ber, &along ) == LBER_ERROR ) {
991                 ld->ld_errno = LDAP_DECODING_ERROR;
992                 ber_free(ber, 1);
993                 return( LBER_ERROR );
994         }
995
996         tag = ber_peek_tag( ber, &len );
997
998         if ( tag == LBER_ERROR ) {
999                 ld->ld_errno = LDAP_DECODING_ERROR;
1000                 ber_free(ber, 1);
1001                 return( LBER_ERROR );
1002         }
1003
1004         *bp = ber;
1005         return tag;
1006 }
1007
1008
1009 static void
1010 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1011 {
1012 /*
1013  * Merge error information in "lr" with "parentr" error code and string.
1014  */
1015         if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1016                 parentr->lr_res_errno = lr->lr_res_errno;
1017                 if ( lr->lr_res_error != NULL ) {
1018                         (void)ldap_append_referral( ld, &parentr->lr_res_error,
1019                             lr->lr_res_error );
1020                 }
1021         } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1022                 parentr->lr_res_errno == LDAP_SUCCESS )
1023         {
1024                 parentr->lr_res_errno = lr->lr_res_errno;
1025                 if ( parentr->lr_res_error != NULL ) {
1026                         LDAP_FREE( parentr->lr_res_error );
1027                 }
1028                 parentr->lr_res_error = lr->lr_res_error;
1029                 lr->lr_res_error = NULL;
1030                 if ( LDAP_NAME_ERROR( lr->lr_res_errno ) ) {
1031                         if ( parentr->lr_res_matched != NULL ) {
1032                                 LDAP_FREE( parentr->lr_res_matched );
1033                         }
1034                         parentr->lr_res_matched = lr->lr_res_matched;
1035                         lr->lr_res_matched = NULL;
1036                 }
1037         }
1038
1039         Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info:  ",
1040             parentr->lr_msgid, 0, 0 );
1041         Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1042             parentr->lr_res_errno, parentr->lr_res_error ?
1043             parentr->lr_res_error : "", parentr->lr_res_matched ?
1044             parentr->lr_res_matched : "" );
1045 }
1046
1047
1048
1049 int
1050 ldap_msgtype( LDAPMessage *lm )
1051 {
1052         assert( lm != NULL );
1053         return ( lm != NULL ) ? (int)lm->lm_msgtype : -1;
1054 }
1055
1056
1057 int
1058 ldap_msgid( LDAPMessage *lm )
1059 {
1060         assert( lm != NULL );
1061
1062         return ( lm != NULL ) ? lm->lm_msgid : -1;
1063 }
1064
1065
1066 char * ldap_int_msgtype2str( ber_tag_t tag )
1067 {
1068         switch( tag ) {
1069         case LDAP_RES_ADD: return "add";
1070         case LDAP_RES_BIND: return "bind";
1071         case LDAP_RES_COMPARE: return "compare";
1072         case LDAP_RES_DELETE: return "delete";
1073         case LDAP_RES_EXTENDED: return "extended-result";
1074         case LDAP_RES_INTERMEDIATE: return "intermediate";
1075         case LDAP_RES_MODIFY: return "modify";
1076         case LDAP_RES_RENAME: return "rename";
1077         case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1078         case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1079         case LDAP_RES_SEARCH_RESULT: return "search-result";
1080         }
1081         return "unknown";
1082 }
1083
1084 int
1085 ldap_msgfree( LDAPMessage *lm )
1086 {
1087         LDAPMessage     *next;
1088         int             type = 0;
1089
1090         Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1091
1092         for ( ; lm != NULL; lm = next ) {
1093                 next = lm->lm_chain;
1094                 type = lm->lm_msgtype;
1095                 ber_free( lm->lm_ber, 1 );
1096                 LDAP_FREE( (char *) lm );
1097         }
1098
1099         return( type );
1100 }
1101
1102 /*
1103  * ldap_msgdelete - delete a message.  It returns:
1104  *      0       if the entire message was deleted
1105  *      -1      if the message was not found, or only part of it was found
1106  */
1107 int
1108 ldap_msgdelete( LDAP *ld, int msgid )
1109 {
1110         LDAPMessage     *lm, *prev;
1111         int rc = 0;
1112
1113         assert( ld != NULL );
1114
1115         Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1116
1117         prev = NULL;
1118 #ifdef LDAP_R_COMPILE
1119         ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1120 #endif
1121         for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1122                 if ( lm->lm_msgid == msgid )
1123                         break;
1124                 prev = lm;
1125         }
1126
1127         if ( lm == NULL ) {
1128                 rc = -1;
1129         } else {
1130                 if ( prev == NULL )
1131                         ld->ld_responses = lm->lm_next;
1132                 else
1133                         prev->lm_next = lm->lm_next;
1134         }
1135 #ifdef LDAP_R_COMPILE
1136         ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1137 #endif
1138         if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1139                 rc = -1;
1140
1141         return( rc );
1142 }
1143
1144
1145 /*
1146  * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1147  */
1148 static int
1149 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1150 {
1151         int     i;
1152
1153         if ( ld->ld_abandoned == NULL )
1154                 return( 0 );
1155
1156         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1157                 if ( ld->ld_abandoned[i] == msgid )
1158                         return( 1 );
1159
1160         return( 0 );
1161 }
1162
1163
1164 static int
1165 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1166 {
1167         int     i;
1168
1169         if ( ld->ld_abandoned == NULL )
1170                 return( -1 );
1171
1172         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1173                 if ( ld->ld_abandoned[i] == msgid )
1174                         break;
1175
1176         if ( ld->ld_abandoned[i] == -1 )
1177                 return( -1 );
1178
1179         for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1180                 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
1181         }
1182
1183         return( 0 );
1184 }