pagectrl.c 6.86 KB
Newer Older
1
2
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
 *
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
 * Copyright 1998-2007 The OpenLDAP Foundation.
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 * Copyright 2006 Hans Leidekker
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
 * Public License.
 *
 * A copy of this license is available in the file LICENSE in the
 * top-level directory of the distribution or, alternatively, at
 * <http://www.OpenLDAP.org/license.html>.
 */

#include "portable.h"

#include <stdio.h>
#include <ac/stdlib.h>
#include <ac/string.h>
#include <ac/time.h>

#include "ldap-int.h"

/* ---------------------------------------------------------------------------
    ldap_create_page_control_value

    Create and encode the value of the paged results control (RFC 2696).

30
31
    ld          (IN) An LDAP session handle
    pagesize    (IN) Page size requested
32
    cookie      (IN) Opaque structure used by the server to track its
33
                     location in the search results.  NULL on the
34
                     first call.
35
36
    value      (OUT) Control value, SHOULD be freed by calling
					 ldap_memfree() when done.
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
    pagedResultsControl ::= SEQUENCE {
            controlType     1.2.840.113556.1.4.319,
            criticality     BOOLEAN DEFAULT FALSE,
            controlValue    searchControlValue }

    searchControlValue ::= SEQUENCE {
            size            INTEGER (0..maxInt),
                                    -- requested page size from client
                                    -- result set size estimate from server
            cookie          OCTET STRING }

   ---------------------------------------------------------------------------*/

int
ldap_create_page_control_value(
53
54
	LDAP *ld,
	ber_int_t pagesize,
55
56
57
58
59
60
61
	struct berval	*cookie,
	struct berval	*value )
{
	BerElement	*ber = NULL;
	ber_tag_t	tag;
	struct berval	null_cookie = { 0, NULL };

62
63
64
	if ( ld == NULL || value == NULL ||
		pagesize < 1 || pagesize > LDAP_MAXINT )
	{
Howard Chu's avatar
Howard Chu committed
65
66
67
		if ( ld )
			ld->ld_errno = LDAP_PARAM_ERROR;
		return LDAP_PARAM_ERROR;
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
	}

	assert( LDAP_VALID( ld ) );

	value->bv_val = NULL;
	value->bv_len = 0;

	if ( cookie == NULL ) {
		cookie = &null_cookie;
	}

	ber = ldap_alloc_ber_with_options( ld );
	if ( ber == NULL ) {
		ld->ld_errno = LDAP_NO_MEMORY;
		return ld->ld_errno;
	}

85
	tag = ber_printf( ber, "{iO}", pagesize, cookie );
86
	if ( tag == LBER_ERROR ) {
87
88
		ld->ld_errno = LDAP_ENCODING_ERROR;
		goto done;
89
90
91
92
93
94
	}

	if ( ber_flatten2( ber, value, 1 ) == -1 ) {
		ld->ld_errno = LDAP_NO_MEMORY;
	}

95
done:;
96
97
98
99
100
101
102
103
104
105
106
107
108
	if ( ber != NULL ) {
		ber_free( ber, 1 );
	}

	return ld->ld_errno;
}


/* ---------------------------------------------------------------------------
    ldap_create_page_control

    Create and encode a page control.

109
110
    ld          (IN) An LDAP session handle
    pagesize    (IN) Page size requested
111
    cookie      (IN) Opaque structure used by the server to track its
112
                     location in the search results.  NULL on the
113
                     first call.
114
115
116
117
118
    value      (OUT) Control value, SHOULD be freed by calling
					 ldap_memfree() when done.
    iscritical  (IN) Criticality
    ctrlp      (OUT) LDAP control, SHOULD be freed by calling
					 ldap_control_free() when done.
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
    pagedResultsControl ::= SEQUENCE {
            controlType     1.2.840.113556.1.4.319,
            criticality     BOOLEAN DEFAULT FALSE,
            controlValue    searchControlValue }

    searchControlValue ::= SEQUENCE {
            size            INTEGER (0..maxInt),
                                    -- requested page size from client
                                    -- result set size estimate from server
            cookie          OCTET STRING }

   ---------------------------------------------------------------------------*/

