2 * Master Configuration routines.
4 * This file contains the common parts of the Bacula
5 * configuration routines.
7 * Note, the configuration file parser consists of three parts
9 * 1. The generic lexical scanner in lib/lex.c and lib/lex.h
11 * 2. The generic config scanner in lib/parse_conf.c and
13 * These files contain the parser code, some utility
14 * routines, and the common store routines (name, int,
17 * 3. The daemon specific file, which contains the Resource
18 * definitions as well as any specific store routines
19 * for the resource records.
21 * N.B. This is a two pass parser, so if you malloc() a string
22 * in a "store" routine, you must ensure to do it during
23 * only one of the two passes, or to free it between.
24 * Also, note that the resource record is malloced and
25 * saved in save_resource() during pass 1. Anything that
26 * you want saved after pass two (e.g. resource pointers)
27 * must explicitly be done in save_resource. Take a look
28 * at the Job resource in src/dird/dird_conf.c to see how
31 * Kern Sibbald, January MM
37 Copyright (C) 2000-2003 Kern Sibbald and John Walker
39 This program is free software; you can redistribute it and/or
40 modify it under the terms of the GNU General Public License as
41 published by the Free Software Foundation; either version 2 of
42 the License, or (at your option) any later version.
44 This program is distributed in the hope that it will be useful,
45 but WITHOUT ANY WARRANTY; without even the implied warranty of
46 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
47 General Public License for more details.
49 You should have received a copy of the GNU General Public
50 License along with this program; if not, write to the Free
51 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
59 extern int debug_level;
61 /* Each daemon has a slightly different set of
62 * resources, so it will define the following
67 extern pthread_mutex_t res_mutex;
68 extern struct s_res resources[];
70 extern int res_all_size;
72 static int res_locked = 0; /* set when resource chains locked */
74 /* Forward referenced subroutines */
75 static void scan_types(LEX *lc, MSGS *msg, int dest, char *where, char *cmd);
78 /* Common Resource definitions */
80 /* Message resource directives
81 * name handler value code flags default_value
83 struct res_items msgs_items[] = {
84 {"name", store_name, ITEM(res_msgs.hdr.name), 0, 0, 0},
85 {"description", store_str, ITEM(res_msgs.hdr.desc), 0, 0, 0},
86 {"mailcommand", store_str, ITEM(res_msgs.mail_cmd), 0, 0, 0},
87 {"operatorcommand", store_str, ITEM(res_msgs.operator_cmd), 0, 0, 0},
88 {"syslog", store_msgs, ITEM(res_msgs), MD_SYSLOG, 0, 0},
89 {"mail", store_msgs, ITEM(res_msgs), MD_MAIL, 0, 0},
90 {"mailonerror", store_msgs, ITEM(res_msgs), MD_MAIL_ON_ERROR, 0, 0},
91 {"file", store_msgs, ITEM(res_msgs), MD_FILE, 0, 0},
92 {"append", store_msgs, ITEM(res_msgs), MD_APPEND, 0, 0},
93 {"stdout", store_msgs, ITEM(res_msgs), MD_STDOUT, 0, 0},
94 {"stderr", store_msgs, ITEM(res_msgs), MD_STDERR, 0, 0},
95 {"director", store_msgs, ITEM(res_msgs), MD_DIRECTOR, 0, 0},
96 {"console", store_msgs, ITEM(res_msgs), MD_CONSOLE, 0, 0},
97 {"operator", store_msgs, ITEM(res_msgs), MD_OPERATOR, 0, 0},
105 /* Various message types */
106 static struct s_mtypes msg_types[] = {
111 {"warning", M_WARNING},
114 {"notsaved", M_NOTSAVED},
115 {"skipped", M_SKIPPED},
117 {"terminate", M_TERM},
118 {"restored", M_RESTORED},
124 /* Simply print a message */
125 static void prtmsg(void *sock, char *fmt, ...)
129 va_start(arg_ptr, fmt);
130 vfprintf(stdout, fmt, arg_ptr);
134 char *res_to_str(int rcode)
136 if (rcode < r_first || rcode > r_last) {
137 return "***UNKNOWN***";
139 return resources[rcode-r_first].name;
145 * Initialize the static structure to zeros, then
146 * apply all the default values.
148 void init_resource(int type, struct res_items *items)
151 int rindex = type - r_first;
153 memset(&res_all, 0, res_all_size);
154 res_all.hdr.rcode = type;
155 res_all.hdr.refcnt = 1;
157 for (i=0; items[i].name; i++) {
158 Dmsg3(300, "Item=%s def=%s defval=%d\n", items[i].name,
159 (items[i].flags & ITEM_DEFAULT) ? "yes" : "no",
160 items[i].default_value);
161 if (items[i].flags & ITEM_DEFAULT && items[i].default_value != 0) {
162 if (items[i].handler == store_yesno) {
163 *(int *)(items[i].value) |= items[i].code;
164 } else if (items[i].handler == store_pint ||
165 items[i].handler == store_int) {
166 *(int *)(items[i].value) = items[i].default_value;
167 } else if (items[i].handler == store_int64) {
168 *(int64_t *)(items[i].value) = items[i].default_value;
169 } else if (items[i].handler == store_size) {
170 *(uint64_t *)(items[i].value) = (uint64_t)items[i].default_value;
171 } else if (items[i].handler == store_time) {
172 *(utime_t *)(items[i].value) = (utime_t)items[i].default_value;
175 /* If this triggers, take a look at lib/parse_conf.h */
176 if (i >= MAX_RES_ITEMS) {
177 Emsg1(M_ERROR_TERM, 0, _("Too many items in %s resource\n"), resources[rindex]);
183 /* Store Messages Destination information */
184 void store_msgs(LEX *lc, struct res_items *item, int index, int pass)
191 Dmsg2(200, "store_msgs pass=%d code=%d\n", pass, item->code);
193 switch (item->code) {
196 case MD_SYSLOG: /* syslog */
198 scan_types(lc, (MSGS *)(item->value), item->code, NULL, NULL);
200 case MD_OPERATOR: /* send to operator */
201 case MD_DIRECTOR: /* send to Director */
202 case MD_MAIL: /* mail */
203 case MD_MAIL_ON_ERROR: /* mail if Job errors */
204 if (item->code == MD_OPERATOR) {
205 cmd = res_all.res_msgs.operator_cmd;
207 cmd = res_all.res_msgs.mail_cmd;
209 dest = get_pool_memory(PM_MESSAGE);
212 /* Pick up comma separated list of destinations */
214 token = lex_get_token(lc, T_NAME); /* scan destination */
215 dest = check_pool_memory_size(dest, dest_len + lc->str_len + 2);
217 strcat(dest, " "); /* separate multiple destinations with space */
220 strcat(dest, lc->str);
221 dest_len += lc->str_len;
222 Dmsg2(100, "store_msgs newdest=%s: dest=%s:\n", lc->str, NPRT(dest));
223 token = lex_get_token(lc, T_ALL);
224 if (token == T_COMMA) {
225 continue; /* get another destination */
227 if (token != T_EQUALS) {
228 scan_err1(lc, "expected an =, got: %s", lc->str);
232 Dmsg1(200, "mail_cmd=%s\n", NPRT(cmd));
233 scan_types(lc, (MSGS *)(item->value), item->code, dest, cmd);
234 free_pool_memory(dest);
235 Dmsg0(200, "done with dest codes\n");
237 case MD_FILE: /* file */
238 case MD_APPEND: /* append */
239 dest = get_pool_memory(PM_MESSAGE);
240 /* Pick up a single destination */
241 token = lex_get_token(lc, T_NAME); /* scan destination */
242 pm_strcpy(&dest, lc->str);
243 dest_len = lc->str_len;
244 token = lex_get_token(lc, T_ALL);
245 Dmsg1(200, "store_msgs dest=%s:\n", NPRT(dest));
246 if (token != T_EQUALS) {
247 scan_err1(lc, "expected an =, got: %s", lc->str);
249 scan_types(lc, (MSGS *)(item->value), item->code, dest, NULL);
250 free_pool_memory(dest);
251 Dmsg0(200, "done with dest codes\n");
255 scan_err1(lc, "Unknown item code: %d\n", item->code);
260 set_bit(index, res_all.hdr.item_present);
261 Dmsg0(200, "Done store_msgs\n");
265 * Scan for message types and add them to the message
266 * destination. The basic job here is to connect message types
267 * (WARNING, ERROR, FATAL, INFO, ...) with an appropriate
268 * destination (MAIL, FILE, OPERATOR, ...)
270 static void scan_types(LEX *lc, MSGS *msg, int dest_code, char *where, char *cmd)
272 int i, found, quit, is_not;
276 for (quit=0; !quit;) {
277 lex_get_token(lc, T_NAME); /* expect at least one type */
279 if (lc->str[0] == '!') {
286 for (i=0; msg_types[i].name; i++) {
287 if (strcasecmp(str, msg_types[i].name) == 0) {
288 msg_type = msg_types[i].token;
294 scan_err1(lc, "message type: %s not found", str);
298 if (msg_type == M_MAX+1) { /* all? */
299 for (i=1; i<=M_MAX; i++) { /* yes set all types */
300 add_msg_dest(msg, dest_code, i, where, cmd);
304 rem_msg_dest(msg, dest_code, msg_type, where);
306 add_msg_dest(msg, dest_code, msg_type, where, cmd);
312 Dmsg0(200, "call lex_get_token() to eat comma\n");
313 lex_get_token(lc, T_ALL); /* eat comma */
315 Dmsg0(200, "Done scan_types()\n");
320 * This routine is ONLY for resource names
321 * Store a name at specified address.
323 void store_name(LEX *lc, struct res_items *item, int index, int pass)
325 lex_get_token(lc, T_NAME);
326 /* Store the name both pass 1 and pass 2 */
327 *(item->value) = bstrdup(lc->str);
329 set_bit(index, res_all.hdr.item_present);
334 * Store a name string at specified address
335 * A name string is limited to MAX_RES_NAME_LENGTH
337 void store_strname(LEX *lc, struct res_items *item, int index, int pass)
339 lex_get_token(lc, T_NAME);
342 *(item->value) = bstrdup(lc->str);
345 set_bit(index, res_all.hdr.item_present);
350 /* Store a string at specified address */
351 void store_str(LEX *lc, struct res_items *item, int index, int pass)
353 lex_get_token(lc, T_STRING);
355 *(item->value) = bstrdup(lc->str);
358 set_bit(index, res_all.hdr.item_present);
362 * Store a directory name at specified address. Note, we do
363 * shell expansion except if the string begins with a vertical
364 * bar (i.e. it will likely be passed to the shell later).
366 void store_dir(LEX *lc, struct res_items *item, int index, int pass)
368 lex_get_token(lc, T_STRING);
370 if (lc->str[0] != '|') {
371 do_shell_expansion(lc->str, sizeof(lc->str));
373 *(item->value) = bstrdup(lc->str);
376 set_bit(index, res_all.hdr.item_present);
380 /* Store a password specified address in MD5 coding */
381 void store_password(LEX *lc, struct res_items *item, int index, int pass)
384 struct MD5Context md5c;
385 unsigned char signature[16];
389 lex_get_token(lc, T_STRING);
392 MD5Update(&md5c, (unsigned char *) (lc->str), lc->str_len);
393 MD5Final(signature, &md5c);
394 for (i = j = 0; i < sizeof(signature); i++) {
395 sprintf(&sig[j], "%02x", signature[i]);
398 *(item->value) = bstrdup(sig);
401 set_bit(index, res_all.hdr.item_present);
405 /* Store a resource at specified address.
406 * If we are in pass 2, do a lookup of the
409 void store_res(LEX *lc, struct res_items *item, int index, int pass)
413 lex_get_token(lc, T_NAME);
415 res = GetResWithName(item->code, lc->str);
417 scan_err3(lc, "Could not find Resource %s referenced on line %d : %s\n",
418 lc->str, lc->line_no, lc->line);
420 *(item->value) = (char *)res;
423 set_bit(index, res_all.hdr.item_present);
427 /* Store an integer at specified address */
428 void store_int(LEX *lc, struct res_items *item, int index, int pass)
430 lex_get_token(lc, T_INT32);
431 *(int *)(item->value) = lc->int32_val;
433 set_bit(index, res_all.hdr.item_present);
436 /* Store a positive integer at specified address */
437 void store_pint(LEX *lc, struct res_items *item, int index, int pass)
439 lex_get_token(lc, T_PINT32);
440 *(int *)(item->value) = lc->pint32_val;
442 set_bit(index, res_all.hdr.item_present);
446 /* Store an 64 bit integer at specified address */
447 void store_int64(LEX *lc, struct res_items *item, int index, int pass)
449 lex_get_token(lc, T_INT64);
450 *(int64_t *)(item->value) = lc->int64_val;
452 set_bit(index, res_all.hdr.item_present);
455 /* Store a size in bytes */
456 void store_size(LEX *lc, struct res_items *item, int index, int pass)
461 Dmsg0(400, "Enter store_size\n");
462 token = lex_get_token(lc, T_ALL);
467 case T_UNQUOTED_STRING:
468 if (!size_to_uint64(lc->str, lc->str_len, &uvalue)) {
469 scan_err1(lc, "expected a size number, got: %s", lc->str);
471 *(uint64_t *)(item->value) = uvalue;
474 scan_err1(lc, "expected a size, got: %s", lc->str);
478 set_bit(index, res_all.hdr.item_present);
479 Dmsg0(400, "Leave store_size\n");
483 /* Store a time period in seconds */
484 void store_time(LEX *lc, struct res_items *item, int index, int pass)
490 token = lex_get_token(lc, T_ALL);
495 case T_UNQUOTED_STRING:
496 bstrncpy(period, lc->str, sizeof(period));
498 token = lex_get_token(lc, T_ALL);
501 case T_UNQUOTED_STRING:
502 bstrncat(period, lc->str, sizeof(period));
506 if (!duration_to_utime(period, &utime)) {
507 scan_err1(lc, "expected a time period, got: %s", period);
509 *(utime_t *)(item->value) = utime;
512 scan_err1(lc, "expected a time period, got: %s", lc->str);
515 if (token != T_EOL) {
518 set_bit(index, res_all.hdr.item_present);
522 /* Store a yes/no in a bit field */
523 void store_yesno(LEX *lc, struct res_items *item, int index, int pass)
525 lex_get_token(lc, T_NAME);
526 if (strcasecmp(lc->str, "yes") == 0) {
527 *(int *)(item->value) |= item->code;
528 } else if (strcasecmp(lc->str, "no") == 0) {
529 *(int *)(item->value) &= ~(item->code);
531 scan_err1(lc, "Expect a YES or NO, got: %s", lc->str);
534 set_bit(index, res_all.hdr.item_present);
552 * Return resource of type rcode that matches name
555 GetResWithName(int rcode, char *name)
558 int rindex = rcode - r_first;
561 res = resources[rindex].res_head;
563 if (strcmp(res->name, name) == 0) {
574 * Return next resource of type rcode. On first
575 * call second arg (res) is NULL, on subsequent
576 * calls, it is called with previous value.
579 GetNextRes(int rcode, RES *res)
582 int rindex = rcode - r_first;
586 Emsg0(M_ABORT, 0, "Resource chain not locked.\n");
589 nres = resources[rindex].res_head;
603 /*********************************************************************
605 * Parse configuration file
609 parse_config(char *cf)
614 enum parse_state state = p_none;
615 struct res_items *items = NULL;
618 /* Make two passes. The first builds the name symbol table,
619 * and the second picks up the items.
621 Dmsg0(200, "Enter parse_config()\n");
622 for (pass=1; pass <= 2; pass++) {
623 Dmsg1(200, "parse_config pass %d\n", pass);
624 lc = lex_open_file(lc, cf, NULL);
625 while ((token=lex_get_token(lc, T_ALL)) != T_EOF) {
626 Dmsg1(150, "parse got token=%s\n", lex_tok_to_str(token));
629 if (token == T_EOL) {
632 if (token != T_IDENTIFIER) {
633 scan_err1(lc, "Expected a Resource name identifier, got: %s", lc->str);
636 for (i=0; resources[i].name; i++)
637 if (strcasecmp(resources[i].name, lc->str) == 0) {
639 items = resources[i].items;
640 res_type = resources[i].rcode;
641 init_resource(res_type, items);
644 if (state == p_none) {
645 scan_err1(lc, "expected resource name, got: %s", lc->str);
656 scan_err1(lc, "not in resource definition: %s", lc->str);
659 for (i=0; items[i].name; i++) {
660 if (strcasecmp(items[i].name, lc->str) == 0) {
661 /* If the ITEM_NO_EQUALS flag is set we do NOT
662 * scan for = after the keyword */
663 if (!(items[i].flags & ITEM_NO_EQUALS)) {
664 token = lex_get_token(lc, T_ALL);
665 Dmsg1 (150, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
666 if (token != T_EQUALS) {
667 scan_err1(lc, "expected an equals, got: %s", lc->str);
671 Dmsg1(150, "calling handler for %s\n", items[i].name);
672 /* Call item handler */
673 items[i].handler(lc, &items[i], i, pass);
679 Dmsg2(150, "level=%d id=%s\n", level, lc->str);
680 Dmsg1(150, "Keyword = %s\n", lc->str);
681 scan_err1(lc, "Keyword \"%s\" not permitted in this resource", lc->str);
689 Dmsg0(150, "T_EOB => define new resource\n");
690 save_resource(res_type, items, pass); /* save resource */
697 scan_err2(lc, "unexpected token %d %s in resource definition",
698 token, lex_tok_to_str(token));
703 scan_err1(lc, "Unknown parser state %d\n", state);
707 if (state != p_none) {
708 scan_err0(lc, "End of conf file reached with unclosed resource.");
710 if (debug_level > 50 && pass == 2) {
712 for (i=r_first; i<=r_last; i++) {
713 dump_resource(i, resources[i-r_first].res_head, prtmsg, NULL);
716 lc = lex_close_file(lc);
718 Dmsg0(200, "Leave parse_config()\n");
721 /*********************************************************************
723 * Free configuration resources
727 free_config_resources()
730 for (i=r_first; i<=r_last; i++) {