]> git.sur5r.net Git - openldap/blob - libraries/libldap/result.c
475effc9d5c062caa9b4e015e625a0eb752f01c3
[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                 }
469         }
470
471         /* All results that just return a status, i.e. don't return data
472          * go through the following code.  This code also chases V2 referrals
473          * and checks if all referrals have been chased.
474          */
475         if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref > -1) ) {
476                 /* For a v3 search referral/reference, only come here if already chased it */
477                 if ( ld->ld_version >= LDAP_VERSION2 &&
478                         ( lr->lr_parent != NULL ||
479                         LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
480                 {
481                         tmpber = *ber;  /* struct copy */
482                         if ( v3ref == 1 ) {
483                                 ; /* V3 search reference or V3 referral sucessfully chased */
484                         } else
485                         if ( ber_scanf( &tmpber, "{iaa}", &lderr,
486                             &lr->lr_res_matched, &lr->lr_res_error )
487                             != LBER_ERROR ) {
488                                 if ( lderr != LDAP_SUCCESS ) {
489                                         /* referrals are in error string */
490                                         refer_cnt = ldap_chase_referrals( ld, lr,
491                                             &lr->lr_res_error, &hadref );
492                                         lr->lr_status = LDAP_REQST_COMPLETED;
493                                         Debug( LDAP_DEBUG_TRACE,
494                                             "read1msg:  V2 referral chased, mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
495                                 }
496
497                                 /* save errno, message, and matched string */
498                                 if ( !hadref || lr->lr_res_error == NULL ) {
499                                         lr->lr_res_errno = ( lderr ==
500                                         LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
501                                         : lderr;
502                                 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
503                                         lr->lr_res_errno = ld->ld_errno;
504                                 } else {
505                                         lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
506                                 }
507 Debug( LDAP_DEBUG_TRACE,
508     "new result:  res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
509     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
510     lr->lr_res_matched ? lr->lr_res_matched : "" );
511                         }
512                 }
513
514                 Debug( LDAP_DEBUG_TRACE,
515                     "read1msg:  %d new referrals\n", refer_cnt, 0, 0 );
516
517                 if ( refer_cnt != 0 ) { /* chasing referrals */
518                         ber_free( ber, 1 );
519                         ber = NULL;
520                         if ( refer_cnt < 0 ) {
521                                 return( -1 );   /* fatal error */
522                         }
523                         lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
524                 } else {
525                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
526                                 /* request without any referrals */
527                                 simple_request = ( hadref ? 0 : 1 );
528                         } else {
529                                 /* request with referrals or child request */
530                                 ber_free( ber, 1 );
531                                 ber = NULL;
532                         }
533
534                         lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
535                         Debug( LDAP_DEBUG_TRACE,
536                             "read1msg:  mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
537                         while ( lr->lr_parent != NULL ) {
538                                 merge_error_info( ld, lr->lr_parent, lr );
539
540                                 lr = lr->lr_parent;
541                                 if ( --lr->lr_outrefcnt > 0 ) {
542                                         break;  /* not completely done yet */
543                                 }
544                         }
545
546                         /* Check if all requests are finished, lr is now parent */
547                         for(tmplr=lr ; tmplr != NULL; tmplr=tmplr->lr_refnext) {
548                                 if( tmplr->lr_status != LDAP_REQST_COMPLETED) {
549                                         break;
550                                 }
551                         }
552
553                         /* This is the parent request if the request has referrals */
554                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL && tmplr == NULL ) {
555                                 id = lr->lr_msgid;
556                                 tag = lr->lr_res_msgtype;
557                                 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
558                                     (long) id, 0, 0 );
559 Debug( LDAP_DEBUG_TRACE,
560 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
561 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
562 lr->lr_res_matched ? lr->lr_res_matched : "" );
563                                 if ( !simple_request ) {
564                                         ber_free( ber, 1 );
565                                         ber = NULL;
566                                         if ( build_result_ber( ld, &ber, lr )
567                                             == LBER_ERROR ) {
568                                                 rc = -1; /* fatal error */
569                                         }
570                                 }
571
572                                 ldap_free_request( ld, lr );
573                         }
574
575                         if ( lc != NULL ) {
576                                 ldap_free_connection( ld, lc, 0, 1 );
577                         }
578                 }
579         }
580
581         if ( ber == NULL ) {
582                 return( rc );
583         }
584
585         /* make a new ldap message */
586         if ( (new = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) ))
587             == NULL ) {
588                 ld->ld_errno = LDAP_NO_MEMORY;
589                 return( -1 );
590         }
591         new->lm_msgid = (int)id;
592         new->lm_msgtype = tag;
593         new->lm_ber = ber;
594
595 #ifndef LDAP_NOCACHE
596                 if ( ld->ld_cache != NULL ) {
597                         ldap_add_result_to_cache( ld, new );
598                 }
599 #endif /* LDAP_NOCACHE */
600
601         /* is this the one we're looking for? */
602         if ( msgid == LDAP_RES_ANY || id == msgid ) {
603                 if ( all == LDAP_MSG_ONE
604                     || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
605                     && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY
606                     && new->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
607                         *result = new;
608                         ld->ld_errno = LDAP_SUCCESS;
609                         return( tag );
610                 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
611                         foundit = 1;    /* return the chain later */
612                 }
613         }
614
615         /* 
616          * if not, we must add it to the list of responses.  if
617          * the msgid is already there, it must be part of an existing
618          * search response.
619          */
620
621         prev = NULL;
622         for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
623                 if ( l->lm_msgid == new->lm_msgid )
624                         break;
625                 prev = l;
626         }
627
628         /* not part of an existing search response */
629         if ( l == NULL ) {
630                 if ( foundit ) {
631                         *result = new;
632                         ld->ld_errno = LDAP_SUCCESS;
633                         return( tag );
634                 }
635
636                 new->lm_next = ld->ld_responses;
637                 ld->ld_responses = new;
638                 return( -2 );   /* continue looking */
639         }
640
641         Debug( LDAP_DEBUG_TRACE, "adding response id %ld type %ld:\n",
642             (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
643
644         /* part of a search response - add to end of list of entries */
645         for ( tmp = l; (tmp->lm_chain != NULL) &&
646                 ((tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
647                  (tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_REFERENCE));
648             tmp = tmp->lm_chain )
649                 ;       /* NULL */
650         tmp->lm_chain = new;
651
652         /* return the whole chain if that's what we were looking for */
653         if ( foundit ) {
654                 if ( prev == NULL )
655                         ld->ld_responses = l->lm_next;
656                 else
657                         prev->lm_next = l->lm_next;
658                 *result = l;
659                 ld->ld_errno = LDAP_SUCCESS;
660 #ifdef LDAP_WORLD_P16
661                 /*
662                  * XXX questionable fix; see text for [P16] on
663                  * http://www.critical-angle.com/ldapworld/patch/
664                  *
665                  * inclusion of this patch causes searchs to hang on
666                  * multiple platforms
667                  */
668                 return( l->lm_msgtype );
669 #else   /* LDAP_WORLD_P16 */
670                 return( tag );
671 #endif  /* !LDAP_WORLD_P16 */
672         }
673
674         return( -2 );   /* continue looking */
675 }
676
677
678 static ber_tag_t
679 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
680 {
681         ber_len_t       len;
682         ber_int_t       tag;
683         ber_int_t       along;
684         BerElement *ber;
685
686         *bp = NULL;
687         ber = ldap_alloc_ber_with_options( ld );
688
689         if( ber == NULL ) {
690                 ld->ld_errno = LDAP_NO_MEMORY;
691                 return LBER_ERROR;
692         }
693
694         if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
695             lr->lr_res_msgtype, lr->lr_res_errno,
696             lr->lr_res_matched ? lr->lr_res_matched : "",
697             lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
698
699                 ld->ld_errno = LDAP_ENCODING_ERROR;
700                 ber_free(ber, 1);
701                 return( LBER_ERROR );
702         }
703
704         ber_reset( ber, 1 );
705
706         if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
707                 ld->ld_errno = LDAP_DECODING_ERROR;
708                 ber_free(ber, 1);
709                 return( LBER_ERROR );
710         }
711
712         if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
713                 ld->ld_errno = LDAP_DECODING_ERROR;
714                 ber_free(ber, 1);
715                 return( LBER_ERROR );
716         }
717
718         tag = ber_peek_tag( ber, &len );
719
720         if ( tag == LBER_ERROR ) {
721                 ld->ld_errno = LDAP_DECODING_ERROR;
722                 ber_free(ber, 1);
723                 return( LBER_ERROR );
724         }
725
726         *bp = ber;
727         return tag;
728 }
729
730
731 static void
732 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
733 {
734 /*
735  * Merge error information in "lr" with "parentr" error code and string.
736  */
737         if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
738                 parentr->lr_res_errno = lr->lr_res_errno;
739                 if ( lr->lr_res_error != NULL ) {
740                         (void)ldap_append_referral( ld, &parentr->lr_res_error,
741                             lr->lr_res_error );
742                 }
743         } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
744             parentr->lr_res_errno == LDAP_SUCCESS ) {
745                 parentr->lr_res_errno = lr->lr_res_errno;
746                 if ( parentr->lr_res_error != NULL ) {
747                         LDAP_FREE( parentr->lr_res_error );
748                 }
749                 parentr->lr_res_error = lr->lr_res_error;
750                 lr->lr_res_error = NULL;
751                 if ( LDAP_NAME_ERROR( lr->lr_res_errno )) {
752                         if ( parentr->lr_res_matched != NULL ) {
753                                 LDAP_FREE( parentr->lr_res_matched );
754                         }
755                         parentr->lr_res_matched = lr->lr_res_matched;
756                         lr->lr_res_matched = NULL;
757                 }
758         }
759
760         Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info:  ",
761             parentr->lr_msgid, 0, 0 );
762         Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
763             parentr->lr_res_errno, parentr->lr_res_error ?
764             parentr->lr_res_error : "", parentr->lr_res_matched ?
765             parentr->lr_res_matched : "" );
766 }
767
768
769
770 int
771 ldap_msgtype( LDAPMessage *lm )
772 {
773         assert( lm != NULL );
774         return ( lm != NULL ) ? lm->lm_msgtype : -1;
775 }
776
777
778 int
779 ldap_msgid( LDAPMessage *lm )
780 {
781         assert( lm != NULL );
782
783         return ( lm != NULL ) ? lm->lm_msgid : -1;
784 }
785
786
787 int
788 ldap_msgfree( LDAPMessage *lm )
789 {
790         LDAPMessage     *next;
791         int             type = 0;
792
793         assert( lm != NULL );
794
795         Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
796
797         for ( ; lm != NULL; lm = next ) {
798                 next = lm->lm_chain;
799                 type = lm->lm_msgtype;
800                 ber_free( lm->lm_ber, 1 );
801                 LDAP_FREE( (char *) lm );
802         }
803
804         return( type );
805 }
806
807 /*
808  * ldap_msgdelete - delete a message.  It returns:
809  *      0       if the entire message was deleted
810  *      -1      if the message was not found, or only part of it was found
811  */
812 int
813 ldap_msgdelete( LDAP *ld, int msgid )
814 {
815         LDAPMessage     *lm, *prev;
816
817         assert( ld != NULL );
818
819         Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
820
821         prev = NULL;
822         for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
823                 if ( lm->lm_msgid == msgid )
824                         break;
825                 prev = lm;
826         }
827
828         if ( lm == NULL )
829                 return( -1 );
830
831         if ( prev == NULL )
832                 ld->ld_responses = lm->lm_next;
833         else
834                 prev->lm_next = lm->lm_next;
835
836         if ( ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
837                 return( -1 );
838
839         return( 0 );
840 }
841
842
843 /*
844  * return 1 if message msgid is waiting to be abandoned, 0 otherwise
845  */
846 static int
847 ldap_abandoned( LDAP *ld, ber_int_t msgid )
848 {
849         int     i;
850
851         if ( ld->ld_abandoned == NULL )
852                 return( 0 );
853
854         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
855                 if ( ld->ld_abandoned[i] == msgid )
856                         return( 1 );
857
858         return( 0 );
859 }
860
861
862 static int
863 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
864 {
865         int     i;
866
867         if ( ld->ld_abandoned == NULL )
868                 return( -1 );
869
870         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
871                 if ( ld->ld_abandoned[i] == msgid )
872                         break;
873
874         if ( ld->ld_abandoned[i] == -1 )
875                 return( -1 );
876
877         for ( ; ld->ld_abandoned[i] != -1; i++ ) {
878                 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
879         }
880
881         return( 0 );
882 }
883
884
885 #ifdef LDAP_CONNECTIONLESS
886 int
887 cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber )
888 {
889         int     rc;
890         ber_tag_t       tag;
891         ber_len_t       len;
892         ber_socket_t    sd;
893
894         ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, &sd );
895         if ( sd != AC_SOCKET_INVALID ) {
896                 /* restored from ldap_select1() in result.c version 1.24 */
897                 fd_set  readfds;
898                 if ( ldap_int_tblsize == 0 )
899                         ldap_int_ip_init();
900                 FD_ZERO( &readfds );
901                 FD_SET( sd, &readfds );
902                 rc = select( ldap_int_tblsize, &readfds, 0, 0, timeout );
903
904                 if ( rc == -1 || rc == 0 ) {
905                         ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
906                             LDAP_TIMEOUT);
907                         return( rc );
908                 }
909         }
910
911         /* get the next message */
912         if ( (tag = ber_get_next( ld->ld_sb, &len, ber ))
913             != LDAP_TAG_MESSAGE ) {
914                 ld->ld_errno = (tag == LBER_DEFAULT ? LDAP_SERVER_DOWN :
915                     LDAP_LOCAL_ERROR);
916                 return( -1 );
917         }
918
919         return( 0 );
920 }
921 #endif /* LDAP_CONNECTIONLESS */