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, 2001, 2002 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},
123 /* Simply print a message */
124 static void prtmsg(void *sock, char *fmt, ...)
128 va_start(arg_ptr, fmt);
129 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;
146 * Initialize the static structure to zeros, then
147 * apply all the default values.
149 void init_resource(int type, struct res_items *items)
152 int rindex = type - r_first;
154 memset(&res_all, 0, res_all_size);
155 res_all.hdr.rcode = type;
156 res_all.hdr.refcnt = 1;
158 for (i=0; items[i].name; i++) {
159 Dmsg3(300, "Item=%s def=%s defval=%d\n", items[i].name,
160 (items[i].flags & ITEM_DEFAULT) ? "yes" : "no",
161 items[i].default_value);
162 if (items[i].flags & ITEM_DEFAULT && items[i].default_value != 0) {
163 if (items[i].handler == store_yesno) {
164 *(int *)(items[i].value) |= items[i].code;
165 } else if (items[i].handler == store_pint ||
166 items[i].handler == store_int) {
167 *(int *)(items[i].value) = items[i].default_value;
168 } else if (items[i].handler == store_int64) {
169 *(int64_t *)(items[i].value) = items[i].default_value;
170 } else if (items[i].handler == store_size ||
171 items[i].handler == store_time) {
172 *(uint64_t *)(items[i].value) = 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); /* scan destination */
215 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
216 scan_err1(lc, "expected a message destination, got: %s", lc->str);
218 dest = (char *) check_pool_memory_size(dest, dest_len + lc->str_len + 2);
220 strcat(dest, " "); /* separate multiple destinations with space */
223 strcat(dest, lc->str);
224 dest_len += lc->str_len;
225 Dmsg2(100, "store_msgs newdest=%s: dest=%s:\n", lc->str, dest);
226 token = lex_get_token(lc);
227 if (token == T_COMMA) {
228 continue; /* get another destination */
230 if (token != T_EQUALS) {
231 scan_err1(lc, "expected an =, got: %s", lc->str);
235 Dmsg1(200, "mail_cmd=%s\n", cmd);
236 scan_types(lc, (MSGS *)(item->value), item->code, dest, cmd);
237 free_pool_memory(dest);
238 Dmsg0(200, "done with dest codes\n");
240 case MD_FILE: /* file */
241 case MD_APPEND: /* append */
242 dest = get_pool_memory(PM_MESSAGE);
243 /* Pick up a single destination */
244 token = lex_get_token(lc); /* scan destination */
245 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
246 scan_err1(lc, "expected a message destination, got: %s", lc->str);
248 dest = check_pool_memory_size(dest, dest_len + lc->str_len + 2);
249 strcpy(dest, lc->str);
250 dest_len = lc->str_len;
251 token = lex_get_token(lc);
252 Dmsg1(200, "store_msgs dest=%s:\n", dest);
253 if (token != T_EQUALS) {
254 scan_err1(lc, "expected an =, got: %s", lc->str);
256 scan_types(lc, (MSGS *)(item->value), item->code, dest, NULL);
257 free_pool_memory(dest);
258 Dmsg0(200, "done with dest codes\n");
262 scan_err1(lc, "Unknown item code: %d\n", item->code);
267 set_bit(index, res_all.hdr.item_present);
268 Dmsg0(200, "Done store_msgs\n");
272 * Scan for message types and add them to the message
273 * destination. The basic job here is to connect message types
274 * (WARNING, ERROR, FATAL, INFO, ...) with an appropriate
275 * destination (MAIL, FILE, OPERATOR, ...)
277 static void scan_types(LEX *lc, MSGS *msg, int dest_code, char *where, char *cmd)
279 int token, i, found, quit, is_not;
283 for (quit=0; !quit;) {
284 token = lex_get_token(lc); /* expect at least one type */
285 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
286 scan_err1(lc, "expected a message type, got: %s", lc->str);
289 if (lc->str[0] == '!') {
296 for (i=0; msg_types[i].name; i++) {
297 if (strcmp(str, msg_types[i].name) == 0) {
298 msg_type = msg_types[i].token;
304 scan_err1(lc, "message type: %s not found", str);
307 if (msg_type == M_MAX+1) { /* all? */
308 for (i=1; i<=M_MAX; i++) { /* yes set all types */
309 add_msg_dest(msg, dest_code, i, where, cmd);
313 rem_msg_dest(msg, dest_code, msg_type, where);
315 add_msg_dest(msg, dest_code, msg_type, where, cmd);
321 Dmsg0(200, "call lex_get_token() to eat comma\n");
322 token = lex_get_token(lc); /* eat comma */
324 Dmsg0(200, "Done scan_types()\n");
329 * This routine is ONLY for resource names
330 * Store a name at specified address.
332 void store_name(LEX *lc, struct res_items *item, int index, int pass)
336 token = lex_get_token(lc);
337 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
338 scan_err1(lc, "expected an identifier or string, got: %s", lc->str);
339 } else if (lc->str_len > MAX_RES_NAME_LENGTH) {
340 scan_err3(lc, "name %s length %d too long, max is %d\n", lc->str,
341 lc->str_len, MAX_RES_NAME_LENGTH);
343 /* Store the name both pass 1 and pass 2 */
344 *(item->value) = bstrdup(lc->str);
347 set_bit(index, res_all.hdr.item_present);
352 * Store a name string at specified address
353 * A name string is limited to MAX_RES_NAME_LENGTH
355 void store_strname(LEX *lc, struct res_items *item, int index, int pass)
359 token = lex_get_token(lc);
360 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
361 scan_err1(lc, "expected an identifier or string, got: %s", lc->str);
362 } else if (lc->str_len > MAX_RES_NAME_LENGTH) {
363 scan_err3(lc, "name %s length %d too long, max is %d\n", lc->str,
364 lc->str_len, MAX_RES_NAME_LENGTH);
368 *(item->value) = bstrdup(lc->str);
371 set_bit(index, res_all.hdr.item_present);
376 /* Store a string at specified address */
377 void store_str(LEX *lc, struct res_items *item, int index, int pass)
381 token = lex_get_token(lc);
382 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
383 scan_err1(lc, "expected an identifier or string, got: %s", lc->str);
386 *(item->value) = bstrdup(lc->str);
390 set_bit(index, res_all.hdr.item_present);
393 /* Store a directory name at specified address */
394 void store_dir(LEX *lc, struct res_items *item, int index, int pass)
398 token = lex_get_token(lc);
399 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
400 scan_err1(lc, "expected an identifier or string, got: %s", lc->str);
403 do_shell_expansion(lc->str);
404 *(item->value) = bstrdup(lc->str);
408 set_bit(index, res_all.hdr.item_present);
412 /* Store a password specified address in MD5 coding */
413 void store_password(LEX *lc, struct res_items *item, int index, int pass)
415 unsigned int token, i, j;
416 struct MD5Context md5c;
417 unsigned char signature[16];
421 token = lex_get_token(lc);
422 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
423 scan_err1(lc, "expected an identifier or string, got: %s\n", lc->str);
427 MD5Update(&md5c, (unsigned char *) (lc->str), lc->str_len);
428 MD5Final(signature, &md5c);
429 for (i = j = 0; i < sizeof(signature); i++) {
430 sprintf(&sig[j], "%02x", signature[i]);
433 *(item->value) = bstrdup(sig);
437 set_bit(index, res_all.hdr.item_present);
441 /* Store a resource at specified address.
442 * If we are in pass 2, do a lookup of the
445 void store_res(LEX *lc, struct res_items *item, int index, int pass)
450 token = lex_get_token(lc);
451 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
452 scan_err1(lc, "expected a Resource name, got: %s", lc->str);
455 res = GetResWithName(item->code, lc->str);
457 scan_err3(lc, "Could not find Resource %s referenced on line %d : %s\n",
458 lc->str, lc->line_no, lc->line);
460 *(item->value) = (char *)res;
463 set_bit(index, res_all.hdr.item_present);
467 /* Store an integer at specified address */
468 void store_int(LEX *lc, struct res_items *item, int index, int pass)
472 token = lex_get_token(lc);
473 if (token != T_NUMBER || !is_a_number(lc->str)) {
474 scan_err1(lc, "expected an integer number, got: %s", lc->str);
477 *(int *)(item->value) = (int)strtod(lc->str, NULL);
479 scan_err1(lc, "expected an integer number, got: %s", lc->str);
483 set_bit(index, res_all.hdr.item_present);
486 /* Store a positive integer at specified address */
487 void store_pint(LEX *lc, struct res_items *item, int index, int pass)
491 token = lex_get_token(lc);
492 if (token != T_NUMBER || !is_a_number(lc->str)) {
493 scan_err1(lc, "expected a positive integer number, got: %s", lc->str);
496 token = (int)strtod(lc->str, NULL);
497 if (errno != 0 || token < 0) {
498 scan_err1(lc, "expected a postive integer number, got: %s", lc->str);
500 *(int *)(item->value) = token;
503 set_bit(index, res_all.hdr.item_present);
507 /* Store an 64 bit integer at specified address */
508 void store_int64(LEX *lc, struct res_items *item, int index, int pass)
512 token = lex_get_token(lc);
513 Dmsg2(400, "int64=:%s: %f\n", lc->str, strtod(lc->str, NULL));
514 if (token != T_NUMBER || !is_a_number(lc->str)) {
515 scan_err1(lc, "expected an integer number, got: %s", lc->str);
518 *(int64_t *)(item->value) = (int64_t)strtod(lc->str, NULL);
520 scan_err1(lc, "expected an integer number, got: %s", lc->str);
523 set_bit(index, res_all.hdr.item_present);
526 /* Store a size in bytes */
527 void store_size(LEX *lc, struct res_items *item, int index, int pass)
531 int mod[] = {'*', 'k', 'm', 'g', 0}; /* first item * not used */
532 uint64_t mult[] = {1, /* byte */
534 1048576, /* megabyte */
535 1073741824}; /* gigabyte */
537 #ifdef we_have_a_compiler_that_works
538 int mod[] = {'*', 'k', 'm', 'g', 't', 0};
539 uint64_t mult[] = {1, /* byte */
541 1048576, /* megabyte */
542 1073741824, /* gigabyte */
543 1099511627776};/* terabyte */
546 Dmsg0(400, "Enter store_size\n");
547 token = lex_get_token(lc);
551 Dmsg2(400, "size num=:%s: %f\n", lc->str, strtod(lc->str, NULL));
552 value = (uint64_t)strtod(lc->str, NULL);
553 if (errno != 0 || token < 0) {
554 scan_err1(lc, "expected a size number, got: %s", lc->str);
556 *(uint64_t *)(item->value) = value;
560 /* Look for modifier */
561 ch = lc->str[lc->str_len - 1];
567 while (mod[++i] != 0) {
570 lc->str[lc->str_len] = 0; /* strip modifier */
575 if (mod[i] == 0 || !is_a_number(lc->str)) {
576 scan_err1(lc, "expected a size number, got: %s", lc->str);
578 Dmsg3(400, "size str=:%s: %f i=%d\n", lc->str, strtod(lc->str, NULL), i);
580 value = (uint64_t)strtod(lc->str, NULL);
581 Dmsg1(400, "Int value = %d\n", (int)value);
582 if (errno != 0 || value < 0) {
583 scan_err1(lc, "expected a size number, got: %s", lc->str);
585 *(uint64_t *)(item->value) = value * mult[i];
586 Dmsg2(400, "Full value = %f %" lld "\n", strtod(lc->str, NULL) * mult[i],
590 scan_err1(lc, "expected a size, got: %s", lc->str);
594 set_bit(index, res_all.hdr.item_present);
595 Dmsg0(400, "Leave store_size\n");
599 /* Store a time period in seconds */
600 void store_time(LEX *lc, struct res_items *item, int index, int pass)
605 token = lex_get_token(lc);
609 value = (btime_t)strtod(lc->str, NULL);
610 if (errno != 0 || value < 0) {
611 scan_err1(lc, "expected a time period, got: %s", lc->str);
613 *(btime_t *)(item->value) = value;
617 if (!string_to_btime(lc->str, &value)) {
618 scan_err1(lc, "expected a time period, got: %s", lc->str);
620 *(btime_t *)(item->value) = value;
623 scan_err1(lc, "expected a time period, got: %s", lc->str);
627 set_bit(index, res_all.hdr.item_present);
631 /* Store a yes/no in a bit field */
632 void store_yesno(LEX *lc, struct res_items *item, int index, int pass)
636 token = lex_get_token(lc);
637 if (token != T_IDENTIFIER && token != T_STRING && token != T_QUOTED_STRING) {
638 scan_err1(lc, "expected an identifier or string, got: %s", lc->str);
639 } else if (strcasecmp(lc->str, "yes") == 0) {
640 *(int *)(item->value) |= item->code;
641 } else if (strcasecmp(lc->str, "no") == 0) {
642 *(int *)(item->value) &= ~(item->code);
644 scan_err1(lc, "Expect a YES or NO, got: %s", lc->str);
647 set_bit(index, res_all.hdr.item_present);
665 * Return resource of type rcode that matches name
668 GetResWithName(int rcode, char *name)
671 int rindex = rcode - r_first;
674 res = resources[rindex].res_head;
676 if (strcmp(res->name, name) == 0) {
687 * Return next resource of type rcode. On first
688 * call second arg (res) is NULL, on subsequent
689 * calls, it is called with previous value.
692 GetNextRes(int rcode, RES *res)
695 int rindex = rcode - r_first;
699 Emsg0(M_ABORT, 0, "Resource chain not locked.\n");
702 nres = resources[rindex].res_head;
716 /*********************************************************************
718 * Parse configuration file
722 parse_config(char *cf)
725 int token, i, res_type, pass;
726 enum parse_state state = p_none;
727 struct res_items *items;
730 /* Make two passes. The first builds the name symbol table,
731 * and the second picks up the items.
733 Dmsg0(200, "Enter parse_config()\n");
734 for (pass=1; pass <= 2; pass++) {
735 Dmsg1(200, "parse_config pass %d\n", pass);
736 lc = lex_open_file(lc, cf);
737 while ((token=lex_get_token(lc)) != T_EOF) {
738 Dmsg1(150, "parse got token=%s\n", lex_tok_to_str(token));
741 if (token == T_EOL) {
744 if (token != T_IDENTIFIER) {
745 scan_err1(lc, "Expected a Resource name identifier, got: %s", lc->str);
747 for (i=0; resources[i].name; i++)
748 if (strcasecmp(resources[i].name, lc->str) == 0) {
750 items = resources[i].items;
751 res_type = resources[i].rcode;
752 init_resource(res_type, items);
755 if (state == p_none) {
756 scan_err1(lc, "expected resource name, got: %s", lc->str);
766 scan_err1(lc, "not in resource definition: %s", lc->str);
768 for (i=0; items[i].name; i++) {
769 if (strcasecmp(items[i].name, lc->str) == 0) {
770 token = lex_get_token(lc);
771 Dmsg1 (150, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
772 if (token != T_EQUALS) {
773 scan_err1(lc, "expected an equals, got: %s", lc->str);
775 Dmsg1(150, "calling handler for %s\n", items[i].name);
776 /* Call item handler */
777 items[i].handler(lc, &items[i], i, pass);
783 Dmsg2(150, "level=%d id=%s\n", level, lc->str);
784 Dmsg1(150, "Keyword = %s\n", lc->str);
785 scan_err1(lc, "Keyword %s not permitted in this resource", lc->str);
792 Dmsg0(150, "T_EOB => define new resource\n");
793 save_resource(res_type, items, pass); /* save resource */
800 scan_err2(lc, "unexpected token %d %s in resource definition",
801 token, lex_tok_to_str(token));
805 scan_err1(lc, "Unknown parser state %d\n", state);
808 if (debug_level > 50 && pass == 2) {
810 for (i=r_first; i<=r_last; i++) {
811 dump_resource(i, resources[i-r_first].res_head, prtmsg, NULL);
814 lc = lex_close_file(lc);
816 Dmsg0(200, "Leave parse_config()\n");
819 /*********************************************************************
821 * Free configuration resources
825 free_config_resources()
828 for (i=r_first; i<=r_last; i++) {