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 );
115 LDAP_LOG ( OPERATION, ARGS, "ldap_result msgid %d\n", msgid, 0, 0 );
117 Debug( LDAP_DEBUG_TRACE, "ldap_result msgid %d\n", msgid, 0, 0 );
120 #ifdef LDAP_R_COMPILE
121 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
123 lm = chkResponseList(ld, msgid, all);
126 rc = wait4msg( ld, msgid, all, timeout, result );
129 ld->ld_errno = LDAP_SUCCESS;
132 #ifdef LDAP_R_COMPILE
133 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
144 LDAPMessage *lm, *lastlm, *nextlm;
146 * Look through the list of responses we have received on
147 * this association and see if the response we're interested in
148 * is there. If it is, return it. If not, call wait4msg() to
149 * wait until it arrives or timeout occurs.
153 LDAP_LOG ( OPERATION, ARGS, "ldap_chkResponseList for msgid=%d, all=%d\n",
156 Debug( LDAP_DEBUG_TRACE,
157 "ldap_chkResponseList for msgid=%d, all=%d\n",
161 for ( lm = ld->ld_responses; lm != NULL; lm = nextlm ) {
162 nextlm = lm->lm_next;
164 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
166 LDAP_LOG ( OPERATION, DETAIL1,
167 "ldap_chkResponseList msg abandoned, msgid %d\n", msgid, 0, 0 );
169 Debug( LDAP_DEBUG_TRACE,
170 "ldap_chkResponseList msg abandoned, msgid %d\n",
173 ldap_mark_abandoned( ld, lm->lm_msgid );
175 if ( lastlm == NULL ) {
176 /* Remove first entry in list */
177 ld->ld_responses = lm->lm_next;
179 lastlm->lm_next = nextlm;
187 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
190 if ( all == LDAP_MSG_ONE || msgid == LDAP_RES_UNSOLICITED ) {
194 if ( lm->lm_chain == NULL ) {
195 if ((lm->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
196 (lm->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
197 (lm->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
203 if ((lm->lm_chain_tail->lm_chain->lm_msgtype
204 == LDAP_RES_SEARCH_ENTRY) ||
205 (lm->lm_chain_tail->lm_chain->lm_msgtype
206 == LDAP_RES_SEARCH_REFERENCE) ||
207 (lm->lm_chain_tail->lm_chain->lm_msgtype
208 == LDAP_RES_INTERMEDIATE)) {
211 tmp = lm->lm_chain_tail->lm_chain;
225 /* Found an entry, remove it from the list */
226 if ( lastlm == NULL ) {
227 ld->ld_responses = (all == LDAP_MSG_ONE && lm->lm_chain != NULL
228 ? lm->lm_chain : lm->lm_next);
230 lastlm->lm_next = (all == LDAP_MSG_ONE && lm->lm_chain != NULL
231 ? lm->lm_chain : lm->lm_next);
233 if ( all == LDAP_MSG_ONE && lm->lm_chain != NULL ) {
234 lm->lm_chain->lm_next = lm->lm_next;
243 LDAP_LOG ( OPERATION, RESULTS, "ldap_chkResponseList returns NULL\n",
246 Debug( LDAP_DEBUG_TRACE,
247 "ldap_chkResponseList returns NULL\n", 0, 0, 0);
251 LDAP_LOG ( OPERATION, RESULTS,
252 "ldap_chkResponseList returns msgid %d, type 0x%02lu\n",
253 lm->lm_msgid, (unsigned long) lm->lm_msgtype, 0 );
255 Debug( LDAP_DEBUG_TRACE,
256 "ldap_chkResponseList returns msgid %d, type 0x%02lu\n",
257 lm->lm_msgid, (unsigned long) lm->lm_msgtype, 0);
269 struct timeval *timeout,
270 LDAPMessage **result )
273 struct timeval tv, *tvp;
274 time_t start_time = 0;
276 LDAPConn *lc, *nextlc;
278 assert( ld != NULL );
279 assert( result != NULL );
282 if ( timeout == NULL ) {
284 LDAP_LOG ( OPERATION, ARGS,
285 "wait4msg (infinite timeout), msgid %d\n", msgid, 0, 0 );
287 Debug( LDAP_DEBUG_TRACE, "wait4msg (infinite timeout), msgid %d\n",
292 LDAP_LOG ( OPERATION, ARGS,
293 "wait4msg (timeout %ld sec, %ld usec), msgid %d\n",
294 (long) timeout->tv_sec, (long) timeout->tv_usec, msgid );
296 Debug( LDAP_DEBUG_TRACE, "wait4msg (timeout %ld sec, %ld usec), msgid %d\n",
297 (long) timeout->tv_sec, (long) timeout->tv_usec, msgid );
300 #endif /* LDAP_DEBUG */
302 if ( timeout == NULL ) {
307 start_time = time( NULL );
314 LDAP_LOG ( OPERATION, ARGS,
315 "wait4msg continue, msgid %d, all %d\n", msgid, all, 0 );
317 Debug( LDAP_DEBUG_TRACE, "wait4msg continue, msgid %d, all %d\n",
320 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
321 ldap_dump_connection( ld, ld->ld_conns, 1 );
322 ldap_dump_requests_and_responses( ld );
324 #endif /* LDAP_DEBUG */
326 if( (*result = chkResponseList(ld, msgid, all)) != NULL ) {
327 rc = (*result)->lm_msgtype;
331 for ( lc = ld->ld_conns; lc != NULL; lc = nextlc ) {
332 nextlc = lc->lconn_next;
333 if ( ber_sockbuf_ctrl( lc->lconn_sb,
334 LBER_SB_OPT_DATA_READY, NULL ) ) {
335 rc = try_read1msg( ld, msgid, all, lc->lconn_sb,
343 rc = ldap_int_select( ld, tvp );
347 LDAP_LOG ( OPERATION, ARGS,
348 "wait4msg: ldap_int_select returned -1: errno %d\n",
351 Debug( LDAP_DEBUG_TRACE,
352 "ldap_int_select returned -1: errno %d\n",
358 if ( rc == 0 || ( rc == -1 && (
359 !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
360 || errno != EINTR )))
362 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
368 rc = -2; /* select interrupted: loop */
371 #ifdef LDAP_R_COMPILE
372 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
374 if ( ld->ld_requests &&
375 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
376 ldap_is_write_ready( ld,
377 ld->ld_requests->lr_conn->lconn_sb ) ) {
378 ldap_int_flush_request( ld, ld->ld_requests );
380 #ifdef LDAP_R_COMPILE
381 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
383 for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
385 nextlc = lc->lconn_next;
386 if ( lc->lconn_status ==
387 LDAP_CONNST_CONNECTED &&
388 ldap_is_read_ready( ld,
390 rc = try_read1msg( ld, msgid, all,
391 lc->lconn_sb, &lc, result );
392 if ( lc == NULL ) lc = nextlc;
399 if ( rc == -2 && tvp != NULL ) {
400 tmp_time = time( NULL );
401 if (( tv.tv_sec -= ( tmp_time - start_time )) <= 0 ) {
402 rc = 0; /* timed out */
403 ld->ld_errno = LDAP_TIMEOUT;
408 LDAP_LOG ( OPERATION, DETAIL1,
409 "wait4msg: %ld secs to go\n", (long) tv.tv_sec, 0, 0 );
411 Debug( LDAP_DEBUG_TRACE, "wait4msg: %ld secs to go\n",
412 (long) tv.tv_sec, 0, 0 );
414 start_time = tmp_time;
429 LDAPMessage **result )
432 LDAPMessage *new, *l, *prev, *tmp, *chain_head;
437 LDAPRequest *lr, *tmplr;
440 int rc, refer_cnt, hadref, simple_request;
442 #ifdef LDAP_CONNECTIONLESS
443 int firstmsg = 1, moremsgs = 0, isv2 = 0;
446 * v3ref = flag for V3 referral / search reference
447 * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
451 assert( ld != NULL );
452 assert( lcp != NULL );
453 assert( *lcp != NULL );
456 LDAP_LOG ( OPERATION, ARGS, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
458 Debug( LDAP_DEBUG_TRACE, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
464 if ( lc->lconn_ber == NULL ) {
465 lc->lconn_ber = ldap_alloc_ber_with_options(ld);
467 if( lc->lconn_ber == NULL ) {
473 assert( LBER_VALID (ber) );
475 /* get the next message */
477 #ifdef LDAP_CONNECTIONLESS
478 if ( LDAP_IS_UDP(ld) ) {
479 struct sockaddr from;
480 ber_int_sb_read(sb, &from, sizeof(struct sockaddr));
481 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2=1;
485 tag = ber_get_next( sb, &len, ber );
486 if ( tag == LDAP_TAG_MESSAGE ) {
488 * We read a complete message.
489 * The connection should no longer need this ber.
491 lc->lconn_ber = NULL;
493 if ( tag != LDAP_TAG_MESSAGE ) {
494 if ( tag == LBER_DEFAULT) {
497 LDAP_LOG ( OPERATION, DETAIL1,
498 "read1msg: ber_get_next failed\n", 0, 0, 0 );
500 Debug( LDAP_DEBUG_CONNS,
501 "ber_get_next failed.\n", 0, 0, 0 );
505 if (errno==EWOULDBLOCK) return -2;
508 if (errno == EAGAIN) return -2;
510 ld->ld_errno = LDAP_SERVER_DOWN;
513 ld->ld_errno = LDAP_LOCAL_ERROR;
518 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
520 ld->ld_errno = LDAP_DECODING_ERROR;
524 /* if it's been abandoned, toss it */
525 if ( ldap_abandoned( ld, id ) ) {
527 LDAP_LOG ( OPERATION, DETAIL1, "read1msg: abandoned\n", 0, 0, 0 );
529 Debug( LDAP_DEBUG_ANY, "abandoned\n", 0, 0, 0);
533 if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
536 return( -2 ); /* continue looking */
539 if (( lr = ldap_find_request_by_msgid( ld, id )) == NULL ) {
541 LDAP_LOG ( OPERATION, DETAIL1,
542 "read1msg: no request for response with msgid %ld (tossing)\n",
545 Debug( LDAP_DEBUG_ANY,
546 "no request for response with msgid %ld (tossing)\n",
551 #ifdef LDAP_CONNECTIONLESS
552 if (LDAP_IS_UDP(ld) && isv2) {
553 ber_scanf(ber, "x{");
557 /* the message type */
558 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
559 ld->ld_errno = LDAP_DECODING_ERROR;
565 LDAP_LOG ( OPERATION, DETAIL1,
566 "read1msg: ldap_read: message type %s msgid %ld, original id %ld\n",
567 ldap_int_msgtype2str( tag ),
568 (long) lr->lr_msgid, (long) lr->lr_origid );
570 Debug( LDAP_DEBUG_TRACE,
571 "ldap_read: message type %s msgid %ld, original id %ld\n",
572 ldap_int_msgtype2str( tag ),
573 (long) lr->lr_msgid, (long) lr->lr_origid );
578 hadref = simple_request = 0;
579 rc = -2; /* default is to keep looking (no response found) */
580 lr->lr_res_msgtype = tag;
583 * This code figures out if we are going to chase a
584 * referral / search reference, or pass it back to the application
586 v3ref = 0; /* Assume not a V3 search reference or referral */
587 if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
588 BerElement tmpber = *ber; /* struct copy */
591 if( tag == LDAP_RES_SEARCH_REFERENCE) {
592 /* This is a V3 search reference */
593 /* Assume we do not chase the reference, but pass it to application */
595 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
596 (lr->lr_parent != NULL) )
598 /* Get the referral list */
599 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
600 rc = LDAP_DECODING_ERROR;
602 /* Note: refs arrary is freed by ldap_chase_v3referrals */
603 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
604 1, &lr->lr_res_error, &hadref );
605 if ( refer_cnt > 0 ) { /* sucessfully chased reference */
606 /* If haven't got end search, set chasing referrals */
607 if( lr->lr_status != LDAP_REQST_COMPLETED) {
608 lr->lr_status = LDAP_REQST_CHASINGREFS;
610 LDAP_LOG ( OPERATION, DETAIL1,
611 "read1msg: search ref chased,"
612 "mark request chasing refs, id = %d\n",
613 lr->lr_msgid, 0, 0 );
615 Debug( LDAP_DEBUG_TRACE,
616 "read1msg: search ref chased, mark request chasing refs, id = %d\n",
620 v3ref = 1; /* We sucessfully chased the reference */
625 /* Check for V3 referral */
627 if ( ber_scanf( &tmpber, "{iaa",/*}*/ &lderr,
628 &lr->lr_res_matched, &lr->lr_res_error )
630 /* Check if V3 referral */
631 if( ber_peek_tag( &tmpber, &len) == LDAP_TAG_REFERRAL ) {
632 /* We have a V3 referral, assume we cannot chase it */
634 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
635 || (lr->lr_parent != NULL) )
637 v3ref = -1; /* Assume referral not chased and return it to app */
638 /* Get the referral list */
639 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
640 rc = LDAP_DECODING_ERROR;
641 lr->lr_status = LDAP_REQST_COMPLETED;
643 LDAP_LOG ( OPERATION, DETAIL1,
644 "read1msg: referral decode error,"
645 "mark request completed, id = %d\n",
646 lr->lr_msgid, 0, 0 );
648 Debug( LDAP_DEBUG_TRACE,
649 "read1msg: referral decode error, mark request completed, id = %d\n",
653 /* Chase the referral
654 * Note: refs arrary is freed by ldap_chase_v3referrals
656 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
657 0, &lr->lr_res_error, &hadref );
658 lr->lr_status = LDAP_REQST_COMPLETED;
660 LDAP_LOG ( OPERATION, DETAIL1,
661 "read1msg: referral chased,"
662 "mark request completed, id = %d\n",
663 lr->lr_msgid, 0, 0 );
665 Debug( LDAP_DEBUG_TRACE,
666 "read1msg: referral chased, mark request completed, id = %d\n",
670 v3ref = 1; /* Referral successfully chased */
676 if( lr->lr_res_matched != NULL ) {
677 LDAP_FREE( lr->lr_res_matched );
678 lr->lr_res_matched = NULL;
680 if( lr->lr_res_error != NULL ) {
681 LDAP_FREE( lr->lr_res_error );
682 lr->lr_res_error = NULL;
688 /* All results that just return a status, i.e. don't return data
689 * go through the following code. This code also chases V2 referrals
690 * and checks if all referrals have been chased.
692 if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref > -1) &&
693 (tag != LDAP_RES_INTERMEDIATE ))
695 /* For a v3 search referral/reference, only come here if already chased it */
696 if ( ld->ld_version >= LDAP_VERSION2 &&
697 ( lr->lr_parent != NULL ||
698 LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
700 tmpber = *ber; /* struct copy */
702 /* V3 search reference or V3 referral
703 * sucessfully chased. If this message
704 * is a search result, then it has no more
705 * outstanding referrals.
707 if ( tag == LDAP_RES_SEARCH_RESULT )
709 } else if ( ber_scanf( &tmpber, "{iaa}", &lderr,
710 &lr->lr_res_matched, &lr->lr_res_error )
712 if ( lderr != LDAP_SUCCESS ) {
713 /* referrals are in error string */
714 refer_cnt = ldap_chase_referrals( ld, lr,
715 &lr->lr_res_error, -1, &hadref );
716 lr->lr_status = LDAP_REQST_COMPLETED;
718 LDAP_LOG ( OPERATION, DETAIL1,
719 "read1msg: V2 referral chased,"
720 "mark request completed, id = %d\n",
721 lr->lr_msgid, 0, 0 );
723 Debug( LDAP_DEBUG_TRACE,
724 "read1msg: V2 referral chased, mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
728 /* save errno, message, and matched string */
729 if ( !hadref || lr->lr_res_error == NULL ) {
730 lr->lr_res_errno = ( lderr ==
731 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
733 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
734 lr->lr_res_errno = ld->ld_errno;
736 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
739 LDAP_LOG ( OPERATION, DETAIL1,
740 "read1msg: new result: res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
741 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
742 lr->lr_res_matched ? lr->lr_res_matched : "" );
744 Debug( LDAP_DEBUG_TRACE,
745 "new result: res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
746 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
747 lr->lr_res_matched ? lr->lr_res_matched : "" );
753 LDAP_LOG ( OPERATION, DETAIL1, "read1msg: %d new referrals\n",
756 Debug( LDAP_DEBUG_TRACE,
757 "read1msg: %d new referrals\n", refer_cnt, 0, 0 );
760 if ( refer_cnt != 0 ) { /* chasing referrals */
763 if ( refer_cnt < 0 ) {
764 return( -1 ); /* fatal error */
766 lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
768 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
769 /* request without any referrals */
770 simple_request = ( hadref ? 0 : 1 );
772 /* request with referrals or child request */
777 lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
779 LDAP_LOG ( OPERATION, DETAIL1,
780 "read1msg: mark request completed, id = %d\n",
781 lr->lr_msgid, 0, 0 );
783 Debug( LDAP_DEBUG_TRACE,
784 "read1msg: mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
786 while ( lr->lr_parent != NULL ) {
787 merge_error_info( ld, lr->lr_parent, lr );
790 if ( --lr->lr_outrefcnt > 0 ) {
791 break; /* not completely done yet */
795 /* Check if all requests are finished, lr is now parent */
797 if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
798 for(tmplr=lr->lr_child; tmplr != NULL; tmplr=tmplr->lr_refnext) {
799 if( tmplr->lr_status != LDAP_REQST_COMPLETED) {
805 /* This is the parent request if the request has referrals */
806 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL && tmplr == NULL ) {
808 tag = lr->lr_res_msgtype;
810 LDAP_LOG ( OPERATION, DETAIL1,
811 "read1msg: request %ld done\n", (long) id, 0, 0 );
812 LDAP_LOG ( OPERATION, DETAIL1,
813 "read1msg: res_errno: %d,res_error: <%s>, res_matched: <%s>\n",
814 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
815 lr->lr_res_matched ? lr->lr_res_matched : "" );
817 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
819 Debug( LDAP_DEBUG_TRACE,
820 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
821 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
822 lr->lr_res_matched ? lr->lr_res_matched : "" );
824 if ( !simple_request ) {
827 if ( build_result_ber( ld, &ber, lr )
829 rc = -1; /* fatal error */
833 ldap_free_request( ld, lr );
837 ldap_free_connection( ld, lc, 0, 1 );
847 /* make a new ldap message */
848 if ( (new = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) ))
850 ld->ld_errno = LDAP_NO_MEMORY;
853 new->lm_msgid = (int)id;
854 new->lm_msgtype = tag;
857 #ifdef LDAP_CONNECTIONLESS
858 /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
859 * the responses are all a sequence wrapped in one message. In
860 * LDAPv3 each response is in its own message. The datagram must
861 * end with a SearchResult. We can't just parse each response in
862 * separate calls to try_read1msg because the header info is only
863 * present at the beginning of the datagram, not at the beginning
864 * of each response. So parse all the responses at once and queue
865 * them up, then pull off the first response to return to the
866 * caller when all parsing is complete.
868 if ( LDAP_IS_UDP(ld) ) {
869 /* If not a result, look for more */
870 if ( tag != LDAP_RES_SEARCH_RESULT ) {
874 /* LDAPv2: dup the current ber, skip past the current
875 * response, and see if there are any more after it.
877 ber = ber_dup( ber );
878 ber_scanf( ber, "x" );
879 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
880 /* There's more - dup the ber buffer so they can all be
881 * individually freed by ldap_msgfree.
884 ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
885 bv.bv_val = LDAP_MALLOC(len);
888 ber_read(ber, bv.bv_val, len);
890 ber_init2(ber, &bv, ld->ld_lberoptions );
894 /* LDAPv3: Just allocate a new ber. Since this is a buffered
895 * datagram, if the sockbuf is readable we still have data
898 ber = ldap_alloc_ber_with_options(ld);
899 if (ber_sockbuf_ctrl(sb, LBER_SB_OPT_DATA_READY, NULL)) ok=1;
901 /* set up response chain */
904 new->lm_next = ld->ld_responses;
905 ld->ld_responses = new;
906 new->lm_chain_tail = new;
910 chain_head->lm_chain_tail = tmp;
913 /* "ok" means there's more to parse */
915 if (isv2) goto nextresp2;
918 /* got to end of datagram without a SearchResult. Free
919 * our dup'd ber, but leave any buffer alone. For v2 case,
920 * the previous response is still using this buffer. For v3,
921 * the new ber has no buffer to free yet.
926 } else if ( moremsgs ) {
927 /* got search result, and we had multiple responses in 1 datagram.
928 * stick the result onto the end of the chain, and then pull the
929 * first response off the head of the chain.
932 chain_head->lm_chain_tail = tmp;
933 *result = chkResponseList( ld, msgid, all );
934 ld->ld_errno = LDAP_SUCCESS;
935 return( (*result)->lm_msgtype );
940 /* is this the one we're looking for? */
941 if ( msgid == LDAP_RES_ANY || id == msgid ) {
942 if ( all == LDAP_MSG_ONE
943 || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
944 && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY
945 && new->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
947 ld->ld_errno = LDAP_SUCCESS;
949 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
950 foundit = 1; /* return the chain later */
955 * if not, we must add it to the list of responses. if
956 * the msgid is already there, it must be part of an existing
961 for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
962 if ( l->lm_msgid == new->lm_msgid )
967 /* not part of an existing search response */
974 new->lm_next = ld->ld_responses;
975 ld->ld_responses = new;
976 new->lm_chain_tail = new;
981 LDAP_LOG ( OPERATION, DETAIL1,
982 "read1msg: adding response id %ld type %ld\n",
983 (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
985 Debug( LDAP_DEBUG_TRACE, "adding response id %ld type %ld:\n",
986 (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
989 /* part of a search response - add to end of list of entries */
990 if (l->lm_chain == NULL) {
991 if ((l->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
992 (l->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
993 (l->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
994 /* do not advance lm_chain_tail in this case */
997 /*FIXME: ldap_msgfree( l );*/
999 l->lm_chain_tail = new;
1002 if ((l->lm_chain_tail->lm_chain->lm_msgtype
1003 == LDAP_RES_SEARCH_ENTRY) ||
1004 (l->lm_chain_tail->lm_chain->lm_msgtype
1005 == LDAP_RES_SEARCH_REFERENCE) ||
1006 (l->lm_chain_tail->lm_chain->lm_msgtype
1007 == LDAP_RES_INTERMEDIATE)) {
1008 l->lm_chain_tail->lm_chain->lm_chain = new;
1009 l->lm_chain_tail = l->lm_chain_tail->lm_chain;
1011 /*FIXME: ldap_msgfree( l->lm_chain_tail->lm_chain );*/
1012 l->lm_chain_tail->lm_chain = new;
1016 /* return the whole chain if that's what we were looking for */
1019 ld->ld_responses = l->lm_next;
1021 prev->lm_next = l->lm_next;
1027 ld->ld_errno = LDAP_SUCCESS;
1030 if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
1033 return( -2 ); /* continue looking */
1038 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
1046 ber = ldap_alloc_ber_with_options( ld );
1049 ld->ld_errno = LDAP_NO_MEMORY;
1053 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
1054 lr->lr_res_msgtype, lr->lr_res_errno,
1055 lr->lr_res_matched ? lr->lr_res_matched : "",
1056 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
1058 ld->ld_errno = LDAP_ENCODING_ERROR;
1060 return( LBER_ERROR );
1063 ber_reset( ber, 1 );
1065 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
1066 ld->ld_errno = LDAP_DECODING_ERROR;
1068 return( LBER_ERROR );
1071 if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
1072 ld->ld_errno = LDAP_DECODING_ERROR;
1074 return( LBER_ERROR );
1077 tag = ber_peek_tag( ber, &len );
1079 if ( tag == LBER_ERROR ) {
1080 ld->ld_errno = LDAP_DECODING_ERROR;
1082 return( LBER_ERROR );
1091 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1094 * Merge error information in "lr" with "parentr" error code and string.
1096 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1097 parentr->lr_res_errno = lr->lr_res_errno;
1098 if ( lr->lr_res_error != NULL ) {
1099 (void)ldap_append_referral( ld, &parentr->lr_res_error,
1102 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1103 parentr->lr_res_errno == LDAP_SUCCESS ) {
1104 parentr->lr_res_errno = lr->lr_res_errno;
1105 if ( parentr->lr_res_error != NULL ) {
1106 LDAP_FREE( parentr->lr_res_error );
1108 parentr->lr_res_error = lr->lr_res_error;
1109 lr->lr_res_error = NULL;
1110 if ( LDAP_NAME_ERROR( lr->lr_res_errno )) {
1111 if ( parentr->lr_res_matched != NULL ) {
1112 LDAP_FREE( parentr->lr_res_matched );
1114 parentr->lr_res_matched = lr->lr_res_matched;
1115 lr->lr_res_matched = NULL;
1120 LDAP_LOG( OPERATION, DETAIL1, "merged parent (id %d) error info: ",
1121 parentr->lr_msgid, 0, 0 );
1122 LDAP_LOG( OPERATION, DETAIL1, "result errno %d, error <%s>, matched <%s>\n",
1123 parentr->lr_res_errno, parentr->lr_res_error ?
1124 parentr->lr_res_error : "", parentr->lr_res_matched ?
1125 parentr->lr_res_matched : "" );
1127 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
1128 parentr->lr_msgid, 0, 0 );
1129 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1130 parentr->lr_res_errno, parentr->lr_res_error ?
1131 parentr->lr_res_error : "", parentr->lr_res_matched ?
1132 parentr->lr_res_matched : "" );
1139 ldap_msgtype( LDAPMessage *lm )
1141 assert( lm != NULL );
1142 return ( lm != NULL ) ? lm->lm_msgtype : -1;
1147 ldap_msgid( LDAPMessage *lm )
1149 assert( lm != NULL );
1151 return ( lm != NULL ) ? lm->lm_msgid : -1;
1155 char * ldap_int_msgtype2str( ber_tag_t tag )
1158 case LDAP_RES_ADD: return "add";
1159 case LDAP_RES_BIND: return "bind";
1160 case LDAP_RES_COMPARE: return "compare";
1161 case LDAP_RES_DELETE: return "delete";
1162 case LDAP_RES_EXTENDED: return "extended-result";
1163 case LDAP_RES_INTERMEDIATE: return "intermediate";
1164 case LDAP_RES_MODIFY: return "modify";
1165 case LDAP_RES_RENAME: return "rename";
1166 case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1167 case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1168 case LDAP_RES_SEARCH_RESULT: return "search-result";
1174 ldap_msgfree( LDAPMessage *lm )
1180 LDAP_LOG ( OPERATION, ENTRY, "ldap_msgfree\n", 0, 0, 0 );
1182 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1185 for ( ; lm != NULL; lm = next ) {
1186 next = lm->lm_chain;
1187 type = lm->lm_msgtype;
1188 ber_free( lm->lm_ber, 1 );
1189 LDAP_FREE( (char *) lm );
1196 * ldap_msgdelete - delete a message. It returns:
1197 * 0 if the entire message was deleted
1198 * -1 if the message was not found, or only part of it was found
1201 ldap_msgdelete( LDAP *ld, int msgid )
1203 LDAPMessage *lm, *prev;
1206 assert( ld != NULL );
1209 LDAP_LOG ( OPERATION, ENTRY, "ldap_msgdelete\n", 0, 0, 0 );
1211 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1215 #ifdef LDAP_R_COMPILE
1216 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1218 for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1219 if ( lm->lm_msgid == msgid )
1228 ld->ld_responses = lm->lm_next;
1230 prev->lm_next = lm->lm_next;
1232 #ifdef LDAP_R_COMPILE
1233 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1235 if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1243 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1246 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1250 if ( ld->ld_abandoned == NULL )
1253 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1254 if ( ld->ld_abandoned[i] == msgid )
1262 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1266 if ( ld->ld_abandoned == NULL )
1269 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1270 if ( ld->ld_abandoned[i] == msgid )
1273 if ( ld->ld_abandoned[i] == -1 )
1276 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1277 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];