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