1 /* result.c - wait for an ldap result */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
17 * All rights reserved.
19 /* This notice applies to changes, created by or for Novell, Inc.,
20 * to preexisting works for which notices appear elsewhere in this file.
22 * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
24 * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES.
25 * USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT TO VERSION
26 * 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS AVAILABLE AT
27 * HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE" IN THE
28 * TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION OF THIS
29 * WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP PUBLIC
30 * LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT THE
31 * PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
33 * Modification to OpenLDAP source by Novell, Inc.
34 * April 2000 sfs Add code to process V3 referrals and search results
36 * Note: A verbatim copy of version 2.0.1 of the OpenLDAP Public License
37 * can be found in the file "build/LICENSE-2.0.1" in this distribution
38 * of OpenLDAP Software.
40 /* Portions Copyright (C) The Internet Society (1997)
41 * ASN.1 fragments are from RFC 2251; see RFC for full legal notices.
46 * LDAPResult ::= SEQUENCE {
47 * resultCode ENUMERATED { ... },
49 * errorMessage LDAPString,
50 * referral Referral OPTIONAL
52 * Referral ::= SEQUENCE OF LDAPURL (one or more)
53 * LDAPURL ::= LDAPString (limited to URL chars)
60 #include <ac/stdlib.h>
63 #include <ac/socket.h>
64 #include <ac/string.h>
66 #include <ac/unistd.h>
71 static int ldap_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
72 static int ldap_mark_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
73 static int wait4msg LDAP_P(( LDAP *ld, ber_int_t msgid, int all, struct timeval *timeout,
74 LDAPMessage **result ));
75 static ber_tag_t try_read1msg LDAP_P(( LDAP *ld, ber_int_t msgid,
76 int all, Sockbuf *sb, LDAPConn **lc, LDAPMessage **result ));
77 static ber_tag_t build_result_ber LDAP_P(( LDAP *ld, BerElement **bp, LDAPRequest *lr ));
78 static void merge_error_info LDAP_P(( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr ));
79 static LDAPMessage * chkResponseList LDAP_P(( LDAP *ld, int msgid, int all));
83 * ldap_result - wait for an ldap result response to a message from the
84 * ldap server. If msgid is LDAP_RES_ANY (-1), any message will be
85 * accepted. If msgid is LDAP_RES_UNSOLICITED (0), any unsolicited
86 * message is accepted. Otherwise ldap_result will wait for a response
87 * with msgid. If all is LDAP_MSG_ONE (0) the first message with id
88 * msgid will be accepted, otherwise, ldap_result will wait for all
89 * responses with id msgid and then return a pointer to the entire list
90 * of messages. In general, this is only useful for search responses,
91 * which can be of three message types (zero or more entries, zero or
92 * search references, followed by an ldap result). An extension to
93 * LDAPv3 allows partial extended responses to be returned in response
94 * to any request. The type of the first message received is returned.
95 * When waiting, any messages that have been abandoned are discarded.
98 * ldap_result( s, msgid, all, timeout, result )
105 struct timeval *timeout,
106 LDAPMessage **result )
111 assert( ld != NULL );
112 assert( result != NULL );
114 Debug( LDAP_DEBUG_TRACE, "ldap_result ld %p msgid %d\n", (void *)ld, msgid, 0 );
116 #ifdef LDAP_R_COMPILE
117 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
119 lm = chkResponseList(ld, msgid, all);
122 rc = wait4msg( ld, msgid, all, timeout, result );
125 ld->ld_errno = LDAP_SUCCESS;
128 #ifdef LDAP_R_COMPILE
129 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
140 LDAPMessage *lm, **lastlm, *nextlm;
142 * Look through the list of responses we have received on
143 * this association and see if the response we're interested in
144 * is there. If it is, return it. If not, call wait4msg() to
145 * wait until it arrives or timeout occurs.
148 Debug( LDAP_DEBUG_TRACE,
149 "ldap_chkResponseList ld %p msgid %d all %d\n",
150 (void *)ld, msgid, all );
151 lastlm = &ld->ld_responses;
152 for ( lm = ld->ld_responses; lm != NULL; lm = nextlm ) {
153 nextlm = lm->lm_next;
155 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
156 Debug( LDAP_DEBUG_TRACE,
157 "ldap_chkResponseList msg abandoned, msgid %d\n",
159 ldap_mark_abandoned( ld, lm->lm_msgid );
161 /* Remove this entry from list */
169 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
172 if ( all == LDAP_MSG_ONE || all == LDAP_MSG_RECEIVED ||
173 msgid == LDAP_RES_UNSOLICITED ) {
177 tmp = lm->lm_chain_tail;
178 if ((tmp->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
179 (tmp->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
180 (tmp->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
190 lastlm = &lm->lm_next;
194 /* Found an entry, remove it from the list */
195 if ( all == LDAP_MSG_ONE && lm->lm_chain != NULL ) {
196 *lastlm = lm->lm_chain;
197 lm->lm_chain->lm_next = lm->lm_next;
198 lm->lm_chain->lm_chain_tail = ( lm->lm_chain_tail != lm ) ? lm->lm_chain_tail : lm->lm_chain;
200 lm->lm_chain_tail = NULL;
202 *lastlm = lm->lm_next;
209 Debug( LDAP_DEBUG_TRACE,
210 "ldap_chkResponseList returns ld %p NULL\n", (void *)ld, 0, 0);
212 Debug( LDAP_DEBUG_TRACE,
213 "ldap_chkResponseList returns ld %p msgid %d, type 0x%02lu\n",
214 (void *)ld, lm->lm_msgid, (unsigned long) lm->lm_msgtype);
225 struct timeval *timeout,
226 LDAPMessage **result )
229 struct timeval tv = { 0 },
232 time_t start_time = 0;
234 LDAPConn *lc, *nextlc;
236 assert( ld != NULL );
237 assert( result != NULL );
240 if ( timeout == NULL ) {
241 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (infinite timeout)\n",
242 (void *)ld, msgid, 0 );
244 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (timeout %ld usec)\n",
245 (void *)ld, msgid, (long)timeout->tv_sec * 1000000 + timeout->tv_usec );
247 #endif /* LDAP_DEBUG */
249 if ( timeout == NULL ) {
255 start_time = time( NULL );
261 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
262 Debug( LDAP_DEBUG_TRACE, "wait4msg continue ld %p msgid %d all %d\n",
263 (void *)ld, msgid, all );
264 ldap_dump_connection( ld, ld->ld_conns, 1 );
265 ldap_dump_requests_and_responses( ld );
267 #endif /* LDAP_DEBUG */
269 if ( (*result = chkResponseList(ld, msgid, all)) != NULL ) {
270 rc = (*result)->lm_msgtype;
275 #ifdef LDAP_R_COMPILE
276 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
278 for ( lc = ld->ld_conns; lc != NULL; lc = nextlc ) {
279 nextlc = lc->lconn_next;
280 if ( ber_sockbuf_ctrl( lc->lconn_sb,
281 LBER_SB_OPT_DATA_READY, NULL ) ) {
282 #ifdef LDAP_R_COMPILE
283 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
285 rc = try_read1msg( ld, msgid, all, lc->lconn_sb,
287 #ifdef LDAP_R_COMPILE
288 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
294 #ifdef LDAP_R_COMPILE
295 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
299 rc = ldap_int_select( ld, tvp );
302 Debug( LDAP_DEBUG_TRACE,
303 "ldap_int_select returned -1: errno %d\n",
308 if ( rc == 0 || ( rc == -1 && (
309 !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
310 || errno != EINTR )))
312 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
318 rc = -2; /* select interrupted: loop */
321 #ifdef LDAP_R_COMPILE
322 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
324 if ( ld->ld_requests &&
325 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
326 ldap_is_write_ready( ld,
327 ld->ld_requests->lr_conn->lconn_sb ) )
329 ldap_int_flush_request( ld, ld->ld_requests );
331 #ifdef LDAP_R_COMPILE
332 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
333 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
335 for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
338 nextlc = lc->lconn_next;
339 if ( lc->lconn_status == LDAP_CONNST_CONNECTED &&
340 ldap_is_read_ready( ld, lc->lconn_sb ))
342 #ifdef LDAP_R_COMPILE
343 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
345 rc = try_read1msg( ld, msgid, all,
346 lc->lconn_sb, &lc, result );
347 if ( lc == NULL ) lc = nextlc;
348 #ifdef LDAP_R_COMPILE
349 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
353 #ifdef LDAP_R_COMPILE
354 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
360 if ( rc == -2 && tvp != NULL ) {
361 tmp_time = time( NULL );
362 tv0.tv_sec -= ( tmp_time - start_time );
363 if ( tv0.tv_sec <= 0 ) {
364 rc = 0; /* timed out */
365 ld->ld_errno = LDAP_TIMEOUT;
368 tv.tv_sec = tv0.tv_sec;
370 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p %ld secs to go\n",
371 (void *)ld, (long) tv.tv_sec, 0 );
372 start_time = tmp_time;
387 LDAPMessage **result )
390 LDAPMessage *newmsg, *l, *prev;
395 LDAPRequest *lr, *tmplr;
398 int rc, refer_cnt, hadref, simple_request;
401 #ifdef LDAP_CONNECTIONLESS
402 LDAPMessage *tmp = NULL, *chain_head = NULL;
403 int moremsgs = 0, isv2 = 0;
407 * v3ref = flag for V3 referral / search reference
408 * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
416 assert( ld != NULL );
417 assert( lcp != NULL );
418 assert( *lcp != NULL );
420 Debug( LDAP_DEBUG_TRACE, "read1msg: ld %p msgid %d all %d\n",
421 (void *)ld, msgid, all );
426 if ( lc->lconn_ber == NULL ) {
427 lc->lconn_ber = ldap_alloc_ber_with_options(ld);
429 if( lc->lconn_ber == NULL ) {
435 assert( LBER_VALID (ber) );
437 /* get the next message */
439 #ifdef LDAP_CONNECTIONLESS
440 if ( LDAP_IS_UDP(ld) ) {
441 struct sockaddr from;
442 ber_int_sb_read(sb, &from, sizeof(struct sockaddr));
443 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2=1;
447 tag = ber_get_next( sb, &len, ber );
448 if ( tag == LDAP_TAG_MESSAGE ) {
450 * We read a complete message.
451 * The connection should no longer need this ber.
453 lc->lconn_ber = NULL;
455 if ( tag != LDAP_TAG_MESSAGE ) {
456 if ( tag == LBER_DEFAULT) {
458 Debug( LDAP_DEBUG_CONNS,
459 "ber_get_next failed.\n", 0, 0, 0 );
462 if (errno==EWOULDBLOCK) return -2;
465 if (errno == EAGAIN) return -2;
467 ld->ld_errno = LDAP_SERVER_DOWN;
470 ld->ld_errno = LDAP_LOCAL_ERROR;
475 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
477 ld->ld_errno = LDAP_DECODING_ERROR;
481 /* if it's been abandoned, toss it */
482 if ( ldap_abandoned( ld, id ) ) {
483 Debug( LDAP_DEBUG_ANY, "abandoned ld %p msgid %ld\n",
484 (void *)ld, (long) id, 0);
487 if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
490 return( -2 ); /* continue looking */
493 lr = ldap_find_request_by_msgid( ld, id );
495 Debug( LDAP_DEBUG_ANY,
496 "no request for response on ld %p msgid %ld (tossing)\n",
497 (void *)ld, (long) id, 0 );
500 #ifdef LDAP_CONNECTIONLESS
501 if (LDAP_IS_UDP(ld) && isv2) {
502 ber_scanf(ber, "x{");
506 /* the message type */
507 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
508 ld->ld_errno = LDAP_DECODING_ERROR;
513 Debug( LDAP_DEBUG_TRACE,
514 "read1msg: ld %p msgid %ld message type %s\n",
515 (void *)ld, (long) lr->lr_msgid, ldap_int_msgtype2str( tag ));
519 hadref = simple_request = 0;
520 rc = -2; /* default is to keep looking (no response found) */
521 lr->lr_res_msgtype = tag;
524 * This code figures out if we are going to chase a
525 * referral / search reference, or pass it back to the application
527 v3ref = V3REF_NOREF; /* Assume not a V3 search reference/referral */
528 if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
529 BerElement tmpber = *ber; /* struct copy */
532 if( tag == LDAP_RES_SEARCH_REFERENCE ) {
533 /* This is a V3 search reference */
534 /* Assume we do not chase the reference,
535 * but pass it to application */
537 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
538 (lr->lr_parent != NULL) )
540 /* Get the referral list */
541 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
542 rc = LDAP_DECODING_ERROR;
544 /* Note: refs array is freed by ldap_chase_v3referrals */
545 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
546 1, &lr->lr_res_error, &hadref );
547 if ( refer_cnt > 0 ) {
548 /* sucessfully chased reference */
549 /* If haven't got end search, set chasing referrals */
550 if( lr->lr_status != LDAP_REQST_COMPLETED) {
551 lr->lr_status = LDAP_REQST_CHASINGREFS;
552 Debug( LDAP_DEBUG_TRACE,
553 "read1msg: search ref chased, "
554 "mark request chasing refs, "
559 /* We sucessfully chased the reference */
560 v3ref = V3REF_SUCCESS;
565 /* Check for V3 referral */
567 char *lr_res_error = NULL;
569 #ifdef LDAP_NULL_IS_NULL
570 if ( ber_scanf( &tmpber, "{eAA",/*}*/ &lderr,
571 &lr->lr_res_matched, &lr_res_error )
573 #else /* ! LDAP_NULL_IS_NULL */
574 if ( ber_scanf( &tmpber, "{eaa",/*}*/ &lderr,
575 &lr->lr_res_matched, &lr_res_error )
577 #endif /* ! LDAP_NULL_IS_NULL */
579 if ( lr_res_error != NULL ) {
580 #ifndef LDAP_NULL_IS_NULL
581 if ( lr_res_error[ 0 ] == '\0' ) {
582 LDAP_FREE( lr_res_error );
585 #endif /* ! LDAP_NULL_IS_NULL */
587 if ( lr->lr_res_error != NULL ) {
588 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
589 LDAP_FREE( (char *)lr_res_error );
592 lr->lr_res_error = lr_res_error;
598 /* Check if V3 referral */
599 if ( ber_peek_tag( &tmpber, &len ) == LDAP_TAG_REFERRAL ) {
600 /* We have a V3 referral, assume we cannot chase it */
602 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
603 || (lr->lr_parent != NULL) )
605 /* Assume referral not chased and return it to app */
608 /* Get the referral list */
609 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
610 rc = LDAP_DECODING_ERROR;
611 lr->lr_status = LDAP_REQST_COMPLETED;
612 Debug( LDAP_DEBUG_TRACE,
613 "read1msg: referral decode error, mark request completed, ld %p msgid %d\n",
614 (void *)ld, lr->lr_msgid, 0);
616 /* Chase the referral
617 * Note: refs arrary is freed by ldap_chase_v3referrals
619 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
620 0, &lr->lr_res_error, &hadref );
621 lr->lr_status = LDAP_REQST_COMPLETED;
622 Debug( LDAP_DEBUG_TRACE,
623 "read1msg: referral chased, mark request completed, ld %p msgid %d\n",
624 (void *)ld, lr->lr_msgid, 0);
626 /* Referral successfully chased */
627 v3ref = V3REF_SUCCESS;
633 if( lr->lr_res_matched != NULL ) {
634 LDAP_FREE( lr->lr_res_matched );
635 lr->lr_res_matched = NULL;
637 if( lr->lr_res_error != NULL ) {
638 LDAP_FREE( lr->lr_res_error );
639 lr->lr_res_error = NULL;
645 /* All results that just return a status, i.e. don't return data
646 * go through the following code. This code also chases V2 referrals
647 * and checks if all referrals have been chased.
649 if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref != V3REF_TOAPP) &&
650 (tag != LDAP_RES_INTERMEDIATE ))
652 /* For a v3 search referral/reference, only come here if already chased it */
653 if ( ld->ld_version >= LDAP_VERSION2 &&
654 ( lr->lr_parent != NULL ||
655 LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
657 char *lr_res_error = NULL;
659 tmpber = *ber; /* struct copy */
660 if ( v3ref == V3REF_SUCCESS ) {
661 /* V3 search reference or V3 referral
662 * sucessfully chased. If this message
663 * is a search result, then it has no more
664 * outstanding referrals.
666 if ( tag == LDAP_RES_SEARCH_RESULT )
668 #ifdef LDAP_NULL_IS_NULL
669 } else if ( ber_scanf( &tmpber, "{eAA}", &lderr,
670 &lr->lr_res_matched, &lr_res_error )
672 #else /* ! LDAP_NULL_IS_NULL */
673 } else if ( ber_scanf( &tmpber, "{eaa}", &lderr,
674 &lr->lr_res_matched, &lr_res_error )
676 #endif /* ! LDAP_NULL_IS_NULL */
678 if ( lr_res_error != NULL ) {
679 #ifndef LDAP_NULL_IS_NULL
680 if ( lr_res_error[ 0 ] == '\0' ) {
681 LDAP_FREE( lr_res_error );
683 #endif /* ! LDAP_NULL_IS_NULL */
685 if ( lr->lr_res_error != NULL ) {
686 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
687 LDAP_FREE( (char *)lr_res_error );
689 lr->lr_res_error = lr_res_error;
697 case LDAP_COMPARE_TRUE:
698 case LDAP_COMPARE_FALSE:
702 if ( lr->lr_res_error == NULL
703 || lr->lr_res_error[ 0 ] == '\0' )
708 /* referrals are in error string */
709 refer_cnt = ldap_chase_referrals( ld, lr,
710 &lr->lr_res_error, -1, &hadref );
711 lr->lr_status = LDAP_REQST_COMPLETED;
712 Debug( LDAP_DEBUG_TRACE,
713 "read1msg: V2 referral chased, "
714 "mark request completed, id = %d\n",
715 lr->lr_msgid, 0, 0 );
719 /* save errno, message, and matched string */
720 if ( !hadref || lr->lr_res_error == NULL ) {
721 lr->lr_res_errno = ( lderr ==
722 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
724 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
725 lr->lr_res_errno = ld->ld_errno;
727 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
730 Debug( LDAP_DEBUG_TRACE, "new result: "
733 "res_matched: <%s>\n",
735 lr->lr_res_error ? lr->lr_res_error : "",
736 lr->lr_res_matched ? lr->lr_res_matched : "" );
739 /* in any case, don't leave any lr_res_error 'round */
740 if ( lr_res_error ) {
741 LDAP_FREE( lr_res_error );
745 Debug( LDAP_DEBUG_TRACE,
746 "read1msg: ld %p %d new referrals\n",
747 (void *)ld, refer_cnt, 0 );
749 if ( refer_cnt != 0 ) { /* chasing referrals */
752 if ( refer_cnt < 0 ) {
753 return( -1 ); /* fatal error */
755 lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
757 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
758 /* request without any referrals */
759 simple_request = ( hadref ? 0 : 1 );
761 /* request with referrals or child request */
766 lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
767 Debug( LDAP_DEBUG_TRACE,
768 "read1msg: mark request completed, ld %p msgid %d\n",
769 (void *)ld, lr->lr_msgid, 0);
770 while ( lr->lr_parent != NULL ) {
771 merge_error_info( ld, lr->lr_parent, lr );
774 if ( --lr->lr_outrefcnt > 0 ) {
775 break; /* not completely done yet */
779 /* Check if all requests are finished, lr is now parent */
781 if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
782 for ( tmplr=lr->lr_child;
784 tmplr=tmplr->lr_refnext)
786 if( tmplr->lr_status != LDAP_REQST_COMPLETED) break;
790 /* This is the parent request if the request has referrals */
791 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
795 tag = lr->lr_res_msgtype;
796 Debug( LDAP_DEBUG_ANY, "request done: ld %p msgid %ld\n",
797 (void *)ld, (long) id, 0 );
798 Debug( LDAP_DEBUG_TRACE,
799 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
800 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
801 lr->lr_res_matched ? lr->lr_res_matched : "" );
802 if ( !simple_request ) {
805 if ( build_result_ber( ld, &ber, lr )
807 rc = -1; /* fatal error */
811 #ifdef LDAP_R_COMPILE
812 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
814 ldap_free_request( ld, lr );
815 #ifdef LDAP_R_COMPILE
816 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
821 #ifdef LDAP_R_COMPILE
822 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
824 ldap_free_connection( ld, lc, 0, 1 );
825 #ifdef LDAP_R_COMPILE
826 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
837 /* make a new ldap message */
838 newmsg = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) );
839 if ( newmsg == NULL ) {
840 ld->ld_errno = LDAP_NO_MEMORY;
843 newmsg->lm_msgid = (int)id;
844 newmsg->lm_msgtype = tag;
845 newmsg->lm_ber = ber;
846 newmsg->lm_chain_tail = newmsg;
848 #ifdef LDAP_CONNECTIONLESS
849 /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
850 * the responses are all a sequence wrapped in one message. In
851 * LDAPv3 each response is in its own message. The datagram must
852 * end with a SearchResult. We can't just parse each response in
853 * separate calls to try_read1msg because the header info is only
854 * present at the beginning of the datagram, not at the beginning
855 * of each response. So parse all the responses at once and queue
856 * them up, then pull off the first response to return to the
857 * caller when all parsing is complete.
859 if ( LDAP_IS_UDP(ld) ) {
860 /* If not a result, look for more */
861 if ( tag != LDAP_RES_SEARCH_RESULT ) {
865 /* LDAPv2: dup the current ber, skip past the current
866 * response, and see if there are any more after it.
868 ber = ber_dup( ber );
869 ber_scanf( ber, "x" );
870 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
871 /* There's more - dup the ber buffer so they can all be
872 * individually freed by ldap_msgfree.
875 ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
876 bv.bv_val = LDAP_MALLOC(len);
879 ber_read(ber, bv.bv_val, len);
881 ber_init2(ber, &bv, ld->ld_lberoptions );
885 /* LDAPv3: Just allocate a new ber. Since this is a buffered
886 * datagram, if the sockbuf is readable we still have data
889 ber = ldap_alloc_ber_with_options(ld);
890 if (ber_sockbuf_ctrl(sb, LBER_SB_OPT_DATA_READY, NULL)) ok=1;
892 /* set up response chain */
894 newmsg->lm_next = ld->ld_responses;
895 ld->ld_responses = newmsg;
898 tmp->lm_chain = newmsg;
900 chain_head->lm_chain_tail = newmsg;
902 /* "ok" means there's more to parse */
904 if (isv2) goto nextresp2;
907 /* got to end of datagram without a SearchResult. Free
908 * our dup'd ber, but leave any buffer alone. For v2 case,
909 * the previous response is still using this buffer. For v3,
910 * the new ber has no buffer to free yet.
915 } else if ( moremsgs ) {
916 /* got search result, and we had multiple responses in 1 datagram.
917 * stick the result onto the end of the chain, and then pull the
918 * first response off the head of the chain.
920 tmp->lm_chain = newmsg;
921 chain_head->lm_chain_tail = newmsg;
922 *result = chkResponseList( ld, msgid, all );
923 ld->ld_errno = LDAP_SUCCESS;
924 return( (*result)->lm_msgtype );
927 #endif /* LDAP_CONNECTIONLESS */
929 /* is this the one we're looking for? */
930 if ( msgid == LDAP_RES_ANY || id == msgid ) {
931 if ( all == LDAP_MSG_ONE
932 || (newmsg->lm_msgtype != LDAP_RES_SEARCH_RESULT
933 && newmsg->lm_msgtype != LDAP_RES_SEARCH_ENTRY
934 && newmsg->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
936 ld->ld_errno = LDAP_SUCCESS;
938 } else if ( newmsg->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
939 foundit = 1; /* return the chain later */
944 * if not, we must add it to the list of responses. if
945 * the msgid is already there, it must be part of an existing
950 for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
951 if ( l->lm_msgid == newmsg->lm_msgid )
956 /* not part of an existing search response */
963 newmsg->lm_next = ld->ld_responses;
964 ld->ld_responses = newmsg;
968 Debug( LDAP_DEBUG_TRACE, "adding response ld %p msgid %ld type %ld:\n",
969 (void *)ld, (long) newmsg->lm_msgid, (long) newmsg->lm_msgtype );
971 /* part of a search response - add to end of list of entries */
972 l->lm_chain_tail->lm_chain = newmsg;
973 l->lm_chain_tail = newmsg;
975 /* return the whole chain if that's what we were looking for */
978 ld->ld_responses = l->lm_next;
980 prev->lm_next = l->lm_next;
986 ld->ld_errno = LDAP_SUCCESS;
989 if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
992 return( -2 ); /* continue looking */
997 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
1005 ber = ldap_alloc_ber_with_options( ld );
1008 ld->ld_errno = LDAP_NO_MEMORY;
1012 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
1013 lr->lr_res_msgtype, lr->lr_res_errno,
1014 lr->lr_res_matched ? lr->lr_res_matched : "",
1015 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 )
1017 ld->ld_errno = LDAP_ENCODING_ERROR;
1019 return( LBER_ERROR );
1022 ber_reset( ber, 1 );
1024 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
1025 ld->ld_errno = LDAP_DECODING_ERROR;
1027 return( LBER_ERROR );
1030 if ( ber_get_enum( ber, &along ) == LBER_ERROR ) {
1031 ld->ld_errno = LDAP_DECODING_ERROR;
1033 return( LBER_ERROR );
1036 tag = ber_peek_tag( ber, &len );
1038 if ( tag == LBER_ERROR ) {
1039 ld->ld_errno = LDAP_DECODING_ERROR;
1041 return( LBER_ERROR );
1050 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1053 * Merge error information in "lr" with "parentr" error code and string.
1055 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1056 parentr->lr_res_errno = lr->lr_res_errno;
1057 if ( lr->lr_res_error != NULL ) {
1058 (void)ldap_append_referral( ld, &parentr->lr_res_error,
1061 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1062 parentr->lr_res_errno == LDAP_SUCCESS )
1064 parentr->lr_res_errno = lr->lr_res_errno;
1065 if ( parentr->lr_res_error != NULL ) {
1066 LDAP_FREE( parentr->lr_res_error );
1068 parentr->lr_res_error = lr->lr_res_error;
1069 lr->lr_res_error = NULL;
1070 if ( LDAP_NAME_ERROR( lr->lr_res_errno ) ) {
1071 if ( parentr->lr_res_matched != NULL ) {
1072 LDAP_FREE( parentr->lr_res_matched );
1074 parentr->lr_res_matched = lr->lr_res_matched;
1075 lr->lr_res_matched = NULL;
1079 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
1080 parentr->lr_msgid, 0, 0 );
1081 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1082 parentr->lr_res_errno, parentr->lr_res_error ?
1083 parentr->lr_res_error : "", parentr->lr_res_matched ?
1084 parentr->lr_res_matched : "" );
1090 ldap_msgtype( LDAPMessage *lm )
1092 assert( lm != NULL );
1093 return ( lm != NULL ) ? (int)lm->lm_msgtype : -1;
1098 ldap_msgid( LDAPMessage *lm )
1100 assert( lm != NULL );
1102 return ( lm != NULL ) ? lm->lm_msgid : -1;
1106 char * ldap_int_msgtype2str( ber_tag_t tag )
1109 case LDAP_RES_ADD: return "add";
1110 case LDAP_RES_BIND: return "bind";
1111 case LDAP_RES_COMPARE: return "compare";
1112 case LDAP_RES_DELETE: return "delete";
1113 case LDAP_RES_EXTENDED: return "extended-result";
1114 case LDAP_RES_INTERMEDIATE: return "intermediate";
1115 case LDAP_RES_MODIFY: return "modify";
1116 case LDAP_RES_RENAME: return "rename";
1117 case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1118 case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1119 case LDAP_RES_SEARCH_RESULT: return "search-result";
1125 ldap_msgfree( LDAPMessage *lm )
1130 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1132 for ( ; lm != NULL; lm = next ) {
1133 next = lm->lm_chain;
1134 type = lm->lm_msgtype;
1135 ber_free( lm->lm_ber, 1 );
1136 LDAP_FREE( (char *) lm );
1143 * ldap_msgdelete - delete a message. It returns:
1144 * 0 if the entire message was deleted
1145 * -1 if the message was not found, or only part of it was found
1148 ldap_msgdelete( LDAP *ld, int msgid )
1150 LDAPMessage *lm, *prev;
1153 assert( ld != NULL );
1155 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1158 #ifdef LDAP_R_COMPILE
1159 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1161 for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1162 if ( lm->lm_msgid == msgid )
1171 ld->ld_responses = lm->lm_next;
1173 prev->lm_next = lm->lm_next;
1175 #ifdef LDAP_R_COMPILE
1176 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1178 if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1186 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1189 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1193 if ( ld->ld_abandoned == NULL )
1196 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1197 if ( ld->ld_abandoned[i] == msgid )
1205 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1209 if ( ld->ld_abandoned == NULL )
1212 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1213 if ( ld->ld_abandoned[i] == msgid )
1216 if ( ld->ld_abandoned[i] == -1 )
1219 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1220 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];