1 /* result.c - wait for an ldap result */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2006 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, 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));
81 #define LDAP_MSG_X_KEEP_LOOKING (-2)
85 * ldap_result - wait for an ldap result response to a message from the
86 * ldap server. If msgid is LDAP_RES_ANY (-1), any message will be
87 * accepted. If msgid is LDAP_RES_UNSOLICITED (0), any unsolicited
88 * message is accepted. Otherwise ldap_result will wait for a response
89 * with msgid. If all is LDAP_MSG_ONE (0) the first message with id
90 * msgid will be accepted, otherwise, ldap_result will wait for all
91 * responses with id msgid and then return a pointer to the entire list
92 * of messages. In general, this is only useful for search responses,
93 * which can be of three message types (zero or more entries, zero or
94 * search references, followed by an ldap result). An extension to
95 * LDAPv3 allows partial extended responses to be returned in response
96 * to any request. The type of the first message received is returned.
97 * When waiting, any messages that have been abandoned are discarded.
100 * ldap_result( s, msgid, all, timeout, result )
107 struct timeval *timeout,
108 LDAPMessage **result )
113 assert( ld != NULL );
114 assert( result != NULL );
116 Debug( LDAP_DEBUG_TRACE, "ldap_result ld %p msgid %d\n", (void *)ld, msgid, 0 );
118 #ifdef LDAP_R_COMPILE
119 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
121 lm = chkResponseList(ld, msgid, all);
124 rc = wait4msg( ld, msgid, all, timeout, result );
127 ld->ld_errno = LDAP_SUCCESS;
130 #ifdef LDAP_R_COMPILE
131 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
142 LDAPMessage *lm, **lastlm, *nextlm;
144 * Look through the list of responses we have received on
145 * this association and see if the response we're interested in
146 * is there. If it is, return it. If not, call wait4msg() to
147 * wait until it arrives or timeout occurs.
150 Debug( LDAP_DEBUG_TRACE,
151 "ldap_chkResponseList ld %p msgid %d all %d\n",
152 (void *)ld, msgid, all );
153 lastlm = &ld->ld_responses;
154 for ( lm = ld->ld_responses; lm != NULL; lm = nextlm ) {
155 nextlm = lm->lm_next;
157 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
158 Debug( LDAP_DEBUG_TRACE,
159 "ldap_chkResponseList msg abandoned, msgid %d\n",
161 ldap_mark_abandoned( ld, lm->lm_msgid );
163 /* Remove this entry from list */
171 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
174 if ( all == LDAP_MSG_ONE || all == LDAP_MSG_RECEIVED ||
175 msgid == LDAP_RES_UNSOLICITED ) {
179 tmp = lm->lm_chain_tail;
180 if ((tmp->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
181 (tmp->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
182 (tmp->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
192 lastlm = &lm->lm_next;
196 /* Found an entry, remove it from the list */
197 if ( all == LDAP_MSG_ONE && lm->lm_chain != NULL ) {
198 *lastlm = lm->lm_chain;
199 lm->lm_chain->lm_next = lm->lm_next;
200 lm->lm_chain->lm_chain_tail = ( lm->lm_chain_tail != lm ) ? lm->lm_chain_tail : lm->lm_chain;
202 lm->lm_chain_tail = NULL;
204 *lastlm = lm->lm_next;
211 Debug( LDAP_DEBUG_TRACE,
212 "ldap_chkResponseList returns ld %p NULL\n", (void *)ld, 0, 0);
214 Debug( LDAP_DEBUG_TRACE,
215 "ldap_chkResponseList returns ld %p msgid %d, type 0x%02lu\n",
216 (void *)ld, lm->lm_msgid, (unsigned long) lm->lm_msgtype);
227 struct timeval *timeout,
228 LDAPMessage **result )
231 struct timeval tv = { 0 },
234 time_t start_time = 0;
238 assert( ld != NULL );
239 assert( result != NULL );
242 if ( timeout == NULL ) {
243 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (infinite timeout)\n",
244 (void *)ld, msgid, 0 );
246 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (timeout %ld usec)\n",
247 (void *)ld, msgid, (long)timeout->tv_sec * 1000000 + timeout->tv_usec );
249 #endif /* LDAP_DEBUG */
251 if ( timeout == NULL ) {
257 start_time = time( NULL );
260 rc = LDAP_MSG_X_KEEP_LOOKING;
261 while ( rc == LDAP_MSG_X_KEEP_LOOKING ) {
263 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
264 Debug( LDAP_DEBUG_TRACE, "wait4msg continue ld %p msgid %d all %d\n",
265 (void *)ld, msgid, all );
266 ldap_dump_connection( ld, ld->ld_conns, 1 );
267 ldap_dump_requests_and_responses( ld );
269 #endif /* LDAP_DEBUG */
271 if ( (*result = chkResponseList(ld, msgid, all)) != NULL ) {
272 rc = (*result)->lm_msgtype;
277 #ifdef LDAP_R_COMPILE
278 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
280 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
281 if ( ber_sockbuf_ctrl( lc->lconn_sb,
282 LBER_SB_OPT_DATA_READY, NULL ) ) {
283 #ifdef LDAP_R_COMPILE
284 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
286 rc = try_read1msg( ld, msgid, all, &lc, result );
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",
304 sock_errno(), 0, 0 );
308 if ( rc == 0 || ( rc == -1 && (
309 !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
310 || sock_errno() != EINTR )))
312 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
318 rc = LDAP_MSG_X_KEEP_LOOKING; /* select interrupted: loop */
320 rc = LDAP_MSG_X_KEEP_LOOKING;
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;
336 rc == LDAP_MSG_X_KEEP_LOOKING && lc != NULL; )
338 if ( lc->lconn_status == LDAP_CONNST_CONNECTED &&
339 ldap_is_read_ready( ld, lc->lconn_sb ))
341 #ifdef LDAP_R_COMPILE
342 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
344 rc = try_read1msg( ld, msgid, all, &lc, result );
345 #ifdef LDAP_R_COMPILE
346 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
349 /* if lc gets free()'d,
350 * there's no guarantee
351 * lc->lconn_next is still
352 * sane; better restart
356 /* don't get to next conn! */
364 #ifdef LDAP_R_COMPILE
365 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
371 if ( rc == LDAP_MSG_X_KEEP_LOOKING && tvp != NULL ) {
372 tmp_time = time( NULL );
373 tv0.tv_sec -= ( tmp_time - start_time );
374 if ( tv0.tv_sec <= 0 ) {
375 rc = 0; /* timed out */
376 ld->ld_errno = LDAP_TIMEOUT;
379 tv.tv_sec = tv0.tv_sec;
381 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p %ld secs to go\n",
382 (void *)ld, (long) tv.tv_sec, 0 );
383 start_time = tmp_time;
397 LDAPMessage **result )
400 LDAPMessage *newmsg, *l, *prev;
405 LDAPRequest *lr, *tmplr;
408 int rc, refer_cnt, hadref, simple_request;
411 #ifdef LDAP_CONNECTIONLESS
412 LDAPMessage *tmp = NULL, *chain_head = NULL;
413 int moremsgs = 0, isv2 = 0;
417 * v3ref = flag for V3 referral / search reference
418 * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
426 assert( ld != NULL );
427 assert( lcp != NULL );
428 assert( *lcp != NULL );
430 Debug( LDAP_DEBUG_TRACE, "read1msg: ld %p msgid %d all %d\n",
431 (void *)ld, msgid, all );
436 if ( lc->lconn_ber == NULL ) {
437 lc->lconn_ber = ldap_alloc_ber_with_options(ld);
439 if( lc->lconn_ber == NULL ) {
445 assert( LBER_VALID (ber) );
447 /* get the next message */
449 #ifdef LDAP_CONNECTIONLESS
450 if ( LDAP_IS_UDP(ld) ) {
451 struct sockaddr from;
452 ber_int_sb_read( lc->lconn_sb, &from, sizeof(struct sockaddr) );
453 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2=1;
457 tag = ber_get_next( lc->lconn_sb, &len, ber );
458 if ( tag == LDAP_TAG_MESSAGE ) {
460 * We read a complete message.
461 * The connection should no longer need this ber.
463 lc->lconn_ber = NULL;
465 if ( tag != LDAP_TAG_MESSAGE ) {
466 if ( tag == LBER_DEFAULT) {
468 Debug( LDAP_DEBUG_CONNS,
469 "ber_get_next failed.\n", 0, 0, 0 );
472 if ( sock_errno() == EWOULDBLOCK ) return LDAP_MSG_X_KEEP_LOOKING;
475 if ( sock_errno() == EAGAIN ) return LDAP_MSG_X_KEEP_LOOKING;
477 ld->ld_errno = LDAP_SERVER_DOWN;
480 ld->ld_errno = LDAP_LOCAL_ERROR;
485 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
487 ld->ld_errno = LDAP_DECODING_ERROR;
491 /* if it's been abandoned, toss it */
492 if ( ldap_abandoned( ld, id ) ) {
493 Debug( LDAP_DEBUG_ANY, "abandoned ld %p msgid %ld\n",
494 (void *)ld, (long) id, 0);
497 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
500 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
503 lr = ldap_find_request_by_msgid( ld, id );
505 Debug( LDAP_DEBUG_ANY,
506 "no request for response on ld %p msgid %ld (tossing)\n",
507 (void *)ld, (long) id, 0 );
510 #ifdef LDAP_CONNECTIONLESS
511 if (LDAP_IS_UDP(ld) && isv2) {
512 ber_scanf(ber, "x{");
516 /* the message type */
517 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
518 ld->ld_errno = LDAP_DECODING_ERROR;
523 Debug( LDAP_DEBUG_TRACE,
524 "read1msg: ld %p msgid %ld message type %s\n",
525 (void *)ld, (long) lr->lr_msgid, ldap_int_msgtype2str( tag ));
529 hadref = simple_request = 0;
530 rc = LDAP_MSG_X_KEEP_LOOKING; /* default is to keep looking (no response found) */
531 lr->lr_res_msgtype = tag;
534 * This code figures out if we are going to chase a
535 * referral / search reference, or pass it back to the application
537 v3ref = V3REF_NOREF; /* Assume not a V3 search reference/referral */
538 if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
539 BerElement tmpber = *ber; /* struct copy */
542 if( tag == LDAP_RES_SEARCH_REFERENCE ) {
543 /* This is a V3 search reference */
544 /* Assume we do not chase the reference,
545 * but pass it to application */
547 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
548 (lr->lr_parent != NULL) )
550 /* Get the referral list */
551 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
552 rc = LDAP_DECODING_ERROR;
554 /* Note: refs array is freed by ldap_chase_v3referrals */
555 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
556 1, &lr->lr_res_error, &hadref );
557 if ( refer_cnt > 0 ) {
558 /* sucessfully chased reference */
559 /* If haven't got end search, set chasing referrals */
560 if( lr->lr_status != LDAP_REQST_COMPLETED) {
561 lr->lr_status = LDAP_REQST_CHASINGREFS;
562 Debug( LDAP_DEBUG_TRACE,
563 "read1msg: search ref chased, "
564 "mark request chasing refs, "
569 /* We sucessfully chased the reference */
570 v3ref = V3REF_SUCCESS;
575 /* Check for V3 referral */
577 char *lr_res_error = NULL;
579 #ifdef LDAP_NULL_IS_NULL
580 if ( ber_scanf( &tmpber, "{eAA",/*}*/ &lderr,
581 &lr->lr_res_matched, &lr_res_error )
583 #else /* ! LDAP_NULL_IS_NULL */
584 if ( ber_scanf( &tmpber, "{eaa",/*}*/ &lderr,
585 &lr->lr_res_matched, &lr_res_error )
587 #endif /* ! LDAP_NULL_IS_NULL */
589 if ( lr_res_error != NULL ) {
590 #ifndef LDAP_NULL_IS_NULL
591 if ( lr_res_error[ 0 ] == '\0' ) {
592 LDAP_FREE( lr_res_error );
595 #endif /* ! LDAP_NULL_IS_NULL */
597 if ( lr->lr_res_error != NULL ) {
598 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
599 LDAP_FREE( (char *)lr_res_error );
602 lr->lr_res_error = lr_res_error;
608 /* Check if V3 referral */
609 if ( ber_peek_tag( &tmpber, &len ) == LDAP_TAG_REFERRAL ) {
610 /* We have a V3 referral, assume we cannot chase it */
612 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
613 || (lr->lr_parent != NULL) )
615 /* Assume referral not chased and return it to app */
618 /* Get the referral list */
619 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
620 rc = LDAP_DECODING_ERROR;
621 lr->lr_status = LDAP_REQST_COMPLETED;
622 Debug( LDAP_DEBUG_TRACE,
623 "read1msg: referral decode error, mark request completed, ld %p msgid %d\n",
624 (void *)ld, lr->lr_msgid, 0);
626 /* Chase the referral
627 * Note: refs arrary is freed by ldap_chase_v3referrals
629 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
630 0, &lr->lr_res_error, &hadref );
631 lr->lr_status = LDAP_REQST_COMPLETED;
632 Debug( LDAP_DEBUG_TRACE,
633 "read1msg: referral chased, mark request completed, ld %p msgid %d\n",
634 (void *)ld, lr->lr_msgid, 0);
636 /* Referral successfully chased */
637 v3ref = V3REF_SUCCESS;
643 if( lr->lr_res_matched != NULL ) {
644 LDAP_FREE( lr->lr_res_matched );
645 lr->lr_res_matched = NULL;
647 if( lr->lr_res_error != NULL ) {
648 LDAP_FREE( lr->lr_res_error );
649 lr->lr_res_error = NULL;
655 /* All results that just return a status, i.e. don't return data
656 * go through the following code. This code also chases V2 referrals
657 * and checks if all referrals have been chased.
659 if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref != V3REF_TOAPP) &&
660 (tag != LDAP_RES_INTERMEDIATE ))
662 /* For a v3 search referral/reference, only come here if already chased it */
663 if ( ld->ld_version >= LDAP_VERSION2 &&
664 ( lr->lr_parent != NULL ||
665 LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
667 char *lr_res_error = NULL;
669 tmpber = *ber; /* struct copy */
670 if ( v3ref == V3REF_SUCCESS ) {
671 /* V3 search reference or V3 referral
672 * sucessfully chased. If this message
673 * is a search result, then it has no more
674 * outstanding referrals.
676 if ( tag == LDAP_RES_SEARCH_RESULT )
678 #ifdef LDAP_NULL_IS_NULL
679 } else if ( ber_scanf( &tmpber, "{eAA}", &lderr,
680 &lr->lr_res_matched, &lr_res_error )
682 #else /* ! LDAP_NULL_IS_NULL */
683 } else if ( ber_scanf( &tmpber, "{eaa}", &lderr,
684 &lr->lr_res_matched, &lr_res_error )
686 #endif /* ! LDAP_NULL_IS_NULL */
688 if ( lr_res_error != NULL ) {
689 #ifndef LDAP_NULL_IS_NULL
690 if ( lr_res_error[ 0 ] == '\0' ) {
691 LDAP_FREE( lr_res_error );
693 #endif /* ! LDAP_NULL_IS_NULL */
695 if ( lr->lr_res_error != NULL ) {
696 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
697 LDAP_FREE( (char *)lr_res_error );
699 lr->lr_res_error = lr_res_error;
707 case LDAP_COMPARE_TRUE:
708 case LDAP_COMPARE_FALSE:
712 if ( lr->lr_res_error == NULL
713 || lr->lr_res_error[ 0 ] == '\0' )
718 /* referrals are in error string */
719 refer_cnt = ldap_chase_referrals( ld, lr,
720 &lr->lr_res_error, -1, &hadref );
721 lr->lr_status = LDAP_REQST_COMPLETED;
722 Debug( LDAP_DEBUG_TRACE,
723 "read1msg: V2 referral chased, "
724 "mark request completed, id = %d\n",
725 lr->lr_msgid, 0, 0 );
729 /* save errno, message, and matched string */
730 if ( !hadref || lr->lr_res_error == NULL ) {
731 lr->lr_res_errno = ( lderr ==
732 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
734 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
735 lr->lr_res_errno = ld->ld_errno;
737 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
740 Debug( LDAP_DEBUG_TRACE, "new result: "
743 "res_matched: <%s>\n",
745 lr->lr_res_error ? lr->lr_res_error : "",
746 lr->lr_res_matched ? lr->lr_res_matched : "" );
749 /* in any case, don't leave any lr_res_error 'round */
750 if ( lr_res_error ) {
751 LDAP_FREE( lr_res_error );
755 Debug( LDAP_DEBUG_TRACE,
756 "read1msg: ld %p %d new referrals\n",
757 (void *)ld, refer_cnt, 0 );
759 if ( refer_cnt != 0 ) { /* chasing referrals */
762 if ( refer_cnt < 0 ) {
763 return( -1 ); /* fatal error */
765 lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
767 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
768 /* request without any referrals */
769 simple_request = ( hadref ? 0 : 1 );
771 /* request with referrals or child request */
776 lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
777 Debug( LDAP_DEBUG_TRACE,
778 "read1msg: mark request completed, ld %p msgid %d\n",
779 (void *)ld, lr->lr_msgid, 0);
780 while ( lr->lr_parent != NULL ) {
781 merge_error_info( ld, lr->lr_parent, lr );
784 if ( --lr->lr_outrefcnt > 0 ) {
785 break; /* not completely done yet */
789 /* Check if all requests are finished, lr is now parent */
791 if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
792 for ( tmplr=lr->lr_child;
794 tmplr=tmplr->lr_refnext)
796 if( tmplr->lr_status != LDAP_REQST_COMPLETED) break;
800 /* This is the parent request if the request has referrals */
801 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
805 tag = lr->lr_res_msgtype;
806 Debug( LDAP_DEBUG_ANY, "request done: ld %p msgid %ld\n",
807 (void *)ld, (long) id, 0 );
808 Debug( LDAP_DEBUG_TRACE,
809 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
810 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
811 lr->lr_res_matched ? lr->lr_res_matched : "" );
812 if ( !simple_request ) {
815 if ( build_result_ber( ld, &ber, lr )
817 rc = -1; /* fatal error */
821 #ifdef LDAP_R_COMPILE
822 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
824 ldap_free_request( ld, lr );
825 #ifdef LDAP_R_COMPILE
826 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
831 #ifdef LDAP_R_COMPILE
832 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
834 ldap_free_connection( ld, lc, 0, 1 );
835 #ifdef LDAP_R_COMPILE
836 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
847 /* make a new ldap message */
848 newmsg = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) );
849 if ( newmsg == NULL ) {
850 ld->ld_errno = LDAP_NO_MEMORY;
853 newmsg->lm_msgid = (int)id;
854 newmsg->lm_msgtype = tag;
855 newmsg->lm_ber = ber;
856 newmsg->lm_chain_tail = newmsg;
858 #ifdef LDAP_CONNECTIONLESS
859 /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
860 * the responses are all a sequence wrapped in one message. In
861 * LDAPv3 each response is in its own message. The datagram must
862 * end with a SearchResult. We can't just parse each response in
863 * separate calls to try_read1msg because the header info is only
864 * present at the beginning of the datagram, not at the beginning
865 * of each response. So parse all the responses at once and queue
866 * them up, then pull off the first response to return to the
867 * caller when all parsing is complete.
869 if ( LDAP_IS_UDP(ld) ) {
870 /* If not a result, look for more */
871 if ( tag != LDAP_RES_SEARCH_RESULT ) {
875 /* LDAPv2: dup the current ber, skip past the current
876 * response, and see if there are any more after it.
878 ber = ber_dup( ber );
879 ber_scanf( ber, "x" );
880 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
881 /* There's more - dup the ber buffer so they can all be
882 * individually freed by ldap_msgfree.
885 ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
886 bv.bv_val = LDAP_MALLOC(len);
889 ber_read(ber, bv.bv_val, len);
891 ber_init2(ber, &bv, ld->ld_lberoptions );
895 /* LDAPv3: Just allocate a new ber. Since this is a buffered
896 * datagram, if the sockbuf is readable we still have data
899 ber = ldap_alloc_ber_with_options( ld );
900 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) ok = 1;
902 /* set up response chain */
904 newmsg->lm_next = ld->ld_responses;
905 ld->ld_responses = newmsg;
908 tmp->lm_chain = newmsg;
910 chain_head->lm_chain_tail = newmsg;
912 /* "ok" means there's more to parse */
914 if (isv2) goto nextresp2;
917 /* got to end of datagram without a SearchResult. Free
918 * our dup'd ber, but leave any buffer alone. For v2 case,
919 * the previous response is still using this buffer. For v3,
920 * the new ber has no buffer to free yet.
925 } else if ( moremsgs ) {
926 /* got search result, and we had multiple responses in 1 datagram.
927 * stick the result onto the end of the chain, and then pull the
928 * first response off the head of the chain.
930 tmp->lm_chain = newmsg;
931 chain_head->lm_chain_tail = newmsg;
932 *result = chkResponseList( ld, msgid, all );
933 ld->ld_errno = LDAP_SUCCESS;
934 return( (*result)->lm_msgtype );
937 #endif /* LDAP_CONNECTIONLESS */
939 /* is this the one we're looking for? */
940 if ( msgid == LDAP_RES_ANY || id == msgid ) {
941 if ( all == LDAP_MSG_ONE
942 || (newmsg->lm_msgtype != LDAP_RES_SEARCH_RESULT
943 && newmsg->lm_msgtype != LDAP_RES_SEARCH_ENTRY
944 && newmsg->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
946 ld->ld_errno = LDAP_SUCCESS;
948 } else if ( newmsg->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
949 foundit = 1; /* return the chain later */
954 * if not, we must add it to the list of responses. if
955 * the msgid is already there, it must be part of an existing
960 for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
961 if ( l->lm_msgid == newmsg->lm_msgid )
966 /* not part of an existing search response */
973 newmsg->lm_next = ld->ld_responses;
974 ld->ld_responses = newmsg;
978 Debug( LDAP_DEBUG_TRACE, "adding response ld %p msgid %ld type %ld:\n",
979 (void *)ld, (long) newmsg->lm_msgid, (long) newmsg->lm_msgtype );
981 /* part of a search response - add to end of list of entries */
982 l->lm_chain_tail->lm_chain = newmsg;
983 l->lm_chain_tail = newmsg;
985 /* return the whole chain if that's what we were looking for */
988 ld->ld_responses = l->lm_next;
990 prev->lm_next = l->lm_next;
996 ld->ld_errno = LDAP_SUCCESS;
999 if ( lc && ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
1002 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
1007 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
1015 ber = ldap_alloc_ber_with_options( ld );
1018 ld->ld_errno = LDAP_NO_MEMORY;
1022 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
1023 lr->lr_res_msgtype, lr->lr_res_errno,
1024 lr->lr_res_matched ? lr->lr_res_matched : "",
1025 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 )
1027 ld->ld_errno = LDAP_ENCODING_ERROR;
1029 return( LBER_ERROR );
1032 ber_reset( ber, 1 );
1034 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
1035 ld->ld_errno = LDAP_DECODING_ERROR;
1037 return( LBER_ERROR );
1040 if ( ber_get_enum( ber, &along ) == LBER_ERROR ) {
1041 ld->ld_errno = LDAP_DECODING_ERROR;
1043 return( LBER_ERROR );
1046 tag = ber_peek_tag( ber, &len );
1048 if ( tag == LBER_ERROR ) {
1049 ld->ld_errno = LDAP_DECODING_ERROR;
1051 return( LBER_ERROR );
1060 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1063 * Merge error information in "lr" with "parentr" error code and string.
1065 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1066 parentr->lr_res_errno = lr->lr_res_errno;
1067 if ( lr->lr_res_error != NULL ) {
1068 (void)ldap_append_referral( ld, &parentr->lr_res_error,
1071 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1072 parentr->lr_res_errno == LDAP_SUCCESS )
1074 parentr->lr_res_errno = lr->lr_res_errno;
1075 if ( parentr->lr_res_error != NULL ) {
1076 LDAP_FREE( parentr->lr_res_error );
1078 parentr->lr_res_error = lr->lr_res_error;
1079 lr->lr_res_error = NULL;
1080 if ( LDAP_NAME_ERROR( lr->lr_res_errno ) ) {
1081 if ( parentr->lr_res_matched != NULL ) {
1082 LDAP_FREE( parentr->lr_res_matched );
1084 parentr->lr_res_matched = lr->lr_res_matched;
1085 lr->lr_res_matched = NULL;
1089 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
1090 parentr->lr_msgid, 0, 0 );
1091 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1092 parentr->lr_res_errno, parentr->lr_res_error ?
1093 parentr->lr_res_error : "", parentr->lr_res_matched ?
1094 parentr->lr_res_matched : "" );
1100 ldap_msgtype( LDAPMessage *lm )
1102 assert( lm != NULL );
1103 return ( lm != NULL ) ? (int)lm->lm_msgtype : -1;
1108 ldap_msgid( LDAPMessage *lm )
1110 assert( lm != NULL );
1112 return ( lm != NULL ) ? lm->lm_msgid : -1;
1116 char * ldap_int_msgtype2str( ber_tag_t tag )
1119 case LDAP_RES_ADD: return "add";
1120 case LDAP_RES_BIND: return "bind";
1121 case LDAP_RES_COMPARE: return "compare";
1122 case LDAP_RES_DELETE: return "delete";
1123 case LDAP_RES_EXTENDED: return "extended-result";
1124 case LDAP_RES_INTERMEDIATE: return "intermediate";
1125 case LDAP_RES_MODIFY: return "modify";
1126 case LDAP_RES_RENAME: return "rename";
1127 case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1128 case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1129 case LDAP_RES_SEARCH_RESULT: return "search-result";
1135 ldap_msgfree( LDAPMessage *lm )
1140 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1142 for ( ; lm != NULL; lm = next ) {
1143 next = lm->lm_chain;
1144 type = lm->lm_msgtype;
1145 ber_free( lm->lm_ber, 1 );
1146 LDAP_FREE( (char *) lm );
1153 * ldap_msgdelete - delete a message. It returns:
1154 * 0 if the entire message was deleted
1155 * -1 if the message was not found, or only part of it was found
1158 ldap_msgdelete( LDAP *ld, int msgid )
1160 LDAPMessage *lm, *prev;
1163 assert( ld != NULL );
1165 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1168 #ifdef LDAP_R_COMPILE
1169 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1171 for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1172 if ( lm->lm_msgid == msgid )
1181 ld->ld_responses = lm->lm_next;
1183 prev->lm_next = lm->lm_next;
1185 #ifdef LDAP_R_COMPILE
1186 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1188 if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1196 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1199 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1203 if ( ld->ld_abandoned == NULL )
1206 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1207 if ( ld->ld_abandoned[i] == msgid )
1215 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1219 if ( ld->ld_abandoned == NULL )
1222 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1223 if ( ld->ld_abandoned[i] == msgid )
1226 if ( ld->ld_abandoned[i] == -1 )
1229 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1230 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];