2 * Lexical scanner for Bacula configuration file
9 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License as
13 published by the Free Software Foundation; either version 2 of
14 the License, or (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public
22 License along with this program; if not, write to the Free
23 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
31 extern int debug_level;
34 * Scan to "logical" end of line. I.e. end of line,
37 void scan_to_eol(LEX *lc)
39 Dmsg0(900, "start scan to eof\n");
40 while (lex_get_token(lc, T_ALL) != T_EOL)
42 Dmsg0(900, "done scan to eof\n");
47 * Format a scanner error message
49 static void s_err(char *file, int line, LEX *lc, char *msg, ...)
55 va_start(arg_ptr, msg);
56 bvsnprintf(buf, sizeof(buf), msg, arg_ptr);
59 if (lc->line_no > lc->begin_line_no) {
60 sprintf(more, _("Problem probably begins at Line %d.\n"), lc->begin_line_no);
64 e_msg(file, line, M_ERROR_TERM, 0, _("Config error: %s\n\
65 : Line %d, col %d of file %s\n%s\n%s"),
66 buf, lc->line_no, lc->col_no, lc->fname, lc->line, more);
71 * Free the current file, and retrieve the contents
72 * of the previous packet if any.
74 LEX *lex_close_file(LEX *lf)
78 Dmsg1(900, "Close lex file: %s\n", lf->fname);
80 Emsg0(M_ABORT, 0, "Close of NULL file\n");
84 Dmsg1(900, "Close cfg file %s\n", lf->fname);
87 of->options = lf->options; /* preserve options */
88 memcpy(lf, of, sizeof(LEX));
89 Dmsg1(900, "Restart scan of cfg file %s\n", of->fname);
99 * Open a new configuration file. We push the
100 * state of the current file (lf) so that we
101 * can do includes. This is a bit of a hammer.
102 * Instead of passing back the pointer to the
103 * new packet, I simply replace the contents
104 * of the caller's packet with the new packet,
105 * and link the contents of the old packet into
109 LEX *lex_open_file(LEX *lf, char *filename, LEX_ERROR_HANDLER *scan_error)
114 char *fname = bstrdup(filename);
117 if ((fd = fopen(fname, "r")) == NULL) {
118 Emsg2(M_ERROR_TERM, 0, _("Cannot open config file %s: %s\n"),
119 fname, strerror(errno));
121 Dmsg1(900, "Open config file: %s\n", fname);
122 nf = (LEX *)malloc(sizeof(LEX));
124 memcpy(nf, lf, sizeof(LEX));
125 memset(lf, 0, sizeof(LEX));
126 lf->next = nf; /* if have lf, push it behind new one */
127 lf->options = nf->options; /* preserve user options */
129 lf = nf; /* start new packet */
130 memset(lf, 0, sizeof(LEX));
134 lf->state = lex_none;
137 lf->scan_error = scan_error;
139 lf->scan_error = s_err;
141 Dmsg1(900, "Return lex=%x\n", lf);
146 * Get the next character from the input.
147 * Returns the character or
148 * L_EOF if end of file
149 * L_EOL if end of line
151 int lex_get_char(LEX *lf)
153 if (lf->ch == L_EOF) {
154 Emsg0(M_ABORT, 0, "get_char: called after EOF\n");
156 if (lf->ch == L_EOL) {
157 if (fgets(lf->line, MAXSTRING, lf->fd) == NULL) {
167 lf->ch = lf->line[lf->col_no];
173 Dmsg2(900, "lex_get_char: %c %d\n", lf->ch, lf->ch);
177 void lex_unget_char(LEX *lf)
186 * Add a character to the current string
188 static void add_str(LEX *lf, int ch)
190 if (lf->str_len >= MAXSTRING-3) {
191 Emsg3(M_ERROR_TERM, 0, _(
192 "Token too long, file: %s, line %d, begins at line %d\n"),
193 lf->fname, lf->line_no, lf->begin_line_no);
195 lf->str[lf->str_len++] = ch;
196 lf->str[lf->str_len] = 0;
202 static void begin_str(LEX *lf, int ch)
209 lf->begin_line_no = lf->line_no; /* save start string line no */
213 static char *lex_state_to_str(int state)
216 case lex_none: return "none";
217 case lex_comment: return "comment";
218 case lex_number: return "number";
219 case lex_ip_addr: return "ip_addr";
220 case lex_identifier: return "identifier";
221 case lex_string: return "string";
222 case lex_quoted_string: return "quoted_string";
223 default: return "??????";
229 * Convert a lex token to a string
230 * used for debug/error printing.
232 char *lex_tok_to_str(int token)
235 case L_EOF: return "L_EOF";
236 case L_EOL: return "L_EOL";
237 case T_NONE: return "T_NONE";
238 case T_NUMBER: return "T_NUMBER";
239 case T_IPADDR: return "T_IPADDR";
240 case T_IDENTIFIER: return "T_IDENTIFIER";
241 case T_UNQUOTED_STRING: return "T_UNQUOTED_STRING";
242 case T_QUOTED_STRING: return "T_QUOTED_STRING";
243 case T_BOB: return "T_BOB";
244 case T_EOB: return "T_EOB";
245 case T_EQUALS: return "T_EQUALS";
246 case T_ERROR: return "T_ERROR";
247 case T_EOF: return "T_EOF";
248 case T_COMMA: return "T_COMMA";
249 case T_EOL: return "T_EOL";
250 default: return "??????";
254 static uint32_t scan_pint(LEX *lf, char *str)
257 if (!is_a_number(str)) {
258 scan_err1(lf, "expected a positive integer number, got: %s", str);
262 dval = strtod(str, NULL);
263 if (errno != 0 || dval < 0) {
264 scan_err1(lf, "expected a postive integer number, got: %s", str);
268 return (uint32_t)dval;
273 * Get the next token from the input
277 lex_get_token(LEX *lf, int expect)
281 int esc_next = FALSE;
283 Dmsg0(900, "enter lex_get_token\n");
284 while (token == T_NONE) {
285 ch = lex_get_char(lf);
288 Dmsg2(900, "Lex state lex_none ch=%d,%x\n", ch, ch);
292 if (lf->options & LOPT_NO_IDENT)
293 lf->state = lex_string;
295 lf->state = lex_identifier;
300 lf->state = lex_number;
304 Dmsg0(900, "Enter lex_none switch\n");
308 Dmsg0(900, "got L_EOF set token=T_EOF\n");
311 lf->state = lex_comment;
322 lf->state = lex_quoted_string;
334 token = T_EOL; /* treat ; like EOL */
337 Dmsg0(900, "got L_EOL set token=T_EOL\n");
341 lf->state = lex_include;
345 lf->state = lex_string;
351 Dmsg1(900, "Lex state lex_comment ch=%x\n", ch);
353 lf->state = lex_none;
355 } else if (ch == L_EOF) {
360 Dmsg2(900, "Lex state lex_number ch=%x %c\n", ch, ch);
365 /* Might want to allow trailing specifications here */
371 /* A valid number can be terminated by the following */
372 if (B_ISSPACE(ch) || ch == L_EOL || ch == ',' || ch == ';') {
374 lf->state = lex_none;
376 lf->state = lex_string;
385 Dmsg1(900, "Lex state lex_ip_addr ch=%x\n", ch);
388 Dmsg1(900, "Lex state lex_string ch=%x\n", ch);
393 if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
394 ch == '\r' || ch == ';' || ch == ',' || ch == '#' || (B_ISSPACE(ch)) ) {
396 token = T_UNQUOTED_STRING;
397 lf->state = lex_none;
403 Dmsg2(900, "Lex state lex_identifier ch=%x %c\n", ch, ch);
407 } else if (B_ISSPACE(ch)) {
409 } else if (ch == '\n' || ch == L_EOL || ch == '=' || ch == '}' || ch == '{' ||
410 ch == '\r' || ch == ';' || ch == ',' || ch == '"' || ch == '#') {
412 token = T_IDENTIFIER;
413 lf->state = lex_none;
415 } else if (ch == L_EOF) {
417 lf->state = lex_none;
421 /* Some non-alpha character => string */
422 lf->state = lex_string;
425 case lex_quoted_string:
426 Dmsg2(900, "Lex state lex_quoted_string ch=%x %c\n", ch, ch);
445 token = T_QUOTED_STRING;
446 lf->state = lex_none;
451 case lex_include: /* scanning a filename */
456 if (B_ISSPACE(ch) || ch == '\n' || ch == L_EOL || ch == '}' || ch == '{' ||
457 ch == ';' || ch == ',' || ch == '"' || ch == '#') {
458 lf->state = lex_none;
459 lf = lex_open_file(lf, lf->str, NULL);
465 Dmsg4(900, "ch=%d state=%s token=%s %c\n", ch, lex_state_to_str(lf->state),
466 lex_tok_to_str(token), ch);
468 Dmsg2(900, "lex returning: line %d token: %s\n", lf->line_no, lex_tok_to_str(token));
472 * Here is where we check to see if the user has set certain
473 * expectations (e.g. 32 bit integer). If so, we do type checking
474 * and possible additional scanning (e.g. for range).
478 lf->pint32_val = scan_pint(lf, lf->str);
479 lf->pint32_val2 = lf->pint32_val;
484 if (token == T_NUMBER) {
485 lf->pint32_val = scan_pint(lf, lf->str);
486 lf->pint32_val2 = lf->pint32_val;
489 char *p = strchr(lf->str, '-');
491 scan_err2(lf, "expected an integer or a range, got %s: %s",
492 lex_tok_to_str(token), lf->str);
496 *p++ = 0; /* terminate first half of range */
497 lf->pint32_val = scan_pint(lf, lf->str);
498 lf->pint32_val2 = scan_pint(lf, p);
499 token = T_PINT32_RANGE;
504 if (token != T_NUMBER || !is_a_number(lf->str)) {
505 scan_err2(lf, "expected an integer number, got %s: %s",
506 lex_tok_to_str(token), lf->str);
511 lf->int32_val = (int32_t)strtod(lf->str, NULL);
513 scan_err2(lf, "expected an integer number, got %s: %s",
514 lex_tok_to_str(token), lf->str);
522 Dmsg2(900, "int64=:%s: %f\n", lf->str, strtod(lf->str, NULL));
523 if (token != T_NUMBER || !is_a_number(lf->str)) {
524 scan_err2(lf, "expected an integer number, got %s: %s",
525 lex_tok_to_str(token), lf->str);
530 lf->int64_val = (int64_t)strtod(lf->str, NULL);
532 scan_err2(lf, "expected an integer number, got %s: %s",
533 lex_tok_to_str(token), lf->str);
541 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
542 scan_err2(lf, "expected a name, got %s: %s",
543 lex_tok_to_str(token), lf->str);
545 } else if (lf->str_len > MAX_RES_NAME_LENGTH) {
546 scan_err3(lf, "name %s length %d too long, max is %d\n", lf->str,
547 lf->str_len, MAX_RES_NAME_LENGTH);
550 POOLMEM *msg = get_pool_memory(PM_EMSG);
551 if (is_name_valid(lf->str, &msg)) {
553 free_pool_memory(msg);
555 scan_err1(lf, "%s\n", msg);
556 free_pool_memory(msg);
563 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
564 scan_err2(lf, "expected a string, got %s: %s",
565 lex_tok_to_str(token), lf->str);
574 break; /* no expectation given */
576 lf->token = token; /* set possible new token */