source/param/params.c

   1 /* -------------------------------------------------------------------------- **
   2  * Microsoft Network Services for Unix, AKA., Andrew Tridgell's SAMBA.
   3  *
   4  * This module Copyright (C) 1990-1998 Karl Auer
   5  *
   6  * Rewritten almost completely by Christopher R. Hertel
   7  * at the University of Minnesota, September, 1997.
   8  * This module Copyright (C) 1997-1998 by the University of Minnesota
   9  * -------------------------------------------------------------------------- **
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24  *
  25  * -------------------------------------------------------------------------- **
  26  *
  27  * Module name: params
  28  *
  29  * -------------------------------------------------------------------------- **
  30  *
  31  *  This module performs lexical analysis and initial parsing of a
  32  *  Windows-like parameter file.  It recognizes and handles four token
  33  *  types:  section-name, parameter-name, parameter-value, and
  34  *  end-of-file.  Comments and line continuation are handled
  35  *  internally.
  36  *
  37  *  The entry point to the module is function pm_process().  This
  38  *  function opens the source file, calls the Parse() function to parse
  39  *  the input, and then closes the file when either the EOF is reached
  40  *  or a fatal error is encountered.
  41  *
  42  *  A sample parameter file might look like this:
  43  *
  44  *  [section one]
  45  *  parameter one = value string
  46  *  parameter two = another value
  47  *  [section two]
  48  *  new parameter = some value or t'other
  49  *
  50  *  The parameter file is divided into sections by section headers:
  51  *  section names enclosed in square brackets (eg. [section one]).
  52  *  Each section contains parameter lines, each of which consist of a
  53  *  parameter name and value delimited by an equal sign.  Roughly, the
  54  *  syntax is:
  55  *
  56  *    <file>            :==  { <section> } EOF
  57  *
  58  *    <section>         :==  <section header> { <parameter line> }
  59  *
  60  *    <section header>  :==  '[' NAME ']'
  61  *
  62  *    <parameter line>  :==  NAME '=' VALUE '\n'
  63  *
  64  *  Blank lines and comment lines are ignored.  Comment lines are lines
  65  *  beginning with either a semicolon (';') or a pound sign ('#').
  66  *
  67  *  All whitespace in section names and parameter names is compressed
  68  *  to single spaces.  Leading and trailing whitespace is stipped from
  69  *  both names and values.
  70  *
  71  *  Only the first equals sign in a parameter line is significant.
  72  *  Parameter values may contain equals signs, square brackets and
  73  *  semicolons.  Internal whitespace is retained in parameter values,
  74  *  with the exception of the '\r' character, which is stripped for
  75  *  historic reasons.  Parameter names may not start with a left square
  76  *  bracket, an equal sign, a pound sign, or a semicolon, because these
  77  *  are used to identify other tokens.
  78  *
  79  * -------------------------------------------------------------------------- **
  80  */
  81
  82 #include "includes.h"
  83
  84 /* -------------------------------------------------------------------------- **
  85  * Constants...
  86  */
  87
  88 #define BUFR_INC 1024
  89
  90
  91 /* -------------------------------------------------------------------------- **
  92  * Variables...
  93  *
  94  *  DEBUGLEVEL  - The ubiquitous DEBUGLEVEL.  This determines which DEBUG()
  95  *                messages will be produced.
  96  *  bufr        - pointer to a global buffer.  This is probably a kludge,
  97  *                but it was the nicest kludge I could think of (for now).
  98  *  bSize       - The size of the global buffer <bufr>.
  99  */
 100
 101 extern int DEBUGLEVEL;
 102
 103 static char *bufr  = NULL;
 104 static int   bSize = 0;
 105
 106 /* we can't use FILE* due to the 256 fd limit - use this cheap hack
 107    instead */
 108 typedef struct {
 109         char *buf;
 110         char *p;
 111         size_t size;
 112 } myFILE;
 113
 114 static int mygetc(myFILE *f)
 115 {
 116         if (f->p >= f->buf+f->size) return EOF;
 117         /* be sure to return chars >127 as positive values */
 118         return (int)( *(f->p++) & 0x00FF );
 119 }
 120
 121 static void myfile_close(myFILE *f)
 122 {
 123         if (!f) return;
 124         if (f->buf) free(f->buf);
 125         free(f);
 126 }
 127
 128 /* -------------------------------------------------------------------------- **
 129  * Functions...
 130  */
 131
 132 static int EatWhitespace( myFILE *InFile )
 133   /* ------------------------------------------------------------------------ **
 134    * Scan past whitespace (see ctype(3C)) and return the first non-whitespace
 135    * character, or newline, or EOF.
 136    *
 137    *  Input:  InFile  - Input source.
 138    *
 139    *  Output: The next non-whitespace character in the input stream.
 140    *
 141    *  Notes:  Because the config files use a line-oriented grammar, we
 142    *          explicitly exclude the newline character from the list of
 143    *          whitespace characters.
 144    *        - Note that both EOF (-1) and the nul character ('\0') are
 145    *          considered end-of-file markers.
 146    *
 147    * ------------------------------------------------------------------------ **
 148    */
 149   {
 150   int c;
 151
 152   for( c = mygetc( InFile ); isspace( c ) && ('\n' != c); c = mygetc( InFile ) )
 153     ;
 154   return( c );
 155   } /* EatWhitespace */
 156
 157 static int EatComment( myFILE *InFile )
 158   /* ------------------------------------------------------------------------ **
 159    * Scan to the end of a comment.
 160    *
 161    *  Input:  InFile  - Input source.
 162    *
 163    *  Output: The character that marks the end of the comment.  Normally,
 164    *          this will be a newline, but it *might* be an EOF.
 165    *
 166    *  Notes:  Because the config files use a line-oriented grammar, we
 167    *          explicitly exclude the newline character from the list of
 168    *          whitespace characters.
 169    *        - Note that both EOF (-1) and the nul character ('\0') are
 170    *          considered end-of-file markers.
 171    *
 172    * ------------------------------------------------------------------------ **
 173    */
 174   {
 175   int c;
 176
 177   for( c = mygetc( InFile ); ('\n'!=c) && (EOF!=c) && (c>0); c = mygetc( InFile ) )
 178     ;
 179   return( c );
 180   } /* EatComment */
 181
 182 /*****************************************************************************
 183  * Scan backards within a string to discover if the last non-whitespace
 184  * character is a line-continuation character ('\\').
 185  *
 186  *  Input:  line  - A pointer to a buffer containing the string to be
 187  *                  scanned.
 188  *          pos   - This is taken to be the offset of the end of the
 189  *                  string.  This position is *not* scanned.
 190  *
 191  *  Output: The offset of the '\\' character if it was found, or -1 to
 192  *          indicate that it was not.
 193  *
 194  *****************************************************************************/
 195
 196 static int Continuation( char *line, int pos )
 197 {
 198         pos--;
 199         while( (pos >= 0) && isspace(line[pos]) )
 200                 pos--;
 201
 202         return (((pos >= 0) && ('\\' == line[pos])) ? pos : -1 );
 203         return (-1);
 204 }
 205
 206
 207 static BOOL Section( myFILE *InFile, BOOL (*sfunc)(char *) )
 208   /* ------------------------------------------------------------------------ **
 209    * Scan a section name, and pass the name to function sfunc().
 210    *
 211    *  Input:  InFile  - Input source.
 212    *          sfunc   - Pointer to the function to be called if the section
 213    *                    name is successfully read.
 214    *
 215    *  Output: True if the section name was read and True was returned from
 216    *          <sfunc>.  False if <sfunc> failed or if a lexical error was
 217    *          encountered.
 218    *
 219    * ------------------------------------------------------------------------ **
 220    */
 221   {
 222   int   c;
 223   int   i;
 224   int   end;
 225   char *func  = "params.c:Section() -";
 226
 227   i = 0;      /* <i> is the offset of the next free byte in bufr[] and  */
 228   end = 0;    /* <end> is the current "end of string" offset.  In most  */
 229               /* cases these will be the same, but if the last          */
 230               /* character written to bufr[] is a space, then <end>     */
 231               /* will be one less than <i>.                             */
 232
 233   c = EatWhitespace( InFile );    /* We've already got the '['.  Scan */
 234                                   /* past initial white space.        */
 235
 236   while( (EOF != c) && (c > 0) )
 237     {
 238
 239     /* Check that the buffer is big enough for the next character. */
 240     if( i > (bSize - 2) )
 241       {
 242       bSize += BUFR_INC;
 243       bufr   = Realloc( bufr, bSize );
 244       if( NULL == bufr )
 245         {
 246         DEBUG(0, ("%s Memory re-allocation failure.", func) );
 247         return( False );
 248         }
 249       }
 250
 251     /* Handle a single character. */
 252     switch( c )
 253       {
 254       case ']':                       /* Found the closing bracket.         */
 255         bufr[end] = '\0';
 256         if( 0 == end )                  /* Don't allow an empty name.       */
 257           {
 258           DEBUG(0, ("%s Empty section name in configuration file.\n", func ));
 259           return( False );
 260           }
 261         if( !sfunc(bufr) )            /* Got a valid name.  Deal with it. */
 262           return( False );
 263         (void)EatComment( InFile );     /* Finish off the line.             */
 264         return( True );
 265
 266       case '\n':                      /* Got newline before closing ']'.    */
 267         i = Continuation( bufr, i );    /* Check for line continuation.     */
 268         if( i < 0 )
 269           {
 270           bufr[end] = '\0';
 271           DEBUG(0, ("%s Badly formed line in configuration file: %s\n",
 272                    func, bufr ));
 273           return( False );
 274           }
 275         end = ( (i > 0) && (' ' == bufr[i - 1]) ) ? (i - 1) : (i);
 276         c = mygetc( InFile );             /* Continue with next line.         */
 277         break;
 278
 279       default:                        /* All else are a valid name chars.   */
 280         if( isspace( c ) )              /* One space per whitespace region. */
 281           {
 282           bufr[end] = ' ';
 283           i = end + 1;
 284           c = EatWhitespace( InFile );
 285           }
 286         else                            /* All others copy verbatim.        */
 287           {
 288           bufr[i++] = c;
 289           end = i;
 290           c = mygetc( InFile );
 291           }
 292       }
 293     }
 294
 295   /* We arrive here if we've met the EOF before the closing bracket. */
 296   DEBUG(0, ("%s Unexpected EOF in the configuration file: %s\n", func, bufr ));
 297   return( False );
 298   } /* Section */
 299
 300 static BOOL Parameter( myFILE *InFile, BOOL (*pfunc)(char *, char *), int c )
 301   /* ------------------------------------------------------------------------ **
 302    * Scan a parameter name and value, and pass these two fields to pfunc().
 303    *
 304    *  Input:  InFile  - The input source.
 305    *          pfunc   - A pointer to the function that will be called to
 306    *                    process the parameter, once it has been scanned.
 307    *          c       - The first character of the parameter name, which
 308    *                    would have been read by Parse().  Unlike a comment
 309    *                    line or a section header, there is no lead-in
 310    *                    character that can be discarded.
 311    *
 312    *  Output: True if the parameter name and value were scanned and processed
 313    *          successfully, else False.
 314    *
 315    *  Notes:  This function is in two parts.  The first loop scans the
 316    *          parameter name.  Internal whitespace is compressed, and an
 317    *          equal sign (=) terminates the token.  Leading and trailing
 318    *          whitespace is discarded.  The second loop scans the parameter
 319    *          value.  When both have been successfully identified, they are
 320    *          passed to pfunc() for processing.
 321    *
 322    * ------------------------------------------------------------------------ **
 323    */
 324   {
 325   int   i       = 0;    /* Position within bufr. */
 326   int   end     = 0;    /* bufr[end] is current end-of-string. */
 327   int   vstart  = 0;    /* Starting position of the parameter value. */
 328   char *func    = "params.c:Parameter() -";
 329
 330   /* Read the parameter name. */
 331   while( 0 == vstart )  /* Loop until we've found the start of the value. */
 332     {
 333
 334     if( i > (bSize - 2) )       /* Ensure there's space for next char.    */
 335       {
 336       bSize += BUFR_INC;
 337       bufr   = Realloc( bufr, bSize );
 338       if( NULL == bufr )
 339         {
 340         DEBUG(0, ("%s Memory re-allocation failure.", func) );
 341         return( False );
 342         }
 343       }
 344
 345     switch( c )
 346       {
 347       case '=':                 /* Equal sign marks end of param name. */
 348         if( 0 == end )              /* Don't allow an empty name.      */
 349           {
 350           DEBUG(0, ("%s Invalid parameter name in config. file.\n", func ));
 351           return( False );
 352           }
 353         bufr[end++] = '\0';         /* Mark end of string & advance.   */
 354         i       = end;              /* New string starts here.         */
 355         vstart  = end;              /* New string is parameter value.  */
 356         bufr[i] = '\0';             /* New string is nul, for now.     */
 357         break;
 358
 359       case '\n':                /* Find continuation char, else error. */
 360         i = Continuation( bufr, i );
 361         if( i < 0 )
 362           {
 363           bufr[end] = '\0';
 364           DEBUG(1,("%s Ignoring badly formed line in configuration file: %s\n",
 365                    func, bufr ));
 366           return( True );
 367           }
 368         end = ( (i > 0) && (' ' == bufr[i - 1]) ) ? (i - 1) : (i);
 369         c = mygetc( InFile );       /* Read past eoln.                   */
 370         break;
 371
 372       case '\0':                /* Shouldn't have EOF within param name. */
 373       case EOF:
 374         bufr[i] = '\0';
 375         DEBUG(1,("%s Unexpected end-of-file at: %s\n", func, bufr ));
 376         return( True );
 377
 378       default:
 379         if( isspace( c ) )     /* One ' ' per whitespace region.       */
 380           {
 381           bufr[end] = ' ';
 382           i = end + 1;
 383           c = EatWhitespace( InFile );
 384           }
 385         else                   /* All others verbatim.                 */
 386           {
 387           bufr[i++] = c;
 388           end = i;
 389           c = mygetc( InFile );
 390           }
 391       }
 392     }
 393
 394   /* Now parse the value. */
 395   c = EatWhitespace( InFile );  /* Again, trim leading whitespace. */
 396   while( (EOF !=c) && (c > 0) )
 397     {
 398
 399     if( i > (bSize - 2) )       /* Make sure there's enough room. */
 400       {
 401       bSize += BUFR_INC;
 402       bufr   = Realloc( bufr, bSize );
 403       if( NULL == bufr )
 404         {
 405         DEBUG(0, ("%s Memory re-allocation failure.", func) );
 406         return( False );
 407         }
 408       }
 409
 410     switch( c )
 411       {
 412       case '\r':              /* Explicitly remove '\r' because the older */
 413         c = mygetc( InFile );   /* version called fgets_slash() which also  */
 414         break;                /* removes them.                            */
 415
 416       case '\n':              /* Marks end of value unless there's a '\'. */
 417         i = Continuation( bufr, i );
 418         if( i < 0 )
 419           c = 0;
 420         else
 421           {
 422           for( end = i; (end >= 0) && isspace(bufr[end]); end-- )
 423             ;
 424           c = mygetc( InFile );
 425           }
 426         break;
 427
 428       default:               /* All others verbatim.  Note that spaces do */
 429         bufr[i++] = c;       /* not advance <end>.  This allows trimming  */
 430         if( !isspace( c ) )  /* of whitespace at the end of the line.     */
 431           end = i;
 432         c = mygetc( InFile );
 433         break;
 434       }
 435     }
 436   bufr[end] = '\0';          /* End of value. */
 437
 438   return( pfunc( bufr, &bufr[vstart] ) );   /* Pass name & value to pfunc().  */
 439   } /* Parameter */
 440
 441 static BOOL Parse( myFILE *InFile,
 442                    BOOL (*sfunc)(char *),
 443                    BOOL (*pfunc)(char *, char *) )
 444   /* ------------------------------------------------------------------------ **
 445    * Scan & parse the input.
 446    *
 447    *  Input:  InFile  - Input source.
 448    *          sfunc   - Function to be called when a section name is scanned.
 449    *                    See Section().
 450    *          pfunc   - Function to be called when a parameter is scanned.
 451    *                    See Parameter().
 452    *
 453    *  Output: True if the file was successfully scanned, else False.
 454    *
 455    *  Notes:  The input can be viewed in terms of 'lines'.  There are four
 456    *          types of lines:
 457    *            Blank      - May contain whitespace, otherwise empty.
 458    *            Comment    - First non-whitespace character is a ';' or '#'.
 459    *                         The remainder of the line is ignored.
 460    *            Section    - First non-whitespace character is a '['.
 461    *            Parameter  - The default case.
 462    *
 463    * ------------------------------------------------------------------------ **
 464    */
 465   {
 466   int    c;
 467
 468   c = EatWhitespace( InFile );
 469   while( (EOF != c) && (c > 0) )
 470     {
 471     switch( c )
 472       {
 473       case '\n':                        /* Blank line. */
 474         c = EatWhitespace( InFile );
 475         break;
 476
 477       case ';':                         /* Comment line. */
 478       case '#':
 479         c = EatComment( InFile );
 480         break;
 481
 482       case '[':                         /* Section Header. */
 483         if( !Section( InFile, sfunc ) )
 484           return( False );
 485         c = EatWhitespace( InFile );
 486         break;
 487
 488       case '\\':                        /* Bogus backslash. */
 489         c = EatWhitespace( InFile );
 490         break;
 491
 492       default:                          /* Parameter line. */
 493         if( !Parameter( InFile, pfunc, c ) )
 494           return( False );
 495         c = EatWhitespace( InFile );
 496         break;
 497       }
 498     }
 499   return( True );
 500   } /* Parse */
 501
 502 static myFILE *OpenConfFile( char *FileName )
 503   /* ------------------------------------------------------------------------ **
 504    * Open a configuration file.
 505    *
 506    *  Input:  FileName  - The pathname of the config file to be opened.
 507    *
 508    *  Output: A pointer of type (char **) to the lines of the file
 509    *
 510    * ------------------------------------------------------------------------ **
 511    */
 512   {
 513   char *func = "params.c:OpenConfFile() -";
 514   extern BOOL in_client;
 515   int lvl = in_client?1:0;
 516   myFILE *ret;
 517
 518   ret = (myFILE *)malloc(sizeof(*ret));
 519   if (!ret) return NULL;
 520
 521   ret->buf = file_load(FileName, &ret->size);
 522   if( NULL == ret->buf )
 523     {
 524     DEBUG( lvl,
 525       ("%s Unable to open configuration file \"%s\":\n\t%s\n",
 526       func, FileName, strerror(errno)) );
 527     free(ret);
 528     return NULL;
 529     }
 530
 531   ret->p = ret->buf;
 532   return( ret );
 533   } /* OpenConfFile */
 534
 535 BOOL pm_process( char *FileName,
 536                  BOOL (*sfunc)(char *),
 537                  BOOL (*pfunc)(char *, char *) )
 538   /* ------------------------------------------------------------------------ **
 539    * Process the named parameter file.
 540    *
 541    *  Input:  FileName  - The pathname of the parameter file to be opened.
 542    *          sfunc     - A pointer to a function that will be called when
 543    *                      a section name is discovered.
 544    *          pfunc     - A pointer to a function that will be called when
 545    *                      a parameter name and value are discovered.
 546    *
 547    *  Output: TRUE if the file was successfully parsed, else FALSE.
 548    *
 549    * ------------------------------------------------------------------------ **
 550    */
 551   {
 552   int   result;
 553   myFILE *InFile;
 554   char *func = "params.c:pm_process() -";
 555
 556   InFile = OpenConfFile( FileName );          /* Open the config file. */
 557   if( NULL == InFile )
 558     return( False );
 559
 560   DEBUG( 3, ("%s Processing configuration file \"%s\"\n", func, FileName) );
 561
 562   if( NULL != bufr )                          /* If we already have a buffer */
 563     result = Parse( InFile, sfunc, pfunc );   /* (recursive call), then just */
 564                                               /* use it.                     */
 565
 566   else                                        /* If we don't have a buffer   */
 567     {                                         /* allocate one, then parse,   */
 568     bSize = BUFR_INC;                         /* then free.                  */
 569     bufr = (char *)malloc( bSize );
 570     if( NULL == bufr )
 571       {
 572       DEBUG(0,("%s memory allocation failure.\n", func));
 573       myfile_close(InFile);
 574       return( False );
 575       }
 576     result = Parse( InFile, sfunc, pfunc );
 577     free( bufr );
 578     bufr  = NULL;
 579     bSize = 0;
 580     }
 581
 582   myfile_close(InFile);
 583
 584   if( !result )                               /* Generic failure. */
 585     {
 586     DEBUG(0,("%s Failed.  Error returned from params.c:parse().\n", func));
 587     return( False );
 588     }
 589
 590   return( True );                             /* Generic success. */
 591   } /* pm_process */
 592
 593 /* -------------------------------------------------------------------------- */