]> git.sur5r.net Git - openldap/blob - servers/slapd/ldapsync.c
ITS#6716 Keep CSN lists sorted by SID
[openldap] / servers / slapd / ldapsync.c
1 /* ldapsync.c -- LDAP Content Sync Routines */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 2003-2011 The OpenLDAP Foundation.
6  * Portions Copyright 2003 IBM Corporation.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted only as authorized by the OpenLDAP
11  * Public License.
12  *
13  * A copy of this license is available in the file LICENSE in the
14  * top-level directory of the distribution or, alternatively, at
15  * <http://www.OpenLDAP.org/license.html>.
16  */
17
18 #include "portable.h"
19
20 #include <stdio.h>
21
22 #include <ac/string.h>
23 #include <ac/socket.h>
24
25 #include "lutil.h"
26 #include "slap.h"
27 #include "../../libraries/liblber/lber-int.h" /* get ber_strndup() */
28 #include "lutil_ldap.h"
29
30 struct slap_sync_cookie_s slap_sync_cookie =
31         LDAP_STAILQ_HEAD_INITIALIZER( slap_sync_cookie );
32
33 void
34 slap_compose_sync_cookie(
35         Operation *op,
36         struct berval *cookie,
37         BerVarray csn,
38         int rid,
39         int sid )
40 {
41         int len, numcsn = 0;
42
43         if ( csn ) {
44                 for (; !BER_BVISNULL( &csn[numcsn] ); numcsn++);
45         }
46
47         if ( numcsn == 0 || rid == -1 ) {
48                 char cookiestr[ LDAP_PVT_CSNSTR_BUFSIZE + 20 ];
49                 if ( rid == -1 ) {
50                         cookiestr[0] = '\0';
51                         len = 0;
52                 } else {
53                         len = snprintf( cookiestr, sizeof( cookiestr ),
54                                         "rid=%03d", rid );
55                         if ( sid >= 0 ) {
56                                 len += sprintf( cookiestr+len, ",sid=%03x", sid );
57                         }
58                 }
59                 ber_str2bv_x( cookiestr, len, 1, cookie, 
60                         op ? op->o_tmpmemctx : NULL );
61         } else {
62                 char *ptr;
63                 int i;
64
65                 len = 0;
66                 for ( i=0; i<numcsn; i++)
67                         len += csn[i].bv_len + 1;
68
69                 len += STRLENOF("rid=123,csn=");
70                 if ( sid >= 0 )
71                         len += STRLENOF("sid=xxx,");
72
73                 cookie->bv_val = slap_sl_malloc( len, op ? op->o_tmpmemctx : NULL );
74
75                 len = sprintf( cookie->bv_val, "rid=%03d,", rid );
76                 ptr = cookie->bv_val + len;
77                 if ( sid >= 0 ) {
78                         ptr += sprintf( ptr, "sid=%03x,", sid );
79                 }
80                 ptr = lutil_strcopy( ptr, "csn=" );
81                 for ( i=0; i<numcsn; i++) {
82                         ptr = lutil_strncopy( ptr, csn[i].bv_val, csn[i].bv_len );
83                         *ptr++ = ';';
84                 }
85                 ptr--;
86                 *ptr = '\0';
87                 cookie->bv_len = ptr - cookie->bv_val;
88         }
89 }
90
91 void
92 slap_sync_cookie_free(
93         struct sync_cookie *cookie,
94         int free_cookie
95 )
96 {
97         if ( cookie == NULL )
98                 return;
99
100         if ( cookie->sids ) {
101                 ch_free( cookie->sids );
102                 cookie->sids = NULL;
103         }
104
105         if ( cookie->ctxcsn ) {
106                 ber_bvarray_free( cookie->ctxcsn );
107                 cookie->ctxcsn = NULL;
108         }
109         cookie->numcsns = 0;
110         if ( !BER_BVISNULL( &cookie->octet_str )) {
111                 ch_free( cookie->octet_str.bv_val );
112                 BER_BVZERO( &cookie->octet_str );
113         }
114
115         if ( free_cookie ) {
116                 ch_free( cookie );
117         }
118
119         return;
120 }
121
122 int
123 slap_parse_csn_sid( struct berval *csnp )
124 {
125         char *p, *q;
126         struct berval csn = *csnp;
127         int i;
128
129         p = ber_bvchr( &csn, '#' );
130         if ( !p )
131                 return -1;
132         p++;
133         csn.bv_len -= p - csn.bv_val;
134         csn.bv_val = p;
135
136         p = ber_bvchr( &csn, '#' );
137         if ( !p )
138                 return -1;
139         p++;
140         csn.bv_len -= p - csn.bv_val;
141         csn.bv_val = p;
142
143         q = ber_bvchr( &csn, '#' );
144         if ( !q )
145                 return -1;
146
147         csn.bv_len = q - p;
148
149         i = strtol( p, &q, 16 );
150         if ( p == q || q != p + csn.bv_len || i < 0 || i > SLAP_SYNC_SID_MAX ) {
151                 i = -1;
152         }
153
154         return i;
155 }
156
157 int *
158 slap_parse_csn_sids( BerVarray csns, int numcsns, void *memctx )
159 {
160         int i, *ret;
161
162         ret = slap_sl_malloc( numcsns * sizeof(int), memctx );
163         for ( i=0; i<numcsns; i++ ) {
164                 ret[i] = slap_parse_csn_sid( &csns[i] );
165         }
166         return ret;
167 }
168
169 static slap_mr_match_func sidsort_cmp;
170
171 static const MatchingRule sidsort_mr = {
172         {},
173         NULL,
174         {},
175         {},
176         0,
177         NULL, NULL, NULL, sidsort_cmp
178 };
179 static const AttributeType sidsort_at = {
180         {},
181         {},
182         NULL, NULL, (MatchingRule *)&sidsort_mr,
183         NULL, NULL, NULL, NULL, NULL, NULL, NULL, SLAP_AT_SORTED_VAL
184 };
185 static const AttributeDescription sidsort_ad = {
186         NULL,
187         (AttributeType *)&sidsort_at
188 };
189
190 static int
191 sidsort_cmp(
192         int *matchp,
193         slap_mask_t flags,
194         Syntax *syntax,
195         MatchingRule *mr,
196         struct berval *b1,
197         void *v2 )
198 {
199         struct berval *b2 = v2;
200         *matchp = b1->bv_len - b2->bv_len;
201         return LDAP_SUCCESS;
202 }
203
204 /* sort CSNs by SID. Use a fake Attribute with our own
205  * syntax and matching rule, which sorts the nvals by
206  * bv_len order. Stuff our sids into the bv_len.
207  */
208 int
209 slap_sort_csn_sids( BerVarray csns, int *sids, int numcsns, void *memctx )
210 {
211         Attribute a;
212         const char *text;
213         int i, rc;
214
215         a.a_desc = (AttributeDescription *)&sidsort_ad;
216         a.a_nvals = slap_sl_malloc( numcsns * sizeof(struct berval), memctx );
217         for ( i=0; i<numcsns; i++ ) {
218                 a.a_nvals[i].bv_len = sids[i];
219                 a.a_nvals[i].bv_val = NULL;
220         }
221         a.a_vals = csns;
222         a.a_numvals = numcsns;
223         a.a_flags = 0;
224         rc = slap_sort_vals( (Modifications *)&a, &text, &i, memctx );
225         for ( i=0; i<numcsns; i++ )
226                 sids[i] = a.a_nvals[i].bv_len;
227         slap_sl_free( a.a_nvals, memctx );
228         return rc;
229 }
230
231 int
232 slap_parse_sync_cookie(
233         struct sync_cookie *cookie,
234         void *memctx
235 )
236 {
237         char *csn_ptr;
238         char *csn_str;
239         char *cval;
240         char *next, *end;
241         AttributeDescription *ad = slap_schema.si_ad_entryCSN;
242
243         if ( cookie == NULL )
244                 return -1;
245
246         if ( cookie->octet_str.bv_len <= STRLENOF( "rid=" ) )
247                 return -1;
248
249         cookie->rid = -1;
250         cookie->sid = -1;
251         cookie->ctxcsn = NULL;
252         cookie->sids = NULL;
253         cookie->numcsns = 0;
254
255         end = cookie->octet_str.bv_val + cookie->octet_str.bv_len;
256
257         for ( next=cookie->octet_str.bv_val; next < end; ) {
258                 if ( !strncmp( next, "rid=", STRLENOF("rid=") )) {
259                         char *rid_ptr = next;
260                         cookie->rid = strtol( &rid_ptr[ STRLENOF( "rid=" ) ], &next, 10 );
261                         if ( next == rid_ptr ||
262                                 next > end ||
263                                 ( *next && *next != ',' ) ||
264                                 cookie->rid < 0 ||
265                                 cookie->rid > SLAP_SYNC_RID_MAX )
266                         {
267                                 return -1;
268                         }
269                         if ( *next == ',' ) {
270                                 next++;
271                         }
272                         if ( !ad ) {
273                                 break;
274                         }
275                         continue;
276                 }
277                 if ( !strncmp( next, "sid=", STRLENOF("sid=") )) {
278                         char *sid_ptr = next;
279                         sid_ptr = next;
280                         cookie->sid = strtol( &sid_ptr[ STRLENOF( "sid=" ) ], &next, 16 );
281                         if ( next == sid_ptr ||
282                                 next > end ||
283                                 ( *next && *next != ',' ) ||
284                                 cookie->sid < 0 ||
285                                 cookie->sid > SLAP_SYNC_SID_MAX )
286                         {
287                                 return -1;
288                         }
289                         if ( *next == ',' ) {
290                                 next++;
291                         }
292                         continue;
293                 }
294                 if ( !strncmp( next, "csn=", STRLENOF("csn=") )) {
295                         struct berval stamp;
296
297                         next += STRLENOF("csn=");
298                         while ( next < end ) {
299                                 csn_str = next;
300                                 csn_ptr = strchr( csn_str, '#' );
301                                 if ( !csn_ptr || csn_ptr > end )
302                                         break;
303                                 /* ad will be NULL when called from main. we just
304                                  * want to parse the rid then. But we still iterate
305                                  * through the string to find the end.
306                                  */
307                                 cval = strchr( csn_ptr, ';' );
308                                 if ( !cval )
309                                         cval = strchr(csn_ptr, ',' );
310                                 if ( cval )
311                                         stamp.bv_len = cval - csn_str;
312                                 else
313                                         stamp.bv_len = end - csn_str;
314                                 if ( ad ) {
315                                         struct berval bv;
316                                         stamp.bv_val = csn_str;
317                                         if ( ad->ad_type->sat_syntax->ssyn_validate(
318                                                 ad->ad_type->sat_syntax, &stamp ) != LDAP_SUCCESS )
319                                                 break;
320                                         if ( ad->ad_type->sat_equality->smr_normalize(
321                                                 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
322                                                 ad->ad_type->sat_syntax,
323                                                 ad->ad_type->sat_equality,
324                                                 &stamp, &bv, memctx ) != LDAP_SUCCESS )
325                                                 break;
326                                         ber_bvarray_add_x( &cookie->ctxcsn, &bv, memctx );
327                                         cookie->numcsns++;
328                                 }
329                                 if ( cval ) {
330                                         next = cval + 1;
331                                         if ( *cval != ';' )
332                                                 break;
333                                 } else {
334                                         next = end;
335                                         break;
336                                 }
337                         }
338                         continue;
339                 }
340                 next++;
341         }
342         if ( cookie->numcsns ) {
343                 cookie->sids = slap_parse_csn_sids( cookie->ctxcsn, cookie->numcsns,
344                         memctx );
345                 if ( cookie->numcsns > 1 )
346                         slap_sort_csn_sids( cookie->ctxcsn, cookie->sids, cookie->numcsns, memctx );
347         }
348         return 0;
349 }
350
351 int
352 slap_init_sync_cookie_ctxcsn(
353         struct sync_cookie *cookie
354 )
355 {
356         char csnbuf[ LDAP_PVT_CSNSTR_BUFSIZE + 4 ];
357         struct berval octet_str = BER_BVNULL;
358         struct berval ctxcsn = BER_BVNULL;
359
360         if ( cookie == NULL )
361                 return -1;
362
363         octet_str.bv_len = snprintf( csnbuf, LDAP_PVT_CSNSTR_BUFSIZE + 4,
364                                         "csn=%4d%02d%02d%02d%02d%02dZ#%06x#%02x#%06x",
365                                         1900, 1, 1, 0, 0, 0, 0, 0, 0 );
366         octet_str.bv_val = csnbuf;
367         ch_free( cookie->octet_str.bv_val );
368         ber_dupbv( &cookie->octet_str, &octet_str );
369
370         ctxcsn.bv_val = octet_str.bv_val + 4;
371         ctxcsn.bv_len = octet_str.bv_len - 4;
372         cookie->ctxcsn = NULL;
373         value_add_one( &cookie->ctxcsn, &ctxcsn );
374         cookie->numcsns = 1;
375         cookie->sid = -1;
376
377         return 0;
378 }
379
380 struct sync_cookie *
381 slap_dup_sync_cookie(
382         struct sync_cookie *dst,
383         struct sync_cookie *src
384 )
385 {
386         struct sync_cookie *new;
387         int i;
388
389         if ( src == NULL )
390                 return NULL;
391
392         if ( dst ) {
393                 ber_bvarray_free( dst->ctxcsn );
394                 dst->ctxcsn = NULL;
395                 dst->sids = NULL;
396                 ch_free( dst->octet_str.bv_val );
397                 BER_BVZERO( &dst->octet_str );
398                 new = dst;
399         } else {
400                 new = ( struct sync_cookie * )
401                                 ch_calloc( 1, sizeof( struct sync_cookie ));
402         }
403
404         new->rid = src->rid;
405         new->sid = src->sid;
406         new->numcsns = src->numcsns;
407
408         if ( src->numcsns ) {
409                 if ( ber_bvarray_dup_x( &new->ctxcsn, src->ctxcsn, NULL )) {
410                         if ( !dst ) {
411                                 ch_free( new );
412                         }
413                         return NULL;
414                 }
415                 new->sids = ch_malloc( src->numcsns * sizeof(int) );
416                 for (i=0; i<src->numcsns; i++)
417                         new->sids[i] = src->sids[i];
418         }
419
420         if ( !BER_BVISNULL( &src->octet_str )) {
421                 ber_dupbv( &new->octet_str, &src->octet_str );
422         }
423
424         return new;
425 }
426