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-2005 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"
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
62 #if defined(HAVE_WIN32) && !defined(HAVE_CYGWIN) && !defined(HAVE_MINGW)
63 extern "C" { // work around visual compiler mangling variables
65 int res_all_size = sizeof(res_all);
69 int res_all_size = sizeof(res_all);
72 /* Definition of records permitted within each
73 * resource with the routine to process the record
77 /* Console "globals" */
78 static RES_ITEM cons_items[] = {
79 {"name", store_name, ITEM(res_cons.hdr.name), 0, ITEM_REQUIRED, 0},
80 {"description", store_str, ITEM(res_cons.hdr.desc), 0, 0, 0},
81 {"rcfile", store_dir, ITEM(res_cons.rc_file), 0, 0, 0},
82 {"historyfile", store_dir, ITEM(res_cons.hist_file), 0, 0, 0},
83 {"password", store_password, ITEM(res_cons.password), 0, ITEM_REQUIRED, 0},
84 {"tlsenable", store_yesno, ITEM(res_cons.tls_enable), 0, 0, 0},
85 {"tlsrequire", store_yesno, ITEM(res_cons.tls_require), 0, 0, 0},
86 {"tlscacertificatefile", store_dir, ITEM(res_cons.tls_ca_certfile), 0, 0, 0},
87 {"tlscacertificatedir", store_dir, ITEM(res_cons.tls_ca_certdir), 0, 0, 0},
88 {"tlscertificate", store_dir, ITEM(res_cons.tls_certfile), 0, 0, 0},
89 {"tlskey", store_dir, ITEM(res_cons.tls_keyfile), 0, 0, 0},
90 {NULL, NULL, NULL, 0, 0, 0}
94 /* Director's that we can contact */
95 static RES_ITEM dir_items[] = {
96 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
97 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
98 {"dirport", store_int, ITEM(res_dir.DIRport), 0, ITEM_DEFAULT, 9101},
99 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
100 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
101 {"tlsenable", store_yesno, ITEM(res_dir.tls_enable), 0, 0, 0},
102 {"tlsrequire", store_yesno, ITEM(res_dir.tls_require), 0, 0, 0},
103 {"tlscacertificatefile", store_dir, ITEM(res_dir.tls_ca_certfile), 0, 0, 0},
104 {"tlscacertificatedir", store_dir, ITEM(res_dir.tls_ca_certdir), 0, 0, 0},
105 {"tlscertificate", store_dir, ITEM(res_dir.tls_certfile), 0, 0, 0},
106 {"tlskey", store_dir, ITEM(res_dir.tls_keyfile), 0, 0, 0},
107 {NULL, NULL, NULL, 0, 0, 0}
111 * This is the master resource definition.
112 * It must have one item for each of the resources.
114 RES_TABLE resources[] = {
115 {"console", cons_items, R_CONSOLE},
116 {"director", dir_items, R_DIRECTOR},
121 /* Dump contents of resource */
122 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
124 URES *res = (URES *)reshdr;
128 printf(wxString(_("No record for %d %s\n")).mb_str(*wxConvCurrent), type, res_to_str(type));
131 if (type < 0) { /* no recursion */
137 printf(wxString(_("Console: name=%s rcfile=%s histfile=%s\n")).mb_str(*wxConvCurrent), reshdr->name,
138 res->res_cons.rc_file, res->res_cons.hist_file);
141 printf(wxString(_("Director: name=%s address=%s DIRport=%d\n")).mb_str(*wxConvCurrent), reshdr->name,
142 res->res_dir.address, res->res_dir.DIRport);
145 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
147 if (recurse && res->res_dir.hdr.next) {
148 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
153 * Free memory of resource.
154 * NB, we don't need to worry about freeing any references
155 * to other resources as they will be freed when that
156 * resource chain is traversed. Mainly we worry about freeing
157 * allocated strings (names).
159 void free_resource(RES *sres, int type)
162 URES *res = (URES *)sres;
167 /* common stuff -- free the resource name */
168 nres = (RES *)res->res_dir.hdr.next;
169 if (res->res_dir.hdr.name) {
170 free(res->res_dir.hdr.name);
172 if (res->res_dir.hdr.desc) {
173 free(res->res_dir.hdr.desc);
178 if (res->res_cons.rc_file) {
179 free(res->res_cons.rc_file);
181 if (res->res_cons.hist_file) {
182 free(res->res_cons.hist_file);
184 if (res->res_cons.tls_ctx) {
185 free_tls_context(res->res_cons.tls_ctx);
187 if (res->res_cons.tls_ca_certfile) {
188 free(res->res_cons.tls_ca_certfile);
190 if (res->res_cons.tls_ca_certdir) {
191 free(res->res_cons.tls_ca_certdir);
193 if (res->res_cons.tls_certfile) {
194 free(res->res_cons.tls_certfile);
196 if (res->res_cons.tls_keyfile) {
197 free(res->res_cons.tls_keyfile);
200 if (res->res_dir.address) {
201 free(res->res_dir.address);
203 if (res->res_dir.tls_ctx) {
204 free_tls_context(res->res_dir.tls_ctx);
206 if (res->res_dir.tls_ca_certfile) {
207 free(res->res_dir.tls_ca_certfile);
209 if (res->res_dir.tls_ca_certdir) {
210 free(res->res_dir.tls_ca_certdir);
212 if (res->res_dir.tls_certfile) {
213 free(res->res_dir.tls_certfile);
215 if (res->res_dir.tls_keyfile) {
216 free(res->res_dir.tls_keyfile);
220 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
222 /* Common stuff again -- free the resource, recurse to next one */
225 free_resource(nres, type);
229 /* Save the new resource by chaining it into the head list for
230 * the resource. If this is pass 2, we update any resource
231 * pointers (currently only in the Job resource).
233 void save_resource(int type, RES_ITEM *items, int pass)
236 int rindex = type - r_first;
241 * Ensure that all required items are present
243 for (i=0; items[i].name; i++) {
244 if (items[i].flags & ITEM_REQUIRED) {
245 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
246 Emsg2(M_ABORT, 0, wxString(_("%s item is required in %s resource, but not found.\n")).mb_str(*wxConvCurrent),
247 items[i].name, resources[rindex]);
252 /* During pass 2, we looked up pointers to all the resources
253 * referrenced in the current resource, , now we
254 * must copy their address from the static record to the allocated
259 /* Resources not containing a resource */
265 Emsg1(M_ERROR, 0, wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
269 /* Note, the resoure name was already saved during pass 1,
270 * so here, we can just release it.
272 if (res_all.res_dir.hdr.name) {
273 free(res_all.res_dir.hdr.name);
274 res_all.res_dir.hdr.name = NULL;
276 if (res_all.res_dir.hdr.desc) {
277 free(res_all.res_dir.hdr.desc);
278 res_all.res_dir.hdr.desc = NULL;
283 /* The following code is only executed during pass 1 */
286 size = sizeof(CONRES);
289 size = sizeof(DIRRES);
292 printf(wxString(_("Unknown resource type %d\n")).mb_str(*wxConvCurrent), type);
299 res = (URES *)malloc(size);
300 memcpy(res, &res_all, size);
301 if (!res_head[rindex]) {
302 res_head[rindex] = (RES *)res; /* store first entry */
305 for (next=res_head[rindex]; next->next; next=next->next) {
306 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
307 Emsg2(M_ERROR_TERM, 0,
308 wxString(_("Attempt to define second %s resource named \"%s\" is not permitted.\n")).mb_str(*wxConvCurrent),
309 resources[rindex].name, res->res_dir.hdr.name);
312 next->next = (RES *)res;
313 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
314 res->res_dir.hdr.name);