git.sur5r.net Git - openldap/blob - libraries/libldap/srchpref.c

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6 /* Portions
   7  * Copyright (c) 1993, 1994 Regents of the University of Michigan.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms are permitted
  11  * provided that this notice is preserved and that due credit is given
  12  * to the University of Michigan at Ann Arbor. The name of the University
  13  * may not be used to endorse or promote products derived from this
  14  * software without specific prior written permission. This software
  15  * is provided ``as is'' without express or implied warranty.
  16  *
  17  * searchpref.c:  search preferences library routines for LDAP clients
  18  * 17 May 1994 by Gordon Good
  19  */
  20
  21 #include "portable.h"
  22
  23 #include <stdio.h>
  24
  25 #include <ac/stdlib.h>
  26
  27 #include <ac/ctype.h>
  28 #include <ac/string.h>
  29 #include <ac/time.h>
  30 #include <ac/unistd.h>
  31
  32 #ifdef HAVE_SYS_FILE_H
  33 #include <sys/file.h>
  34 #endif
  35
  36 #include "ldap-int.h"
  37 #include "srchpref.h"
  38
  39 #include "ldap-int.h"
  40
  41 static void free_searchobj LDAP_P(( struct ldap_searchobj *so ));
  42 static int read_next_searchobj LDAP_P(( char **bufp, ber_len_t *blenp,
  43         struct ldap_searchobj **sop, int soversion ));
  44
  45
  46 static const char *const        sobjoptions[] = {
  47     "internal",
  48     NULL
  49 };
  50
  51
  52 static const unsigned long      sobjoptvals[] = {
  53     LDAP_SEARCHOBJ_OPT_INTERNAL,
  54 };
  55
  56
  57 int
  58 ldap_init_searchprefs( char *file, struct ldap_searchobj **solistp )
  59 {
  60     FILE        *fp;
  61     char        *buf;
  62     long        rlen, len;
  63     int         rc, eof;
  64
  65     if (( fp = fopen( file, "r" )) == NULL ) {
  66         return( LDAP_SEARCHPREF_ERR_FILE );
  67     }
  68
  69     if ( fseek( fp, 0L, SEEK_END ) != 0 ) {     /* move to end to get len */
  70         fclose( fp );
  71         return( LDAP_SEARCHPREF_ERR_FILE );
  72     }
  73
  74     len = ftell( fp );
  75
  76     if ( fseek( fp, 0L, SEEK_SET ) != 0 ) {     /* back to start of file */
  77         fclose( fp );
  78         return( LDAP_SEARCHPREF_ERR_FILE );
  79     }
  80
  81     if (( buf = LDAP_MALLOC( (size_t)len )) == NULL ) {
  82         fclose( fp );
  83         return( LDAP_SEARCHPREF_ERR_MEM );
  84     }
  85
  86     rlen = fread( buf, 1, (size_t)len, fp );
  87     eof = feof( fp );
  88     fclose( fp );
  89
  90     if ( rlen != len && !eof ) {        /* error:  didn't get the whole file */
  91         LDAP_FREE( buf );
  92         return( LDAP_SEARCHPREF_ERR_FILE );
  93     }
  94
  95     rc = ldap_init_searchprefs_buf( buf, rlen, solistp );
  96     LDAP_FREE( buf );
  97
  98     return( rc );
  99 }
 100
 101
 102 int
 103 ldap_init_searchprefs_buf(
 104         char *buf,
 105         ber_len_t buflen,
 106         struct ldap_searchobj **solistp )
 107 {
 108     int                         rc = -1, version;
 109     char                        **toks;
 110     struct ldap_searchobj       *prevso, *so;
 111
 112     *solistp = prevso = NULL;
 113
 114     if ( ldap_int_next_line_tokens( &buf, &buflen, &toks ) != 2 ||
 115             strcasecmp( toks[ 0 ], "version" ) != 0 ) {
 116         LDAP_VFREE( toks );
 117         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 118     }
 119     version = atoi( toks[ 1 ] );
 120     LDAP_VFREE( toks );
 121     if ( version != LDAP_SEARCHPREF_VERSION &&
 122             version != LDAP_SEARCHPREF_VERSION_ZERO ) {
 123         return( LDAP_SEARCHPREF_ERR_VERSION );
 124     }
 125
 126     while ( buflen > 0 && ( rc = read_next_searchobj( &buf, &buflen, &so,
 127             version )) == 0 && so != NULL ) {
 128         if ( prevso == NULL ) {
 129             *solistp = so;
 130         } else {
 131             prevso->so_next = so;
 132         }
 133         prevso = so;
 134     }
 135
 136     if ( rc != 0 ) {
 137         ldap_free_searchprefs( *solistp );
 138     }
 139
 140     return( rc );
 141 }
 142
 143
 144
 145 void
 146 ldap_free_searchprefs( struct ldap_searchobj *solist )
 147 {
 148     struct ldap_searchobj       *so, *nextso;
 149
 150     if ( solist != NULL ) {
 151         for ( so = solist; so != NULL; so = nextso ) {
 152             nextso = so->so_next;
 153             free_searchobj( so );
 154         }
 155     }
 156     /* XXX XXX need to do some work here */
 157 }
 158
 159
 160 static void
 161 free_searchobj( struct ldap_searchobj *so )
 162 {
 163     if ( so != NULL ) {
 164         if ( so->so_objtypeprompt != NULL ) {
 165             LDAP_FREE(  so->so_objtypeprompt );
 166         }
 167         if ( so->so_prompt != NULL ) {
 168             LDAP_FREE(  so->so_prompt );
 169         }
 170         if ( so->so_filterprefix != NULL ) {
 171             LDAP_FREE(  so->so_filterprefix );
 172         }
 173         if ( so->so_filtertag != NULL ) {
 174             LDAP_FREE(  so->so_filtertag );
 175         }
 176         if ( so->so_defaultselectattr != NULL ) {
 177             LDAP_FREE(  so->so_defaultselectattr );
 178         }
 179         if ( so->so_defaultselecttext != NULL ) {
 180             LDAP_FREE(  so->so_defaultselecttext );
 181         }
 182         if ( so->so_salist != NULL ) {
 183             struct ldap_searchattr *sa, *nextsa;
 184             for ( sa = so->so_salist; sa != NULL; sa = nextsa ) {
 185                 nextsa = sa->sa_next;
 186                 if ( sa->sa_attrlabel != NULL ) {
 187                     LDAP_FREE( sa->sa_attrlabel );
 188                 }
 189                 if ( sa->sa_attr != NULL ) {
 190                     LDAP_FREE( sa->sa_attr );
 191                 }
 192                 if ( sa->sa_selectattr != NULL ) {
 193                     LDAP_FREE( sa->sa_selectattr );
 194                 }
 195                 if ( sa->sa_selecttext != NULL ) {
 196                     LDAP_FREE( sa->sa_selecttext );
 197                 }
 198                 LDAP_FREE( sa );
 199             }
 200         }
 201         if ( so->so_smlist != NULL ) {
 202             struct ldap_searchmatch *sm, *nextsm;
 203             for ( sm = so->so_smlist; sm != NULL; sm = nextsm ) {
 204                 nextsm = sm->sm_next;
 205                 if ( sm->sm_matchprompt != NULL ) {
 206                     LDAP_FREE( sm->sm_matchprompt );
 207                 }
 208                 if ( sm->sm_filter != NULL ) {
 209                     LDAP_FREE( sm->sm_filter );
 210                 }
 211                 LDAP_FREE( sm );
 212             }
 213         }
 214         LDAP_FREE( so );
 215     }
 216 }
 217
 218
 219
 220 struct ldap_searchobj *
 221 ldap_first_searchobj( struct ldap_searchobj *solist )
 222 {
 223     return( solist );
 224 }
 225
 226
 227 struct ldap_searchobj *
 228 ldap_next_searchobj( struct ldap_searchobj *solist, struct ldap_searchobj *so )
 229 {
 230     return( so == NULL ? so : so->so_next );
 231 }
 232
 233
 234
 235 static int
 236 read_next_searchobj(
 237         char **bufp,
 238         ber_len_t *blenp,
 239         struct ldap_searchobj **sop,
 240         int soversion )
 241 {
 242     int                         i, j, tokcnt;
 243     char                        **toks;
 244     struct ldap_searchobj       *so;
 245     struct ldap_searchattr      **sa;
 246     struct ldap_searchmatch     **sm;
 247
 248     *sop = NULL;
 249
 250     /*
 251      * Object type prompt comes first
 252      */
 253     if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) != 1 ) {
 254         LDAP_VFREE( toks );
 255         return( tokcnt == 0 ? 0 : LDAP_SEARCHPREF_ERR_SYNTAX );
 256     }
 257
 258     if (( so = (struct ldap_searchobj *)LDAP_CALLOC( 1,
 259             sizeof( struct ldap_searchobj ))) == NULL ) {
 260         LDAP_VFREE( toks );
 261         return(  LDAP_SEARCHPREF_ERR_MEM );
 262     }
 263     so->so_objtypeprompt = toks[ 0 ];
 264     LDAP_FREE( (char *)toks );
 265
 266     /*
 267      * if this is post-version zero, options come next
 268      */
 269     if ( soversion > LDAP_SEARCHPREF_VERSION_ZERO ) {
 270         if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) < 1 ) {
 271             LDAP_VFREE( toks );
 272             ldap_free_searchprefs( so );
 273             return( LDAP_SEARCHPREF_ERR_SYNTAX );
 274         }
 275         for ( i = 0; toks[ i ] != NULL; ++i ) {
 276             for ( j = 0; sobjoptions[ j ] != NULL; ++j ) {
 277                 if ( strcasecmp( toks[ i ], sobjoptions[ j ] ) == 0 ) {
 278                     so->so_options |= sobjoptvals[ j ];
 279                 }
 280             }
 281         }
 282         LDAP_VFREE( toks );
 283     }
 284
 285     /*
 286      * "Fewer choices" prompt is next
 287      */
 288     if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) != 1 ) {
 289         LDAP_VFREE( toks );
 290         ldap_free_searchprefs( so );
 291         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 292     }
 293     so->so_prompt = toks[ 0 ];
 294     LDAP_FREE( (char *)toks );
 295
 296     /*
 297      * Filter prefix for "More Choices" searching is next
 298      */
 299     if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) != 1 ) {
 300         LDAP_VFREE( toks );
 301         ldap_free_searchprefs( so );
 302         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 303     }
 304     so->so_filterprefix = toks[ 0 ];
 305     LDAP_FREE( (char *)toks );
 306
 307     /*
 308      * "Fewer Choices" filter tag comes next
 309      */
 310     if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) != 1 ) {
 311         LDAP_VFREE( toks );
 312         ldap_free_searchprefs( so );
 313         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 314     }
 315     so->so_filtertag = toks[ 0 ];
 316     LDAP_FREE( (char *)toks );
 317
 318     /*
 319      * Selection (disambiguation) attribute comes next
 320      */
 321     if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) != 1 ) {
 322         LDAP_VFREE( toks );
 323         ldap_free_searchprefs( so );
 324         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 325     }
 326     so->so_defaultselectattr = toks[ 0 ];
 327     LDAP_FREE( (char *)toks );
 328
 329     /*
 330      * Label for selection (disambiguation) attribute
 331      */
 332     if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) != 1 ) {
 333         LDAP_VFREE( toks );
 334         ldap_free_searchprefs( so );
 335         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 336     }
 337     so->so_defaultselecttext = toks[ 0 ];
 338     LDAP_FREE( (char *)toks );
 339
 340     /*
 341      * Search scope is next
 342      */
 343     if (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) != 1 ) {
 344         LDAP_VFREE( toks );
 345         ldap_free_searchprefs( so );
 346         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 347     }
 348     if ( !strcasecmp(toks[ 0 ], "subtree" )) {
 349         so->so_defaultscope = LDAP_SCOPE_SUBTREE;
 350     } else if ( !strcasecmp(toks[ 0 ], "onelevel" )) {
 351         so->so_defaultscope = LDAP_SCOPE_ONELEVEL;
 352     } else if ( !strcasecmp(toks[ 0 ], "base" )) {
 353         so->so_defaultscope = LDAP_SCOPE_BASE;
 354     } else {
 355         ldap_free_searchprefs( so );
 356         return( LDAP_SEARCHPREF_ERR_SYNTAX );
 357     }
 358     LDAP_VFREE( toks );
 359
 360
 361     /*
 362      * "More Choices" search option list comes next
 363      */
 364     sa = &( so->so_salist );
 365     while (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) > 0 ) {
 366         if ( tokcnt < 5 ) {
 367             LDAP_VFREE( toks );
 368             ldap_free_searchprefs( so );
 369             return( LDAP_SEARCHPREF_ERR_SYNTAX );
 370         }
 371         if (( *sa = ( struct ldap_searchattr * ) LDAP_CALLOC( 1,
 372                 sizeof( struct ldap_searchattr ))) == NULL ) {
 373             LDAP_VFREE( toks );
 374             ldap_free_searchprefs( so );
 375             return(  LDAP_SEARCHPREF_ERR_MEM );
 376         }
 377         ( *sa )->sa_attrlabel = toks[ 0 ];
 378         ( *sa )->sa_attr = toks[ 1 ];
 379         ( *sa )->sa_selectattr = toks[ 3 ];
 380         ( *sa )->sa_selecttext = toks[ 4 ];
 381         /* Deal with bitmap */
 382         ( *sa )->sa_matchtypebitmap = 0;
 383         for ( i = strlen( toks[ 2 ] ) - 1, j = 0; i >= 0; i--, j++ ) {
 384             if ( toks[ 2 ][ i ] == '1' ) {
 385                 ( *sa )->sa_matchtypebitmap |= (1 << j);
 386             }
 387         }
 388         LDAP_FREE( toks[ 2 ] );
 389         LDAP_FREE( ( char * ) toks );
 390         sa = &(( *sa )->sa_next);
 391     }
 392     *sa = NULL;
 393
 394     /*
 395      * Match types are last
 396      */
 397     sm = &( so->so_smlist );
 398     while (( tokcnt = ldap_int_next_line_tokens( bufp, blenp, &toks )) > 0 ) {
 399         if ( tokcnt < 2 ) {
 400             LDAP_VFREE( toks );
 401             ldap_free_searchprefs( so );
 402             return( LDAP_SEARCHPREF_ERR_SYNTAX );
 403         }
 404         if (( *sm = ( struct ldap_searchmatch * ) LDAP_CALLOC( 1,
 405                 sizeof( struct ldap_searchmatch ))) == NULL ) {
 406             LDAP_VFREE( toks );
 407             ldap_free_searchprefs( so );
 408             return(  LDAP_SEARCHPREF_ERR_MEM );
 409         }
 410         ( *sm )->sm_matchprompt = toks[ 0 ];
 411         ( *sm )->sm_filter = toks[ 1 ];
 412         LDAP_FREE( ( char * ) toks );
 413         sm = &(( *sm )->sm_next );
 414     }
 415     *sm = NULL;
 416
 417     *sop = so;
 418     return( 0 );
 419 }