1 /* valsort.c - sort attribute values */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2005 The OpenLDAP Foundation.
6 * Portions copyright 2005 Symas Corporation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
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>.
18 * This work was initially developed by Howard Chu for inclusion in
23 * This overlay sorts the values of multi-valued attributes when returning
24 * them in a search response.
28 #ifdef SLAPD_OVER_VALSORT
32 #include <ac/string.h>
39 #define VALSORT_ASCEND 0
40 #define VALSORT_DESCEND 1
42 #define VALSORT_ALPHA 2
43 #define VALSORT_NUMERIC 4
45 #define VALSORT_WEIGHTED 8
47 typedef struct valsort_info {
48 struct valsort_info *vi_next;
50 AttributeDescription *vi_ad;
54 static ConfigDriver valsort_cf_func;
56 static ConfigTable valsort_cfats[] = {
57 { "valsort-attr", "attribute> <dn> <sort-type", 4, 5, 0, ARG_MAGIC,
58 valsort_cf_func, "( OLcfgOvAt:5.1 NAME 'olcValSortAttr' "
59 "DESC 'Sorting rule for attribute under given DN' "
60 "EQUALITY caseIgnoreMatch "
61 "SYNTAX OMsDirectoryString )", NULL, NULL },
65 static ConfigOCs valsort_cfocs[] = {
67 "NAME 'olcValSortConfig' "
68 "DESC 'Value Sorting configuration' "
69 "SUP olcOverlayConfig "
70 "MUST olcValSortAttr )",
71 Cft_Overlay, valsort_cfats },
75 static slap_verbmasks sorts[] = {
76 { BER_BVC("alpha-ascend"), VALSORT_ASCEND|VALSORT_ALPHA },
77 { BER_BVC("alpha-descend"), VALSORT_DESCEND|VALSORT_ALPHA },
78 { BER_BVC("numeric-ascend"), VALSORT_ASCEND|VALSORT_NUMERIC },
79 { BER_BVC("numeric-ascend"), VALSORT_DESCEND|VALSORT_NUMERIC },
80 { BER_BVC("weighted"), VALSORT_WEIGHTED },
85 valsort_cf_func(ConfigArgs *c) {
86 slap_overinst *on = (slap_overinst *)c->bi;
87 valsort_info vitmp, *vi;
88 const char *text = NULL;
92 if ( c->op == SLAP_CONFIG_EMIT ) {
93 for ( vi = on->on_bi.bi_private; vi; vi = vi->vi_next ) {
94 struct berval bv2 = BER_BVNULL, bvret;
98 len = vi->vi_ad->ad_cname.bv_len + 1 + vi->vi_dn.bv_len + 3;
100 if ( i & VALSORT_WEIGHTED ) {
101 enum_to_verb( sorts, VALSORT_WEIGHTED, &bv2 );
102 len += bv2.bv_len + 1;
103 i ^= VALSORT_WEIGHTED;
105 enum_to_verb( sorts, i, &bv );
107 bvret.bv_val = ch_malloc( len+1 );
110 ptr = lutil_strcopy( bvret.bv_val, vi->vi_ad->ad_cname.bv_val );
113 ptr = lutil_strcopy( ptr, vi->vi_dn.bv_val );
116 if ( vi->vi_sort & VALSORT_WEIGHTED ) {
117 ptr = lutil_strcopy( ptr, bv2.bv_val );
120 strcpy( ptr, bv.bv_val );
121 ber_bvarray_add( &c->rvalue_vals, &bvret );
123 i = ( c->rvalue_vals != NULL ) ? 0 : 1;
125 } else if ( c->op == LDAP_MOD_DELETE ) {
127 for ( vi = on->on_bi.bi_private; vi; vi = c->be->be_private ) {
128 on->on_bi.bi_private = vi->vi_next;
129 ch_free( vi->vi_dn.bv_val );
135 for (i=0, prev = (valsort_info **)&on->on_bi.bi_private,
136 vi = *prev; vi && i<c->valx;
137 prev = &vi->vi_next, vi = vi->vi_next, i++ );
138 (*prev)->vi_next = vi->vi_next;
139 ch_free( vi->vi_dn.bv_val );
145 i = slap_str2ad( c->argv[1], &vitmp.vi_ad, &text );
147 sprintf( c->msg, "<%s> %s", c->argv[0], text );
148 Debug( LDAP_DEBUG_ANY, "%s: %s (%s)!\n",
149 c->log, c->msg, c->argv[1] );
152 ber_str2bv( c->argv[2], 0, 0, &bv );
153 i = dnNormalize( 0, NULL, NULL, &bv, &vitmp.vi_dn, NULL );
155 sprintf( c->msg, "<%s> unable to normalize DN", c->argv[0] );
156 Debug( LDAP_DEBUG_ANY, "%s: %s (%s)!\n",
157 c->log, c->msg, c->argv[2] );
160 i = verb_to_mask( c->argv[3], sorts );
161 if ( BER_BVISNULL( &sorts[i].word )) {
162 sprintf( c->msg, "<%s> unrecognized sort type", c->argv[0] );
163 Debug( LDAP_DEBUG_ANY, "%s: %s (%s)!\n",
164 c->log, c->msg, c->argv[3] );
167 vitmp.vi_sort = sorts[i].mask;
168 if ( sorts[i].mask == VALSORT_WEIGHTED && c->argc == 5 ) {
169 i = verb_to_mask( c->argv[4], sorts );
170 if ( BER_BVISNULL( &sorts[i].word )) {
171 sprintf( c->msg, "<%s> unrecognized sort type", c->argv[0] );
172 Debug( LDAP_DEBUG_ANY, "%s: %s (%s)!\n",
173 c->log, c->msg, c->argv[4] );
176 vitmp.vi_sort |= sorts[i].mask;
178 vi = ch_malloc( sizeof(valsort_info) );
180 vi->vi_next = on->on_bi.bi_private;
181 on->on_bi.bi_private = vi;
185 /* Use Insertion Sort algorithm on selected values */
187 do_sort( Operation *op, Attribute *a, int beg, int num, slap_mask_t sort )
190 struct berval tmp, ntmp, *vals, *nvals;
192 gotnvals = (a->a_vals != a->a_nvals );
194 nvals = a->a_nvals + beg;
196 vals = a->a_vals + beg;
198 if ( sort & VALSORT_NUMERIC ) {
199 long *numbers = op->o_tmpalloc( num * sizeof(long), op->o_tmpmemctx ),
201 for (i=0; i<num; i++)
202 numbers[i] = strtol( nvals[i].bv_val, NULL, 0 );
204 for (i=1; i<num; i++) {
207 if ( gotnvals ) tmp = vals[i];
210 int cmp = (sort & VALSORT_DESCEND) ? numbers[j-1] < idx :
213 numbers[j] = numbers[j-1];
214 nvals[j] = nvals[j-1];
215 if ( gotnvals ) vals[j] = vals[j-1];
220 if ( gotnvals ) vals[j] = tmp;
222 op->o_tmpfree( numbers, op->o_tmpmemctx );
224 for (i=1; i<num; i++) {
226 if ( gotnvals ) tmp = vals[i];
229 int cmp = strcmp( nvals[j-1].bv_val, ntmp.bv_val );
230 cmp = (sort & VALSORT_DESCEND) ? (cmp < 0) : (cmp > 0);
233 nvals[j] = nvals[j-1];
234 if ( gotnvals ) vals[j] = vals[j-1];
238 if ( gotnvals ) vals[j] = tmp;
244 valsort_response( Operation *op, SlapReply *rs )
250 /* We only want search responses */
251 if ( rs->sr_type != REP_SEARCH ) return SLAP_CB_CONTINUE;
253 on = (slap_overinst *) op->o_bd->bd_info;
254 vi = on->on_bi.bi_private;
256 /* And we must have something configured */
257 if ( !vi ) return SLAP_CB_CONTINUE;
259 /* Find a rule whose baseDN matches this entry */
260 for (; vi; vi = vi->vi_next ) {
263 if ( !dnIsSuffix( &rs->sr_entry->e_nname, &vi->vi_dn ))
266 /* Find attr that this rule affects */
267 a = attr_find( rs->sr_entry->e_attrs, vi->vi_ad );
270 if (( rs->sr_flags & ( REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED )) !=
271 ( REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED )) {
272 rs->sr_entry = entry_dup( rs->sr_entry );
273 rs->sr_flags |= REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED;
274 a = attr_find( rs->sr_entry->e_attrs, vi->vi_ad );
278 for ( n = 0; !BER_BVISNULL( &a->a_vals[n] ); n++ );
280 if ( vi->vi_sort & VALSORT_WEIGHTED ) {
282 long *index = op->o_tmpalloc( n * sizeof(long), op->o_tmpmemctx );
284 gotnvals = (a->a_vals != a->a_nvals );
286 for (i=0; i<n; i++) {
287 char *ptr = strchr( a->a_nvals[i].bv_val, '{' );
290 Debug(LDAP_DEBUG_TRACE, "weights missing from attr %s "
291 "in entry %s\n", vi->vi_ad->ad_cname.bv_val,
292 rs->sr_entry->e_name.bv_val, 0 );
295 index[i] = strtol( ptr+1, &end, 0 );
297 Debug(LDAP_DEBUG_TRACE, "weights misformatted "
299 rs->sr_entry->e_name.bv_val, 0, 0 );
302 /* Strip out weights */
303 ptr = a->a_nvals[i].bv_val;
308 a->a_nvals[i].bv_len = ptr - a->a_nvals[i].bv_val;
310 if ( a->a_vals != a->a_nvals ) {
311 ptr = a->a_vals[i].bv_val;
312 end = strchr( ptr, '}' ) + 1;
316 a->a_vals[i].bv_len = ptr - a->a_vals[i].bv_val;
319 /* An attr was missing weights here, ignore it */
321 op->o_tmpfree( index, op->o_tmpmemctx );
325 for ( i=1; i<n; i++) {
327 struct berval tmp = a->a_vals[i], ntmp;
328 if ( gotnvals ) ntmp = a->a_nvals[i];
330 while (( j>0 ) && (index[j-1] > idx )) {
331 index[j] = index[j-1];
332 a->a_vals[j] = a->a_vals[j-1];
333 if ( gotnvals ) a->a_nvals[j] = a->a_nvals[j-1];
338 if ( gotnvals ) a->a_nvals[j] = ntmp;
340 /* Check for secondary sort */
341 if ( vi->vi_sort ^ VALSORT_WEIGHTED ) {
343 for (j=i+1; j<n; j++) {
344 if (index[i] != index[j])
348 do_sort( op, a, i, j-i, vi->vi_sort );
352 op->o_tmpfree( index, op->o_tmpmemctx );
354 do_sort( op, a, 0, n, vi->vi_sort );
357 return SLAP_CB_CONTINUE;
361 valsort_add( Operation *op, SlapReply *rs )
363 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
364 valsort_info *vi = on->on_bi.bi_private;
370 /* See if any weighted sorting applies to this entry */
371 for ( ;vi;vi=vi->vi_next ) {
372 if ( !dnIsSuffix( &op->o_req_ndn, &vi->vi_dn ))
374 if ( !(vi->vi_sort & VALSORT_WEIGHTED ))
376 a = attr_find( op->ora_e->e_attrs, vi->vi_ad );
379 for (i=0; !BER_BVISNULL( &a->a_vals[i] ); i++) {
380 ptr = strchr(a->a_vals[i].bv_val, '{' );
382 Debug(LDAP_DEBUG_TRACE, "weight missing from attribute %s\n",
383 vi->vi_ad->ad_cname.bv_val, 0, 0);
384 send_ldap_error( op, rs, LDAP_CONSTRAINT_VIOLATION,
385 "weight missing from attribute" );
388 strtol( ptr+1, &end, 0 );
390 Debug(LDAP_DEBUG_TRACE, "weight is misformatted in %s\n",
391 vi->vi_ad->ad_cname.bv_val, 0, 0);
392 send_ldap_error( op, rs, LDAP_CONSTRAINT_VIOLATION,
393 "weight is misformatted" );
398 return SLAP_CB_CONTINUE;
402 valsort_modify( Operation *op, SlapReply *rs )
404 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
405 valsort_info *vi = on->on_bi.bi_private;
411 /* See if any weighted sorting applies to this entry */
412 for ( ;vi;vi=vi->vi_next ) {
413 if ( !dnIsSuffix( &op->o_req_ndn, &vi->vi_dn ))
415 if ( !(vi->vi_sort & VALSORT_WEIGHTED ))
417 for (ml = op->orm_modlist; ml; ml=ml->sml_next ) {
418 if ( ml->sml_desc == vi->vi_ad )
423 for (i=0; !BER_BVISNULL( &ml->sml_values[i] ); i++) {
424 ptr = strchr(ml->sml_values[i].bv_val, '{' );
426 Debug(LDAP_DEBUG_TRACE, "weight missing from attribute %s\n",
427 vi->vi_ad->ad_cname.bv_val, 0, 0);
428 send_ldap_error( op, rs, LDAP_CONSTRAINT_VIOLATION,
429 "weight missing from attribute" );
432 strtol( ptr+1, &end, 0 );
434 Debug(LDAP_DEBUG_TRACE, "weight is misformatted in %s\n",
435 vi->vi_ad->ad_cname.bv_val, 0, 0);
436 send_ldap_error( op, rs, LDAP_CONSTRAINT_VIOLATION,
437 "weight is misformatted" );
442 return SLAP_CB_CONTINUE;
450 slap_overinst *on = (slap_overinst *)be->bd_info;
451 valsort_info *vi = on->on_bi.bi_private, *next;
453 for (; vi; vi = next) {
455 ch_free( vi->vi_dn.bv_val );
462 static slap_overinst valsort;
468 valsort.on_bi.bi_type = "valsort";
469 valsort.on_bi.bi_db_destroy = valsort_destroy;
471 valsort.on_bi.bi_op_add = valsort_add;
472 valsort.on_bi.bi_op_modify = valsort_modify;
474 valsort.on_response = valsort_response;
476 valsort.on_bi.bi_cf_ocs = valsort_cfocs;
478 rc = config_register_schema( valsort_cfats, valsort_cfocs );
481 return overlay_register(&valsort);
484 #if SLAPD_OVER_VALSORT == SLAPD_MOD_DYNAMIC
485 int init_module( int argc, char *argv[]) {
486 return valsort_init();
490 #endif /* SLAPD_OVER_VALSORT */