]> git.sur5r.net Git - openldap/blob - libraries/libldap/result.c
56eb3291c3c8038ba7f43d4448f7a5fae3d1e004
[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         int     v3ref;
411
412         assert( ld != NULL );
413         assert( lcp != NULL );
414         assert( *lcp != NULL );
415         
416         Debug( LDAP_DEBUG_TRACE, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
417
418         lc = *lcp;
419
420 retry:
421         if ( lc->lconn_ber == NULL ) {
422                 lc->lconn_ber = ldap_alloc_ber_with_options(ld);
423
424                 if( lc->lconn_ber == NULL ) {
425                         return -1;
426                 }
427         }
428
429         ber = lc->lconn_ber;
430         assert( LBER_VALID (ber) );
431
432         /* get the next message */
433         errno = 0;
434 #ifdef LDAP_CONNECTIONLESS
435         if ( LDAP_IS_UDP(ld) ) {
436                 struct sockaddr from;
437                 ber_int_sb_read(sb, &from, sizeof(struct sockaddr));
438                 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2=1;
439         }
440 nextresp3:
441 #endif
442         tag = ber_get_next( sb, &len, ber );
443         if ( tag == LDAP_TAG_MESSAGE ) {
444                 /*
445                  * We read a complete message.
446                  * The connection should no longer need this ber.
447                  */
448                 lc->lconn_ber = NULL;
449         }
450         if ( tag != LDAP_TAG_MESSAGE ) {
451                 if ( tag == LBER_DEFAULT) {
452 #ifdef LDAP_DEBUG                  
453                         Debug( LDAP_DEBUG_CONNS,
454                               "ber_get_next failed.\n", 0, 0, 0 );
455 #endif             
456 #ifdef EWOULDBLOCK                      
457                         if (errno==EWOULDBLOCK) return -2;
458 #endif
459 #ifdef EAGAIN
460                         if (errno == EAGAIN) return -2;
461 #endif
462                         ld->ld_errno = LDAP_SERVER_DOWN;
463                         return -1;
464                 }
465                 ld->ld_errno = LDAP_LOCAL_ERROR;
466                 return -1;
467         }
468
469         /* message id */
470         if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
471                 ber_free( ber, 1 );
472                 ld->ld_errno = LDAP_DECODING_ERROR;
473                 return( -1 );
474         }
475
476         /* if it's been abandoned, toss it */
477         if ( ldap_abandoned( ld, id ) ) {
478                 Debug( LDAP_DEBUG_ANY, "abandoned\n", 0, 0, 0);
479 retry_ber:
480                 ber_free( ber, 1 );
481                 if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
482                         goto retry;
483                 }
484                 return( -2 );   /* continue looking */
485         }
486
487         lr = ldap_find_request_by_msgid( ld, id );
488         if ( lr == NULL ) {
489                 Debug( LDAP_DEBUG_ANY,
490                     "no request for response with msgid %ld (tossing)\n",
491                     (long) id, 0, 0 );
492                 goto retry_ber;
493         }
494 #ifdef LDAP_CONNECTIONLESS
495         if (LDAP_IS_UDP(ld) && isv2) {
496                 ber_scanf(ber, "x{");
497         }
498 nextresp2:
499 #endif
500         /* the message type */
501         if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
502                 ld->ld_errno = LDAP_DECODING_ERROR;
503                 ber_free( ber, 1 );
504                 return( -1 );
505         }
506
507         Debug( LDAP_DEBUG_TRACE,
508                 "ldap_read: message type %s msgid %ld, original id %ld\n",
509                 ldap_int_msgtype2str( tag ),
510                 (long) lr->lr_msgid, (long) lr->lr_origid );
511
512         id = lr->lr_origid;
513         refer_cnt = 0;
514         hadref = simple_request = 0;
515         rc = -2;        /* default is to keep looking (no response found) */
516         lr->lr_res_msgtype = tag;
517
518         /*
519          * This code figures out if we are going to chase a
520          * referral / search reference, or pass it back to the application
521          */
522         v3ref = 0;      /* Assume not a V3 search reference or referral */
523         if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
524                 BerElement      tmpber = *ber;  /* struct copy */
525                 char **refs = NULL;
526
527                 if( tag == LDAP_RES_SEARCH_REFERENCE) {
528                         /* This is a V3 search reference */
529                         /* Assume we do not chase the reference, but pass it to application */
530                         v3ref = -1;
531                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
532                                         (lr->lr_parent != NULL) )
533                         {
534                                 /* Get the referral list */
535                                 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
536                                         rc = LDAP_DECODING_ERROR;
537                                 } else {
538                                         /* Note: refs arrary is freed by ldap_chase_v3referrals */
539                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
540                                             1, &lr->lr_res_error, &hadref );
541                                         if ( refer_cnt > 0 ) {  /* sucessfully chased reference */
542                                                 /* If haven't got end search, set chasing referrals */
543                                                 if( lr->lr_status != LDAP_REQST_COMPLETED) {
544                                                         lr->lr_status = LDAP_REQST_CHASINGREFS;
545                                                         Debug( LDAP_DEBUG_TRACE,
546                                                             "read1msg:  search ref chased, mark request chasing refs, id = %d\n",
547                                                             lr->lr_msgid, 0, 0);
548                                                 }
549                                                 v3ref = 1;      /* We sucessfully chased the reference */
550                                         }
551                                 }
552                         }
553                 } else {
554                         /* Check for V3 referral */
555                         ber_len_t       len;
556                         char            *lr_res_error = NULL;
557
558                         if ( ber_scanf( &tmpber, "{iaa",/*}*/ &lderr,
559                                     &lr->lr_res_matched, &lr_res_error )
560                                     != LBER_ERROR )
561                         {
562                                 if ( lr_res_error != NULL ) {
563                                         if ( lr->lr_res_error != NULL ) {
564                                                 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
565                                                 LDAP_FREE( (char *)lr_res_error );
566
567                                         } else {
568                                                 lr->lr_res_error = lr_res_error;
569                                         }
570                                 }
571
572                                 /* Check if V3 referral */
573                                 if ( ber_peek_tag( &tmpber, &len ) == LDAP_TAG_REFERRAL ) {
574                                         /* We have a V3 referral, assume we cannot chase it */
575                                         v3ref = -1;
576                                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
577                                                          || (lr->lr_parent != NULL) )
578                                         {
579                                                 v3ref = -1;  /* Assume referral not chased and return it to app */
580                                                 /* Get the referral list */
581                                                 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
582                                                         rc = LDAP_DECODING_ERROR;
583                                                         lr->lr_status = LDAP_REQST_COMPLETED;
584                                                         Debug( LDAP_DEBUG_TRACE,
585                                                             "read1msg: referral decode error, mark request completed, id = %d\n",
586                                                                     lr->lr_msgid, 0, 0);
587                                                 } else {
588                                                         /* Chase the referral 
589                                                          * Note: refs arrary is freed by ldap_chase_v3referrals
590                                                          */
591                                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
592                                                             0, &lr->lr_res_error, &hadref );
593                                                         lr->lr_status = LDAP_REQST_COMPLETED;
594                                                         Debug( LDAP_DEBUG_TRACE,
595                                                             "read1msg:  referral chased, mark request completed, id = %d\n",
596                                                             lr->lr_msgid, 0, 0);
597                                                         if( refer_cnt > 0) {
598                                                                 v3ref = 1;  /* Referral successfully chased */
599                                                         }
600                                                 }
601                                         }
602                                 }
603
604                                 if( lr->lr_res_matched != NULL ) {
605                                         LDAP_FREE( lr->lr_res_matched );
606                                         lr->lr_res_matched = NULL;
607                                 }
608                                 if( lr->lr_res_error != NULL ) {
609                                         LDAP_FREE( lr->lr_res_error );
610                                         lr->lr_res_error = NULL;
611                                 }
612                         }
613                 }
614         }
615
616         /* All results that just return a status, i.e. don't return data
617          * go through the following code.  This code also chases V2 referrals
618          * and checks if all referrals have been chased.
619          */
620         if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref > -1) &&
621                 (tag != LDAP_RES_INTERMEDIATE ))
622         {
623                 /* For a v3 search referral/reference, only come here if already chased it */
624                 if ( ld->ld_version >= LDAP_VERSION2 &&
625                         ( lr->lr_parent != NULL ||
626                         LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
627                 {
628                         char            *lr_res_error = NULL;
629
630                         tmpber = *ber;  /* struct copy */
631                         if ( v3ref == 1 ) {
632                                 /* V3 search reference or V3 referral
633                                  * sucessfully chased. If this message
634                                  * is a search result, then it has no more
635                                  * outstanding referrals.
636                                  */
637                                 if ( tag == LDAP_RES_SEARCH_RESULT )
638                                         refer_cnt = 0;
639                         } else if ( ber_scanf( &tmpber, "{iaa}", &lderr,
640                                 &lr->lr_res_matched, &lr_res_error )
641                                 != LBER_ERROR )
642                         {
643                                 if ( lr_res_error != NULL ) {
644                                         if ( lr->lr_res_error != NULL ) {
645                                                 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
646                                                 LDAP_FREE( (char *)lr_res_error );
647                                         } else {
648                                                 lr->lr_res_error = lr_res_error;
649                                         }
650                                 }
651
652                                 if ( lderr != LDAP_SUCCESS ) {
653                                         /* referrals are in error string */
654                                         refer_cnt = ldap_chase_referrals( ld, lr,
655                                                 &lr->lr_res_error, -1, &hadref );
656                                         lr->lr_status = LDAP_REQST_COMPLETED;
657                                         Debug( LDAP_DEBUG_TRACE,
658                                             "read1msg:  V2 referral chased, mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
659                                 }
660
661                                 /* save errno, message, and matched string */
662                                 if ( !hadref || lr->lr_res_error == NULL ) {
663                                         lr->lr_res_errno = ( lderr ==
664                                         LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
665                                         : lderr;
666                                 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
667                                         lr->lr_res_errno = ld->ld_errno;
668                                 } else {
669                                         lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
670                                 }
671 Debug( LDAP_DEBUG_TRACE,
672     "new result:  res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
673     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
674     lr->lr_res_matched ? lr->lr_res_matched : "" );
675                         }
676                 }
677
678                 Debug( LDAP_DEBUG_TRACE,
679                     "read1msg:  %d new referrals\n", refer_cnt, 0, 0 );
680
681                 if ( refer_cnt != 0 ) { /* chasing referrals */
682                         ber_free( ber, 1 );
683                         ber = NULL;
684                         if ( refer_cnt < 0 ) {
685                                 return( -1 );   /* fatal error */
686                         }
687                         lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
688                 } else {
689                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
690                                 /* request without any referrals */
691                                 simple_request = ( hadref ? 0 : 1 );
692                         } else {
693                                 /* request with referrals or child request */
694                                 ber_free( ber, 1 );
695                                 ber = NULL;
696                         }
697
698                         lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
699                         Debug( LDAP_DEBUG_TRACE,
700                             "read1msg:  mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
701                         while ( lr->lr_parent != NULL ) {
702                                 merge_error_info( ld, lr->lr_parent, lr );
703
704                                 lr = lr->lr_parent;
705                                 if ( --lr->lr_outrefcnt > 0 ) {
706                                         break;  /* not completely done yet */
707                                 }
708                         }
709
710                         /* Check if all requests are finished, lr is now parent */
711                         tmplr = lr;
712                         if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
713                                 for ( tmplr=lr->lr_child;
714                                         tmplr != NULL;
715                                         tmplr=tmplr->lr_refnext)
716                                 {
717                                         if( tmplr->lr_status != LDAP_REQST_COMPLETED) break;
718                                 }
719                         }
720
721                         /* This is the parent request if the request has referrals */
722                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
723                                 tmplr == NULL )
724                         {
725                                 id = lr->lr_msgid;
726                                 tag = lr->lr_res_msgtype;
727                                 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
728                                     (long) id, 0, 0 );
729 Debug( LDAP_DEBUG_TRACE,
730 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
731 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
732 lr->lr_res_matched ? lr->lr_res_matched : "" );
733                                 if ( !simple_request ) {
734                                         ber_free( ber, 1 );
735                                         ber = NULL;
736                                         if ( build_result_ber( ld, &ber, lr )
737                                             == LBER_ERROR ) {
738                                                 rc = -1; /* fatal error */
739                                         }
740                                 }
741
742 #ifdef LDAP_R_COMPILE
743                                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
744 #endif
745                                 ldap_free_request( ld, lr );
746 #ifdef LDAP_R_COMPILE
747                                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
748 #endif
749                         }
750
751                         if ( lc != NULL ) {
752 #ifdef LDAP_R_COMPILE
753                                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
754 #endif
755                                 ldap_free_connection( ld, lc, 0, 1 );
756 #ifdef LDAP_R_COMPILE
757                                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
758 #endif
759                                 *lcp = NULL;
760                         }
761                 }
762         }
763
764         if ( ber == NULL ) {
765                 return( rc );
766         }
767
768         /* make a new ldap message */
769         newmsg = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) );
770         if ( newmsg == NULL ) {
771                 ld->ld_errno = LDAP_NO_MEMORY;
772                 return( -1 );
773         }
774         newmsg->lm_msgid = (int)id;
775         newmsg->lm_msgtype = tag;
776         newmsg->lm_ber = ber;
777
778 #ifdef LDAP_CONNECTIONLESS
779         /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
780          * the responses are all a sequence wrapped in one message. In
781          * LDAPv3 each response is in its own message. The datagram must
782          * end with a SearchResult. We can't just parse each response in
783          * separate calls to try_read1msg because the header info is only
784          * present at the beginning of the datagram, not at the beginning
785          * of each response. So parse all the responses at once and queue
786          * them up, then pull off the first response to return to the
787          * caller when all parsing is complete.
788          */
789         if ( LDAP_IS_UDP(ld) ) {
790                 /* If not a result, look for more */
791                 if ( tag != LDAP_RES_SEARCH_RESULT ) {
792                         int ok = 0;
793                         moremsgs = 1;
794                         if (isv2) {
795                                 /* LDAPv2: dup the current ber, skip past the current
796                                  * response, and see if there are any more after it.
797                                  */
798                                 ber = ber_dup( ber );
799                                 ber_scanf( ber, "x" );
800                                 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
801                                         /* There's more - dup the ber buffer so they can all be
802                                          * individually freed by ldap_msgfree.
803                                          */
804                                         struct berval bv;
805                                         ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
806                                         bv.bv_val = LDAP_MALLOC(len);
807                                         if (bv.bv_val) {
808                                                 ok=1;
809                                                 ber_read(ber, bv.bv_val, len);
810                                                 bv.bv_len = len;
811                                                 ber_init2(ber, &bv, ld->ld_lberoptions );
812                                         }
813                                 }
814                         } else {
815                                 /* LDAPv3: Just allocate a new ber. Since this is a buffered
816                                  * datagram, if the sockbuf is readable we still have data
817                                  * to parse.
818                                  */
819                                 ber = ldap_alloc_ber_with_options(ld);
820                                 if (ber_sockbuf_ctrl(sb, LBER_SB_OPT_DATA_READY, NULL)) ok=1;
821                         }
822                         /* set up response chain */
823                         if ( firstmsg ) {
824                                 firstmsg = 0;
825                                 newmsg->lm_next = ld->ld_responses;
826                                 ld->ld_responses = newmsg;
827                                 newmsg->lm_chain_tail = newmsg;
828                                 chain_head = newmsg;
829                         } else {
830                                 assert( tmp != NULL );
831                                 tmp->lm_chain = newmsg;
832                                 chain_head->lm_chain_tail = tmp;
833                         }
834                         tmp = newmsg;
835                         /* "ok" means there's more to parse */
836                         if (ok) {
837                                 if (isv2) goto nextresp2;
838                                 else goto nextresp3;
839                         } else {
840                                 /* got to end of datagram without a SearchResult. Free
841                                  * our dup'd ber, but leave any buffer alone. For v2 case,
842                                  * the previous response is still using this buffer. For v3,
843                                  * the new ber has no buffer to free yet.
844                                  */
845                                 ber_free(ber, 0);
846                                 return -1;
847                         }
848                 } else if ( moremsgs ) {
849                 /* got search result, and we had multiple responses in 1 datagram.
850                  * stick the result onto the end of the chain, and then pull the
851                  * first response off the head of the chain.
852                  */
853                         tmp->lm_chain = newmsg;
854                         chain_head->lm_chain_tail = tmp;
855                         *result = chkResponseList( ld, msgid, all );
856                         ld->ld_errno = LDAP_SUCCESS;
857                         return( (*result)->lm_msgtype );
858                 }
859         }
860 #endif /* LDAP_CONNECTIONLESS */
861
862         /* is this the one we're looking for? */
863         if ( msgid == LDAP_RES_ANY || id == msgid ) {
864                 if ( all == LDAP_MSG_ONE
865                     || (newmsg->lm_msgtype != LDAP_RES_SEARCH_RESULT
866                     && newmsg->lm_msgtype != LDAP_RES_SEARCH_ENTRY
867                     && newmsg->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
868                         *result = newmsg;
869                         ld->ld_errno = LDAP_SUCCESS;
870                         return( tag );
871                 } else if ( newmsg->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
872                         foundit = 1;    /* return the chain later */
873                 }
874         }
875
876         /* 
877          * if not, we must add it to the list of responses.  if
878          * the msgid is already there, it must be part of an existing
879          * search response.
880          */
881
882         prev = NULL;
883         for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
884                 if ( l->lm_msgid == newmsg->lm_msgid )
885                         break;
886                 prev = l;
887         }
888
889         /* not part of an existing search response */
890         if ( l == NULL ) {
891                 if ( foundit ) {
892                         *result = newmsg;
893                         goto exit;
894                 }
895
896                 newmsg->lm_next = ld->ld_responses;
897                 ld->ld_responses = newmsg;
898                 newmsg->lm_chain_tail = newmsg;
899                 goto exit;
900         }
901
902         Debug( LDAP_DEBUG_TRACE, "adding response id %ld type %ld:\n",
903             (long) newmsg->lm_msgid, (long) newmsg->lm_msgtype, 0 );
904
905         /* part of a search response - add to end of list of entries */
906         if (l->lm_chain == NULL) {
907                 assert(l->lm_chain_tail == l);
908                 l->lm_chain = newmsg;
909         } else {
910                 assert(l->lm_chain_tail != NULL);
911                 assert(l->lm_chain_tail->lm_chain != NULL);
912                 if ((l->lm_chain_tail->lm_chain->lm_msgtype
913                                 == LDAP_RES_SEARCH_ENTRY) ||
914                         (l->lm_chain_tail->lm_chain->lm_msgtype
915                                 == LDAP_RES_SEARCH_REFERENCE) ||
916                         (l->lm_chain_tail->lm_chain->lm_msgtype
917                                 == LDAP_RES_INTERMEDIATE)) {
918                         l->lm_chain_tail->lm_chain->lm_chain = newmsg;
919                         l->lm_chain_tail = l->lm_chain_tail->lm_chain;
920                 } else {
921                         /*FIXME: ldap_msgfree( l->lm_chain_tail->lm_chain );*/
922                         l->lm_chain_tail->lm_chain = newmsg;
923                 }
924         }
925
926         /* return the whole chain if that's what we were looking for */
927         if ( foundit ) {
928                 if ( prev == NULL )
929                         ld->ld_responses = l->lm_next;
930                 else
931                         prev->lm_next = l->lm_next;
932                 *result = l;
933         }
934
935 exit:
936         if ( foundit ) {
937                 ld->ld_errno = LDAP_SUCCESS;
938                 return( tag );
939         }
940         if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
941                 goto retry;
942         }
943         return( -2 );   /* continue looking */
944 }
945
946
947 static ber_tag_t
948 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
949 {
950         ber_len_t       len;
951         ber_tag_t       tag;
952         ber_int_t       along;
953         BerElement *ber;
954
955         *bp = NULL;
956         ber = ldap_alloc_ber_with_options( ld );
957
958         if( ber == NULL ) {
959                 ld->ld_errno = LDAP_NO_MEMORY;
960                 return LBER_ERROR;
961         }
962
963         if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
964                 lr->lr_res_msgtype, lr->lr_res_errno,
965                 lr->lr_res_matched ? lr->lr_res_matched : "",
966                 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 )
967         {
968                 ld->ld_errno = LDAP_ENCODING_ERROR;
969                 ber_free(ber, 1);
970                 return( LBER_ERROR );
971         }
972
973         ber_reset( ber, 1 );
974
975         if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
976                 ld->ld_errno = LDAP_DECODING_ERROR;
977                 ber_free(ber, 1);
978                 return( LBER_ERROR );
979         }
980
981         if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
982                 ld->ld_errno = LDAP_DECODING_ERROR;
983                 ber_free(ber, 1);
984                 return( LBER_ERROR );
985         }
986
987         tag = ber_peek_tag( ber, &len );
988
989         if ( tag == LBER_ERROR ) {
990                 ld->ld_errno = LDAP_DECODING_ERROR;
991                 ber_free(ber, 1);
992                 return( LBER_ERROR );
993         }
994
995         *bp = ber;
996         return tag;
997 }
998
999
1000 static void
1001 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1002 {
1003 /*
1004  * Merge error information in "lr" with "parentr" error code and string.
1005  */
1006         if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1007                 parentr->lr_res_errno = lr->lr_res_errno;
1008                 if ( lr->lr_res_error != NULL ) {
1009                         (void)ldap_append_referral( ld, &parentr->lr_res_error,
1010                             lr->lr_res_error );
1011                 }
1012         } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1013                 parentr->lr_res_errno == LDAP_SUCCESS )
1014         {
1015                 parentr->lr_res_errno = lr->lr_res_errno;
1016                 if ( parentr->lr_res_error != NULL ) {
1017                         LDAP_FREE( parentr->lr_res_error );
1018                 }
1019                 parentr->lr_res_error = lr->lr_res_error;
1020                 lr->lr_res_error = NULL;
1021                 if ( LDAP_NAME_ERROR( lr->lr_res_errno ) ) {
1022                         if ( parentr->lr_res_matched != NULL ) {
1023                                 LDAP_FREE( parentr->lr_res_matched );
1024                         }
1025                         parentr->lr_res_matched = lr->lr_res_matched;
1026                         lr->lr_res_matched = NULL;
1027                 }
1028         }
1029
1030         Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info:  ",
1031             parentr->lr_msgid, 0, 0 );
1032         Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1033             parentr->lr_res_errno, parentr->lr_res_error ?
1034             parentr->lr_res_error : "", parentr->lr_res_matched ?
1035             parentr->lr_res_matched : "" );
1036 }
1037
1038
1039
1040 int
1041 ldap_msgtype( LDAPMessage *lm )
1042 {
1043         assert( lm != NULL );
1044         return ( lm != NULL ) ? lm->lm_msgtype : -1;
1045 }
1046
1047
1048 int
1049 ldap_msgid( LDAPMessage *lm )
1050 {
1051         assert( lm != NULL );
1052
1053         return ( lm != NULL ) ? lm->lm_msgid : -1;
1054 }
1055
1056
1057 char * ldap_int_msgtype2str( ber_tag_t tag )
1058 {
1059         switch( tag ) {
1060         case LDAP_RES_ADD: return "add";
1061         case LDAP_RES_BIND: return "bind";
1062         case LDAP_RES_COMPARE: return "compare";
1063         case LDAP_RES_DELETE: return "delete";
1064         case LDAP_RES_EXTENDED: return "extended-result";
1065         case LDAP_RES_INTERMEDIATE: return "intermediate";
1066         case LDAP_RES_MODIFY: return "modify";
1067         case LDAP_RES_RENAME: return "rename";
1068         case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1069         case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1070         case LDAP_RES_SEARCH_RESULT: return "search-result";
1071         }
1072         return "unknown";
1073 }
1074
1075 int
1076 ldap_msgfree( LDAPMessage *lm )
1077 {
1078         LDAPMessage     *next;
1079         int             type = 0;
1080
1081         Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1082
1083         for ( ; lm != NULL; lm = next ) {
1084                 next = lm->lm_chain;
1085                 type = lm->lm_msgtype;
1086                 ber_free( lm->lm_ber, 1 );
1087                 LDAP_FREE( (char *) lm );
1088         }
1089
1090         return( type );
1091 }
1092
1093 /*
1094  * ldap_msgdelete - delete a message.  It returns:
1095  *      0       if the entire message was deleted
1096  *      -1      if the message was not found, or only part of it was found
1097  */
1098 int
1099 ldap_msgdelete( LDAP *ld, int msgid )
1100 {
1101         LDAPMessage     *lm, *prev;
1102         int rc = 0;
1103
1104         assert( ld != NULL );
1105
1106         Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1107
1108         prev = NULL;
1109 #ifdef LDAP_R_COMPILE
1110         ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1111 #endif
1112         for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1113                 if ( lm->lm_msgid == msgid )
1114                         break;
1115                 prev = lm;
1116         }
1117
1118         if ( lm == NULL ) {
1119                 rc = -1;
1120         } else {
1121                 if ( prev == NULL )
1122                         ld->ld_responses = lm->lm_next;
1123                 else
1124                         prev->lm_next = lm->lm_next;
1125         }
1126 #ifdef LDAP_R_COMPILE
1127         ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1128 #endif
1129         if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1130                 rc = -1;
1131
1132         return( rc );
1133 }
1134
1135
1136 /*
1137  * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1138  */
1139 static int
1140 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1141 {
1142         int     i;
1143
1144         if ( ld->ld_abandoned == NULL )
1145                 return( 0 );
1146
1147         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1148                 if ( ld->ld_abandoned[i] == msgid )
1149                         return( 1 );
1150
1151         return( 0 );
1152 }
1153
1154
1155 static int
1156 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1157 {
1158         int     i;
1159
1160         if ( ld->ld_abandoned == NULL )
1161                 return( -1 );
1162
1163         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1164                 if ( ld->ld_abandoned[i] == msgid )
1165                         break;
1166
1167         if ( ld->ld_abandoned[i] == -1 )
1168                 return( -1 );
1169
1170         for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1171                 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
1172         }
1173
1174         return( 0 );
1175 }