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 + 1];
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_addresses_port, ITEM(res_client.FDaddrs), 0, ITEM_DEFAULT, 9102},
86 {"fdaddress", store_addresses_address, ITEM(res_client.FDaddrs), 0, ITEM_DEFAULT, 9102},
87 {"fdaddresses", store_addresses, ITEM(res_client.FDaddrs), 0, ITEM_DEFAULT, 9102},
89 {"workingdirectory", store_dir, ITEM(res_client.working_directory), 0, ITEM_REQUIRED, 0},
90 {"piddirectory", store_dir, ITEM(res_client.pid_directory), 0, ITEM_REQUIRED, 0},
91 {"subsysdirectory", store_dir, ITEM(res_client.subsys_directory), 0, 0, 0},
92 {"requiressl", store_yesno, ITEM(res_client.require_ssl), 1, ITEM_DEFAULT, 0},
93 {"maximumconcurrentjobs", store_pint, ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 10},
94 {"messages", store_res, ITEM(res_client.messages), R_MSGS, 0, 0},
95 {"heartbeatinterval", store_time, ITEM(res_client.heartbeat_interval), 0, ITEM_DEFAULT, 0},
96 {"sdconnecttimeout", store_time,ITEM(res_client.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
97 {"maximumnetworkbuffersize", store_pint, ITEM(res_client.max_network_buffer_size), 0, 0, 0},
98 {NULL, NULL, NULL, 0, 0, 0}
101 /* Directors that can use our services */
102 static RES_ITEM dir_items[] = {
103 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
104 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
105 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
106 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
107 {"enablessl", store_yesno, ITEM(res_dir.enable_ssl),1, ITEM_DEFAULT, 0},
108 {"monitor", store_yesno, ITEM(res_dir.monitor), 1, ITEM_DEFAULT, 0},
109 {NULL, NULL, NULL, 0, 0, 0}
112 /* Message resource */
113 extern RES_ITEM msgs_items[];
116 * This is the master resource definition.
117 * It must have one item for each of the resources.
119 RES_TABLE resources[] = {
120 {"director", dir_items, R_DIRECTOR},
121 {"filedaemon", cli_items, R_CLIENT},
122 {"client", cli_items, R_CLIENT}, /* alias for filedaemon */
123 {"messages", msgs_items, R_MSGS},
128 /* Dump contents of resource */
129 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
131 URES *res = (URES *)reshdr;
135 sendit(sock, "No record for %d %s\n", type, res_to_str(type));
138 if (type < 0) { /* no recursion */
144 sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
145 res->res_dir.password);
148 sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
149 get_first_port_host_order(res->res_client.FDaddrs));
152 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
153 if (res->res_msgs.mail_cmd)
154 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
155 if (res->res_msgs.operator_cmd)
156 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
159 sendit(sock, "Unknown resource type %d\n", type);
161 if (recurse && res->res_dir.hdr.next)
162 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
166 * Free memory of resource.
167 * NB, we don't need to worry about freeing any references
168 * to other resources as they will be freed when that
169 * resource chain is traversed. Mainly we worry about freeing
170 * allocated strings (names).
172 void free_resource(RES *sres, int type)
175 URES *res = (URES *)sres;
181 /* common stuff -- free the resource name */
182 nres = (RES *)res->res_dir.hdr.next;
183 if (res->res_dir.hdr.name) {
184 free(res->res_dir.hdr.name);
186 if (res->res_dir.hdr.desc) {
187 free(res->res_dir.hdr.desc);
191 if (res->res_dir.password) {
192 free(res->res_dir.password);
194 if (res->res_dir.address) {
195 free(res->res_dir.address);
199 if (res->res_client.working_directory) {
200 free(res->res_client.working_directory);
202 if (res->res_client.pid_directory) {
203 free(res->res_client.pid_directory);
205 if (res->res_client.subsys_directory) {
206 free(res->res_client.subsys_directory);
208 if (res->res_client.FDaddrs) {
209 free_addresses(res->res_client.FDaddrs);
213 if (res->res_msgs.mail_cmd)
214 free(res->res_msgs.mail_cmd);
215 if (res->res_msgs.operator_cmd)
216 free(res->res_msgs.operator_cmd);
217 free_msgs_res((MSGS *)res); /* free message resource */
221 printf("Unknown resource type %d\n", type);
223 /* Common stuff again -- free the resource, recurse to next one */
228 free_resource(nres, type);
232 /* Save the new resource by chaining it into the head list for
233 * the resource. If this is pass 2, we update any resource
234 * pointers (currently only in the Job resource).
236 void save_resource(int type, RES_ITEM *items, int pass)
239 int rindex = type - r_first;
244 * Ensure that all required items are present
246 for (i=0; items[i].name; i++) {
247 if (items[i].flags & ITEM_REQUIRED) {
248 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
249 Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
250 items[i].name, resources[rindex]);
255 /* During pass 2, we looked up pointers to all the resources
256 * referrenced in the current resource, , now we
257 * must copy their address from the static record to the allocated
262 /* Resources not containing a resource */
267 /* Resources containing another resource */
269 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
270 Emsg1(M_ABORT, 0, "Cannot find Client resource %s\n", res_all.res_dir.hdr.name);
272 res->res_client.messages = res_all.res_client.messages;
275 Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
279 /* Note, the resoure name was already saved during pass 1,
280 * so here, we can just release it.
282 if (res_all.res_dir.hdr.name) {
283 free(res_all.res_dir.hdr.name);
284 res_all.res_dir.hdr.name = NULL;
286 if (res_all.res_dir.hdr.desc) {
287 free(res_all.res_dir.hdr.desc);
288 res_all.res_dir.hdr.desc = NULL;
293 /* The following code is only executed on pass 1 */
296 size = sizeof(DIRRES);
299 size = sizeof(CLIENT);
305 printf(_("Unknown resource type %d\n"), type);
312 res = (URES *)malloc(size);
313 memcpy(res, &res_all, size);
314 if (!res_head[rindex]) {
315 res_head[rindex] = (RES *)res; /* store first entry */
318 /* Add new res to end of chain */
319 for (next=res_head[rindex]; next->next; next=next->next) {
320 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
321 Emsg2(M_ERROR_TERM, 0,
322 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
323 resources[rindex].name, res->res_dir.hdr.name);
326 next->next = (RES *)res;
327 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
328 res->res_dir.hdr.name);