1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
|
/*
* Generic configuration file handling.
* By Andy McFadden. This software is in the public domain.
* Code formatted with 4-space tabs (use ":set ts=4" in vi).
*
* Page down a few screens for instructions. Basically, set up a config
* description table, then either call:
*
* read_config_file(argv[0], config_tab, config_count, filename);
* or
* read_config(argv[0], config_tab, config_count, fp);
*
* To free up any allocated space, call:
*
* dispose_config(argv[0], config_tab, config_count);
*
* Compile with -DSYSV on systems that use <string.h> instead of <strings.h>.
* If you're missing strcasecmp(), add -DNEED_STRCASECMP.
*
*
* readconf.c revision history:
*
* v1.1 ATM 15-Feb-96
* Reformatted source, converting to ANSI C. Added "dispose" functions.
* Made config table an argument. Added cf_forgiving and cf_check_alloc.
* v1.0 ATM 22-Jul-94
* Seems to work.
*/
#include <stdio.h>
#ifdef SYSV
# include <stdlib.h>
# include <string.h>
#else
# include <string.h>
# include <strings.h>
#endif
#include <math.h> /* for strtod() */
#include <malloc.h>
#include <errno.h>
#include "readconf.h"
#ifndef TRUE
# define TRUE 1
# define FALSE 0
#endif /*TRUE*/
/*
* Tweak these as needed (change values, make them public, etc).
*/
static int cf_debug = FALSE; /* print debugging info */
static int cf_verbose = FALSE; /* print progress info */
static int cf_forgiving = FALSE; /* allow unknown tags? */
static int cf_check_alloc = TRUE; /* only malloc onto NULL pointer? */
/*#define NEED_STRCASECMP*/
/*
* The basic configuration line looks like:
*
* tag_name : value
*
* Leading and trailing whitespace is removed. Whitespace before and after
* the colon is removed. Blank lines and lines starting with '#' are
* ignored (this happens after the leading w/s is removed, so any line where
* a '#' is the first non-whitespace char is ignored).
*
* Double quotes and backslashes may be used to escape whitespace and break
* long lines. The maximum length of a complete line (i.e. including parts
* broken across newlines with '\') is CF_MAX_LINE_LEN. The maximum length
* of the tag is CF_MAX_TAG_LEN. Note that the tag portion may NOT include
* quotes or backslashes (well, they won't be interpreted specially).
*
* Some of the ANSI C character escape sequences (e.g. \n, \t) are supported.
*
*
* The following classes of configuration statements are supported:
*
* CF_BOOLEAN boolean_value: True
*
* The corresponding variable is set to 0 if the rhs is "off" or "false",
* or 1 if the rhs is "on" or "true". The values are case-insensitive.
*
* CF_INT int_value: 12345
*
* The corresponding variable is set to the value of the rhs as it's
* evaluated by strtol(str, NULL, 0). So, "0x1234" and "01234" are
* treated as hex and octal, respectively.
*
* CF_DOUBLE double_value: 12345.0
*
* The corresponding variable is set to the value of the rhs as it's
* evaluated by strtod(str, NULL). If the system is lame, atof(str)
* may be used instead.
*
* CF_STRING string_value: The quick brown fox.
*
* The value, stripped of leading and trailing whitespace, is copied
* with substitutions into the storage space indicated (see below). The
* length of the space should be given in the "size" field. If "size"
* is zero, and "reference" points to a NULL char*, then space will be
* allocated with malloc(3). "size"==0, *"ref"!=NULL generates an error.
*
* CF_MULTI_STRING multi_value: The quick brown fox.
*
* The difference between CF_STRING and CF_MULTI_STRING is that the
* latter parses the string into separate components, and then passes
* them as individual arguments to a subroutine (see below). The
* "delim" field is a pointer to a string with the field delimiters,
* usually whitespace ("\t ") or a colon (":"). The "size" field is
* not used here.
*
* The function called by a CF_MULTI_STRING line takes two arguments,
* argc and argv, which are identical in form to the arguments supplied
* to main(). The strings are part of a static buffer, and the
* argument vector pointers are dynamically allocated space which will
* be freed after the procedure call, so the arguments must be copied
* if they are to be kept.
*
* CF_MULTI_LINE multi_line_start
* line1
* line2
* line3
* multi_line_end
*
* When you need a whole collection of free-form lines, use
* CF_MULTI_LINE. Each line is passed verbatim (NO w/s stripping, NO
* '\' evaluation, etc) to the specified routine. An end tag should be
* pointed to be the "delim" field; when the parser sees it at the start
* of a line it goes on to the next tag.
*
* The function called by CF_MULTI_LINE takes one argument, the
* un-parsed rhs. This is also in a static buffer, and must be copied.
*/
/*
* The structure defining the config file has five fields:
*
* kind
* What kind of field this is, e.g. CF_STRING.
*
* tag
* What tag will be used to identify this item, i.e. what word comes
* before the ':'. Matching of tags is case-insensitive.
*
* reference
* Variable to change (for BOOLEAN, INT, DOUBLE, and STRING) or function
* to call (for MULTI_STRING and MULTI_LINE). Note that string is
* either a (char *) for size != 0 or a (char **) for size == 0.
*
* size
* Used by STRING to specify the size of a buffer. If set to zero,
* *and* the variable to change is NULL, space will be allocated with
* malloc(). This value should be equal to the TOTAL size of the
* buffer, i.e. "size" of 16 means 15 characters plus the '\0'.
*
* delim
* Used by MULTI_STRING to define where the word breaks are, and used
* by MULTI_LINE to define where the list ends.
*
* flags
* Currently not used. See next section for possible uses.
*/
/*
* Miscellaneous ideas:
*
* - allow a combined MULTI_STRING and MULTI_LINE for convenience.
* - allow /bin/sh-style variable substitution, including environment
* variables.
* - support all of the ANSI C escape sequences, especially \x07 and \007.
*
* - use the "flags" field to define items as "configure-once-only", so
* that a second instance of that tag generates an error.
* - use the "flags" field to define MULTI_STRING delimiters as "single"
* or "many". Right now "ack foo bar" results in 'ack', 'foo', and
* 'bar', which is desirable. However, parsing an /etc/passwd entry like
* "daemon:*:1:1::/:" will result in a missing field, because the "::" is
* meant to indicate an empty string for the fifth entry, but the current
* implementation will combine the delimiters together.
* - use the "flags" field to define whether MULTI_LINE fields must have a
* closing delimiter, or if it's acceptable to just let them run until EOF.
* - use the "flags" field to decide if we really want to strip off trailing
* whitespace. Right now, it will cut off trailing spaces even if they
* are inside double quotes. (Better yet, fix the code so that it deals
* with trailing w/s correctly.)
*
* - could move the configuration struct, along with all of these comments,
* into a separate header file for ease of use. But that creates yet
* another file to deal with, which probably isn't desirable.
*/
#ifdef NEED_STRCASECMP /* not uncommon for libc to be missing this */
/*
* Like strcmp(), but case independent.
*/
int
strcasecmp(register const char *str1, register const char *str2)
{
while (*str1 && *str2 && toupper(*str1) == toupper(*str2))
str1++, str2++;
return (*str1 - *str2);
}
/*
* Like strncmp(), but case independent.
*/
int
strncasecmp(register const char *str1, register const char *str2, size_t n)
{
while (n && *str1 && *str2 && toupper(*str1) == toupper(*str2))
str1++, str2++, n--;
if (n)
return (*str1 - *str2);
else
return (0); /* no mismatch in first n chars */
}
#endif /*NEED_STRCASECMP*/
typedef int (*CF_INTFUNCPTR)(); /* pointer to function returning int */
/*
* Local prototypes.
*/
static int add_ms(char *str);
static int convert_ms(void);
static const CONFIG * lookup_tag(const CONFIG *config_tab, int config_count, char *tag_name);
static int read_line(FILE *fp);
static int get_full_line(const CONFIG *config_tab, int config_size, FILE *fp);
static int eval_boolean(const CONFIG *configp);
static int eval_int(const CONFIG *configp);
static int eval_double(const CONFIG *configp);
static int eval_string(const CONFIG *configp);
static int eval_multi_string(const CONFIG *configp);
static int eval_multi_line(const CONFIG *configp, FILE *fp);
#define CF_MAX_LINE_LEN 1024
#define CF_MAX_TAG_LEN 32
#define CF_MAX_MS_TOKEN 128 /* just a sanity check */
const char *default_argv0 = "<caller unknown>";
/* private definition of isspace(); only tab and space */
#define cf_isspace(x) ((x) == ' ' || (x) == '\t')
#define cf_iseol(x) ((x) == '\n' || (x) == '\0')
/* local buffers */
static char line_buf[CF_MAX_LINE_LEN+1]; /* used with fgets() */
static char full_line_buf[CF_MAX_LINE_LEN+1]; /* post-processing version */
static char tag_buf[CF_MAX_TAG_LEN+1]; /* the tag, in lower case */
static int line; /* current line # in input */
static char *cf_err_str = NULL; /* error message */
/* MULTI_STRING data */
typedef struct list_t {
char *data;
struct list_t *next;
} LIST;
static int ms_argc;
static char **ms_argv;
static LIST *head = NULL, *tail;
/*
* Initialize MULTI_STRING stuff.
*/
static int
init_ms(void)
{
if (head != NULL) {
fprintf(stderr, "init_ms(): called twice without convert_ms()\n");
return (-1);
}
ms_argc = 0;
ms_argv = (char **)NULL;
return (0);
}
/*
* Add a new token to the MULTI_STRING list.
*/
static int
add_ms(char *str)
{
LIST *lp;
if (ms_argc >= CF_MAX_MS_TOKEN) {
cf_err_str = "too many tokens on one line";
return (-1);
}
ms_argc++;
lp = (LIST *)malloc(sizeof(LIST));
if (lp == NULL) {
fprintf(stderr, "add_ms(): malloc() failed\n");
return (-1);
}
lp->data = str;
lp->next = NULL;
if (head == NULL) {
head = tail = lp;
} else {
tail->next = lp;
tail = lp;
}
return (0);
}
/*
* Convert the list of tokens into an argument vector. Frees the list nodes.
*/
static int
convert_ms(void)
{
LIST *lp, *tmplp;
int i;
/* allocate space for the string vector; freed in eval_multi_string */
ms_argv = (char **)malloc(sizeof(char *) * ms_argc);
/* copy the pointers from the list to the vector, freeing the list nodes */
i = 0;
lp = head;
while (lp != NULL) {
ms_argv[i++] = lp->data;
tmplp = lp->next;
free(lp);
lp = tmplp;
}
head = tail = NULL;
/* if the last token got eaten as trailing whitespace, nuke it */
if (*(ms_argv[ms_argc-1]) == '\0')
ms_argc--;
if (cf_debug) {
int j;
for (j = 0; j < ms_argc; j++)
printf(" TOKEN: '%s'\n", ms_argv[j]);
}
return (0);
}
/*
* Look up a tag in the config[] array.
*
* Returns a pointer to the CONFIG struct if found, NULL if not.
*/
static const CONFIG *
lookup_tag(const CONFIG *config_tab, int config_count, char *tag_name)
{
const CONFIG *conp;
int i;
for (conp = config_tab, i = 0; i < config_count; i++, conp++) {
if (strcasecmp(conp->tag, tag_name) == 0) {
if (cf_debug) printf("lookup: '%s' found\n", tag_name);
return (conp);
}
}
if (cf_debug) printf("lookup: '%s' NOT FOUND\n", tag_name);
return (NULL);
}
/*
* Read a line of input.
*
* Returns 0 on success, 1 on EOF reached, -1 on error. Results are placed
* into line_buf.
*/
static int
read_line(FILE *fp)
{
if ((fgets(line_buf, CF_MAX_LINE_LEN, fp)) == NULL) {
if (ferror(fp)) return (-1);
if (feof(fp)) return (1);
cf_err_str = "fgets() failed, but I don't know why";
return (-1);
}
line++;
if (cf_debug) printf("LINE(%d): '%s'\n", line, line_buf);
return (0);
}
/*
* Read a full line of input from the configuration file, doing all of the
* appropriate processing.
*
* Uses a DFA to process the input. I cheat a bit and allow transitions
* without eating a character.
*
* Returns 0 on success, 1 on EOF reached, and -1 on error. The results
* of the routine are placed into tag_buf and full_line_buf.
*/
static int
get_full_line(const CONFIG *config_tab, int config_size, FILE *fp)
{
enum { R_CHAOS, R_START, R_TAG, R_PRECOLON, R_POSTCOLON,
R_RHS, R_RHS_MS, R_DQUOTE, R_BACK, R_DQ_BACK, R_ERROR, R_DONE
} state;
const CONFIG *configp = NULL;
char *inp, *outp, *cp;
int val, is_ms = 0;
full_line_buf[0] = '\0';
inp = outp = NULL;
init_ms();
state = R_CHAOS;
/*
* Welcome to the machine.
*/
while (state != R_DONE) {
switch (state) {
case R_CHAOS: /* in the beginning, there was... */
if ((val = read_line(fp)))
return (val); /* bail on error or EOF */
inp = line_buf;
state = R_START;
break;
case R_START: /* skip leading whitespace */
if (cf_isspace(*inp)) { /* WS --> loop */
inp++;
break;
}
if (*inp == '#' || cf_iseol(*inp)) {
state = R_CHAOS; /* '#' or blank --> R_CHAOS */
break;
}
state = R_TAG; /* else --> R_TAG */
outp = tag_buf;
break;
case R_TAG: /* copy tag into tag_buf */
/* terminate outp in case we exit */
*outp = '\0';
if (cf_isspace(*inp)) { /* WS --> R_PRECOLON */
inp++;
state = R_PRECOLON;
break;
}
if (*inp == ':') { /* ':' --> R_POSTCOLON */
inp++;
state = R_POSTCOLON;
break;
}
/* this happens for MULTI_LINE stuff */
if (cf_iseol(*inp)) { /* EOL --> R_DONE */
state = R_DONE;
break;
}
*outp++ = *inp++; /* else --> loop */
break;
case R_PRECOLON: /* tag done, waiting for colon */
if (*inp == ':') { /* ':' --> R_POSTCOLON */
inp++;
state = R_POSTCOLON;
break;
}
/* again, MULTI_LINE stuff here */
if (cf_iseol(*inp)) { /* EOL --> R_DONE */
state = R_DONE;
break;
}
if (cf_isspace(*inp)) { /* WS --> loop */
inp++;
break;
}
cf_err_str = "invalid lhs - more than one word before colon";
state = R_ERROR;
break;
case R_POSTCOLON: /* got colon, eat whitespace */
if (cf_isspace(*inp)) { /* WS --> loop */
inp++;
break;
}
if (cf_iseol(*inp)) { /* EOL --> R_ERROR */
cf_err_str = "invalid rhs - no data after colon";
state = R_ERROR;
break;
}
/* figure out if it's a MULTI_STRING or not, since we have to
parse it differently if it is */
if ((configp = lookup_tag(config_tab, config_size, tag_buf)) == NULL)
{
if (cf_forgiving) {
return (0); /* error gets caught later */
}
cf_err_str = "unknown tag";
state = R_ERROR;
break;
}
is_ms = (configp->kind == CF_MULTI_STRING);
outp = full_line_buf;
if (is_ms)
add_ms(outp);
state = R_RHS; /* else --> R_RHS */
break;
case R_RHS: /* reading right-hand-side now */
if (outp - full_line_buf >= CF_MAX_LINE_LEN) {
cf_err_str = "invalid rhs - line too long";
state = R_ERROR;
break;
}
if (cf_iseol(*inp)) { /* EOL --> R_DONE */
*outp = '\0';
state = R_DONE;
break;
}
if (*inp == '\"') { /* '"' --> R_DQUOTE */
inp++;
state = R_DQUOTE;
break;
}
if (*inp == '\\') { /* '\' --> R_BACK */
inp++;
state = R_BACK;
break;
}
if (is_ms) {
/* see if we want to break here */
if (strchr(configp->delim, *inp) != NULL) {
*outp++ = '\0';
inp++;
state = R_RHS_MS;
break;
}
}
*outp++ = *inp++; /* else --> loop */
break;
case R_RHS_MS: /* skipping over delimiter(s) */
if (strchr(configp->delim, *inp) == NULL) {
/* !DELIM --> RHS */
if (add_ms(outp) < 0) { /* another one coming! */
state = R_ERROR;
break;
}
state = R_RHS;
break;
}
inp++; /* else --> loop */
break;
case R_DQUOTE: /* inside double quotes */
if (outp - full_line_buf >= CF_MAX_LINE_LEN) {
cf_err_str = "invalid rhs - line too long";
state = R_ERROR;
break;
}
if (cf_iseol(*inp)) { /* EOL --> R_ERROR */
cf_err_str = "reached EOL inside double quotes";
state = R_ERROR;
break;
}
if (*inp == '\"') { /* '"' --> R_RHS */
inp++;
state = R_RHS;
break;
}
if (*inp == '\\') { /* '\' --> R_DQ_BACK */
inp++;
state = R_DQ_BACK;
break;
}
*outp++ = *inp++; /* else --> loop */
break;
case R_BACK: /* escape the next character */
if (outp - full_line_buf >= CF_MAX_LINE_LEN) {
cf_err_str = "invalid rhs - line too long";
state = R_ERROR;
break;
}
if (cf_iseol(*inp)) { /* EOL --> read next */
if ((val = read_line(fp))) {
if (val > 0)
cf_err_str = "can't escape EOF!";
state = R_ERROR;
break;
}
inp = line_buf;
state = R_RHS;
break;
}
switch (*inp) {
case 'n': *outp++ = '\n'; break;
case 't': *outp++ = '\t'; break;
default: *outp++ = *inp; break;
}
inp++;
state = R_RHS;
break;
case R_DQ_BACK: /* escape next, inside double quotes */
if (outp - full_line_buf >= CF_MAX_LINE_LEN) {
cf_err_str = "invalid rhs - line too long";
state = R_ERROR;
break;
}
if (cf_iseol(*inp)) { /* EOL --> read next */
if ((val = read_line(fp))) {
if (val > 0)
cf_err_str = "can't escape EOF!";
state = R_ERROR;
}
inp = line_buf;
state = R_DQUOTE;
break;
}
switch (*inp) {
case 'n': *outp++ = '\n'; break;
case 't': *outp++ = '\t'; break;
default: *outp++ = *inp; break;
}
inp++;
state = R_DQUOTE;
break;
case R_DONE: /* we're all done! */
/* shouldn't actually get here, caught by while() */
break;
case R_ERROR: /* error! */
if (cf_debug) printf("--- full_line_buf R_ERROR\n");
return (-1);
default:
cf_err_str = "damaged state in read_full_line()";
return (-1);
}
}
/*
* Now trim off trailing white space. In the case of a MULTI_STRING,
* this could cause us to completely trim off the final string. This
* is fine... usually.
*/
cp = outp-1;
while (cf_isspace(*cp))
*cp-- = '\0';
if (is_ms)
convert_ms();
if (cf_debug) {
if (is_ms)
printf("PARSED: '%s':(multi-line str)\n", tag_buf);
else
printf("PARSED: '%s':'%s'\n", tag_buf, full_line_buf);
}
return (0);
}
/*
* Evaluate an argument of the appropriate kind, storing the value in
* configp->reference or calling the function (*configp->reference)().
*
* Returns 0 on a successful evaluation, -1 on error.
*/
static int
eval_boolean(const CONFIG *configp)
{
if (strcasecmp(full_line_buf, "true") == 0 ||
strcasecmp(full_line_buf, "on") == 0)
{
*((int *) configp->reference) = TRUE;
return (0);
} else if (strcasecmp(full_line_buf, "false") == 0 ||
strcasecmp(full_line_buf, "off") == 0)
{
*((int *) configp->reference) = FALSE;
return (0);
} else {
cf_err_str = "invalid value for a boolean";
return (-1);
}
}
static int
eval_int(const CONFIG *configp)
{
*((int *) configp->reference) = strtol(full_line_buf, NULL, 0);
return (0);
}
static int
eval_double(const CONFIG *configp)
{
/* Can use atof() here. Note this will fail if strtod() not prototyped. */
*((double *) configp->reference) = (double)strtod(full_line_buf, NULL);
return (0);
}
static int
eval_string(const CONFIG *configp)
{
char *cp;
int len;
len = strlen(full_line_buf);
if (!configp->size) {
/* need to allocate space */
if (cf_check_alloc) {
if (*((char **) configp->reference) != NULL) {
cf_err_str = "tried to store dynamic string in non-NULL var";
return (-1);
}
}
if ((cp = (char *)malloc(len+1)) == NULL) {
cf_err_str = "malloc() failed";
return (-1);
}
if (cf_debug) printf("MALLOC 0x%.8lx\n", (long)cp);
strcpy(cp, full_line_buf);
*((char **) configp->reference) = cp;
} else {
/* reference is a fixed-size buffer */
if (configp->size < (len+1)) {
cf_err_str = "string longer than allocated space";
return (-1);
}
strcpy((char *) configp->reference, full_line_buf);
}
return (0);
}
static int
eval_multi_string(const CONFIG *configp)
{
int res;
res = (*((CF_INTFUNCPTR) configp->reference))(ms_argc, ms_argv);
free(ms_argv); /* free vector of pointers into full_line_buf */
ms_argc = 0;
if (res < 0)
cf_err_str = "error parsing string data";
return (res);
}
static int
eval_multi_line(const CONFIG *configp, FILE *fp)
{
int res, len;
len = strlen(configp->delim);
while (1) {
res = read_line(fp);
if (res < 0) return (-1);
/*if (res > 0) break;*/ /* EOF reached; allow it */
if (res > 0) return (-1); /* EOF reached; error */
/* match as a prefix; don't require a '\n' after it in line_buf */
if (strncasecmp(configp->delim, line_buf, len) == 0)
break;
res = (*((CF_INTFUNCPTR) configp->reference))(line_buf);
if (res < 0) {
cf_err_str = "error parsing multi-line data";
return (-1);
}
}
return (0);
}
/*
* Report a problem to the user.
*
* This exists because of a specific application in something I was working
* on (multiple independently updated programs sharing a config file, some
* of which didn't have a stdout/stderr), so it's not used consistently.
*/
static void
report_problem(char *whine, int cline)
{
/*syslog(LOG_ALERT|LOG_USER, "WARNING: config line %d: %s", cline, whine);*/
fprintf(stderr, "WARNING: config line %d: %s\n", cline, whine);
}
/*
* ===========================================================================
* Public routines.
* ===========================================================================
*/
/*
* Main entry point.
*
* Returns 0 on success, -1 on failure. Appropriate diagnostic messages
* will be sent to stderr on failure.
*
* (Takes argv0 as an argument to generate nice error messages.)
*/
int
read_config(const char *argv0, const CONFIG *config_tab, int config_size, FILE *fp)
{
const CONFIG *configp;
int err, res;
/* sanity check on config table */
if (config_tab[0].kind > CF_MULTI_LINE ||
config_size < 0 || config_size > 1024)
{
cf_err_str = "config table corrupt";
goto error;
}
if (argv0 == NULL)
argv0 = default_argv0;
line = 0;
while (1) {
/* read a full config line into full_line_buf, tag in tag_buf */
res = get_full_line(config_tab, config_size, fp);
if (res > 0) break; /* EOF reached */
if (res < 0) goto error; /* error */
/* find the matching entry in config[] */
if ((configp = lookup_tag(config_tab, config_size, tag_buf)) == NULL) {
cf_err_str = "unknown tag";
if (cf_forgiving) {
report_problem(cf_err_str, line);
continue;
} else {
goto error;
}
}
/* empty right-hand-side only allowed on MULTI_LINE tag */
if (configp->kind != CF_MULTI_LINE && full_line_buf[0] == '\0') {
/* (...but full_line_buf is irrelevant for MULTI_STRING) */
if (!(configp->kind == CF_MULTI_STRING && ms_argc)) {
cf_err_str = "missing rhs";
goto error;
}
}
/* do something appropriate with the tag we got */
switch (configp->kind) {
case CF_BOOLEAN:
res = eval_boolean(configp);
break;
case CF_INT:
res = eval_int(configp);
break;
case CF_DOUBLE:
res = eval_double(configp);
break;
case CF_STRING:
res = eval_string(configp);
break;
case CF_MULTI_STRING:
res = eval_multi_string(configp);
break;
case CF_MULTI_LINE:
res = eval_multi_line(configp, fp);
break;
default:
cf_err_str = "bogus config kind?";
res = -1;
}
if (res < 0) goto error;
}
if (cf_verbose) printf("--- configuration successfully read\n");
return (0);
error:
err = errno;
fflush(stdout);
errno = err;
if (cf_err_str != NULL) {
fprintf(stderr, "%s: ", argv0);
if (line) fprintf(stderr, "line %d: ", line);
fprintf(stderr, "%s\n", cf_err_str);
} else {
perror(argv0);
}
cf_err_str = NULL;
if (cf_verbose) printf("--- aborting config file read\n");
return (-1);
}
/*
* Alternate entry point; takes a filename as an argument instead of a
* FILE*. File will be opened before calling read_config(), and closed
* before returning.
*/
int
read_config_file(const char *argv0, const CONFIG *config_tab, int config_count, const char *filename)
{
FILE *fp;
int err, res;
if (argv0 == NULL)
argv0 = default_argv0;
if ((fp = fopen(filename, "r")) == NULL) {
err = errno;
fprintf(stderr, "%s: unable to read %s: ", argv0, filename);
errno = err; /* fprintf() could change errno */
perror(NULL);
return (-1);
}
if (cf_verbose) printf("--- reading configuration from '%s'\n", filename);
res = read_config(argv0, config_tab, config_count, fp);
fclose(fp);
return (res);
}
/*
* Run down the config_tab, calling any dispose routines found.
*
* Entries with type=CF_STRING and size!=0 that are non-NULL and don't
* have a dispose routine will be free()d. If cf_check_alloc is false
* this could end up calling free() on static storage, but that isn't fatal.
*
* To reload the config file, you should call this routine and then
* call read_config() or read_config_file().
*/
int
dispose_config(const char *argv0, const CONFIG *config_tab, int config_count)
{
const CONFIG *configp;
if (argv0 == NULL)
argv0 = default_argv0;
for (configp = config_tab; config_count--; configp++) {
if (configp->dispose != NULL) {
if (cf_debug) printf("DISPOSE 0x%.8lx\n", (long)configp->dispose);
(*configp->dispose)();
} else {
/* no dispose routine; see if we want to call free() on the
"reference" field */
if (configp->kind == CF_STRING && !configp->size &&
*((char **)configp->reference) != NULL)
{
char *cp = *((char **) configp->reference);
if (cf_debug) printf("FREE 0x%.8lx\n", (long)cp);
free(cp);
*((char **)configp->reference) = NULL;
}
}
}
return (0);
}
|