int
ldap_create_page_control(
	LDAP		*ld,
136
	ber_int_t	pagesize,
137
138
139
140
141
142
143
144
145
146
147
	struct berval	*cookie,
	int		iscritical,
	LDAPControl	**ctrlp )
{
	struct berval	value;

	if ( ctrlp == NULL ) {
		ld->ld_errno = LDAP_PARAM_ERROR;
		return ld->ld_errno;
	}

148
149
	ld->ld_errno = ldap_create_page_control_value( ld,
		pagesize, cookie, &value );
150
	if ( ld->ld_errno == LDAP_SUCCESS ) {
151
152
153
		ld->ld_errno = ldap_control_create( LDAP_CONTROL_PAGEDRESULTS,
			iscritical, &value, 0, ctrlp );
		if ( ld->ld_errno != LDAP_SUCCESS ) {
154
155
156
157
158
159
160
161
162
163
164
165
166
			LDAP_FREE( value.bv_val );
		}
	}

	return ld->ld_errno;
}


/* ---------------------------------------------------------------------------
    ldap_parse_pageresponse_control

    Decode a page control.

167
168
169
170
    ld          (IN) An LDAP session handle
    ctrl        (IN) The page response control
    count      (OUT) The number of entries in the page.
    cookie     (OUT) Opaque cookie.  Use ldap_memfree() to
171
172
173
174
175
176
                     free the bv_val member of this structure.

   ---------------------------------------------------------------------------*/

int
ldap_parse_pageresponse_control(
177
178
179
180
	LDAP *ld,
	LDAPControl *ctrl,
	ber_int_t *countp,
	struct berval *cookie )
181
182
183
184
185
186
{
	BerElement *ber;
	ber_tag_t tag;
	ber_int_t count;

	if ( ld == NULL || ctrl == NULL || cookie == NULL ) {
Howard Chu's avatar
Howard Chu committed
187
188
189
		if ( ld )
			ld->ld_errno = LDAP_PARAM_ERROR;
		return LDAP_PARAM_ERROR;
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
	}

	/* Create a BerElement from the berval returned in the control. */
	ber = ber_init( &ctrl->ldctl_value );

	if ( ber == NULL ) {
		ld->ld_errno = LDAP_NO_MEMORY;
		return ld->ld_errno;
	}

	/* Extract the count and cookie from the control. */
	tag = ber_scanf( ber, "{io}", &count, cookie );
        ber_free( ber, 1 );

	if ( tag == LBER_ERROR ) {
		ld->ld_errno = LDAP_DECODING_ERROR;
	} else {
		ld->ld_errno = LDAP_SUCCESS;

		if ( countp != NULL ) {
			*countp = (unsigned long)count;
		}
	}

	return ld->ld_errno;
}

/* ---------------------------------------------------------------------------
    ldap_parse_page_control

    Decode a page control.

222
223
224
225
226
    ld          (IN) An LDAP session handle
    ctrls       (IN) Response controls
    count      (OUT) The number of entries in the page.
    cookie     (OUT) Opaque cookie.  Use ldap_memfree() to
                     free the bv_val member of this structure.
227
228
229
230
231
232
233

   ---------------------------------------------------------------------------*/

int
ldap_parse_page_control(
	LDAP		*ld,
	LDAPControl	**ctrls,
234
	ber_int_t *countp,
235
236
	struct berval	**cookiep )
{
237
	LDAPControl *c;
238
239
240
241
242
243
244
245
246
247
248
249
	struct berval	cookie;

	if ( cookiep == NULL ) {
		ld->ld_errno = LDAP_PARAM_ERROR;
		return ld->ld_errno;
	}

	if ( ctrls == NULL ) {
		ld->ld_errno =  LDAP_CONTROL_NOT_FOUND;
		return ld->ld_errno;
	}

250
	c = ldap_control_find( LDAP_CONTROL_PAGEDRESULTS, ctrls, NULL );
251
252
	if ( c == NULL ) {
		/* No page control was found. */
253
254
255
256
		ld->ld_errno = LDAP_CONTROL_NOT_FOUND;
		return ld->ld_errno;
	}

257
	ld->ld_errno = ldap_parse_pageresponse_control( ld, c, countp, &cookie );
258
	if ( ld->ld_errno == LDAP_SUCCESS ) {
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
259
		*cookiep = LDAP_MALLOC( sizeof( struct berval ) );
260
261
262
263
264
265
266
267
268
269
		if ( *cookiep == NULL ) {
			ld->ld_errno = LDAP_NO_MEMORY;
		} else {
			**cookiep = cookie;
		}
	}

	return ld->ld_errno;
}