2 * Main configuration file parser for Bacula User Agent
3 * some parts may be split into separate files such as
4 * the schedule configuration (sch_config.c).
6 * Note, the configuration file parser consists of three parts
8 * 1. The generic lexical scanner in lib/lex.c and lib/lex.h
10 * 2. The generic config scanner in lib/parse_config.c and
12 * These files contain the parser code, some utility
13 * routines, and the common store routines (name, int,
16 * 3. The daemon specific file, which contains the Resource
17 * definitions as well as any specific store routines
18 * for the resource records.
20 * Kern Sibbald, January MM, September MM
23 Copyright (C) 2000-2006 Kern Sibbald
25 This program is free software; you can redistribute it and/or
26 modify it under the terms of the GNU General Public License
27 version 2 as amended with additional clauses defined in the
28 file LICENSE in the main source directory.
30 This program is distributed in the hope that it will be useful,
31 but WITHOUT ANY WARRANTY; without even the implied warranty of
32 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 the file LICENSE for additional details.
37 /* _("...") macro returns a wxChar*, so if we need a char*, we need to convert it with:
38 * wxString(_("...")).mb_str(*wxConvCurrent) */
41 #include "console_conf.h"
45 /* Define the first and last resource ID record
46 * types. Note, these should be unique for each
47 * daemon though not a requirement.
49 int r_first = R_FIRST;
51 static RES *sres_head[R_LAST - R_FIRST + 1];
52 RES **res_head = sres_head;
54 /* Forward referenced subroutines */
57 /* We build the current resource here as we are
58 * scanning the resource configuration definition,
59 * then move it to allocated memory when the resource
63 extern "C" { // work around visual compiler mangling variables
69 int res_all_size = sizeof(res_all);
71 /* Definition of records permitted within each
72 * resource with the routine to process the record
76 /* Console "globals" */
77 static RES_ITEM cons_items[] = {
78 {"name", store_name, ITEM(res_cons.hdr.name), 0, ITEM_REQUIRED, 0},
79 {"description", store_str, ITEM(res_cons.hdr.desc), 0, 0, 0},
80 {"rcfile", store_dir, ITEM(res_cons.rc_file), 0, 0, 0},
81 {"historyfile", store_dir, ITEM(res_cons.hist_file), 0, 0, 0},
82 {"password", store_password, ITEM(res_cons.password), 0, ITEM_REQUIRED, 0},
83 {"tlsenable", store_bit, ITEM(res_cons.tls_enable), 1, 0, 0},
84 {"tlsrequire", store_bit, ITEM(res_cons.tls_require), 1, 0, 0},
85 {"tlscacertificatefile", store_dir, ITEM(res_cons.tls_ca_certfile), 0, 0, 0},
86 {"tlscacertificatedir", store_dir, ITEM(res_cons.tls_ca_certdir), 0, 0, 0},
87 {"tlscertificate", store_dir, ITEM(res_cons.tls_certfile), 0, 0, 0},
88 {"tlskey", store_dir, ITEM(res_cons.tls_keyfile), 0, 0, 0},
89 {NULL, NULL, {0}, 0, 0, 0}
93 /* Director's that we can contact */
94 static RES_ITEM dir_items[] = {
95 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
96 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
97 {"dirport", store_int, ITEM(res_dir.DIRport), 0, ITEM_DEFAULT, 9101},
98 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
99 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
100 {"tlsenable", store_bit, ITEM(res_dir.tls_enable), 1, 0, 0},
101 {"tlsrequire", store_bit, ITEM(res_dir.tls_require), 1, 0, 0},
102 {"tlscacertificatefile", store_dir, ITEM(res_dir.tls_ca_certfile), 0, 0, 0},
103 {"tlscacertificatedir", store_dir, ITEM(res_dir.tls_ca_certdir), 0, 0, 0},
104 {"tlscertificate", store_dir, ITEM(res_dir.tls_certfile), 0, 0, 0},
105 {"tlskey", store_dir, ITEM(res_dir.tls_keyfile), 0, 0, 0},
106 {NULL, NULL, {0}, 0, 0, 0}
110 * This is the master resource definition.
111 * It must have one item for each of the resources.
113 RES_TABLE resources[] = {
114 {"console", cons_items, R_CONSOLE},
115 {"director", dir_items, R_DIRECTOR},
120 /* Dump contents of resource */
121 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
123 URES *res = (URES *)reshdr;
127 printf(wxString(_("No record for %d %s\n")).mb_str(*wxConvCurrent), type, res_to_str(type));
130 if (type < 0) { /* no recursion */
136 printf(wxString(_("Console: name=%s rcfile=%s histfile=%s\n")).mb_str(*wxConvCurrent), reshdr->name,
137 res->res_cons.rc_file, res->res_cons.hist_file);
140 printf(wxString(_("Director: name=%s address=%s DIRport=%d\n")).mb_str(*wxConvCurrent), reshdr->name,
141 res->res_dir.address, res->res_dir.DIRport);
144 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
146 if (recurse && res->res_dir.hdr.next) {
147 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
152 * Free memory of resource.
153 * NB, we don't need to worry about freeing any references
154 * to other resources as they will be freed when that
155 * resource chain is traversed. Mainly we worry about freeing
156 * allocated strings (names).
158 void free_resource(RES *sres, int type)
161 URES *res = (URES *)sres;
166 /* common stuff -- free the resource name */
167 nres = (RES *)res->res_dir.hdr.next;
168 if (res->res_dir.hdr.name) {
169 free(res->res_dir.hdr.name);
171 if (res->res_dir.hdr.desc) {
172 free(res->res_dir.hdr.desc);
177 if (res->res_cons.rc_file) {
178 free(res->res_cons.rc_file);
180 if (res->res_cons.hist_file) {
181 free(res->res_cons.hist_file);
183 if (res->res_cons.tls_ctx) {
184 free_tls_context(res->res_cons.tls_ctx);
186 if (res->res_cons.tls_ca_certfile) {
187 free(res->res_cons.tls_ca_certfile);
189 if (res->res_cons.tls_ca_certdir) {
190 free(res->res_cons.tls_ca_certdir);
192 if (res->res_cons.tls_certfile) {
193 free(res->res_cons.tls_certfile);
195 if (res->res_cons.tls_keyfile) {
196 free(res->res_cons.tls_keyfile);
199 if (res->res_dir.address) {
200 free(res->res_dir.address);
202 if (res->res_dir.tls_ctx) {
203 free_tls_context(res->res_dir.tls_ctx);
205 if (res->res_dir.tls_ca_certfile) {
206 free(res->res_dir.tls_ca_certfile);
208 if (res->res_dir.tls_ca_certdir) {
209 free(res->res_dir.tls_ca_certdir);
211 if (res->res_dir.tls_certfile) {
212 free(res->res_dir.tls_certfile);
214 if (res->res_dir.tls_keyfile) {
215 free(res->res_dir.tls_keyfile);
219 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
221 /* Common stuff again -- free the resource, recurse to next one */
224 free_resource(nres, type);
228 /* Save the new resource by chaining it into the head list for
229 * the resource. If this is pass 2, we update any resource
230 * pointers (currently only in the Job resource).
232 void save_resource(int type, RES_ITEM *items, int pass)
235 int rindex = type - r_first;
240 * Ensure that all required items are present
242 for (i=0; items[i].name; i++) {
243 if (items[i].flags & ITEM_REQUIRED) {
244 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
245 Emsg2(M_ABORT, 0, wxString(_("%s item is required in %s resource, but not found.\n")).mb_str(*wxConvCurrent),
246 items[i].name, resources[rindex]);
251 /* During pass 2, we looked up pointers to all the resources
252 * referrenced in the current resource, , now we
253 * must copy their address from the static record to the allocated
258 /* Resources not containing a resource */
264 Emsg1(M_ERROR, 0, wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
268 /* Note, the resoure name was already saved during pass 1,
269 * so here, we can just release it.
271 if (res_all.res_dir.hdr.name) {
272 free(res_all.res_dir.hdr.name);
273 res_all.res_dir.hdr.name = NULL;
275 if (res_all.res_dir.hdr.desc) {
276 free(res_all.res_dir.hdr.desc);
277 res_all.res_dir.hdr.desc = NULL;
282 /* The following code is only executed during pass 1 */
285 size = sizeof(CONRES);
288 size = sizeof(DIRRES);
291 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
298 res = (URES *)malloc(size);
299 memcpy(res, &res_all, size);
300 if (!res_head[rindex]) {
301 res_head[rindex] = (RES *)res; /* store first entry */
304 for (next=res_head[rindex]; next->next; next=next->next) {
305 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
306 Emsg2(M_ERROR_TERM, 0,
307 wxString(_("Attempt to define second %s resource named \"%s\" is not permitted.\n")).mb_str(*wxConvCurrent),
308 resources[rindex].name, res->res_dir.hdr.name);
311 next->next = (RES *)res;
312 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
313 res->res_dir.hdr.name);