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,
39 void scan_to_eol(LEX *lc)
41 Dmsg0(900, "start scan to eof\n");
42 while (lex_get_token(lc, T_ALL) != T_EOL)
44 Dmsg0(900, "done scan to eof\n");
49 * Format a scanner error message
51 static void s_err(const char *file, int line, LEX *lc, const char *msg, ...)
57 va_start(arg_ptr, msg);
58 bvsnprintf(buf, sizeof(buf), msg, arg_ptr);
61 if (lc->line_no > lc->begin_line_no) {
62 bsnprintf(more, sizeof(more),
63 _("Problem probably begins at line %d.\n"), lc->begin_line_no);
67 e_msg(file, line, M_ERROR_TERM, 0, _("Config error: %s\n\
68 : line %d, col %d of file %s\n%s\n%s"),
69 buf, lc->line_no, lc->col_no, lc->fname, lc->line, more);
74 * Free the current file, and retrieve the contents
75 * of the previous packet if any.
77 LEX *lex_close_file(LEX *lf)
81 Dmsg1(900, "Close lex file: %s\n", lf->fname);
83 Emsg0(M_ABORT, 0, "Close of NULL file\n");
87 Dmsg1(900, "Close cfg file %s\n", lf->fname);
90 of->options = lf->options; /* preserve options */
91 memcpy(lf, of, sizeof(LEX));
92 Dmsg1(900, "Restart scan of cfg file %s\n", of->fname);
102 * Open a new configuration file. We push the
103 * state of the current file (lf) so that we
104 * can do includes. This is a bit of a hammer.
105 * Instead of passing back the pointer to the
106 * new packet, I simply replace the contents
107 * of the caller's packet with the new packet,
108 * and link the contents of the old packet into
112 LEX *lex_open_file(LEX *lf, const char *filename, LEX_ERROR_HANDLER *scan_error)
117 char *fname = bstrdup(filename);
120 if ((fd = fopen(fname, "r")) == NULL) {
121 Emsg2(M_ERROR_TERM, 0, _("Cannot open config file %s: %s\n"),
122 fname, strerror(errno));
123 return NULL; /* Never reached if exit_on_error == 1 */
125 Dmsg1(900, "Open config file: %s\n", fname);
126 nf = (LEX *)malloc(sizeof(LEX));
128 memcpy(nf, lf, sizeof(LEX));
129 memset(lf, 0, sizeof(LEX));
130 lf->next = nf; /* if have lf, push it behind new one */
131 lf->options = nf->options; /* preserve user options */
133 lf = nf; /* start new packet */
134 memset(lf, 0, sizeof(LEX));
138 lf->state = lex_none;
141 lf->scan_error = scan_error;
143 lf->scan_error = s_err;
145 Dmsg1(900, "Return lex=%x\n", lf);
150 * Get the next character from the input.
151 * Returns the character or
152 * L_EOF if end of file
153 * L_EOL if end of line
155 int lex_get_char(LEX *lf)
157 if (lf->ch == L_EOF) {
158 Emsg0(M_ABORT, 0, "get_char: called after EOF\n");
160 if (lf->ch == L_EOL) {
161 if (bfgets(lf->line, MAXSTRING, lf->fd) == NULL) {
171 lf->ch = lf->line[lf->col_no];
177 Dmsg2(900, "lex_get_char: %c %d\n", lf->ch, lf->ch);
181 void lex_unget_char(LEX *lf)
190 * Add a character to the current string
192 static void add_str(LEX *lf, int ch)
194 if (lf->str_len >= MAXSTRING-3) {
195 Emsg3(M_ERROR_TERM, 0, _(
196 _("Config token too long, file: %s, line %d, begins at line %d\n")),
197 lf->fname, lf->line_no, lf->begin_line_no);
199 lf->str[lf->str_len++] = ch;
200 lf->str[lf->str_len] = 0;
206 static void begin_str(LEX *lf, int ch)
213 lf->begin_line_no = lf->line_no; /* save start string line no */
217 static const char *lex_state_to_str(int state)
220 case lex_none: return "none";
221 case lex_comment: return "comment";
222 case lex_number: return "number";
223 case lex_ip_addr: return "ip_addr";
224 case lex_identifier: return "identifier";
225 case lex_string: return "string";
226 case lex_quoted_string: return "quoted_string";
227 default: return "??????";
233 * Convert a lex token to a string
234 * used for debug/error printing.
236 const char *lex_tok_to_str(int token)
239 case L_EOF: return "L_EOF";
240 case L_EOL: return "L_EOL";
241 case T_NONE: return "T_NONE";
242 case T_NUMBER: return "T_NUMBER";
243 case T_IPADDR: return "T_IPADDR";
244 case T_IDENTIFIER: return "T_IDENTIFIER";
245 case T_UNQUOTED_STRING: return "T_UNQUOTED_STRING";
246 case T_QUOTED_STRING: return "T_QUOTED_STRING";
247 case T_BOB: return "T_BOB";
248 case T_EOB: return "T_EOB";
249 case T_EQUALS: return "T_EQUALS";
250 case T_ERROR: return "T_ERROR";
251 case T_EOF: return "T_EOF";
252 case T_COMMA: return "T_COMMA";
253 case T_EOL: return "T_EOL";
254 default: return "??????";
258 static uint32_t scan_pint(LEX *lf, char *str)
261 if (!is_a_number(str)) {
262 scan_err1(lf, _("expected a positive integer number, got: %s"), str);
266 val = str_to_int64(str);
267 if (errno != 0 || val < 0) {
268 scan_err1(lf, _("expected a postive integer number, got: %s"), str);
272 return (uint32_t)val;
277 * Get the next token from the input
281 lex_get_token(LEX *lf, int expect)
285 int esc_next = FALSE;
287 Dmsg0(900, "enter lex_get_token\n");
288 while (token == T_NONE) {
289 ch = lex_get_char(lf);
292 Dmsg2(900, "Lex state lex_none ch=%d,%x\n", ch, ch);
296 if (lf->options & LOPT_NO_IDENT)
297 lf->state = lex_string;
299 lf->state = lex_identifier;
304 lf->state = lex_number;
308 Dmsg0(900, "Enter lex_none switch\n");
312 Dmsg0(900, "got L_EOF set token=T_EOF\n");
315 lf->state = lex_comment;
326 lf->state = lex_quoted_string;
338 token = T_EOL; /* treat ; like EOL */
341 Dmsg0(900, "got L_EOL set token=T_EOL\n");
345 lf->state = lex_include;
349 lf->state = lex_string;
355 Dmsg1(900, "Lex state lex_comment ch=%x\n", ch);
357 lf->state = lex_none;
359 } else if (ch == L_EOF) {
364 Dmsg2(900, "Lex state lex_number ch=%x %c\n", ch, ch);
369 /* Might want to allow trailing specifications here */
375 /* A valid number can be terminated by the following */
376 if (B_ISSPACE(ch) || ch == L_EOL || ch == ',' || ch == ';') {
378 lf->state = lex_none;
380 lf->state = lex_string;
389 Dmsg1(900, "Lex state lex_ip_addr ch=%x\n", ch);
392 Dmsg1(900, "Lex state lex_string ch=%x\n", ch);
397 if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
398 ch == '\r' || ch == ';' || ch == ',' || ch == '#' || (B_ISSPACE(ch)) ) {
400 token = T_UNQUOTED_STRING;
401 lf->state = lex_none;
407 Dmsg2(900, "Lex state lex_identifier ch=%x %c\n", ch, ch);
411 } else if (B_ISSPACE(ch)) {
413 } else if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
414 ch == '\r' || ch == ';' || ch == ',' || ch == '"' || ch == '#') {
416 token = T_IDENTIFIER;
417 lf->state = lex_none;
419 } else if (ch == L_EOF) {
421 lf->state = lex_none;
425 /* Some non-alpha character => string */
426 lf->state = lex_string;
429 case lex_quoted_string:
430 Dmsg2(900, "Lex state lex_quoted_string ch=%x %c\n", ch, ch);
449 token = T_QUOTED_STRING;
450 lf->state = lex_none;
455 case lex_include: /* scanning a filename */
460 if (B_ISSPACE(ch) || ch == '\n' || ch == L_EOL || ch == '}' || ch == '{' ||
461 ch == ';' || ch == ',' || ch == '"' || ch == '#') {
462 lf->state = lex_none;
463 lf = lex_open_file(lf, lf->str, NULL);
472 Dmsg4(900, "ch=%d state=%s token=%s %c\n", ch, lex_state_to_str(lf->state),
473 lex_tok_to_str(token), ch);
475 Dmsg2(900, "lex returning: line %d token: %s\n", lf->line_no, lex_tok_to_str(token));
479 * Here is where we check to see if the user has set certain
480 * expectations (e.g. 32 bit integer). If so, we do type checking
481 * and possible additional scanning (e.g. for range).
485 lf->pint32_val = scan_pint(lf, lf->str);
486 lf->pint32_val2 = lf->pint32_val;
491 if (token == T_NUMBER) {
492 lf->pint32_val = scan_pint(lf, lf->str);
493 lf->pint32_val2 = lf->pint32_val;
496 char *p = strchr(lf->str, '-');
498 scan_err2(lf, _("expected an integer or a range, got %s: %s"),
499 lex_tok_to_str(token), lf->str);
503 *p++ = 0; /* terminate first half of range */
504 lf->pint32_val = scan_pint(lf, lf->str);
505 lf->pint32_val2 = scan_pint(lf, p);
506 token = T_PINT32_RANGE;
511 if (token != T_NUMBER || !is_a_number(lf->str)) {
512 scan_err2(lf, _("expected an integer number, got %s: %s"),
513 lex_tok_to_str(token), lf->str);
518 lf->int32_val = (int32_t)str_to_int64(lf->str);
520 scan_err2(lf, _("expected an integer number, got %s: %s"),
521 lex_tok_to_str(token), lf->str);
529 Dmsg2(900, "int64=:%s: %f\n", lf->str, strtod(lf->str, NULL));
530 if (token != T_NUMBER || !is_a_number(lf->str)) {
531 scan_err2(lf, _("expected an integer number, got %s: %s"),
532 lex_tok_to_str(token), lf->str);
537 lf->int64_val = str_to_int64(lf->str);
539 scan_err2(lf, _("expected an integer number, got %s: %s"),
540 lex_tok_to_str(token), lf->str);
548 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
549 scan_err2(lf, _("expected a name, got %s: %s"),
550 lex_tok_to_str(token), lf->str);
552 } else if (lf->str_len > MAX_RES_NAME_LENGTH) {
553 scan_err3(lf, _("name %s length %d too long, max is %d\n"), lf->str,
554 lf->str_len, MAX_RES_NAME_LENGTH);
560 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
561 scan_err2(lf, _("expected a string, got %s: %s"),
562 lex_tok_to_str(token), lf->str);
571 break; /* no expectation given */
573 lf->token = token; /* set possible new token */