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) {
138 Emsg2(M_ERROR_TERM, 0, _("Cannot open config file %s: %s\n"),
139 fname, strerror(errno));
140 return NULL; /* Never reached if exit_on_error == 1 */
142 Dmsg1(2000, "Open config file: %s\n", fname);
143 nf = (LEX *)malloc(sizeof(LEX));
145 memcpy(nf, lf, sizeof(LEX));
146 memset(lf, 0, sizeof(LEX));
147 lf->next = nf; /* if have lf, push it behind new one */
148 lf->options = nf->options; /* preserve user options */
150 lf = nf; /* start new packet */
151 memset(lf, 0, sizeof(LEX));
155 lf->state = lex_none;
158 lf->scan_error = scan_error;
160 lf->scan_error = s_err;
162 Dmsg1(2000, "Return lex=%x\n", lf);
167 * Get the next character from the input.
168 * Returns the character or
169 * L_EOF if end of file
170 * L_EOL if end of line
172 int lex_get_char(LEX *lf)
174 if (lf->ch == L_EOF) {
175 Emsg0(M_ABORT, 0, "get_char: called after EOF\n");
177 if (lf->ch == L_EOL) {
178 if (bfgets(lf->line, MAXSTRING, lf->fd) == NULL) {
188 lf->ch = lf->line[lf->col_no];
194 Dmsg2(2000, "lex_get_char: %c %d\n", lf->ch, lf->ch);
198 void lex_unget_char(LEX *lf)
207 * Add a character to the current string
209 static void add_str(LEX *lf, int ch)
211 if (lf->str_len >= MAXSTRING-3) {
212 Emsg3(M_ERROR_TERM, 0, _(
213 _("Config token too long, file: %s, line %d, begins at line %d\n")),
214 lf->fname, lf->line_no, lf->begin_line_no);
216 lf->str[lf->str_len++] = ch;
217 lf->str[lf->str_len] = 0;
223 static void begin_str(LEX *lf, int ch)
230 lf->begin_line_no = lf->line_no; /* save start string line no */
234 static const char *lex_state_to_str(int state)
237 case lex_none: return "none";
238 case lex_comment: return "comment";
239 case lex_number: return "number";
240 case lex_ip_addr: return "ip_addr";
241 case lex_identifier: return "identifier";
242 case lex_string: return "string";
243 case lex_quoted_string: return "quoted_string";
244 default: return "??????";
250 * Convert a lex token to a string
251 * used for debug/error printing.
253 const char *lex_tok_to_str(int token)
256 case L_EOF: return "L_EOF";
257 case L_EOL: return "L_EOL";
258 case T_NONE: return "T_NONE";
259 case T_NUMBER: return "T_NUMBER";
260 case T_IPADDR: return "T_IPADDR";
261 case T_IDENTIFIER: return "T_IDENTIFIER";
262 case T_UNQUOTED_STRING: return "T_UNQUOTED_STRING";
263 case T_QUOTED_STRING: return "T_QUOTED_STRING";
264 case T_BOB: return "T_BOB";
265 case T_EOB: return "T_EOB";
266 case T_EQUALS: return "T_EQUALS";
267 case T_ERROR: return "T_ERROR";
268 case T_EOF: return "T_EOF";
269 case T_COMMA: return "T_COMMA";
270 case T_EOL: return "T_EOL";
271 default: return "??????";
275 static uint32_t scan_pint(LEX *lf, char *str)
278 if (!is_a_number(str)) {
279 scan_err1(lf, _("expected a positive integer number, got: %s"), str);
283 val = str_to_int64(str);
284 if (errno != 0 || val < 0) {
285 scan_err1(lf, _("expected a postive integer number, got: %s"), str);
289 return (uint32_t)val;
294 * Get the next token from the input
298 lex_get_token(LEX *lf, int expect)
302 bool esc_next = false;
304 Dmsg0(2000, "enter lex_get_token\n");
305 while (token == T_NONE) {
306 ch = lex_get_char(lf);
309 Dmsg2(2000, "Lex state lex_none ch=%d,%x\n", ch, ch);
313 if (lf->options & LOPT_NO_IDENT)
314 lf->state = lex_string;
316 lf->state = lex_identifier;
321 lf->state = lex_number;
325 Dmsg0(2000, "Enter lex_none switch\n");
329 Dmsg0(2000, "got L_EOF set token=T_EOF\n");
332 lf->state = lex_comment;
343 lf->state = lex_quoted_string;
355 if (expect != T_SKIP_EOL) {
356 token = T_EOL; /* treat ; like EOL */
360 Dmsg0(2000, "got L_EOL set token=T_EOL\n");
361 if (expect != T_SKIP_EOL) {
366 lf->state = lex_include;
370 lf->state = lex_string;
376 Dmsg1(2000, "Lex state lex_comment ch=%x\n", ch);
378 lf->state = lex_none;
379 if (expect != T_SKIP_EOL) {
382 } else if (ch == L_EOF) {
387 Dmsg2(2000, "Lex state lex_number ch=%x %c\n", ch, ch);
392 /* Might want to allow trailing specifications here */
398 /* A valid number can be terminated by the following */
399 if (B_ISSPACE(ch) || ch == L_EOL || ch == ',' || ch == ';') {
401 lf->state = lex_none;
403 lf->state = lex_string;
412 Dmsg1(2000, "Lex state lex_ip_addr ch=%x\n", ch);
415 Dmsg1(2000, "Lex state lex_string ch=%x\n", ch);
420 if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
421 ch == '\r' || ch == ';' || ch == ',' || ch == '#' || (B_ISSPACE(ch)) ) {
423 token = T_UNQUOTED_STRING;
424 lf->state = lex_none;
430 Dmsg2(2000, "Lex state lex_identifier ch=%x %c\n", ch, ch);
434 } else if (B_ISSPACE(ch)) {
436 } else if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
437 ch == '\r' || ch == ';' || ch == ',' || ch == '"' || ch == '#') {
439 token = T_IDENTIFIER;
440 lf->state = lex_none;
442 } else if (ch == L_EOF) {
444 lf->state = lex_none;
448 /* Some non-alpha character => string */
449 lf->state = lex_string;
452 case lex_quoted_string:
453 Dmsg2(2000, "Lex state lex_quoted_string ch=%x %c\n", ch, ch);
472 token = T_QUOTED_STRING;
473 lf->state = lex_none;
478 case lex_include: /* scanning a filename */
483 if (B_ISSPACE(ch) || ch == '\n' || ch == L_EOL || ch == '}' || ch == '{' ||
484 ch == ';' || ch == ',' || ch == '"' || ch == '#') {
485 lf->state = lex_none;
486 lf = lex_open_file(lf, lf->str, NULL);
495 Dmsg4(2000, "ch=%d state=%s token=%s %c\n", ch, lex_state_to_str(lf->state),
496 lex_tok_to_str(token), ch);
498 Dmsg2(2000, "lex returning: line %d token: %s\n", lf->line_no, lex_tok_to_str(token));
502 * Here is where we check to see if the user has set certain
503 * expectations (e.g. 32 bit integer). If so, we do type checking
504 * and possible additional scanning (e.g. for range).
508 lf->pint32_val = scan_pint(lf, lf->str);
509 lf->pint32_val2 = lf->pint32_val;
514 if (token == T_NUMBER) {
515 lf->pint32_val = scan_pint(lf, lf->str);
516 lf->pint32_val2 = lf->pint32_val;
519 char *p = strchr(lf->str, '-');
521 scan_err2(lf, _("expected an integer or a range, got %s: %s"),
522 lex_tok_to_str(token), lf->str);
526 *p++ = 0; /* terminate first half of range */
527 lf->pint32_val = scan_pint(lf, lf->str);
528 lf->pint32_val2 = scan_pint(lf, p);
529 token = T_PINT32_RANGE;
534 if (token != T_NUMBER || !is_a_number(lf->str)) {
535 scan_err2(lf, _("expected an integer number, got %s: %s"),
536 lex_tok_to_str(token), lf->str);
541 lf->int32_val = (int32_t)str_to_int64(lf->str);
543 scan_err2(lf, _("expected an integer number, got %s: %s"),
544 lex_tok_to_str(token), lf->str);
552 Dmsg2(2000, "int64=:%s: %f\n", lf->str, strtod(lf->str, NULL));
553 if (token != T_NUMBER || !is_a_number(lf->str)) {
554 scan_err2(lf, _("expected an integer number, got %s: %s"),
555 lex_tok_to_str(token), lf->str);
560 lf->int64_val = str_to_int64(lf->str);
562 scan_err2(lf, _("expected an integer number, got %s: %s"),
563 lex_tok_to_str(token), lf->str);
571 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
572 scan_err2(lf, _("expected a name, got %s: %s"),
573 lex_tok_to_str(token), lf->str);
575 } else if (lf->str_len > MAX_RES_NAME_LENGTH) {
576 scan_err3(lf, _("name %s length %d too long, max is %d\n"), lf->str,
577 lf->str_len, MAX_RES_NAME_LENGTH);
583 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
584 scan_err2(lf, _("expected a string, got %s: %s"),
585 lex_tok_to_str(token), lf->str);
594 break; /* no expectation given */
596 lf->token = token; /* set possible new token */