2 * Lexical scanner for Bacula configuration file
11 Copyright (C) 2000-2005 Kern Sibbald
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
33 extern int debug_level;
36 * Scan to "logical" end of line. I.e. end of line,
37 * or semicolon, but stop on T_EOB (same as end of
38 * line except it is not eaten).
40 void scan_to_eol(LEX *lc)
43 Dmsg0(2000, "start scan to eof\n");
44 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
53 * Get next token, but skip EOL
55 int scan_to_next_not_eol(LEX * lc)
59 token = lex_get_token(lc, T_ALL);
60 } while (token == T_EOL);
65 * Format a scanner error message
67 static void s_err(const char *file, int line, LEX *lc, const char *msg, ...)
73 va_start(arg_ptr, msg);
74 bvsnprintf(buf, sizeof(buf), msg, arg_ptr);
77 if (lc->line_no > lc->begin_line_no) {
78 bsnprintf(more, sizeof(more),
79 _("Problem probably begins at line %d.\n"), lc->begin_line_no);
83 if (lc->line_no > 0) {
84 e_msg(file, line, M_ERROR_TERM, 0, _("Config error: %s\n"
85 " : line %d, col %d of file %s\n%s\n%s"),
86 buf, lc->line_no, lc->col_no, lc->fname, lc->line, more);
88 e_msg(file, line, M_ERROR_TERM, 0, _("Config error: %s\n"), buf);
92 void lex_set_default_error_handler(LEX *lf)
94 lf->scan_error = s_err;
99 * Free the current file, and retrieve the contents
100 * of the previous packet if any.
102 LEX *lex_close_file(LEX *lf)
106 Dmsg1(2000, "Close lex file: %s\n", lf->fname);
108 Emsg0(M_ABORT, 0, "Close of NULL file\n");
112 Dmsg1(2000, "Close cfg file %s\n", lf->fname);
115 of->options = lf->options; /* preserve options */
116 memcpy(lf, of, sizeof(LEX));
117 Dmsg1(2000, "Restart scan of cfg file %s\n", of->fname);
127 * Open a new configuration file. We push the
128 * state of the current file (lf) so that we
129 * can do includes. This is a bit of a hammer.
130 * Instead of passing back the pointer to the
131 * new packet, I simply replace the contents
132 * of the caller's packet with the new packet,
133 * and link the contents of the old packet into
137 LEX *lex_open_file(LEX *lf, const char *filename, LEX_ERROR_HANDLER *scan_error)
142 char *fname = bstrdup(filename);
145 if ((fd = fopen(fname, "r")) == NULL) {
148 Dmsg1(2000, "Open config file: %s\n", fname);
149 nf = (LEX *)malloc(sizeof(LEX));
151 memcpy(nf, lf, sizeof(LEX));
152 memset(lf, 0, sizeof(LEX));
153 lf->next = nf; /* if have lf, push it behind new one */
154 lf->options = nf->options; /* preserve user options */
156 lf = nf; /* start new packet */
157 memset(lf, 0, sizeof(LEX));
160 lf->scan_error = scan_error;
162 lex_set_default_error_handler(lf);
166 lf->state = lex_none;
168 Dmsg1(2000, "Return lex=%x\n", lf);
173 * Get the next character from the input.
174 * Returns the character or
175 * L_EOF if end of file
176 * L_EOL if end of line
178 int lex_get_char(LEX *lf)
180 if (lf->ch == L_EOF) {
181 Emsg0(M_ABORT, 0, "get_char: called after EOF\n");
183 if (lf->ch == L_EOL) {
184 if (bfgets(lf->line, MAXSTRING, lf->fd) == NULL) {
194 lf->ch = (uint8_t)lf->line[lf->col_no];
200 Dmsg2(2000, "lex_get_char: %c %d\n", lf->ch, lf->ch);
204 void lex_unget_char(LEX *lf)
213 * Add a character to the current string
215 static void add_str(LEX *lf, int ch)
217 if (lf->str_len >= MAXSTRING-3) {
218 Emsg3(M_ERROR_TERM, 0, _(
219 _("Config token too long, file: %s, line %d, begins at line %d\n")),
220 lf->fname, lf->line_no, lf->begin_line_no);
222 lf->str[lf->str_len++] = ch;
223 lf->str[lf->str_len] = 0;
229 static void begin_str(LEX *lf, int ch)
236 lf->begin_line_no = lf->line_no; /* save start string line no */
240 static const char *lex_state_to_str(int state)
243 case lex_none: return "none";
244 case lex_comment: return "comment";
245 case lex_number: return "number";
246 case lex_ip_addr: return "ip_addr";
247 case lex_identifier: return "identifier";
248 case lex_string: return "string";
249 case lex_quoted_string: return "quoted_string";
250 default: return "??????";
256 * Convert a lex token to a string
257 * used for debug/error printing.
259 const char *lex_tok_to_str(int token)
262 case L_EOF: return "L_EOF";
263 case L_EOL: return "L_EOL";
264 case T_NONE: return "T_NONE";
265 case T_NUMBER: return "T_NUMBER";
266 case T_IPADDR: return "T_IPADDR";
267 case T_IDENTIFIER: return "T_IDENTIFIER";
268 case T_UNQUOTED_STRING: return "T_UNQUOTED_STRING";
269 case T_QUOTED_STRING: return "T_QUOTED_STRING";
270 case T_BOB: return "T_BOB";
271 case T_EOB: return "T_EOB";
272 case T_EQUALS: return "T_EQUALS";
273 case T_ERROR: return "T_ERROR";
274 case T_EOF: return "T_EOF";
275 case T_COMMA: return "T_COMMA";
276 case T_EOL: return "T_EOL";
277 default: return "??????";
281 static uint32_t scan_pint(LEX *lf, char *str)
284 if (!is_a_number(str)) {
285 scan_err1(lf, _("expected a positive integer number, got: %s"), str);
289 val = str_to_int64(str);
290 if (errno != 0 || val < 0) {
291 scan_err1(lf, _("expected a postive integer number, got: %s"), str);
295 return (uint32_t)val;
300 * Get the next token from the input
304 lex_get_token(LEX *lf, int expect)
308 bool esc_next = false;
310 Dmsg0(2000, "enter lex_get_token\n");
311 while (token == T_NONE) {
312 ch = lex_get_char(lf);
315 Dmsg2(2000, "Lex state lex_none ch=%d,%x\n", ch, ch);
319 if (lf->options & LOPT_NO_IDENT || lf->options & LOPT_STRING) {
320 lf->state = lex_string;
322 lf->state = lex_identifier;
328 if (lf->options & LOPT_STRING) {
329 lf->state = lex_string;
331 lf->state = lex_number;
336 Dmsg0(2000, "Enter lex_none switch\n");
340 Dmsg0(2000, "got L_EOF set token=T_EOF\n");
343 lf->state = lex_comment;
354 lf->state = lex_quoted_string;
366 if (expect != T_SKIP_EOL) {
367 token = T_EOL; /* treat ; like EOL */
371 Dmsg0(2000, "got L_EOL set token=T_EOL\n");
372 if (expect != T_SKIP_EOL) {
377 lf->state = lex_include;
381 lf->state = lex_string;
387 Dmsg1(2000, "Lex state lex_comment ch=%x\n", ch);
389 lf->state = lex_none;
390 if (expect != T_SKIP_EOL) {
393 } else if (ch == L_EOF) {
398 Dmsg2(2000, "Lex state lex_number ch=%x %c\n", ch, ch);
403 /* Might want to allow trailing specifications here */
409 /* A valid number can be terminated by the following */
410 if (B_ISSPACE(ch) || ch == L_EOL || ch == ',' || ch == ';') {
412 lf->state = lex_none;
414 lf->state = lex_string;
423 Dmsg1(2000, "Lex state lex_ip_addr ch=%x\n", ch);
426 Dmsg1(2000, "Lex state lex_string ch=%x\n", ch);
431 if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
432 ch == '\r' || ch == ';' || ch == ',' || ch == '#' || (B_ISSPACE(ch)) ) {
434 token = T_UNQUOTED_STRING;
435 lf->state = lex_none;
441 Dmsg2(2000, "Lex state lex_identifier ch=%x %c\n", ch, ch);
445 } else if (B_ISSPACE(ch)) {
447 } else if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
448 ch == '\r' || ch == ';' || ch == ',' || ch == '"' || ch == '#') {
450 token = T_IDENTIFIER;
451 lf->state = lex_none;
453 } else if (ch == L_EOF) {
455 lf->state = lex_none;
459 /* Some non-alpha character => string */
460 lf->state = lex_string;
463 case lex_quoted_string:
464 Dmsg2(2000, "Lex state lex_quoted_string ch=%x %c\n", ch, ch);
483 token = T_QUOTED_STRING;
484 lf->state = lex_none;
489 case lex_include: /* scanning a filename */
494 if (B_ISSPACE(ch) || ch == '\n' || ch == L_EOL || ch == '}' || ch == '{' ||
495 ch == ';' || ch == ',' || ch == '"' || ch == '#') {
496 /* Keep the original LEX so we can print an error if the included file can't be opened. */
499 lf->state = lex_none;
500 lf = lex_open_file(lf, lf->str, NULL);
503 scan_err2(lfori, _("Cannot open included config file %s: %s\n"),
504 lfori->str, be.strerror());
512 Dmsg4(2000, "ch=%d state=%s token=%s %c\n", ch, lex_state_to_str(lf->state),
513 lex_tok_to_str(token), ch);
515 Dmsg2(2000, "lex returning: line %d token: %s\n", lf->line_no, lex_tok_to_str(token));
519 * Here is where we check to see if the user has set certain
520 * expectations (e.g. 32 bit integer). If so, we do type checking
521 * and possible additional scanning (e.g. for range).
525 lf->pint32_val = scan_pint(lf, lf->str);
526 lf->pint32_val2 = lf->pint32_val;
531 if (token == T_NUMBER) {
532 lf->pint32_val = scan_pint(lf, lf->str);
533 lf->pint32_val2 = lf->pint32_val;
536 char *p = strchr(lf->str, '-');
538 scan_err2(lf, _("expected an integer or a range, got %s: %s"),
539 lex_tok_to_str(token), lf->str);
543 *p++ = 0; /* terminate first half of range */
544 lf->pint32_val = scan_pint(lf, lf->str);
545 lf->pint32_val2 = scan_pint(lf, p);
546 token = T_PINT32_RANGE;
551 if (token != T_NUMBER || !is_a_number(lf->str)) {
552 scan_err2(lf, _("expected an integer number, got %s: %s"),
553 lex_tok_to_str(token), lf->str);
558 lf->int32_val = (int32_t)str_to_int64(lf->str);
560 scan_err2(lf, _("expected an integer number, got %s: %s"),
561 lex_tok_to_str(token), lf->str);
569 Dmsg2(2000, "int64=:%s: %f\n", lf->str, strtod(lf->str, NULL));
570 if (token != T_NUMBER || !is_a_number(lf->str)) {
571 scan_err2(lf, _("expected an integer number, got %s: %s"),
572 lex_tok_to_str(token), lf->str);
577 lf->int64_val = str_to_int64(lf->str);
579 scan_err2(lf, _("expected an integer number, got %s: %s"),
580 lex_tok_to_str(token), lf->str);
588 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
589 scan_err2(lf, _("expected a name, got %s: %s"),
590 lex_tok_to_str(token), lf->str);
592 } else if (lf->str_len > MAX_RES_NAME_LENGTH) {
593 scan_err3(lf, _("name %s length %d too long, max is %d\n"), lf->str,
594 lf->str_len, MAX_RES_NAME_LENGTH);
600 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
601 scan_err2(lf, _("expected a string, got %s: %s"),
602 lex_tok_to_str(token), lf->str);
611 break; /* no expectation given */
613 lf->token = token; /* set possible new token */