2 * Main configuration file parser for Bacula File Daemon (Client)
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, September MM
25 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
27 This program is free software; you can redistribute it and/or
28 modify it under the terms of the GNU General Public License as
29 published by the Free Software Foundation; either version 2 of
30 the License, or (at your option) any later version.
32 This program is distributed in the hope that it will be useful,
33 but WITHOUT ANY WARRANTY; without even the implied warranty of
34 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
35 General Public License for more details.
37 You should have received a copy of the GNU General Public
38 License along with this program; if not, write to the Free
39 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
48 /* Define the first and last resource ID record
49 * types. Note, these should be unique for each
50 * daemon though not a requirement.
52 int r_first = R_FIRST;
54 static RES *sres_head[R_LAST - R_FIRST];
55 RES **res_head = sres_head;
58 /* Forward referenced subroutines */
61 /* We build the current resource here as we are
62 * scanning the resource configuration definition,
63 * then move it to allocated memory when the resource
66 #if defined(HAVE_WIN32) && !defined(HAVE_CYGWIN)
67 extern "C" { // work around visual compiler mangling variables
69 int res_all_size = sizeof(res_all);
73 int res_all_size = sizeof(res_all);
76 /* Definition of records permitted within each
77 * resource with the routine to process the record
81 /* Client or File daemon "Global" resources */
82 static RES_ITEM cli_items[] = {
83 {"name", store_name, ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
84 {"description", store_str, ITEM(res_client.hdr.desc), 0, 0, 0},
85 {"fdport", store_pint, ITEM(res_client.FDport), 0, ITEM_DEFAULT, 9102},
86 {"fdaddress", store_str, ITEM(res_client.FDaddr), 0, 0, 0},
87 {"workingdirectory", store_dir, ITEM(res_client.working_directory), 0, ITEM_REQUIRED, 0},
88 {"piddirectory", store_dir, ITEM(res_client.pid_directory), 0, ITEM_REQUIRED, 0},
89 {"subsysdirectory", store_dir, ITEM(res_client.subsys_directory), 0, 0, 0},
90 {"requiressl", store_yesno, ITEM(res_client.require_ssl), 1, ITEM_DEFAULT, 0},
91 {"maximumconcurrentjobs", store_pint, ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 10},
92 {"messages", store_res, ITEM(res_client.messages), R_MSGS, 0, 0},
93 {"heartbeatinterval", store_time, ITEM(res_client.heartbeat_interval), 0, ITEM_DEFAULT, 0},
94 {"sdconnecttimeout", store_time,ITEM(res_client.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
95 {"maximumnetworkbuffersize", store_pint, ITEM(res_client.max_network_buffer_size), 0, 0, 0},
96 {NULL, NULL, NULL, 0, 0, 0}
99 /* Directors that can use our services */
100 static RES_ITEM dir_items[] = {
101 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
102 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
103 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
104 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
105 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl),1, ITEM_DEFAULT, 0},
106 {NULL, NULL, NULL, 0, 0, 0}
109 /* Message resource */
110 extern RES_ITEM msgs_items[];
113 * This is the master resource definition.
114 * It must have one item for each of the resources.
116 RES_TABLE resources[] = {
117 {"director", dir_items, R_DIRECTOR, NULL},
118 {"filedaemon", cli_items, R_CLIENT, NULL},
119 {"client", cli_items, R_CLIENT, NULL}, /* alias for filedaemon */
120 {"messages", msgs_items, R_MSGS, NULL},
121 {NULL, NULL, 0, NULL}
125 /* Dump contents of resource */
126 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
128 URES *res = (URES *)reshdr;
132 sendit(sock, "No record for %d %s\n", type, res_to_str(type));
135 if (type < 0) { /* no recursion */
141 sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
142 res->res_dir.password);
145 sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
146 res->res_client.FDport);
149 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
150 if (res->res_msgs.mail_cmd)
151 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
152 if (res->res_msgs.operator_cmd)
153 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
156 sendit(sock, "Unknown resource type %d\n", type);
158 if (recurse && res->res_dir.hdr.next)
159 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
163 * Free memory of resource.
164 * NB, we don't need to worry about freeing any references
165 * to other resources as they will be freed when that
166 * resource chain is traversed. Mainly we worry about freeing
167 * allocated strings (names).
169 void free_resource(RES *sres, int type)
172 URES *res = (URES *)sres;
178 /* common stuff -- free the resource name */
179 nres = (RES *)res->res_dir.hdr.next;
180 if (res->res_dir.hdr.name) {
181 free(res->res_dir.hdr.name);
183 if (res->res_dir.hdr.desc) {
184 free(res->res_dir.hdr.desc);
189 if (res->res_dir.password) {
190 free(res->res_dir.password);
192 if (res->res_dir.address) {
193 free(res->res_dir.address);
197 if (res->res_client.working_directory) {
198 free(res->res_client.working_directory);
200 if (res->res_client.pid_directory) {
201 free(res->res_client.pid_directory);
203 if (res->res_client.subsys_directory) {
204 free(res->res_client.subsys_directory);
206 if (res->res_client.FDaddr) {
207 free(res->res_client.FDaddr);
211 if (res->res_msgs.mail_cmd)
212 free(res->res_msgs.mail_cmd);
213 if (res->res_msgs.operator_cmd)
214 free(res->res_msgs.operator_cmd);
215 free_msgs_res((MSGS *)res); /* free message resource */
219 printf("Unknown resource type %d\n", type);
221 /* 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, _("%s item is required in %s resource, but not found.\n"),
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 */
265 /* Resources containing another resource */
267 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
268 Emsg1(M_ABORT, 0, "Cannot find Client resource %s\n", res_all.res_dir.hdr.name);
270 res->res_client.messages = res_all.res_client.messages;
273 Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
277 /* Note, the resoure name was already saved during pass 1,
278 * so here, we can just release it.
280 if (res_all.res_dir.hdr.name) {
281 free(res_all.res_dir.hdr.name);
282 res_all.res_dir.hdr.name = NULL;
284 if (res_all.res_dir.hdr.desc) {
285 free(res_all.res_dir.hdr.desc);
286 res_all.res_dir.hdr.desc = NULL;
291 /* The following code is only executed on pass 1 */
294 size = sizeof(DIRRES);
297 size = sizeof(CLIENT);
303 printf(_("Unknown resource type %d\n"), type);
310 res = (URES *)malloc(size);
311 memcpy(res, &res_all, size);
312 if (!resources[rindex].res_head) {
313 resources[rindex].res_head = (RES *)res; /* store first entry */
316 /* Add new res to end of chain */
317 for (next=resources[rindex].res_head; next->next; next=next->next) {
318 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
319 Emsg2(M_ERROR_TERM, 0,
320 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
321 resources[rindex].name, res->res_dir.hdr.name);
324 next->next = (RES *)res;
325 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
326 res->res_dir.hdr.name);