2 * Main configuration file parser for Bacula Directors,
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
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,
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 pthread_mutex_t res_mutex = PTHREAD_MUTEX_INITIALIZER;
55 /* Imported subroutines */
56 extern void store_run(LEX *lc, struct res_items *item, int index, int pass);
59 /* Forward referenced subroutines */
61 static void store_inc(LEX *lc, struct res_items *item, int index, int pass);
62 static void store_backup(LEX *lc, struct res_items *item, int index, int pass);
63 static void store_restore(LEX *lc, struct res_items *item, int index, int pass);
64 static void store_jobtype(LEX *lc, struct res_items *item, int index, int pass);
65 static void store_level(LEX *lc, struct res_items *item, int index, int pass);
66 static void store_replace(LEX *lc, struct res_items *item, int index, int pass);
69 /* We build the current resource here as we are
70 * scanning the resource configuration definition,
71 * then move it to allocated memory when the resource
75 int res_all_size = sizeof(res_all);
78 /* Definition of records permitted within each
79 * resource with the routine to process the record
80 * information. NOTE! quoted names must be in lower case.
85 * name handler value code flags default_value
87 static struct res_items dir_items[] = {
88 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
89 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
90 {"messages", store_res, ITEM(res_dir.messages), R_MSGS, 0, 0},
91 {"dirport", store_pint, ITEM(res_dir.DIRport), 0, ITEM_DEFAULT, 9101},
92 {"diraddress", store_str, ITEM(res_dir.DIRaddr), 0, 0, 0},
93 {"queryfile", store_dir, ITEM(res_dir.query_file), 0, ITEM_REQUIRED, 0},
94 {"workingdirectory", store_dir, ITEM(res_dir.working_directory), 0, ITEM_REQUIRED, 0},
95 {"piddirectory", store_dir, ITEM(res_dir.pid_directory), 0, ITEM_REQUIRED, 0},
96 {"subsysdirectory", store_dir, ITEM(res_dir.subsys_directory), 0, ITEM_REQUIRED, 0},
97 {"maximumconcurrentjobs", store_pint, ITEM(res_dir.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
98 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
99 {"fdconnecttimeout", store_time,ITEM(res_dir.FDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
100 {"sdconnecttimeout", store_time,ITEM(res_dir.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
101 {NULL, NULL, NULL, 0, 0, 0}
105 * Client or File daemon resource
107 * name handler value code flags default_value
110 static struct res_items cli_items[] = {
111 {"name", store_name, ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
112 {"description", store_str, ITEM(res_client.hdr.desc), 0, 0, 0},
113 {"address", store_str, ITEM(res_client.address), 0, ITEM_REQUIRED, 0},
114 {"fdport", store_pint, ITEM(res_client.FDport), 0, ITEM_DEFAULT, 9102},
115 {"password", store_password, ITEM(res_client.password), 0, ITEM_REQUIRED, 0},
116 {"catalog", store_res, ITEM(res_client.catalog), R_CATALOG, 0, 0},
117 {"fileretention", store_time, ITEM(res_client.FileRetention), 0, ITEM_DEFAULT, 60*60*24*60},
118 {"jobretention", store_time, ITEM(res_client.JobRetention), 0, ITEM_DEFAULT, 60*60*24*180},
119 {"autoprune", store_yesno, ITEM(res_client.AutoPrune), 1, ITEM_DEFAULT, 1},
120 {NULL, NULL, NULL, 0, 0, 0}
123 /* Storage daemon resource
125 * name handler value code flags default_value
127 static struct res_items store_items[] = {
128 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
129 {"description", store_str, ITEM(res_store.hdr.desc), 0, 0, 0},
130 {"sdport", store_pint, ITEM(res_store.SDport), 0, ITEM_DEFAULT, 9103},
131 {"sddport", store_pint, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
132 {"address", store_str, ITEM(res_store.address), 0, ITEM_REQUIRED, 0},
133 {"password", store_password, ITEM(res_store.password), 0, ITEM_REQUIRED, 0},
134 {"device", store_strname, ITEM(res_store.dev_name), 0, ITEM_REQUIRED, 0},
135 {"mediatype", store_strname, ITEM(res_store.media_type), 0, ITEM_REQUIRED, 0},
136 {"autochanger", store_yesno, ITEM(res_store.autochanger), 1, ITEM_DEFAULT, 0},
137 {NULL, NULL, NULL, 0, 0, 0}
141 * Catalog Resource Directives
143 * name handler value code flags default_value
145 static struct res_items cat_items[] = {
146 {"name", store_name, ITEM(res_cat.hdr.name), 0, ITEM_REQUIRED, 0},
147 {"description", store_str, ITEM(res_cat.hdr.desc), 0, 0, 0},
148 {"address", store_str, ITEM(res_cat.address), 0, 0, 0},
149 {"dbport", store_pint, ITEM(res_cat.DBport), 0, 0, 0},
150 /* keep this password as store_str for the moment */
151 {"password", store_str, ITEM(res_cat.db_password), 0, 0, 0},
152 {"user", store_str, ITEM(res_cat.db_user), 0, 0, 0},
153 {"dbname", store_str, ITEM(res_cat.db_name), 0, ITEM_REQUIRED, 0},
154 {NULL, NULL, NULL, 0, 0, 0}
158 * Job Resource Directives
160 * name handler value code flags default_value
162 static struct res_items job_items[] = {
163 {"name", store_name, ITEM(res_job.hdr.name), 0, ITEM_REQUIRED, 0},
164 {"description", store_str, ITEM(res_job.hdr.desc), 0, 0, 0},
165 {"backup", store_backup, ITEM(res_job), JT_BACKUP, 0, 0},
166 {"verify", store_backup, ITEM(res_job), JT_VERIFY, 0, 0},
167 {"restore", store_restore, ITEM(res_job), JT_RESTORE, 0, 0},
168 {"schedule", store_res, ITEM(res_job.schedule), R_SCHEDULE, 0, 0},
169 {"type", store_jobtype, ITEM(res_job), 0, 0, 0},
170 {"level", store_level, ITEM(res_job), 0, 0, 0},
171 {"messages", store_res, ITEM(res_job.messages), R_MSGS, 0, 0},
172 {"storage", store_res, ITEM(res_job.storage), R_STORAGE, 0, 0},
173 {"pool", store_res, ITEM(res_job.pool), R_POOL, 0, 0},
174 {"client", store_res, ITEM(res_job.client), R_CLIENT, 0, 0},
175 {"fileset", store_res, ITEM(res_job.fileset), R_FILESET, 0, 0},
176 {"where", store_dir, ITEM(res_job.RestoreWhere), 0, 0, 0},
177 {"replace", store_replace, ITEM(res_job.replace), REPLACE_ALWAYS, ITEM_DEFAULT, 0},
178 {"bootstrap",store_dir, ITEM(res_job.RestoreBootstrap), 0, 0, 0},
179 {"maxruntime", store_time, ITEM(res_job.MaxRunTime), 0, 0, 0},
180 {"maxstartdelay", store_time,ITEM(res_job.MaxStartDelay), 0, 0, 0},
181 {"prunejobs", store_yesno, ITEM(res_job.PruneJobs), 1, ITEM_DEFAULT, 0},
182 {"prunefiles", store_yesno, ITEM(res_job.PruneFiles), 1, ITEM_DEFAULT, 0},
183 {"prunevolumes", store_yesno, ITEM(res_job.PruneVolumes), 1, ITEM_DEFAULT, 0},
184 {"runbeforejob", store_str, ITEM(res_job.RunBeforeJob), 0, 0, 0},
185 {"runafterjob", store_str, ITEM(res_job.RunAfterJob), 0, 0, 0},
186 {"spoolattributes", store_yesno, ITEM(res_job.SpoolAttributes), 1, ITEM_DEFAULT, 0},
187 {"writebootstrap", store_dir, ITEM(res_job.WriteBootstrap), 0, 0, 0},
188 {NULL, NULL, NULL, 0, 0, 0}
193 * name handler value code flags default_value
195 static struct res_items fs_items[] = {
196 {"name", store_name, ITEM(res_fs.hdr.name), 0, ITEM_REQUIRED, 0},
197 {"description", store_str, ITEM(res_fs.hdr.desc), 0, 0, 0},
198 {"include", store_inc, NULL, 0, 0, 0},
199 {"exclude", store_inc, NULL, 1, 0, 0},
200 {NULL, NULL, NULL, 0, 0, 0}
203 /* Schedule -- see run_conf.c */
206 * name handler value code flags default_value
208 static struct res_items sch_items[] = {
209 {"name", store_name, ITEM(res_sch.hdr.name), 0, ITEM_REQUIRED, 0},
210 {"description", store_str, ITEM(res_sch.hdr.desc), 0, 0, 0},
211 {"run", store_run, ITEM(res_sch.run), 0, 0, 0},
212 {NULL, NULL, NULL, 0, 0, 0}
215 /* Group resource -- not implemented
217 * name handler value code flags default_value
219 static struct res_items group_items[] = {
220 {"name", store_name, ITEM(res_group.hdr.name), 0, ITEM_REQUIRED, 0},
221 {"description", store_str, ITEM(res_group.hdr.desc), 0, 0, 0},
222 {NULL, NULL, NULL, 0, 0, 0}
227 * name handler value code flags default_value
229 static struct res_items pool_items[] = {
230 {"name", store_name, ITEM(res_pool.hdr.name), 0, ITEM_REQUIRED, 0},
231 {"description", store_str, ITEM(res_pool.hdr.desc), 0, 0, 0},
232 {"pooltype", store_strname, ITEM(res_pool.pool_type), 0, ITEM_REQUIRED, 0},
233 {"labelformat", store_strname, ITEM(res_pool.label_format), 0, 0, 0},
234 {"usecatalog", store_yesno, ITEM(res_pool.use_catalog), 1, ITEM_DEFAULT, 1},
235 {"usevolumeonce", store_yesno, ITEM(res_pool.use_volume_once), 1, 0, 0},
236 {"maximumvolumes", store_pint, ITEM(res_pool.max_volumes), 0, 0, 0},
237 {"maximumvolumejobs", store_pint, ITEM(res_pool.MaxVolumeJobs), 0, 0, 0},
238 {"acceptanyvolume", store_yesno, ITEM(res_pool.accept_any_volume), 1, ITEM_DEFAULT, 1},
239 {"catalogfiles", store_yesno, ITEM(res_pool.catalog_files), 1, ITEM_DEFAULT, 1},
240 {"volumeretention", store_time, ITEM(res_pool.VolRetention), 0, ITEM_DEFAULT, 60*60*24*365},
241 {"volumeuseduration", store_time, ITEM(res_pool.VolUseDuration), 0, 0, 0},
242 {"autoprune", store_yesno, ITEM(res_pool.AutoPrune), 1, ITEM_DEFAULT, 1},
243 {"recycle", store_yesno, ITEM(res_pool.Recycle), 1, ITEM_DEFAULT, 1},
244 {NULL, NULL, NULL, 0, 0, 0}
249 * name handler value code flags default_value
251 static struct res_items counter_items[] = {
252 {"name", store_name, ITEM(res_counter.hdr.name), 0, ITEM_REQUIRED, 0},
253 {"description", store_str, ITEM(res_counter.hdr.desc), 0, 0, 0},
254 {"minimum", store_int, ITEM(res_counter.MinValue), 0, ITEM_DEFAULT, 0},
255 {"maximum", store_pint, ITEM(res_counter.MaxValue), 0, ITEM_DEFAULT, INT32_MAX},
256 {"global", store_yesno, ITEM(res_counter.Global), 0, ITEM_DEFAULT, 0},
257 {"wrapcounter", store_strname, ITEM(res_counter.WrapCounter), 0, 0, 0},
258 {NULL, NULL, NULL, 0, 0, 0}
262 /* Message resource */
263 extern struct res_items msgs_items[];
266 * This is the master resource definition.
267 * It must have one item for each of the resources.
269 * name items rcode res_head
271 struct s_res resources[] = {
272 {"director", dir_items, R_DIRECTOR, NULL},
273 {"client", cli_items, R_CLIENT, NULL},
274 {"job", job_items, R_JOB, NULL},
275 {"storage", store_items, R_STORAGE, NULL},
276 {"catalog", cat_items, R_CATALOG, NULL},
277 {"schedule", sch_items, R_SCHEDULE, NULL},
278 {"fileset", fs_items, R_FILESET, NULL},
279 {"group", group_items, R_GROUP, NULL},
280 {"pool", pool_items, R_POOL, NULL},
281 {"messages", msgs_items, R_MSGS, NULL},
282 {"counter", counter_items, R_COUNTER, NULL},
283 {NULL, NULL, 0, NULL}
287 /* Keywords (RHS) permitted in Job Level records
289 * level_name level job_type
291 struct s_jl joblevels[] = {
292 {"Full", L_FULL, JT_BACKUP},
293 {"Incremental", L_INCREMENTAL, JT_BACKUP},
294 {"Differential", L_DIFFERENTIAL, JT_BACKUP},
295 {"Level", L_LEVEL, JT_BACKUP},
296 {"Since", L_SINCE, JT_BACKUP},
297 {"Catalog", L_VERIFY_CATALOG, JT_VERIFY},
298 {"Initcatalog", L_VERIFY_INIT, JT_VERIFY},
299 {"VolumeToCatalog", L_VERIFY_VOLUME_TO_CATALOG, JT_VERIFY},
300 {"Data", L_VERIFY_DATA, JT_VERIFY},
304 /* Keywords (RHS) permitted in Job type records
308 struct s_jt jobtypes[] = {
309 {"backup", JT_BACKUP},
311 {"verify", JT_VERIFY},
312 {"restore", JT_RESTORE},
317 /* Keywords (RHS) permitted in Backup and Verify records */
318 static struct s_kw BakVerFields[] = {
325 /* Keywords (RHS) permitted in Restore records */
326 static struct s_kw RestoreFields[] = {
329 {"jobid", 'J'}, /* JobId to restore */
330 {"where", 'W'}, /* root of restore */
331 {"replace", 'R'}, /* replacement options */
332 {"bootstrap", 'B'}, /* bootstrap file */
336 /* Options permitted in Restore replace= */
337 struct s_kw ReplaceOptions[] = {
338 {"always", REPLACE_ALWAYS},
339 {"ifnewer", REPLACE_IFNEWER},
340 {"ifolder", REPLACE_IFOLDER},
341 {"never", REPLACE_NEVER},
347 /* Define FileSet KeyWord values */
349 #define INC_KW_NONE 0
350 #define INC_KW_COMPRESSION 1
351 #define INC_KW_SIGNATURE 2
352 #define INC_KW_ENCRYPTION 3
353 #define INC_KW_VERIFY 4
354 #define INC_KW_ONEFS 5
355 #define INC_KW_RECURSE 6
356 #define INC_KW_SPARSE 7
357 #define INC_KW_REPLACE 8 /* restore options */
359 /* Include keywords */
360 static struct s_kw FS_option_kw[] = {
361 {"compression", INC_KW_COMPRESSION},
362 {"signature", INC_KW_SIGNATURE},
363 {"encryption", INC_KW_ENCRYPTION},
364 {"verify", INC_KW_VERIFY},
365 {"onefs", INC_KW_ONEFS},
366 {"recurse", INC_KW_RECURSE},
367 {"sparse", INC_KW_SPARSE},
368 {"replace", INC_KW_REPLACE},
372 /* Options for FileSet keywords */
380 /* Options permitted for each keyword and resulting value */
381 static struct s_fs_opt FS_options[] = {
382 {"md5", INC_KW_SIGNATURE, "M"},
383 {"gzip", INC_KW_COMPRESSION, "Z6"},
384 {"gzip1", INC_KW_COMPRESSION, "Z1"},
385 {"gzip2", INC_KW_COMPRESSION, "Z2"},
386 {"gzip3", INC_KW_COMPRESSION, "Z3"},
387 {"gzip4", INC_KW_COMPRESSION, "Z4"},
388 {"gzip5", INC_KW_COMPRESSION, "Z5"},
389 {"gzip6", INC_KW_COMPRESSION, "Z6"},
390 {"gzip7", INC_KW_COMPRESSION, "Z7"},
391 {"gzip8", INC_KW_COMPRESSION, "Z8"},
392 {"gzip9", INC_KW_COMPRESSION, "Z9"},
393 {"blowfish", INC_KW_ENCRYPTION, "B"}, /* ***FIXME*** not implemented */
394 {"3des", INC_KW_ENCRYPTION, "3"}, /* ***FIXME*** not implemented */
395 {"yes", INC_KW_ONEFS, "0"},
396 {"no", INC_KW_ONEFS, "f"},
397 {"yes", INC_KW_RECURSE, "0"},
398 {"no", INC_KW_RECURSE, "h"},
399 {"yes", INC_KW_SPARSE, "s"},
400 {"no", INC_KW_SPARSE, "0"},
401 {"always", INC_KW_REPLACE, "a"},
402 {"ifnewer", INC_KW_REPLACE, "w"},
403 {"never", INC_KW_REPLACE, "n"},
407 char *level_to_str(int level)
410 static char level_no[30];
411 char *str = level_no;
413 sprintf(level_no, "%d", level); /* default if not found */
414 for (i=0; joblevels[i].level_name; i++) {
415 if (level == joblevels[i].level) {
416 str = joblevels[i].level_name;
425 /* Dump contents of resource */
426 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
429 URES *res = (URES *)reshdr;
433 sendit(sock, "No %s resource defined\n", res_to_str(type));
436 if (type < 0) { /* no recursion */
442 char ed1[30], ed2[30];
443 sendit(sock, "Director: name=%s maxjobs=%d FDtimeout=%s SDtimeout=%s\n",
444 reshdr->name, res->res_dir.MaxConcurrentJobs,
445 edit_uint64(res->res_dir.FDConnectTimeout, ed1),
446 edit_uint64(res->res_dir.SDConnectTimeout, ed2));
447 if (res->res_dir.query_file) {
448 sendit(sock, " query_file=%s\n", res->res_dir.query_file);
450 if (res->res_dir.messages) {
451 sendit(sock, " --> ");
452 dump_resource(-R_MSGS, (RES *)res->res_dir.messages, sendit, sock);
456 sendit(sock, "Client: name=%s address=%s FDport=%d\n",
457 res->res_client.hdr.name, res->res_client.address, res->res_client.FDport);
458 sendit(sock, "JobRetention=%" lld " FileRetention=%" lld " AutoPrune=%d\n",
459 res->res_client.JobRetention, res->res_client.FileRetention,
460 res->res_client.AutoPrune);
461 if (res->res_client.catalog) {
462 sendit(sock, " --> ");
463 dump_resource(-R_CATALOG, (RES *)res->res_client.catalog, sendit, sock);
467 sendit(sock, "Storage: name=%s address=%s SDport=%d\n\
468 DeviceName=%s MediaType=%s\n",
469 res->res_store.hdr.name, res->res_store.address, res->res_store.SDport,
470 res->res_store.dev_name, res->res_store.media_type);
473 sendit(sock, "Catalog: name=%s address=%s DBport=%d db_name=%s\n\
475 res->res_cat.hdr.name, NPRT(res->res_cat.address),
476 res->res_cat.DBport, res->res_cat.db_name, NPRT(res->res_cat.db_user));
479 sendit(sock, "Job: name=%s JobType=%d level=%s\n", res->res_job.hdr.name,
480 res->res_job.JobType, level_to_str(res->res_job.level));
481 if (res->res_job.client) {
482 sendit(sock, " --> ");
483 dump_resource(-R_CLIENT, (RES *)res->res_job.client, sendit, sock);
485 if (res->res_job.fileset) {
486 sendit(sock, " --> ");
487 dump_resource(-R_FILESET, (RES *)res->res_job.fileset, sendit, sock);
489 if (res->res_job.schedule) {
490 sendit(sock, " --> ");
491 dump_resource(-R_SCHEDULE, (RES *)res->res_job.schedule, sendit, sock);
493 if (res->res_job.RestoreWhere) {
494 sendit(sock, " --> Where=%s\n", NPRT(res->res_job.RestoreWhere));
496 if (res->res_job.RestoreBootstrap) {
497 sendit(sock, " --> Bootstrap=%s\n", NPRT(res->res_job.RestoreBootstrap));
499 if (res->res_job.RunBeforeJob) {
500 sendit(sock, " --> RunBefore=%s\n", NPRT(res->res_job.RunBeforeJob));
502 if (res->res_job.RunAfterJob) {
503 sendit(sock, " --> RunAfter=%s\n", NPRT(res->res_job.RunAfterJob));
505 if (res->res_job.WriteBootstrap) {
506 sendit(sock, " --> WriteBootstrap=%s\n", NPRT(res->res_job.WriteBootstrap));
508 if (res->res_job.storage) {
509 sendit(sock, " --> ");
510 dump_resource(-R_STORAGE, (RES *)res->res_job.storage, sendit, sock);
512 if (res->res_job.pool) {
513 sendit(sock, " --> ");
514 dump_resource(-R_POOL, (RES *)res->res_job.pool, sendit, sock);
516 sendit(sock, "!!! No Pool resource\n");
518 if (res->res_job.messages) {
519 sendit(sock, " --> ");
520 dump_resource(-R_MSGS, (RES *)res->res_job.messages, sendit, sock);
524 sendit(sock, "FileSet: name=%s\n", res->res_fs.hdr.name);
525 for (i=0; i<res->res_fs.num_includes; i++)
526 sendit(sock, " Inc: %s\n", res->res_fs.include_array[i]);
527 for (i=0; i<res->res_fs.num_excludes; i++)
528 sendit(sock, " Exc: %s\n", res->res_fs.exclude_array[i]);
531 if (res->res_sch.run) {
533 RUN *run = res->res_sch.run;
534 char buf[1000], num[10];
535 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
540 sendit(sock, " --> Run Level=%s\n", level_to_str(run->level));
541 strcpy(buf, " hour=");
542 for (i=0; i<24; i++) {
543 if (bit_is_set(i, run->hour)) {
544 sprintf(num, "%d ", i+1);
550 strcpy(buf, " mday=");
551 for (i=0; i<31; i++) {
552 if (bit_is_set(i, run->mday)) {
553 sprintf(num, "%d ", i+1);
559 strcpy(buf, " month=");
560 for (i=0; i<12; i++) {
561 if (bit_is_set(i, run->month)) {
562 sprintf(num, "%d ", i+1);
568 strcpy(buf, " wday=");
569 for (i=0; i<7; i++) {
570 if (bit_is_set(i, run->wday)) {
571 sprintf(num, "%d ", i+1);
577 sendit(sock, " mins=%d\n", run->minute);
579 sendit(sock, " --> ");
580 dump_resource(-R_POOL, (RES *)run->pool, sendit, sock);
583 sendit(sock, " --> ");
584 dump_resource(-R_STORAGE, (RES *)run->storage, sendit, sock);
587 sendit(sock, " --> ");
588 dump_resource(-R_MSGS, (RES *)run->msgs, sendit, sock);
590 /* If another Run record is chained in, go print it */
596 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
600 sendit(sock, "Group: name=%s\n", res->res_group.hdr.name);
603 sendit(sock, "Pool: name=%s PoolType=%s\n", res->res_pool.hdr.name,
604 res->res_pool.pool_type);
605 sendit(sock, " use_cat=%d use_once=%d acpt_any=%d cat_files=%d\n",
606 res->res_pool.use_catalog, res->res_pool.use_volume_once,
607 res->res_pool.accept_any_volume, res->res_pool.catalog_files);
608 sendit(sock, " max_vols=%d auto_prune=%d VolRetention=%" lld "\n",
609 res->res_pool.max_volumes, res->res_pool.AutoPrune,
610 res->res_pool.VolRetention);
611 sendit(sock, " recycle=%d LabelFormat=%s\n", res->res_pool.Recycle,
612 NPRT(res->res_pool.label_format));
615 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
616 if (res->res_msgs.mail_cmd)
617 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
618 if (res->res_msgs.operator_cmd)
619 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
622 sendit(sock, "Unknown resource type %d\n", type);
625 if (recurse && res->res_dir.hdr.next) {
626 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
631 * Free memory of resource.
632 * NB, we don't need to worry about freeing any references
633 * to other resources as they will be freed when that
634 * resource chain is traversed. Mainly we worry about freeing
635 * allocated strings (names).
637 void free_resource(int type)
642 int rindex = type - r_first;
644 res = (URES *)resources[rindex].res_head;
649 /* common stuff -- free the resource name and description */
650 nres = (RES *)res->res_dir.hdr.next;
651 if (res->res_dir.hdr.name) {
652 free(res->res_dir.hdr.name);
654 if (res->res_dir.hdr.desc) {
655 free(res->res_dir.hdr.desc);
660 if (res->res_dir.working_directory) {
661 free(res->res_dir.working_directory);
663 if (res->res_dir.pid_directory) {
664 free(res->res_dir.pid_directory);
666 if (res->res_dir.subsys_directory) {
667 free(res->res_dir.subsys_directory);
669 if (res->res_dir.password) {
670 free(res->res_dir.password);
672 if (res->res_dir.query_file) {
673 free(res->res_dir.query_file);
675 if (res->res_dir.DIRaddr) {
676 free(res->res_dir.DIRaddr);
680 if (res->res_client.address) {
681 free(res->res_client.address);
683 if (res->res_client.password) {
684 free(res->res_client.password);
688 if (res->res_store.address)
689 free(res->res_store.address);
690 if (res->res_store.password)
691 free(res->res_store.password);
692 if (res->res_store.media_type)
693 free(res->res_store.media_type);
694 if (res->res_store.dev_name)
695 free(res->res_store.dev_name);
698 if (res->res_cat.address)
699 free(res->res_cat.address);
700 if (res->res_cat.db_user)
701 free(res->res_cat.db_user);
702 if (res->res_cat.db_name)
703 free(res->res_cat.db_name);
704 if (res->res_cat.db_password)
705 free(res->res_cat.db_password);
708 if ((num=res->res_fs.num_includes)) {
710 free(res->res_fs.include_array[num]);
711 free(res->res_fs.include_array);
713 if ((num=res->res_fs.num_excludes)) {
715 free(res->res_fs.exclude_array[num]);
716 free(res->res_fs.exclude_array);
720 if (res->res_pool.pool_type) {
721 free(res->res_pool.pool_type);
723 if (res->res_pool.label_format) {
724 free(res->res_pool.label_format);
728 if (res->res_sch.run) {
730 nrun = res->res_sch.run;
739 if (res->res_job.RestoreWhere) {
740 free(res->res_job.RestoreWhere);
742 if (res->res_job.RestoreBootstrap) {
743 free(res->res_job.RestoreBootstrap);
745 if (res->res_job.WriteBootstrap) {
746 free(res->res_job.WriteBootstrap);
748 if (res->res_job.RunBeforeJob) {
749 free(res->res_job.RunBeforeJob);
751 if (res->res_job.RunAfterJob) {
752 free(res->res_job.RunAfterJob);
756 if (res->res_msgs.mail_cmd)
757 free(res->res_msgs.mail_cmd);
758 if (res->res_msgs.operator_cmd)
759 free(res->res_msgs.operator_cmd);
760 free_msgs_res((MSGS *)res); /* free message resource */
766 printf("Unknown resource type %d\n", type);
768 /* Common stuff again -- free the resource, recurse to next one */
772 resources[rindex].res_head = nres;
779 * Save the new resource by chaining it into the head list for
780 * the resource. If this is pass 2, we update any resource
781 * pointers because they may not have been defined until
784 void save_resource(int type, struct res_items *items, int pass)
787 int rindex = type - r_first;
792 * Ensure that all required items are present
794 for (i=0; items[i].name; i++) {
795 if (items[i].flags & ITEM_REQUIRED) {
796 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
797 Emsg2(M_ERROR_TERM, 0, "%s item is required in %s resource, but not found.\n",
798 items[i].name, resources[rindex]);
801 /* If this triggers, take a look at lib/parse_conf.h */
802 if (i >= MAX_RES_ITEMS) {
803 Emsg1(M_ERROR_TERM, 0, "Too many items in %s resource\n", resources[rindex]);
807 /* During pass 2 in each "store" routine, we looked up pointers
808 * to all the resources referrenced in the current resource, now we
809 * must copy their addresses from the static record to the allocated
814 /* Resources not containing a resource */
823 /* Resources containing another resource */
825 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
826 Emsg1(M_ERROR_TERM, 0, "Cannot find Director resource %s\n", res_all.res_dir.hdr.name);
828 res->res_dir.messages = res_all.res_dir.messages;
831 if ((res = (URES *)GetResWithName(R_JOB, res_all.res_dir.hdr.name)) == NULL) {
832 Emsg1(M_ERROR_TERM, 0, "Cannot find Job resource %s\n", res_all.res_dir.hdr.name);
834 res->res_job.messages = res_all.res_job.messages;
835 res->res_job.schedule = res_all.res_job.schedule;
836 res->res_job.client = res_all.res_job.client;
837 res->res_job.fileset = res_all.res_job.fileset;
838 res->res_job.storage = res_all.res_job.storage;
839 res->res_job.pool = res_all.res_job.pool;
840 if (res->res_job.JobType == 0) {
841 Emsg1(M_ERROR_TERM, 0, "Job Type not defined for Job resource %s\n", res_all.res_dir.hdr.name);
843 if (res->res_job.level != 0) {
845 for (i=0; joblevels[i].level_name; i++) {
846 if (joblevels[i].level == res->res_job.level &&
847 joblevels[i].job_type == res->res_job.JobType) {
853 Emsg1(M_ERROR_TERM, 0, "Inappropriate level specified in Job resource %s\n",
854 res_all.res_dir.hdr.name);
859 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_client.hdr.name)) == NULL) {
860 Emsg1(M_ERROR_TERM, 0, "Cannot find Client resource %s\n", res_all.res_client.hdr.name);
862 res->res_client.catalog = res_all.res_client.catalog;
865 /* Schedule is a bit different in that it contains a RUN record
866 * chain which isn't a "named" resource. This chain was linked
867 * in by run_conf.c during pass 2, so here we jam the pointer
868 * into the Schedule resource.
870 if ((res = (URES *)GetResWithName(R_SCHEDULE, res_all.res_client.hdr.name)) == NULL) {
871 Emsg1(M_ERROR_TERM, 0, "Cannot find Schedule resource %s\n", res_all.res_client.hdr.name);
873 res->res_sch.run = res_all.res_sch.run;
876 Emsg1(M_ERROR, 0, "Unknown resource type %d\n", type);
880 /* Note, the resource name was already saved during pass 1,
881 * so here, we can just release it.
883 if (res_all.res_dir.hdr.name) {
884 free(res_all.res_dir.hdr.name);
885 res_all.res_dir.hdr.name = NULL;
887 if (res_all.res_dir.hdr.desc) {
888 free(res_all.res_dir.hdr.desc);
889 res_all.res_dir.hdr.desc = NULL;
894 /* The following code is only executed for pass 1 */
897 size = sizeof(DIRRES);
900 size =sizeof(CLIENT);
903 size = sizeof(STORE);
912 size = sizeof(FILESET);
915 size = sizeof(SCHED);
918 size = sizeof(GROUP);
927 printf("Unknown resource type %d\n", type);
934 res = (URES *)malloc(size);
935 memcpy(res, &res_all, size);
936 if (!resources[rindex].res_head) {
937 resources[rindex].res_head = (RES *)res; /* store first entry */
940 /* Add new res to end of chain */
941 for (next=resources[rindex].res_head; next->next; next=next->next)
943 next->next = (RES *)res;
944 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
945 res->res_dir.hdr.name);
951 * Store JobType (backup, verify, restore)
954 static void store_jobtype(LEX *lc, struct res_items *item, int index, int pass)
958 token = lex_get_token(lc, T_NAME);
959 /* Store the type both pass 1 and pass 2 */
960 for (i=0; jobtypes[i].type_name; i++) {
961 if (strcasecmp(lc->str, jobtypes[i].type_name) == 0) {
962 ((JOB *)(item->value))->JobType = jobtypes[i].job_type;
968 scan_err1(lc, "Expected a Job Type keyword, got: %s", lc->str);
971 set_bit(index, res_all.hdr.item_present);
975 * Store Job Level (Full, Incremental, ...)
978 static void store_level(LEX *lc, struct res_items *item, int index, int pass)
982 token = lex_get_token(lc, T_NAME);
983 /* Store the level pass 2 so that type is defined */
984 for (i=0; joblevels[i].level_name; i++) {
985 if (strcasecmp(lc->str, joblevels[i].level_name) == 0) {
986 ((JOB *)(item->value))->level = joblevels[i].level;
992 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
995 set_bit(index, res_all.hdr.item_present);
998 static void store_replace(LEX *lc, struct res_items *item, int index, int pass)
1001 token = lex_get_token(lc, T_NAME);
1002 /* Scan Replacement options */
1003 for (i=0; ReplaceOptions[i].name; i++) {
1004 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1005 ((JOB *)(item->value))->replace = ReplaceOptions[i].token;
1011 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1014 set_bit(index, res_all.hdr.item_present);
1018 * Store backup/verify info for Job record
1020 * Note, this code is used for both BACKUP and VERIFY jobs
1022 * Backup = Client=<client-name> FileSet=<FileSet-name> Level=<level>
1024 static void store_backup(LEX *lc, struct res_items *item, int index, int pass)
1028 int options = lc->options;
1030 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1033 ((JOB *)(item->value))->JobType = item->code;
1034 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
1037 Dmsg1(150, "store_backup got token=%s\n", lex_tok_to_str(token));
1039 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1040 scan_err1(lc, "Expected a backup/verify keyword, got: %s", lc->str);
1042 Dmsg1(190, "Got keyword: %s\n", lc->str);
1044 for (i=0; BakVerFields[i].name; i++) {
1045 if (strcasecmp(lc->str, BakVerFields[i].name) == 0) {
1047 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
1048 scan_err1(lc, "Expected an equals, got: %s", lc->str);
1050 token = lex_get_token(lc, T_NAME);
1051 Dmsg1(190, "Got value: %s\n", lc->str);
1052 switch (BakVerFields[i].token) {
1054 /* Find Client Resource */
1056 res = GetResWithName(R_CLIENT, lc->str);
1058 scan_err1(lc, "Could not find specified Client Resource: %s",
1061 res_all.res_job.client = (CLIENT *)res;
1065 /* Find FileSet Resource */
1067 res = GetResWithName(R_FILESET, lc->str);
1069 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1072 res_all.res_job.fileset = (FILESET *)res;
1077 for (i=0; joblevels[i].level_name; i++) {
1078 if (joblevels[i].job_type == item->code &&
1079 strcasecmp(lc->str, joblevels[i].level_name) == 0) {
1080 ((JOB *)(item->value))->level = joblevels[i].level;
1086 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
1091 } /* end if strcmp() */
1094 scan_err1(lc, "%s not a valid Backup/verify keyword", lc->str);
1097 lc->options = options; /* reset original options */
1098 set_bit(index, res_all.hdr.item_present);
1102 * Store restore info for Job record
1104 * Restore = JobId=<job-id> Where=<root-directory> Replace=<options> Bootstrap=<file>
1107 static void store_restore(LEX *lc, struct res_items *item, int index, int pass)
1111 int options = lc->options;
1113 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1115 Dmsg0(190, "Enter store_restore()\n");
1117 ((JOB *)(item->value))->JobType = item->code;
1118 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
1121 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1122 scan_err1(lc, "expected a name, got: %s", lc->str);
1125 for (i=0; RestoreFields[i].name; i++) {
1126 Dmsg1(190, "Restore kw=%s\n", lc->str);
1127 if (strcasecmp(lc->str, RestoreFields[i].name) == 0) {
1129 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
1130 scan_err1(lc, "Expected an equals, got: %s", lc->str);
1132 token = lex_get_token(lc, T_ALL);
1133 Dmsg1(190, "Restore value=%s\n", lc->str);
1134 switch (RestoreFields[i].token) {
1137 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1138 scan_err1(lc, "Expected a Restore bootstrap file, got: %s", lc->str);
1141 res_all.res_job.RestoreBootstrap = bstrdup(lc->str);
1145 /* Find Client Resource */
1147 res = GetResWithName(R_CLIENT, lc->str);
1149 scan_err1(lc, "Could not find specified Client Resource: %s",
1152 res_all.res_job.client = (CLIENT *)res;
1156 /* Find FileSet Resource */
1158 res = GetResWithName(R_FILESET, lc->str);
1160 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1163 res_all.res_job.fileset = (FILESET *)res;
1168 if (token != T_NUMBER) {
1169 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1172 res_all.res_job.RestoreJobId = strtol(lc->str, NULL, 0);
1173 Dmsg1(190, "RestorJobId=%d\n", res_all.res_job.RestoreJobId);
1175 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1180 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1181 scan_err1(lc, "Expected a Restore root directory, got: %s", lc->str);
1184 res_all.res_job.RestoreWhere = bstrdup(lc->str);
1188 /* Replacement options */
1189 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1190 scan_err1(lc, "Expected a keyword name, got: %s", lc->str);
1192 /* Fix to scan Replacement options */
1193 for (i=0; ReplaceOptions[i].name; i++) {
1194 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1195 ((JOB *)(item->value))->replace = ReplaceOptions[i].token;
1201 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1206 } /* end if strcmp() */
1209 scan_err1(lc, "%s not a valid Restore keyword", lc->str);
1212 lc->options = options; /* reset original options */
1213 set_bit(index, res_all.hdr.item_present);
1219 * Scan for Include options (keyword=option) is converted into one or
1220 * two characters. Verifyopts=xxxx is Vxxxx:
1222 static void scan_include_options(LEX *lc, int keyword, char *opts, int optlen)
1227 option[0] = 0; /* default option = none */
1228 opts[0] = option[2] = 0; /* terminate options */
1230 token = lex_get_token(lc, T_NAME); /* expect at least one option */
1231 if (keyword == INC_KW_VERIFY) { /* special case */
1232 /* ***FIXME**** ensure these are in permitted set */
1233 bstrncat(opts, "V", optlen); /* indicate Verify */
1234 bstrncat(opts, lc->str, optlen);
1235 bstrncat(opts, ":", optlen); /* terminate it */
1237 for (i=0; FS_options[i].name; i++) {
1238 if (strcasecmp(lc->str, FS_options[i].name) == 0 && FS_options[i].keyword == keyword) {
1239 /* NOTE! maximum 2 letters here or increase option[3] */
1240 option[0] = FS_options[i].option[0];
1241 option[1] = FS_options[i].option[1];
1247 scan_err1(lc, "Expected a FileSet option keyword, got: %s", lc->str);
1249 bstrncat(opts, option, optlen);
1252 /* check if more options are specified */
1253 if (lc->ch != ',') {
1254 break; /* no, get out */
1256 token = lex_get_token(lc, T_ALL); /* yes, eat comma */
1261 /* Store FileSet Include/Exclude info */
1262 static void store_inc(LEX *lc, struct res_items *item, int index, int pass)
1265 int options = lc->options;
1271 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1273 /* Get include options */
1274 strcpy(inc_opts, "0"); /* set no options */
1275 while ((token=lex_get_token(lc, T_ALL)) != T_BOB) {
1276 keyword = INC_KW_NONE;
1277 for (i=0; FS_option_kw[i].name; i++) {
1278 if (strcasecmp(lc->str, FS_option_kw[i].name) == 0) {
1279 keyword = FS_option_kw[i].token;
1283 if (keyword == INC_KW_NONE) {
1284 scan_err1(lc, "Expected a FileSet keyword, got: %s", lc->str);
1286 /* Option keyword should be following by = <option> */
1287 if ((token=lex_get_token(lc, T_ALL)) != T_EQUALS) {
1288 scan_err1(lc, "expected an = following keyword, got: %s", lc->str);
1290 scan_include_options(lc, keyword, inc_opts, sizeof(inc_opts));
1291 if (token == T_BOB) {
1295 strcat(inc_opts, " "); /* add field separator */
1296 inc_opts_len = strlen(inc_opts);
1300 if (!res_all.res_fs.have_MD5) {
1301 MD5Init(&res_all.res_fs.md5c);
1302 res_all.res_fs.have_MD5 = TRUE;
1304 /* Pickup include/exclude names. Note, they are stored as
1306 * where XYZ are the include/exclude options for the FileSet
1307 * a "0 " (zero) indicates no options,
1308 * and fname is the file/directory name given
1310 while ((token = lex_get_token(lc, T_ALL)) != T_EOB) {
1317 case T_UNQUOTED_STRING:
1318 case T_QUOTED_STRING:
1319 fname = (char *) malloc(lc->str_len + inc_opts_len + 1);
1320 strcpy(fname, inc_opts);
1321 strcat(fname, lc->str);
1322 if (res_all.res_fs.have_MD5) {
1323 MD5Update(&res_all.res_fs.md5c, (unsigned char *) fname, inc_opts_len + lc->str_len);
1325 if (item->code == 0) { /* include */
1326 if (res_all.res_fs.num_includes == res_all.res_fs.include_size) {
1327 res_all.res_fs.include_size += 10;
1328 if (res_all.res_fs.include_array == NULL) {
1329 res_all.res_fs.include_array = (char **) malloc(sizeof(char *) * res_all.res_fs.include_size);
1331 res_all.res_fs.include_array = (char **) realloc(res_all.res_fs.include_array,
1332 sizeof(char *) * res_all.res_fs.include_size);
1335 res_all.res_fs.include_array[res_all.res_fs.num_includes++] =
1337 } else { /* exclude */
1338 if (res_all.res_fs.num_excludes == res_all.res_fs.exclude_size) {
1339 res_all.res_fs.exclude_size += 10;
1340 if (res_all.res_fs.exclude_array == NULL) {
1341 res_all.res_fs.exclude_array = (char **) malloc(sizeof(char *) * res_all.res_fs.exclude_size);
1343 res_all.res_fs.exclude_array = (char **) realloc(res_all.res_fs.exclude_array,
1344 sizeof(char *) * res_all.res_fs.exclude_size);
1347 res_all.res_fs.exclude_array[res_all.res_fs.num_excludes++] =
1352 scan_err1(lc, "Expected a filename, got: %s", lc->str);
1355 } else { /* pass 2 */
1356 while (lex_get_token(lc, T_ALL) != T_EOB)
1360 lc->options = options;
1361 set_bit(index, res_all.hdr.item_present);