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