1 /* ldif-filter -- clean up LDIF testdata from stdin */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2009-2015 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 file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
21 #include <ac/stdlib.h>
22 #include <ac/string.h>
23 #include <ac/unistd.h>
28 #define DEFAULT_SPECS "ndb=a,null=n"
30 typedef struct { char *val; size_t len, alloc; } String;
31 typedef struct { String *val; size_t len, alloc; } Strings;
33 /* Flags and corresponding program options */
34 enum { SORT_ATTRS = 1, SORT_ENTRIES = 2, NO_OUTPUT = 4, DUMMY_FLAG = 8 };
35 static const char spec_options[] = "aen"; /* option index = log2(enum flag) */
37 static const char *progname = "ldif-filter";
38 static const String null_string = { NULL, 0, 0 };
44 Usage: %s [-b backend] [-s spec[,spec]...]\n\
45 Filter standard input by first <spec> matching '[<backend>]=[a][e][n]':\n\
46 - Remove LDIF comments.\n\
47 - 'a': Sort attributes in entries.\n\
48 - 'e': Sort any entries separated by just one empty line.\n\
49 - 'n': Output nothing.\n\
50 <backend> defaults to the $BACKEND environment variable.\n\
51 Use specs '%s' if no spec on the command line applies.\n",
52 progname, DEFAULT_SPECS );
56 /* Return flags from "backend=flags" in spec; nonzero if backend found */
58 get_flags( const char *backend, const char *spec )
60 size_t len = strlen( backend );
61 unsigned flags = DUMMY_FLAG;
64 while ( '=' != *(spec += strncmp( spec, backend, len ) ? 0 : len) ) {
65 if ( (spec = strchr( spec, ',' )) == NULL ) {
70 while ( *++spec && *spec != ',' ) {
71 if ( (tmp = strchr( spec_options, *spec )) == NULL ) {
74 flags |= 1U << (tmp - spec_options);
79 #define APPEND(s /* String or Strings */, data, count, isString) do { \
80 size_t slen = (s)->len, salloc = (s)->alloc, sz = sizeof *(s)->val; \
81 if ( salloc <= slen + (count) ) { \
82 (s)->alloc = salloc += salloc + ((count)|7) + 1; \
83 (s)->val = xrealloc( (s)->val, sz * salloc ); \
85 memcpy( (s)->val + slen, data, sz * ((count) + !!(isString)) ); \
86 (s)->len = slen + (count); \
90 xrealloc( void *ptr, size_t len )
92 if ( (ptr = realloc( ptr, len )) == NULL ) {
100 cmp( const void *s, const void *t )
102 return strcmp( ((const String *) s)->val, ((const String *) t)->val );
106 sort_strings( Strings *ss, size_t offset )
108 qsort( ss->val + offset, ss->len - offset, sizeof(*ss->val), cmp );
111 /* Build entry ss[n] from attrs ss[n...], and free the attrs */
113 build_entry( Strings *ss, size_t n, unsigned flags, size_t new_len )
115 String *vals = ss->val, *e = &vals[n];
116 size_t end = ss->len;
119 if ( flags & SORT_ATTRS ) {
120 sort_strings( ss, n + 1 );
122 e->val = xrealloc( e->val, e->alloc = new_len + 1 );
123 ptr = e->val + e->len;
126 for ( ; n < end; free( vals[n++].val )) {
127 ptr = strcpy( ptr, vals[n].val ) + vals[n].len;
129 assert( ptr == e->val + new_len );
132 /* Flush entries to stdout and free them */
134 flush_entries( Strings *ss, const char *sep, unsigned flags )
136 size_t i, end = ss->len;
137 const char *prefix = "";
139 if ( flags & SORT_ENTRIES ) {
140 sort_strings( ss, 0 );
142 for ( i = 0; i < end; i++, prefix = sep ) {
143 if ( printf( "%s%s", prefix, ss->val[i].val ) < 0 ) {
145 exit( EXIT_FAILURE );
147 free( ss->val[i].val );
153 filter_stdin( unsigned flags )
156 Strings ss = { NULL, 0, 0 }; /* entries + attrs of partial entry */
157 size_t entries = 0, attrs_totlen = 0, line_len;
158 const char *entry_sep = "\n", *sep = "";
159 int comment = 0, eof = 0, eol, prev_eol = 1; /* flags */
162 /* LDIF = Entries ss[..entries-1] + sep + attrs ss[entries..] + line */
163 for ( ; !eof || ss.len || *sep; prev_eol = eol ) {
164 if ( eof || (eof = !fgets( line, sizeof(line), stdin ))) {
165 strcpy( line, prev_eol ? "" : *sep ? sep : "\n" );
167 line_len = strlen( line );
168 eol = (line_len == 0 || line[line_len - 1] == '\n');
170 if ( *line == ' ' ) { /* continuation line? */
172 } else if ( prev_eol ) { /* start of logical line? */
173 comment = (*line == '#');
175 if ( comment || (flags & NO_OUTPUT) ) {
179 /* Collect attrs for partial entry in ss[entries...] */
180 if ( !prev_eol && attrs_totlen != 0 ) {
182 } else if ( line_len > (*line == '\r' ? 2 : 1) ) {
183 APPEND( &ss, &null_string, 1, 0 ); /* new attr */
185 s = &ss.val[ss.len - 1];
186 APPEND( s, line, line_len, 1 ); /* strcat to attr */
187 attrs_totlen += line_len;
191 /* Empty line - consume sep+attrs or entries+sep */
192 if ( attrs_totlen != 0 ) {
195 fputs( sep, stdout );
196 build_entry( &ss, entries++, flags, attrs_totlen );
199 flush_entries( &ss, entry_sep, flags );
200 fputs( sep, stdout );
203 sep = "\r\n" + 2 - line_len; /* sep = copy(line) */
210 main( int argc, char **argv )
212 const char *backend = getenv( "BACKEND" ), *specs = "", *tmp;
217 progname = (tmp = strrchr( argv[0], '/' )) ? tmp+1 : argv[0];
220 while ( (i = getopt( argc, argv, "b:s:" )) != EOF ) {
232 if ( optind < argc ) {
235 if ( backend == NULL ) {
240 _setmode(1, _O_BINARY); /* don't convert \n to \r\n on stdout */
242 flags = get_flags( backend, specs );
243 filter_stdin( flags ? flags : get_flags( backend, DEFAULT_SPECS ));
244 if ( fclose( stdout ) == EOF ) {