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(400, "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) {
193 Dmsg2(400, "fget line=%d %s", lf->line_no, lf->line);
195 lf->ch = (uint8_t)lf->line[lf->col_no];
201 Dmsg2(2000, "lex_get_char: %c %d\n", lf->ch, lf->ch);
205 void lex_unget_char(LEX *lf)
214 * Add a character to the current string
216 static void add_str(LEX *lf, int ch)
218 if (lf->str_len >= MAXSTRING-3) {
219 Emsg3(M_ERROR_TERM, 0, _(
220 _("Config token too long, file: %s, line %d, begins at line %d\n")),
221 lf->fname, lf->line_no, lf->begin_line_no);
223 lf->str[lf->str_len++] = ch;
224 lf->str[lf->str_len] = 0;
230 static void begin_str(LEX *lf, int ch)
237 lf->begin_line_no = lf->line_no; /* save start string line no */
241 static const char *lex_state_to_str(int state)
244 case lex_none: return "none";
245 case lex_comment: return "comment";
246 case lex_number: return "number";
247 case lex_ip_addr: return "ip_addr";
248 case lex_identifier: return "identifier";
249 case lex_string: return "string";
250 case lex_quoted_string: return "quoted_string";
251 default: return "??????";
257 * Convert a lex token to a string
258 * used for debug/error printing.
260 const char *lex_tok_to_str(int token)
263 case L_EOF: return "L_EOF";
264 case L_EOL: return "L_EOL";
265 case T_NONE: return "T_NONE";
266 case T_NUMBER: return "T_NUMBER";
267 case T_IPADDR: return "T_IPADDR";
268 case T_IDENTIFIER: return "T_IDENTIFIER";
269 case T_UNQUOTED_STRING: return "T_UNQUOTED_STRING";
270 case T_QUOTED_STRING: return "T_QUOTED_STRING";
271 case T_BOB: return "T_BOB";
272 case T_EOB: return "T_EOB";
273 case T_EQUALS: return "T_EQUALS";
274 case T_ERROR: return "T_ERROR";
275 case T_EOF: return "T_EOF";
276 case T_COMMA: return "T_COMMA";
277 case T_EOL: return "T_EOL";
278 default: return "??????";
282 static uint32_t scan_pint(LEX *lf, char *str)
285 if (!is_a_number(str)) {
286 scan_err1(lf, _("expected a positive integer number, got: %s"), str);
290 val = str_to_int64(str);
291 if (errno != 0 || val < 0) {
292 scan_err1(lf, _("expected a postive integer number, got: %s"), str);
296 return (uint32_t)val;
301 * Get the next token from the input
305 lex_get_token(LEX *lf, int expect)
309 bool esc_next = false;
311 Dmsg0(2000, "enter lex_get_token\n");
312 while (token == T_NONE) {
313 ch = lex_get_char(lf);
316 Dmsg2(2000, "Lex state lex_none ch=%d,%x\n", ch, ch);
320 if (lf->options & LOPT_NO_IDENT || lf->options & LOPT_STRING) {
321 lf->state = lex_string;
323 lf->state = lex_identifier;
329 if (lf->options & LOPT_STRING) {
330 lf->state = lex_string;
332 lf->state = lex_number;
337 Dmsg0(2000, "Enter lex_none switch\n");
341 Dmsg0(2000, "got L_EOF set token=T_EOF\n");
344 lf->state = lex_comment;
355 lf->state = lex_quoted_string;
367 if (expect != T_SKIP_EOL) {
368 token = T_EOL; /* treat ; like EOL */
372 Dmsg0(2000, "got L_EOL set token=T_EOL\n");
373 if (expect != T_SKIP_EOL) {
378 lf->state = lex_include;
382 lf->state = lex_string;
388 Dmsg1(2000, "Lex state lex_comment ch=%x\n", ch);
390 lf->state = lex_none;
391 if (expect != T_SKIP_EOL) {
394 } else if (ch == L_EOF) {
399 Dmsg2(2000, "Lex state lex_number ch=%x %c\n", ch, ch);
404 /* Might want to allow trailing specifications here */
410 /* A valid number can be terminated by the following */
411 if (B_ISSPACE(ch) || ch == L_EOL || ch == ',' || ch == ';') {
413 lf->state = lex_none;
415 lf->state = lex_string;
424 Dmsg1(2000, "Lex state lex_ip_addr ch=%x\n", ch);
427 Dmsg1(2000, "Lex state lex_string ch=%x\n", ch);
432 if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
433 ch == '\r' || ch == ';' || ch == ',' || ch == '#' || (B_ISSPACE(ch)) ) {
435 token = T_UNQUOTED_STRING;
436 lf->state = lex_none;
442 Dmsg2(2000, "Lex state lex_identifier ch=%x %c\n", ch, ch);
446 } else if (B_ISSPACE(ch)) {
448 } else if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
449 ch == '\r' || ch == ';' || ch == ',' || ch == '"' || ch == '#') {
451 token = T_IDENTIFIER;
452 lf->state = lex_none;
454 } else if (ch == L_EOF) {
456 lf->state = lex_none;
460 /* Some non-alpha character => string */
461 lf->state = lex_string;
464 case lex_quoted_string:
465 Dmsg2(2000, "Lex state lex_quoted_string ch=%x %c\n", ch, ch);
484 token = T_QUOTED_STRING;
485 lf->state = lex_none;
490 case lex_include: /* scanning a filename */
495 if (B_ISSPACE(ch) || ch == '\n' || ch == L_EOL || ch == '}' || ch == '{' ||
496 ch == ';' || ch == ',' || ch == '"' || ch == '#') {
497 /* Keep the original LEX so we can print an error if the included file can't be opened. */
500 lf->state = lex_none;
501 lf = lex_open_file(lf, lf->str, NULL);
504 scan_err2(lfori, _("Cannot open included config file %s: %s\n"),
505 lfori->str, be.strerror());
513 Dmsg4(2000, "ch=%d state=%s token=%s %c\n", ch, lex_state_to_str(lf->state),
514 lex_tok_to_str(token), ch);
516 Dmsg2(2000, "lex returning: line %d token: %s\n", lf->line_no, lex_tok_to_str(token));
520 * Here is where we check to see if the user has set certain
521 * expectations (e.g. 32 bit integer). If so, we do type checking
522 * and possible additional scanning (e.g. for range).
526 lf->pint32_val = scan_pint(lf, lf->str);
527 lf->pint32_val2 = lf->pint32_val;
532 if (token == T_NUMBER) {
533 lf->pint32_val = scan_pint(lf, lf->str);
534 lf->pint32_val2 = lf->pint32_val;
537 char *p = strchr(lf->str, '-');
539 scan_err2(lf, _("expected an integer or a range, got %s: %s"),
540 lex_tok_to_str(token), lf->str);
544 *p++ = 0; /* terminate first half of range */
545 lf->pint32_val = scan_pint(lf, lf->str);
546 lf->pint32_val2 = scan_pint(lf, p);
547 token = T_PINT32_RANGE;
552 if (token != T_NUMBER || !is_a_number(lf->str)) {
553 scan_err2(lf, _("expected an integer number, got %s: %s"),
554 lex_tok_to_str(token), lf->str);
559 lf->int32_val = (int32_t)str_to_int64(lf->str);
561 scan_err2(lf, _("expected an integer number, got %s: %s"),
562 lex_tok_to_str(token), lf->str);
570 Dmsg2(2000, "int64=:%s: %f\n", lf->str, strtod(lf->str, NULL));
571 if (token != T_NUMBER || !is_a_number(lf->str)) {
572 scan_err2(lf, _("expected an integer number, got %s: %s"),
573 lex_tok_to_str(token), lf->str);
578 lf->int64_val = str_to_int64(lf->str);
580 scan_err2(lf, _("expected an integer number, got %s: %s"),
581 lex_tok_to_str(token), lf->str);
589 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
590 scan_err2(lf, _("expected a name, got %s: %s"),
591 lex_tok_to_str(token), lf->str);
593 } else if (lf->str_len > MAX_RES_NAME_LENGTH) {
594 scan_err3(lf, _("name %s length %d too long, max is %d\n"), lf->str,
595 lf->str_len, MAX_RES_NAME_LENGTH);
601 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
602 scan_err2(lf, _("expected a string, got %s: %s"),
603 lex_tok_to_str(token), lf->str);
612 break; /* no expectation given */
614 lf->token = token; /* set possible new token */