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) */
43 #include "console_conf.h"
47 /* Define the first and last resource ID record
48 * types. Note, these should be unique for each
49 * daemon though not a requirement.
51 int r_first = R_FIRST;
53 static RES *sres_head[R_LAST - R_FIRST + 1];
54 RES **res_head = sres_head;
56 /* Forward referenced subroutines */
59 /* We build the current resource here as we are
60 * scanning the resource configuration definition,
61 * then move it to allocated memory when the resource
65 extern "C" { // work around visual compiler mangling variables
71 int res_all_size = sizeof(res_all);
73 /* Definition of records permitted within each
74 * resource with the routine to process the record
78 /* Console "globals" */
79 static RES_ITEM cons_items[] = {
80 {"name", store_name, ITEM(res_cons.hdr.name), 0, ITEM_REQUIRED, 0},
81 {"description", store_str, ITEM(res_cons.hdr.desc), 0, 0, 0},
82 {"rcfile", store_dir, ITEM(res_cons.rc_file), 0, 0, 0},
83 {"historyfile", store_dir, ITEM(res_cons.hist_file), 0, 0, 0},
84 {"password", store_password, ITEM(res_cons.password), 0, ITEM_REQUIRED, 0},
85 {"tlsenable", store_bit, ITEM(res_cons.tls_enable), 1, 0, 0},
86 {"tlsrequire", store_bit, ITEM(res_cons.tls_require), 1, 0, 0},
87 {"tlscacertificatefile", store_dir, ITEM(res_cons.tls_ca_certfile), 0, 0, 0},
88 {"tlscacertificatedir", store_dir, ITEM(res_cons.tls_ca_certdir), 0, 0, 0},
89 {"tlscertificate", store_dir, ITEM(res_cons.tls_certfile), 0, 0, 0},
90 {"tlskey", store_dir, ITEM(res_cons.tls_keyfile), 0, 0, 0},
91 {NULL, NULL, {0}, 0, 0, 0}
95 /* Director's that we can contact */
96 static RES_ITEM dir_items[] = {
97 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
98 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
99 {"dirport", store_int, ITEM(res_dir.DIRport), 0, ITEM_DEFAULT, 9101},
100 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
101 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
102 {"tlsenable", store_bit, ITEM(res_dir.tls_enable), 1, 0, 0},
103 {"tlsrequire", store_bit, ITEM(res_dir.tls_require), 1, 0, 0},
104 {"tlscacertificatefile", store_dir, ITEM(res_dir.tls_ca_certfile), 0, 0, 0},
105 {"tlscacertificatedir", store_dir, ITEM(res_dir.tls_ca_certdir), 0, 0, 0},
106 {"tlscertificate", store_dir, ITEM(res_dir.tls_certfile), 0, 0, 0},
107 {"tlskey", store_dir, ITEM(res_dir.tls_keyfile), 0, 0, 0},
108 {NULL, NULL, {0}, 0, 0, 0}
112 * This is the master resource definition.
113 * It must have one item for each of the resources.
115 RES_TABLE resources[] = {
116 {"console", cons_items, R_CONSOLE},
117 {"director", dir_items, R_DIRECTOR},
122 /* Dump contents of resource */
123 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
125 URES *res = (URES *)reshdr;
129 printf(wxString(_("No record for %d %s\n")).mb_str(*wxConvCurrent), type, res_to_str(type));
132 if (type < 0) { /* no recursion */
138 printf(wxString(_("Console: name=%s rcfile=%s histfile=%s\n")).mb_str(*wxConvCurrent), reshdr->name,
139 res->res_cons.rc_file, res->res_cons.hist_file);
142 printf(wxString(_("Director: name=%s address=%s DIRport=%d\n")).mb_str(*wxConvCurrent), reshdr->name,
143 res->res_dir.address, res->res_dir.DIRport);
146 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
148 if (recurse && res->res_dir.hdr.next) {
149 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
154 * Free memory of resource.
155 * NB, we don't need to worry about freeing any references
156 * to other resources as they will be freed when that
157 * resource chain is traversed. Mainly we worry about freeing
158 * allocated strings (names).
160 void free_resource(RES *sres, int type)
163 URES *res = (URES *)sres;
168 /* common stuff -- free the resource name */
169 nres = (RES *)res->res_dir.hdr.next;
170 if (res->res_dir.hdr.name) {
171 bfree(res->res_dir.hdr.name);
173 if (res->res_dir.hdr.desc) {
174 bfree(res->res_dir.hdr.desc);
179 if (res->res_cons.rc_file) {
180 bfree(res->res_cons.rc_file);
182 if (res->res_cons.hist_file) {
183 bfree(res->res_cons.hist_file);
185 if (res->res_cons.tls_ctx) {
186 free_tls_context(res->res_cons.tls_ctx);
188 if (res->res_cons.tls_ca_certfile) {
189 bfree(res->res_cons.tls_ca_certfile);
191 if (res->res_cons.tls_ca_certdir) {
192 bfree(res->res_cons.tls_ca_certdir);
194 if (res->res_cons.tls_certfile) {
195 bfree(res->res_cons.tls_certfile);
197 if (res->res_cons.tls_keyfile) {
198 bfree(res->res_cons.tls_keyfile);
201 if (res->res_dir.address) {
202 bfree(res->res_dir.address);
204 if (res->res_dir.tls_ctx) {
205 free_tls_context(res->res_dir.tls_ctx);
207 if (res->res_dir.tls_ca_certfile) {
208 bfree(res->res_dir.tls_ca_certfile);
210 if (res->res_dir.tls_ca_certdir) {
211 bfree(res->res_dir.tls_ca_certdir);
213 if (res->res_dir.tls_certfile) {
214 bfree(res->res_dir.tls_certfile);
216 if (res->res_dir.tls_keyfile) {
217 bfree(res->res_dir.tls_keyfile);
221 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
223 /* Common stuff again -- free the resource, recurse to next one */
226 free_resource(nres, type);
230 /* Save the new resource by chaining it into the head list for
231 * the resource. If this is pass 2, we update any resource
232 * pointers (currently only in the Job resource).
234 void save_resource(int type, RES_ITEM *items, int pass)
237 int rindex = type - r_first;
242 * Ensure that all required items are present
244 for (i=0; items[i].name; i++) {
245 if (items[i].flags & ITEM_REQUIRED) {
246 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
247 Emsg2(M_ABORT, 0, wxString(_("%s item is required in %s resource, but not found.\n")).mb_str(*wxConvCurrent),
248 items[i].name, resources[rindex]);
253 /* During pass 2, we looked up pointers to all the resources
254 * referrenced in the current resource, , now we
255 * must copy their address from the static record to the allocated
260 /* Resources not containing a resource */
266 Emsg1(M_ERROR, 0, wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
270 /* Note, the resoure name was already saved during pass 1,
271 * so here, we can just release it.
273 if (res_all.res_dir.hdr.name) {
274 bfree(res_all.res_dir.hdr.name);
275 res_all.res_dir.hdr.name = NULL;
277 if (res_all.res_dir.hdr.desc) {
278 bfree(res_all.res_dir.hdr.desc);
279 res_all.res_dir.hdr.desc = NULL;
284 /* The following code is only executed during pass 1 */
287 size = sizeof(CONRES);
290 size = sizeof(DIRRES);
293 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
300 res = (URES *)bmalloc(size);
301 memcpy(res, &res_all, size);
302 if (!res_head[rindex]) {
303 res_head[rindex] = (RES *)res; /* store first entry */
306 for (next=res_head[rindex]; next->next; next=next->next) {
307 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
308 Emsg2(M_ERROR_TERM, 0,
309 wxString(_("Attempt to define second %s resource named \"%s\" is not permitted.\n")).mb_str(*wxConvCurrent),
310 resources[rindex].name, res->res_dir.hdr.name);
313 next->next = (RES *)res;
314 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
315 res->res_dir.hdr.name);