2 * Lexical scanner for Bacula configuration file
11 Copyright (C) 2000-2004 Kern Sibbald and John Walker
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);
66 * Format a scanner error message
68 static void s_err(const char *file, int line, LEX *lc, const char *msg, ...)
74 va_start(arg_ptr, msg);
75 bvsnprintf(buf, sizeof(buf), msg, arg_ptr);
78 if (lc->line_no > lc->begin_line_no) {
79 bsnprintf(more, sizeof(more),
80 _("Problem probably begins at line %d.\n"), lc->begin_line_no);
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);
91 * Free the current file, and retrieve the contents
92 * of the previous packet if any.
94 LEX *lex_close_file(LEX *lf)
98 Dmsg1(2000, "Close lex file: %s\n", lf->fname);
100 Emsg0(M_ABORT, 0, "Close of NULL file\n");
104 Dmsg1(2000, "Close cfg file %s\n", lf->fname);
107 of->options = lf->options; /* preserve options */
108 memcpy(lf, of, sizeof(LEX));
109 Dmsg1(2000, "Restart scan of cfg file %s\n", of->fname);
119 * Open a new configuration file. We push the
120 * state of the current file (lf) so that we
121 * can do includes. This is a bit of a hammer.
122 * Instead of passing back the pointer to the
123 * new packet, I simply replace the contents
124 * of the caller's packet with the new packet,
125 * and link the contents of the old packet into
129 LEX *lex_open_file(LEX *lf, const char *filename, LEX_ERROR_HANDLER *scan_error)
134 char *fname = bstrdup(filename);
137 if ((fd = fopen(fname, "r")) == NULL) {
139 Emsg2(M_ERROR_TERM, 0, _("Cannot open config file %s: %s\n"),
140 fname, be.strerror());
141 return NULL; /* Never reached if exit_on_error == 1 */
143 Dmsg1(2000, "Open config file: %s\n", fname);
144 nf = (LEX *)malloc(sizeof(LEX));
146 memcpy(nf, lf, sizeof(LEX));
147 memset(lf, 0, sizeof(LEX));
148 lf->next = nf; /* if have lf, push it behind new one */
149 lf->options = nf->options; /* preserve user options */
151 lf = nf; /* start new packet */
152 memset(lf, 0, sizeof(LEX));
156 lf->state = lex_none;
159 lf->scan_error = scan_error;
161 lf->scan_error = s_err;
163 Dmsg1(2000, "Return lex=%x\n", lf);
168 * Get the next character from the input.
169 * Returns the character or
170 * L_EOF if end of file
171 * L_EOL if end of line
173 int lex_get_char(LEX *lf)
175 if (lf->ch == L_EOF) {
176 Emsg0(M_ABORT, 0, "get_char: called after EOF\n");
178 if (lf->ch == L_EOL) {
179 if (bfgets(lf->line, MAXSTRING, lf->fd) == NULL) {
189 lf->ch = lf->line[lf->col_no];
195 Dmsg2(2000, "lex_get_char: %c %d\n", lf->ch, lf->ch);
199 void lex_unget_char(LEX *lf)
208 * Add a character to the current string
210 static void add_str(LEX *lf, int ch)
212 if (lf->str_len >= MAXSTRING-3) {
213 Emsg3(M_ERROR_TERM, 0, _(
214 _("Config token too long, file: %s, line %d, begins at line %d\n")),
215 lf->fname, lf->line_no, lf->begin_line_no);
217 lf->str[lf->str_len++] = ch;
218 lf->str[lf->str_len] = 0;
224 static void begin_str(LEX *lf, int ch)
231 lf->begin_line_no = lf->line_no; /* save start string line no */
235 static const char *lex_state_to_str(int state)
238 case lex_none: return "none";
239 case lex_comment: return "comment";
240 case lex_number: return "number";
241 case lex_ip_addr: return "ip_addr";
242 case lex_identifier: return "identifier";
243 case lex_string: return "string";
244 case lex_quoted_string: return "quoted_string";
245 default: return "??????";
251 * Convert a lex token to a string
252 * used for debug/error printing.
254 const char *lex_tok_to_str(int token)
257 case L_EOF: return "L_EOF";
258 case L_EOL: return "L_EOL";
259 case T_NONE: return "T_NONE";
260 case T_NUMBER: return "T_NUMBER";
261 case T_IPADDR: return "T_IPADDR";
262 case T_IDENTIFIER: return "T_IDENTIFIER";
263 case T_UNQUOTED_STRING: return "T_UNQUOTED_STRING";
264 case T_QUOTED_STRING: return "T_QUOTED_STRING";
265 case T_BOB: return "T_BOB";
266 case T_EOB: return "T_EOB";
267 case T_EQUALS: return "T_EQUALS";
268 case T_ERROR: return "T_ERROR";
269 case T_EOF: return "T_EOF";
270 case T_COMMA: return "T_COMMA";
271 case T_EOL: return "T_EOL";
272 default: return "??????";
276 static uint32_t scan_pint(LEX *lf, char *str)
279 if (!is_a_number(str)) {
280 scan_err1(lf, _("expected a positive integer number, got: %s"), str);
284 val = str_to_int64(str);
285 if (errno != 0 || val < 0) {
286 scan_err1(lf, _("expected a postive integer number, got: %s"), str);
290 return (uint32_t)val;
295 * Get the next token from the input
299 lex_get_token(LEX *lf, int expect)
303 bool esc_next = false;
305 Dmsg0(2000, "enter lex_get_token\n");
306 while (token == T_NONE) {
307 ch = lex_get_char(lf);
310 Dmsg2(2000, "Lex state lex_none ch=%d,%x\n", ch, ch);
314 if (lf->options & LOPT_NO_IDENT)
315 lf->state = lex_string;
317 lf->state = lex_identifier;
322 lf->state = lex_number;
326 Dmsg0(2000, "Enter lex_none switch\n");
330 Dmsg0(2000, "got L_EOF set token=T_EOF\n");
333 lf->state = lex_comment;
344 lf->state = lex_quoted_string;
356 if (expect != T_SKIP_EOL) {
357 token = T_EOL; /* treat ; like EOL */
361 Dmsg0(2000, "got L_EOL set token=T_EOL\n");
362 if (expect != T_SKIP_EOL) {
367 lf->state = lex_include;
371 lf->state = lex_string;
377 Dmsg1(2000, "Lex state lex_comment ch=%x\n", ch);
379 lf->state = lex_none;
380 if (expect != T_SKIP_EOL) {
383 } else if (ch == L_EOF) {
388 Dmsg2(2000, "Lex state lex_number ch=%x %c\n", ch, ch);
393 /* Might want to allow trailing specifications here */
399 /* A valid number can be terminated by the following */
400 if (B_ISSPACE(ch) || ch == L_EOL || ch == ',' || ch == ';') {
402 lf->state = lex_none;
404 lf->state = lex_string;
413 Dmsg1(2000, "Lex state lex_ip_addr ch=%x\n", ch);
416 Dmsg1(2000, "Lex state lex_string ch=%x\n", ch);
421 if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
422 ch == '\r' || ch == ';' || ch == ',' || ch == '#' || (B_ISSPACE(ch)) ) {
424 token = T_UNQUOTED_STRING;
425 lf->state = lex_none;
431 Dmsg2(2000, "Lex state lex_identifier ch=%x %c\n", ch, ch);
435 } else if (B_ISSPACE(ch)) {
437 } else if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
438 ch == '\r' || ch == ';' || ch == ',' || ch == '"' || ch == '#') {
440 token = T_IDENTIFIER;
441 lf->state = lex_none;
443 } else if (ch == L_EOF) {
445 lf->state = lex_none;
449 /* Some non-alpha character => string */
450 lf->state = lex_string;
453 case lex_quoted_string:
454 Dmsg2(2000, "Lex state lex_quoted_string ch=%x %c\n", ch, ch);
473 token = T_QUOTED_STRING;
474 lf->state = lex_none;
479 case lex_include: /* scanning a filename */
484 if (B_ISSPACE(ch) || ch == '\n' || ch == L_EOL || ch == '}' || ch == '{' ||
485 ch == ';' || ch == ',' || ch == '"' || ch == '#') {
486 lf->state = lex_none;
487 lf = lex_open_file(lf, lf->str, NULL);
496 Dmsg4(2000, "ch=%d state=%s token=%s %c\n", ch, lex_state_to_str(lf->state),
497 lex_tok_to_str(token), ch);
499 Dmsg2(2000, "lex returning: line %d token: %s\n", lf->line_no, lex_tok_to_str(token));
503 * Here is where we check to see if the user has set certain
504 * expectations (e.g. 32 bit integer). If so, we do type checking
505 * and possible additional scanning (e.g. for range).
509 lf->pint32_val = scan_pint(lf, lf->str);
510 lf->pint32_val2 = lf->pint32_val;
515 if (token == T_NUMBER) {
516 lf->pint32_val = scan_pint(lf, lf->str);
517 lf->pint32_val2 = lf->pint32_val;
520 char *p = strchr(lf->str, '-');
522 scan_err2(lf, _("expected an integer or a range, got %s: %s"),
523 lex_tok_to_str(token), lf->str);
527 *p++ = 0; /* terminate first half of range */
528 lf->pint32_val = scan_pint(lf, lf->str);
529 lf->pint32_val2 = scan_pint(lf, p);
530 token = T_PINT32_RANGE;
535 if (token != T_NUMBER || !is_a_number(lf->str)) {
536 scan_err2(lf, _("expected an integer number, got %s: %s"),
537 lex_tok_to_str(token), lf->str);
542 lf->int32_val = (int32_t)str_to_int64(lf->str);
544 scan_err2(lf, _("expected an integer number, got %s: %s"),
545 lex_tok_to_str(token), lf->str);
553 Dmsg2(2000, "int64=:%s: %f\n", lf->str, strtod(lf->str, NULL));
554 if (token != T_NUMBER || !is_a_number(lf->str)) {
555 scan_err2(lf, _("expected an integer number, got %s: %s"),
556 lex_tok_to_str(token), lf->str);
561 lf->int64_val = str_to_int64(lf->str);
563 scan_err2(lf, _("expected an integer number, got %s: %s"),
564 lex_tok_to_str(token), lf->str);
572 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
573 scan_err2(lf, _("expected a name, got %s: %s"),
574 lex_tok_to_str(token), lf->str);
576 } else if (lf->str_len > MAX_RES_NAME_LENGTH) {
577 scan_err3(lf, _("name %s length %d too long, max is %d\n"), lf->str,
578 lf->str_len, MAX_RES_NAME_LENGTH);
584 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
585 scan_err2(lf, _("expected a string, got %s: %s"),
586 lex_tok_to_str(token), lf->str);
595 break; /* no expectation given */
597 lf->token = token; /* set possible new token */