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