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);
68 /* We build the current resource here as we are
69 * scanning the resource configuration definition,
70 * then move it to allocated memory when the resource
74 int res_all_size = sizeof(res_all);
77 /* Definition of records permitted within each
78 * resource with the routine to process the record
79 * information. NOTE! quoted names must be in lower case.
84 * name handler value code flags default_value
86 static struct res_items dir_items[] = {
87 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
88 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
89 {"messages", store_res, ITEM(res_dir.messages), R_MSGS, 0, 0},
90 {"dirport", store_pint, ITEM(res_dir.DIRport), 0, ITEM_REQUIRED, 0},
91 {"queryfile", store_dir, ITEM(res_dir.query_file), 0, 0, 0},
92 {"workingdirectory", store_dir, ITEM(res_dir.working_directory), 0, ITEM_REQUIRED, 0},
93 {"piddirectory", store_dir, ITEM(res_dir.pid_directory), 0, ITEM_REQUIRED, 0},
94 {"subsysdirectory", store_dir, ITEM(res_dir.subsys_directory), 0, ITEM_REQUIRED, 0},
95 {"maximumconcurrentjobs", store_pint, ITEM(res_dir.MaxConcurrentJobs), 0, ITEM_DEFAULT, 1},
96 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
97 {"fdconnecttimeout", store_time,ITEM(res_dir.FDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
98 {"sdconnecttimeout", store_time,ITEM(res_dir.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
99 {NULL, NULL, NULL, 0, 0, 0}
103 * Client or File daemon resource
105 * name handler value code flags default_value
108 static struct res_items cli_items[] = {
109 {"name", store_name, ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
110 {"description", store_str, ITEM(res_client.hdr.desc), 0, 0, 0},
111 {"address", store_str, ITEM(res_client.address), 0, ITEM_REQUIRED, 0},
112 {"fdport", store_pint, ITEM(res_client.FDport), 0, ITEM_REQUIRED, 0},
113 {"password", store_password, ITEM(res_client.password), 0, ITEM_REQUIRED, 0},
114 {"catalog", store_res, ITEM(res_client.catalog), R_CATALOG, 0, 0},
115 {"fileretention", store_time, ITEM(res_client.FileRetention), 0, ITEM_DEFAULT, 60*60*24*60},
116 {"jobretention", store_time, ITEM(res_client.JobRetention), 0, ITEM_DEFAULT, 60*60*24*180},
117 {"autoprune", store_yesno, ITEM(res_client.AutoPrune), 1, ITEM_DEFAULT, 1},
118 {NULL, NULL, NULL, 0, 0, 0}
121 /* Storage daemon resource
123 * name handler value code flags default_value
125 static struct res_items store_items[] = {
126 {"name", store_name, ITEM(res_store.hdr.name), 0, ITEM_REQUIRED, 0},
127 {"description", store_str, ITEM(res_store.hdr.desc), 0, 0, 0},
128 {"sdport", store_pint, ITEM(res_store.SDport), 0, ITEM_REQUIRED, 0},
129 {"sddport", store_pint, ITEM(res_store.SDDport), 0, 0, 0}, /* deprecated */
130 {"address", store_str, ITEM(res_store.address), 0, ITEM_REQUIRED, 0},
131 {"password", store_password, ITEM(res_store.password), 0, ITEM_REQUIRED, 0},
132 {"device", store_strname, ITEM(res_store.dev_name), 0, ITEM_REQUIRED, 0},
133 {"mediatype", store_strname, ITEM(res_store.media_type), 0, ITEM_REQUIRED, 0},
134 {NULL, NULL, NULL, 0, 0, 0}
138 * Catalog Resource Directives
140 * name handler value code flags default_value
142 static struct res_items cat_items[] = {
143 {"name", store_name, ITEM(res_cat.hdr.name), 0, ITEM_REQUIRED, 0},
144 {"description", store_str, ITEM(res_cat.hdr.desc), 0, 0, 0},
145 {"address", store_str, ITEM(res_cat.address), 0, 0, 0},
146 {"dbport", store_pint, ITEM(res_cat.DBport), 0, 0, 0},
147 /* keep this password as store_str for the moment */
148 {"password", store_str, ITEM(res_cat.db_password), 0, 0, 0},
149 {"user", store_str, ITEM(res_cat.db_user), 0, 0, 0},
150 {"dbname", store_str, ITEM(res_cat.db_name), 0, ITEM_REQUIRED, 0},
151 {NULL, NULL, NULL, 0, 0, 0}
155 * Job Resource Directives
157 * name handler value code flags default_value
159 static struct res_items job_items[] = {
160 {"name", store_name, ITEM(res_job.hdr.name), 0, ITEM_REQUIRED, 0},
161 {"description", store_str, ITEM(res_job.hdr.desc), 0, 0, 0},
162 {"backup", store_backup, ITEM(res_job), JT_BACKUP, 0, 0},
163 {"verify", store_backup, ITEM(res_job), JT_VERIFY, 0, 0},
164 {"restore", store_restore, ITEM(res_job), JT_RESTORE, 0, 0},
165 {"schedule", store_res, ITEM(res_job.schedule), R_SCHEDULE, 0, 0},
166 {"type", store_jobtype, ITEM(res_job), 0, 0, 0},
167 {"level", store_level, ITEM(res_job), 0, 0, 0},
168 {"messages", store_res, ITEM(res_job.messages), R_MSGS, 0, 0},
169 {"storage", store_res, ITEM(res_job.storage), R_STORAGE, 0, 0},
170 {"pool", store_res, ITEM(res_job.pool), R_POOL, 0, 0},
171 {"client", store_res, ITEM(res_job.client), R_CLIENT, 0, 0},
172 {"fileset", store_res, ITEM(res_job.fs), R_FILESET, 0, 0},
173 {"where", store_dir, ITEM(res_job.RestoreWhere), 0, 0, 0},
174 {"bootstrap",store_dir, ITEM(res_job.RestoreBootstrap), 0, 0, 0},
175 {"maxruntime", store_time, ITEM(res_job.MaxRunTime), 0, 0, 0},
176 {"maxstartdelay", store_time,ITEM(res_job.MaxStartDelay), 0, 0, 0},
177 {"prunejobs", store_yesno, ITEM(res_job.PruneJobs), 1, ITEM_DEFAULT, 0},
178 {"prunefiles", store_yesno, ITEM(res_job.PruneFiles), 1, ITEM_DEFAULT, 0},
179 {"prunevolumes", store_yesno, ITEM(res_job.PruneVolumes), 1, ITEM_DEFAULT, 0},
180 {"runbeforejob", store_str, ITEM(res_job.RunBeforeJob), 0, 0, 0},
181 {"runafterjob", store_str, ITEM(res_job.RunAfterJob), 0, 0, 0},
182 {NULL, NULL, NULL, 0, 0, 0}
187 * name handler value code flags default_value
189 static struct res_items fs_items[] = {
190 {"name", store_name, ITEM(res_fs.hdr.name), 0, ITEM_REQUIRED, 0},
191 {"description", store_str, ITEM(res_fs.hdr.desc), 0, 0, 0},
192 {"include", store_inc, NULL, 0, 0, 0},
193 {"exclude", store_inc, NULL, 1, 0, 0},
194 {NULL, NULL, NULL, 0, 0, 0}
197 /* Schedule -- see run_conf.c */
200 * name handler value code flags default_value
202 static struct res_items sch_items[] = {
203 {"name", store_name, ITEM(res_sch.hdr.name), 0, ITEM_REQUIRED, 0},
204 {"description", store_str, ITEM(res_sch.hdr.desc), 0, 0, 0},
205 {"run", store_run, ITEM(res_sch.run), 0, 0, 0},
206 {NULL, NULL, NULL, 0, 0, 0}
209 /* Group resource -- not implemented
211 * name handler value code flags default_value
213 static struct res_items group_items[] = {
214 {"name", store_name, ITEM(res_group.hdr.name), 0, ITEM_REQUIRED, 0},
215 {"description", store_str, ITEM(res_group.hdr.desc), 0, 0, 0},
216 {NULL, NULL, NULL, 0, 0, 0}
221 * name handler value code flags default_value
223 static struct res_items pool_items[] = {
224 {"name", store_name, ITEM(res_pool.hdr.name), 0, ITEM_REQUIRED, 0},
225 {"description", store_str, ITEM(res_pool.hdr.desc), 0, 0, 0},
226 {"pooltype", store_strname, ITEM(res_pool.pool_type), 0, ITEM_REQUIRED, 0},
227 {"labelformat", store_strname, ITEM(res_pool.label_format), 0, 0, 0},
228 {"usecatalog", store_yesno, ITEM(res_pool.use_catalog), 1, ITEM_DEFAULT, 1},
229 {"usevolumeonce", store_yesno, ITEM(res_pool.use_volume_once), 1, 0, 0},
230 {"maximumvolumes", store_pint, ITEM(res_pool.max_volumes), 0, 0, 0},
231 {"acceptanyvolume", store_yesno, ITEM(res_pool.accept_any_volume), 1, 0, 0},
232 {"catalogfiles", store_yesno, ITEM(res_pool.catalog_files), 1, ITEM_DEFAULT, 1},
233 {"volumeretention", store_time, ITEM(res_pool.VolRetention), 0, ITEM_DEFAULT, 60*60*24*365},
234 {"autoprune", store_yesno, ITEM(res_pool.AutoPrune), 1, ITEM_DEFAULT, 1},
235 {"recycle", store_yesno, ITEM(res_pool.Recycle), 1, ITEM_DEFAULT, 1},
236 {NULL, NULL, NULL, 0, 0, 0}
241 * name handler value code flags default_value
243 static struct res_items counter_items[] = {
244 {"name", store_name, ITEM(res_counter.hdr.name), 0, ITEM_REQUIRED, 0},
245 {"description", store_str, ITEM(res_counter.hdr.desc), 0, 0, 0},
246 {"minimum", store_int, ITEM(res_counter.MinValue), 0, ITEM_DEFAULT, 0},
247 {"maximum", store_pint, ITEM(res_counter.MaxValue), 0, ITEM_DEFAULT, INT32_MAX},
248 {"global", store_yesno, ITEM(res_counter.Global), 0, ITEM_DEFAULT, 0},
249 {"wrapcounter", store_strname, ITEM(res_counter.WrapCounter), 0, 0, 0},
250 {NULL, NULL, NULL, 0, 0, 0}
254 /* Message resource */
255 extern struct res_items msgs_items[];
258 * This is the master resource definition.
259 * It must have one item for each of the resources.
261 * name items rcode res_head
263 struct s_res resources[] = {
264 {"director", dir_items, R_DIRECTOR, NULL},
265 {"client", cli_items, R_CLIENT, NULL},
266 {"job", job_items, R_JOB, NULL},
267 {"storage", store_items, R_STORAGE, NULL},
268 {"catalog", cat_items, R_CATALOG, NULL},
269 {"schedule", sch_items, R_SCHEDULE, NULL},
270 {"fileset", fs_items, R_FILESET, NULL},
271 {"group", group_items, R_GROUP, NULL},
272 {"pool", pool_items, R_POOL, NULL},
273 {"messages", msgs_items, R_MSGS, NULL},
274 {"counter", counter_items, R_COUNTER, NULL},
275 {NULL, NULL, 0, NULL}
279 /* Keywords (RHS) permitted in Job Level records
281 * level_name level job_type
283 struct s_jl joblevels[] = {
284 {"Full", L_FULL, JT_BACKUP},
285 {"Incremental", L_INCREMENTAL, JT_BACKUP},
286 {"Differential", L_DIFFERENTIAL, JT_BACKUP},
287 {"Level", L_LEVEL, JT_BACKUP},
288 {"Since", L_SINCE, JT_BACKUP},
289 {"Catalog", L_VERIFY_CATALOG, JT_VERIFY},
290 {"Initcatalog", L_VERIFY_INIT, JT_VERIFY},
291 {"VolumeToCatalog", L_VERIFY_VOLUME_TO_CATALOG, JT_VERIFY},
292 {"Data", L_VERIFY_DATA, JT_VERIFY},
296 /* Keywords (RHS) permitted in Job type records
300 struct s_jt jobtypes[] = {
301 {"backup", JT_BACKUP},
303 {"verify", JT_VERIFY},
304 {"restore", JT_RESTORE},
309 /* Keywords (RHS) permitted in Backup and Verify records */
310 static struct s_kw BakVerFields[] = {
317 /* Keywords (RHS) permitted in Restore records */
318 static struct s_kw RestoreFields[] = {
321 {"jobid", 'J'}, /* JobId to restore */
322 {"where", 'W'}, /* root of restore */
323 {"replace", 'R'}, /* replacement options */
324 {"bootstrap", 'B'}, /* bootstrap file */
328 /* Options permitted in Restore replace= */
329 static struct s_kw ReplaceOptions[] = {
330 {"always", 'A'}, /* always */
338 /* Define FileSet KeyWord values */
341 #define FS_KW_COMPRESSION 1
342 #define FS_KW_SIGNATURE 2
343 #define FS_KW_ENCRYPTION 3
344 #define FS_KW_VERIFY 4
345 #define FS_KW_ONEFS 5
346 #define FS_KW_RECURSE 6
348 /* FileSet keywords */
349 static struct s_kw FS_option_kw[] = {
350 {"compression", FS_KW_COMPRESSION},
351 {"signature", FS_KW_SIGNATURE},
352 {"encryption", FS_KW_ENCRYPTION},
353 {"verify", FS_KW_VERIFY},
354 {"onefs", FS_KW_ONEFS},
355 {"recurse", FS_KW_RECURSE},
359 /* Options for FileSet keywords */
367 /* Options permitted for each keyword and resulting value */
368 static struct s_fs_opt FS_options[] = {
369 {"md5", FS_KW_SIGNATURE, "M"},
370 {"gzip", FS_KW_COMPRESSION, "Z6"},
371 {"gzip1", FS_KW_COMPRESSION, "Z1"},
372 {"gzip2", FS_KW_COMPRESSION, "Z2"},
373 {"gzip3", FS_KW_COMPRESSION, "Z3"},
374 {"gzip4", FS_KW_COMPRESSION, "Z4"},
375 {"gzip5", FS_KW_COMPRESSION, "Z5"},
376 {"gzip6", FS_KW_COMPRESSION, "Z6"},
377 {"gzip7", FS_KW_COMPRESSION, "Z7"},
378 {"gzip8", FS_KW_COMPRESSION, "Z8"},
379 {"gzip9", FS_KW_COMPRESSION, "Z9"},
380 {"blowfish", FS_KW_ENCRYPTION, "B"}, /* ***FIXME*** not implemented */
381 {"3des", FS_KW_ENCRYPTION, "3"}, /* ***FIXME*** not implemented */
382 {"yes", FS_KW_ONEFS, "0"},
383 {"no", FS_KW_ONEFS, "f"},
384 {"yes", FS_KW_RECURSE, "0"},
385 {"no", FS_KW_RECURSE, "h"},
389 char *level_to_str(int level)
392 static char level_no[30];
393 char *str = level_no;
395 sprintf(level_no, "%d", level); /* default if not found */
396 for (i=0; joblevels[i].level_name; i++) {
397 if (level == joblevels[i].level) {
398 str = joblevels[i].level_name;
407 /* Dump contents of resource */
408 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
411 URES *res = (URES *)reshdr;
415 sendit(sock, "No %s resource defined\n", res_to_str(type));
418 if (type < 0) { /* no recursion */
424 char ed1[30], ed2[30];
425 sendit(sock, "Director: name=%s maxjobs=%d FDtimeout=%s SDtimeout=%s\n",
426 reshdr->name, res->res_dir.MaxConcurrentJobs,
427 edit_uint64(res->res_dir.FDConnectTimeout, ed1),
428 edit_uint64(res->res_dir.SDConnectTimeout, ed2));
429 if (res->res_dir.query_file) {
430 sendit(sock, " query_file=%s\n", res->res_dir.query_file);
432 if (res->res_dir.messages) {
433 sendit(sock, " --> ");
434 dump_resource(-R_MSGS, (RES *)res->res_dir.messages, sendit, sock);
438 sendit(sock, "Client: name=%s address=%s FDport=%d\n",
439 res->res_client.hdr.name, res->res_client.address, res->res_client.FDport);
440 sendit(sock, "JobRetention=%" lld " FileRetention=%" lld " AutoPrune=%d\n",
441 res->res_client.JobRetention, res->res_client.FileRetention,
442 res->res_client.AutoPrune);
443 if (res->res_client.catalog) {
444 sendit(sock, " --> ");
445 dump_resource(-R_CATALOG, (RES *)res->res_client.catalog, sendit, sock);
449 sendit(sock, "Storage: name=%s address=%s SDport=%d\n\
450 DeviceName=%s MediaType=%s\n",
451 res->res_store.hdr.name, res->res_store.address, res->res_store.SDport,
452 res->res_store.dev_name, res->res_store.media_type);
455 sendit(sock, "Catalog: name=%s address=%s DBport=%d db_name=%s\n\
457 res->res_cat.hdr.name, NPRT(res->res_cat.address),
458 res->res_cat.DBport, res->res_cat.db_name, NPRT(res->res_cat.db_user));
461 sendit(sock, "Job: name=%s JobType=%d level=%s\n", res->res_job.hdr.name,
462 res->res_job.JobType, level_to_str(res->res_job.level));
463 if (res->res_job.client) {
464 sendit(sock, " --> ");
465 dump_resource(-R_CLIENT, (RES *)res->res_job.client, sendit, sock);
467 if (res->res_job.fs) {
468 sendit(sock, " --> ");
469 dump_resource(-R_FILESET, (RES *)res->res_job.fs, sendit, sock);
471 if (res->res_job.schedule) {
472 sendit(sock, " --> ");
473 dump_resource(-R_SCHEDULE, (RES *)res->res_job.schedule, sendit, sock);
475 if (res->res_job.RestoreWhere) {
476 sendit(sock, " --> Where=%s\n", NPRT(res->res_job.RestoreWhere));
478 if (res->res_job.RestoreBootstrap) {
479 sendit(sock, " --> Bootstrap=%s\n", NPRT(res->res_job.RestoreBootstrap));
481 if (res->res_job.RunBeforeJob) {
482 sendit(sock, " --> RunBefore=%s\n", NPRT(res->res_job.RunBeforeJob));
484 if (res->res_job.RunAfterJob) {
485 sendit(sock, " --> RunAfter=%s\n", NPRT(res->res_job.RunAfterJob));
487 if (res->res_job.storage) {
488 sendit(sock, " --> ");
489 dump_resource(-R_STORAGE, (RES *)res->res_job.storage, sendit, sock);
491 if (res->res_job.pool) {
492 sendit(sock, " --> ");
493 dump_resource(-R_POOL, (RES *)res->res_job.pool, sendit, sock);
495 sendit(sock, "!!! No Pool resource\n");
497 if (res->res_job.messages) {
498 sendit(sock, " --> ");
499 dump_resource(-R_MSGS, (RES *)res->res_job.messages, sendit, sock);
503 sendit(sock, "FileSet: name=%s\n", res->res_fs.hdr.name);
504 for (i=0; i<res->res_fs.num_includes; i++)
505 sendit(sock, " Inc: %s\n", res->res_fs.include_array[i]);
506 for (i=0; i<res->res_fs.num_excludes; i++)
507 sendit(sock, " Exc: %s\n", res->res_fs.exclude_array[i]);
510 if (res->res_sch.run) {
512 RUN *run = res->res_sch.run;
513 char buf[1000], num[10];
514 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
519 sendit(sock, " --> Run Level=%s\n", level_to_str(run->level));
520 strcpy(buf, " hour=");
521 for (i=0; i<24; i++) {
522 if (bit_is_set(i, run->hour)) {
523 sprintf(num, "%d ", i+1);
529 strcpy(buf, " mday=");
530 for (i=0; i<31; i++) {
531 if (bit_is_set(i, run->mday)) {
532 sprintf(num, "%d ", i+1);
538 strcpy(buf, " month=");
539 for (i=0; i<12; i++) {
540 if (bit_is_set(i, run->month)) {
541 sprintf(num, "%d ", i+1);
547 strcpy(buf, " wday=");
548 for (i=0; i<7; i++) {
549 if (bit_is_set(i, run->wday)) {
550 sprintf(num, "%d ", i+1);
556 sendit(sock, " mins=%d\n", run->minute);
558 sendit(sock, " --> ");
559 dump_resource(-R_POOL, (RES *)run->pool, sendit, sock);
562 sendit(sock, " --> ");
563 dump_resource(-R_STORAGE, (RES *)run->storage, sendit, sock);
566 sendit(sock, " --> ");
567 dump_resource(-R_MSGS, (RES *)run->msgs, sendit, sock);
569 /* If another Run record is chained in, go print it */
575 sendit(sock, "Schedule: name=%s\n", res->res_sch.hdr.name);
579 sendit(sock, "Group: name=%s\n", res->res_group.hdr.name);
582 sendit(sock, "Pool: name=%s PoolType=%s\n", res->res_pool.hdr.name,
583 res->res_pool.pool_type);
584 sendit(sock, " use_cat=%d use_once=%d acpt_any=%d cat_files=%d\n",
585 res->res_pool.use_catalog, res->res_pool.use_volume_once,
586 res->res_pool.accept_any_volume, res->res_pool.catalog_files);
587 sendit(sock, " max_vols=%d auto_prune=%d VolRetention=%" lld "\n",
588 res->res_pool.max_volumes, res->res_pool.AutoPrune,
589 res->res_pool.VolRetention);
590 sendit(sock, " recycle=%d LabelFormat=%s\n", res->res_pool.Recycle,
591 NPRT(res->res_pool.label_format));
594 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
595 if (res->res_msgs.mail_cmd)
596 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
597 if (res->res_msgs.operator_cmd)
598 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
601 sendit(sock, "Unknown resource type %d\n", type);
604 if (recurse && res->res_dir.hdr.next) {
605 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
610 * Free memory of resource.
611 * NB, we don't need to worry about freeing any references
612 * to other resources as they will be freed when that
613 * resource chain is traversed. Mainly we worry about freeing
614 * allocated strings (names).
616 void free_resource(int type)
621 int rindex = type - r_first;
623 res = (URES *)resources[rindex].res_head;
628 /* common stuff -- free the resource name and description */
629 nres = (RES *)res->res_dir.hdr.next;
630 if (res->res_dir.hdr.name) {
631 free(res->res_dir.hdr.name);
633 if (res->res_dir.hdr.desc) {
634 free(res->res_dir.hdr.desc);
639 if (res->res_dir.working_directory)
640 free(res->res_dir.working_directory);
641 if (res->res_dir.pid_directory)
642 free(res->res_dir.pid_directory);
643 if (res->res_dir.subsys_directory)
644 free(res->res_dir.subsys_directory);
645 if (res->res_dir.password)
646 free(res->res_dir.password);
647 if (res->res_dir.query_file)
648 free(res->res_dir.query_file);
651 if (res->res_client.address)
652 free(res->res_client.address);
653 if (res->res_client.password)
654 free(res->res_client.password);
657 if (res->res_store.address)
658 free(res->res_store.address);
659 if (res->res_store.password)
660 free(res->res_store.password);
661 if (res->res_store.media_type)
662 free(res->res_store.media_type);
663 if (res->res_store.dev_name)
664 free(res->res_store.dev_name);
667 if (res->res_cat.address)
668 free(res->res_cat.address);
669 if (res->res_cat.db_user)
670 free(res->res_cat.db_user);
671 if (res->res_cat.db_name)
672 free(res->res_cat.db_name);
673 if (res->res_cat.db_password)
674 free(res->res_cat.db_password);
677 if ((num=res->res_fs.num_includes)) {
679 free(res->res_fs.include_array[num]);
680 free(res->res_fs.include_array);
682 if ((num=res->res_fs.num_excludes)) {
684 free(res->res_fs.exclude_array[num]);
685 free(res->res_fs.exclude_array);
689 if (res->res_pool.pool_type) {
690 free(res->res_pool.pool_type);
692 if (res->res_pool.label_format) {
693 free(res->res_pool.label_format);
697 if (res->res_sch.run) {
699 nrun = res->res_sch.run;
708 if (res->res_job.RestoreWhere) {
709 free(res->res_job.RestoreWhere);
711 if (res->res_job.RestoreBootstrap) {
712 free(res->res_job.RestoreBootstrap);
714 if (res->res_job.RunBeforeJob) {
715 free(res->res_job.RunBeforeJob);
717 if (res->res_job.RunAfterJob) {
718 free(res->res_job.RunAfterJob);
722 if (res->res_msgs.mail_cmd)
723 free(res->res_msgs.mail_cmd);
724 if (res->res_msgs.operator_cmd)
725 free(res->res_msgs.operator_cmd);
726 free_msgs_res((MSGS *)res); /* free message resource */
732 printf("Unknown resource type %d\n", type);
734 /* Common stuff again -- free the resource, recurse to next one */
738 resources[rindex].res_head = nres;
745 * Save the new resource by chaining it into the head list for
746 * the resource. If this is pass 2, we update any resource
747 * pointers because they may not have been defined until
750 void save_resource(int type, struct res_items *items, int pass)
753 int rindex = type - r_first;
758 * Ensure that all required items are present
760 for (i=0; items[i].name; i++) {
761 if (items[i].flags & ITEM_REQUIRED) {
762 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
763 Emsg2(M_ABORT, 0, "%s item is required in %s resource, but not found.\n",
764 items[i].name, resources[rindex]);
767 /* If this triggers, take a look at lib/parse_conf.h */
768 if (i >= MAX_RES_ITEMS) {
769 Emsg1(M_ABORT, 0, "Too many items in %s resource\n", resources[rindex]);
773 /* During pass 2 in each "store" routine, we looked up pointers
774 * to all the resources referrenced in the current resource, now we
775 * must copy their addresses from the static record to the allocated
780 /* Resources not containing a resource */
789 /* Resources containing another resource */
791 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
792 Emsg1(M_ABORT, 0, "Cannot find Director resource %s\n", res_all.res_dir.hdr.name);
794 res->res_dir.messages = res_all.res_dir.messages;
797 if ((res = (URES *)GetResWithName(R_JOB, res_all.res_dir.hdr.name)) == NULL) {
798 Emsg1(M_ABORT, 0, "Cannot find Job resource %s\n", res_all.res_dir.hdr.name);
800 res->res_job.messages = res_all.res_job.messages;
801 res->res_job.schedule = res_all.res_job.schedule;
802 res->res_job.client = res_all.res_job.client;
803 res->res_job.fs = res_all.res_job.fs;
804 res->res_job.storage = res_all.res_job.storage;
805 res->res_job.pool = res_all.res_job.pool;
806 if (res->res_job.JobType == 0) {
807 Emsg1(M_ABORT, 0, "Job Type not defined for Job resource %s\n", res_all.res_dir.hdr.name);
809 if (res->res_job.level != 0) {
811 for (i=0; joblevels[i].level_name; i++) {
812 if (joblevels[i].level == res->res_job.level &&
813 joblevels[i].job_type == res->res_job.JobType) {
819 Emsg1(M_ABORT, 0, "Inappropriate level specified in Job resource %s\n",
820 res_all.res_dir.hdr.name);
825 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_client.hdr.name)) == NULL) {
826 Emsg1(M_ABORT, 0, "Cannot find Client resource %s\n", res_all.res_client.hdr.name);
828 res->res_client.catalog = res_all.res_client.catalog;
831 /* Schedule is a bit different in that it contains a RUN record
832 * chain which isn't a "named" resource. This chain was linked
833 * in by run_conf.c during pass 2, so here we jam the pointer
834 * into the Schedule resource.
836 if ((res = (URES *)GetResWithName(R_SCHEDULE, res_all.res_client.hdr.name)) == NULL) {
837 Emsg1(M_ABORT, 0, "Cannot find Schedule resource %s\n", res_all.res_client.hdr.name);
839 res->res_sch.run = res_all.res_sch.run;
842 Emsg1(M_ERROR, 0, "Unknown resource type %d\n", type);
846 /* Note, the resource name was already saved during pass 1,
847 * so here, we can just release it.
849 if (res_all.res_dir.hdr.name) {
850 free(res_all.res_dir.hdr.name);
851 res_all.res_dir.hdr.name = NULL;
853 if (res_all.res_dir.hdr.desc) {
854 free(res_all.res_dir.hdr.desc);
855 res_all.res_dir.hdr.desc = NULL;
860 /* The following code is only executed for pass 1 */
863 size = sizeof(DIRRES);
866 size =sizeof(CLIENT);
869 size = sizeof(STORE);
878 size = sizeof(FILESET);
881 size = sizeof(SCHED);
884 size = sizeof(GROUP);
893 printf("Unknown resource type %d\n", type);
899 res = (URES *)malloc(size);
900 memcpy(res, &res_all, size);
901 if (!resources[rindex].res_head) {
902 resources[rindex].res_head = (RES *)res; /* store first entry */
905 /* Add new res to end of chain */
906 for (next=resources[rindex].res_head; next->next; next=next->next)
908 next->next = (RES *)res;
909 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
910 res->res_dir.hdr.name);
916 * Store JobType (backup, verify, restore)
919 static void store_jobtype(LEX *lc, struct res_items *item, int index, int pass)
923 token = lex_get_token(lc, T_NAME);
924 /* Store the type both pass 1 and pass 2 */
925 for (i=0; jobtypes[i].type_name; i++) {
926 if (strcasecmp(lc->str, jobtypes[i].type_name) == 0) {
927 ((JOB *)(item->value))->JobType = jobtypes[i].job_type;
933 scan_err1(lc, "Expected a Job Type keyword, got: %s", lc->str);
936 set_bit(index, res_all.hdr.item_present);
940 * Store Job Level (Full, Incremental, ...)
943 static void store_level(LEX *lc, struct res_items *item, int index, int pass)
947 token = lex_get_token(lc, T_NAME);
948 /* Store the level pass 2 so that type is defined */
949 for (i=0; joblevels[i].level_name; i++) {
950 if (strcasecmp(lc->str, joblevels[i].level_name) == 0) {
951 ((JOB *)(item->value))->level = joblevels[i].level;
957 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
960 set_bit(index, res_all.hdr.item_present);
966 * Store backup/verify info for Job record
968 * Note, this code is used for both BACKUP and VERIFY jobs
970 * Backup = Client=<client-name> FileSet=<FileSet-name> Level=<level>
972 static void store_backup(LEX *lc, struct res_items *item, int index, int pass)
976 int options = lc->options;
978 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
981 ((JOB *)(item->value))->JobType = item->code;
982 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
985 Dmsg1(150, "store_backup got token=%s\n", lex_tok_to_str(token));
987 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
988 scan_err1(lc, "Expected a backup/verify keyword, got: %s", lc->str);
990 Dmsg1(190, "Got keyword: %s\n", lc->str);
992 for (i=0; BakVerFields[i].name; i++) {
993 if (strcasecmp(lc->str, BakVerFields[i].name) == 0) {
995 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
996 scan_err1(lc, "Expected an equals, got: %s", lc->str);
998 token = lex_get_token(lc, T_NAME);
999 Dmsg1(190, "Got value: %s\n", lc->str);
1000 switch (BakVerFields[i].token) {
1002 /* Find Client Resource */
1004 res = GetResWithName(R_CLIENT, lc->str);
1006 scan_err1(lc, "Could not find specified Client Resource: %s",
1009 res_all.res_job.client = (CLIENT *)res;
1013 /* Find FileSet Resource */
1015 res = GetResWithName(R_FILESET, lc->str);
1017 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1020 res_all.res_job.fs = (FILESET *)res;
1025 for (i=0; joblevels[i].level_name; i++) {
1026 if (joblevels[i].job_type == item->code &&
1027 strcasecmp(lc->str, joblevels[i].level_name) == 0) {
1028 ((JOB *)(item->value))->level = joblevels[i].level;
1034 scan_err1(lc, "Expected a Job Level keyword, got: %s", lc->str);
1039 } /* end if strcmp() */
1042 scan_err1(lc, "%s not a valid Backup/verify keyword", lc->str);
1045 lc->options = options; /* reset original options */
1046 set_bit(index, res_all.hdr.item_present);
1050 * Store restore info for Job record
1052 * Restore = JobId=<job-id> Where=<root-directory> Replace=<options> Bootstrap=<file>
1055 static void store_restore(LEX *lc, struct res_items *item, int index, int pass)
1059 int options = lc->options;
1061 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1063 Dmsg0(190, "Enter store_restore()\n");
1065 ((JOB *)(item->value))->JobType = item->code;
1066 while ((token = lex_get_token(lc, T_ALL)) != T_EOL) {
1069 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1070 scan_err1(lc, "expected a name, got: %s", lc->str);
1073 for (i=0; RestoreFields[i].name; i++) {
1074 Dmsg1(190, "Restore kw=%s\n", lc->str);
1075 if (strcasecmp(lc->str, RestoreFields[i].name) == 0) {
1077 if (lex_get_token(lc, T_ALL) != T_EQUALS) {
1078 scan_err1(lc, "Expected an equals, got: %s", lc->str);
1080 token = lex_get_token(lc, T_ALL);
1081 Dmsg1(190, "Restore value=%s\n", lc->str);
1082 switch (RestoreFields[i].token) {
1085 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1086 scan_err1(lc, "Expected a Restore bootstrap file, got: %s", lc->str);
1089 res_all.res_job.RestoreBootstrap = bstrdup(lc->str);
1093 /* Find Client Resource */
1095 res = GetResWithName(R_CLIENT, lc->str);
1097 scan_err1(lc, "Could not find specified Client Resource: %s",
1100 res_all.res_job.client = (CLIENT *)res;
1104 /* Find FileSet Resource */
1106 res = GetResWithName(R_FILESET, lc->str);
1108 scan_err1(lc, "Could not find specified FileSet Resource: %s\n",
1111 res_all.res_job.fs = (FILESET *)res;
1116 if (token != T_NUMBER) {
1117 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1120 res_all.res_job.RestoreJobId = strtol(lc->str, NULL, 0);
1121 Dmsg1(190, "RestorJobId=%d\n", res_all.res_job.RestoreJobId);
1123 scan_err1(lc, "expected an integer number, got: %s", lc->str);
1128 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1129 scan_err1(lc, "Expected a Restore root directory, got: %s", lc->str);
1132 res_all.res_job.RestoreWhere = bstrdup(lc->str);
1136 /* Replacement options */
1137 if (token != T_IDENTIFIER && token != T_UNQUOTED_STRING && token != T_QUOTED_STRING) {
1138 scan_err1(lc, "Expected a keyword name, got: %s", lc->str);
1140 /* Fix to scan Replacement options */
1141 for (i=0; ReplaceOptions[i].name; i++) {
1142 if (strcasecmp(lc->str, ReplaceOptions[i].name) == 0) {
1143 ((JOB *)(item->value))->RestoreOptions = ReplaceOptions[i].token;
1149 scan_err1(lc, "Expected a Restore replacement option, got: %s", lc->str);
1154 } /* end if strcmp() */
1157 scan_err1(lc, "%s not a valid Restore keyword", lc->str);
1160 lc->options = options; /* reset original options */
1161 set_bit(index, res_all.hdr.item_present);
1167 * Scan for FileSet options (keyword=option) is converted into one or
1168 * two characters. Verifyopts=xxxx is Vxxxx:
1170 static char *scan_fs_options(LEX *lc, int keyword)
1173 static char opts[100];
1176 option[0] = 0; /* default option = none */
1177 opts[0] = option[2] = 0; /* terminate options */
1179 token = lex_get_token(lc, T_NAME); /* expect at least one option */
1180 if (keyword == FS_KW_VERIFY) { /* special case */
1181 /* ***FIXME**** ensure these are in permitted set */
1182 strcpy(option, "V"); /* indicate Verify */
1183 strcat(option, lc->str);
1184 strcat(option, ":"); /* terminate it */
1186 for (i=0; FS_options[i].name; i++) {
1187 if (strcasecmp(lc->str, FS_options[i].name) == 0 && FS_options[i].keyword == keyword) {
1188 option[0] = FS_options[i].option[0];
1189 option[1] = FS_options[i].option[1];
1195 scan_err1(lc, "Expected a FileSet option keyword, got: %s", lc->str);
1198 strcat(opts, option);
1200 /* check if more options are specified */
1201 if (lc->ch != ',') {
1202 break; /* no, get out */
1204 token = lex_get_token(lc, T_ALL); /* yes, eat comma */
1211 /* Store FileSet Include/Exclude info */
1212 static void store_inc(LEX *lc, struct res_items *item, int index, int pass)
1215 int options = lc->options;
1221 lc->options |= LOPT_NO_IDENT; /* make spaces significant */
1223 /* Get include options */
1224 strcpy(inc_opts, "0"); /* set no options */
1225 while ((token=lex_get_token(lc, T_ALL)) != T_BOB) {
1226 keyword = FS_KW_NONE;
1227 for (i=0; FS_option_kw[i].name; i++) {
1228 if (strcasecmp(lc->str, FS_option_kw[i].name) == 0) {
1229 keyword = FS_option_kw[i].token;
1233 if (keyword == FS_KW_NONE) {
1234 scan_err1(lc, "Expected a FileSet keyword, got: %s", lc->str);
1236 /* Option keyword should be following by = <option> */
1237 if ((token=lex_get_token(lc, T_ALL)) != T_EQUALS) {
1238 scan_err1(lc, "expected an = following keyword, got: %s", lc->str);
1240 strcat(inc_opts, scan_fs_options(lc, keyword));
1241 if (token == T_BOB) {
1245 strcat(inc_opts, " "); /* add field separator */
1246 inc_opts_len = strlen(inc_opts);
1250 if (!res_all.res_fs.have_MD5) {
1251 MD5Init(&res_all.res_fs.md5c);
1252 res_all.res_fs.have_MD5 = TRUE;
1254 /* Pickup include/exclude names. Note, they are stored as
1256 * where XYZ are the include/exclude options for the FileSet
1257 * a "0 " (zero) indicates no options,
1258 * and fname is the file/directory name given
1260 while ((token = lex_get_token(lc, T_ALL)) != T_EOB) {
1267 case T_UNQUOTED_STRING:
1268 case T_QUOTED_STRING:
1269 fname = (char *) malloc(lc->str_len + inc_opts_len + 1);
1270 strcpy(fname, inc_opts);
1271 strcat(fname, lc->str);
1272 if (res_all.res_fs.have_MD5) {
1273 MD5Update(&res_all.res_fs.md5c, (unsigned char *) fname, inc_opts_len + lc->str_len);
1275 if (item->code == 0) { /* include */
1276 if (res_all.res_fs.num_includes == res_all.res_fs.include_size) {
1277 res_all.res_fs.include_size += 10;
1278 if (res_all.res_fs.include_array == NULL) {
1279 res_all.res_fs.include_array = (char **) malloc(sizeof(char *) * res_all.res_fs.include_size);
1281 res_all.res_fs.include_array = (char **) realloc(res_all.res_fs.include_array,
1282 sizeof(char *) * res_all.res_fs.include_size);
1285 res_all.res_fs.include_array[res_all.res_fs.num_includes++] =
1287 } else { /* exclude */
1288 if (res_all.res_fs.num_excludes == res_all.res_fs.exclude_size) {
1289 res_all.res_fs.exclude_size += 10;
1290 if (res_all.res_fs.exclude_array == NULL) {
1291 res_all.res_fs.exclude_array = (char **) malloc(sizeof(char *) * res_all.res_fs.exclude_size);
1293 res_all.res_fs.exclude_array = (char **) realloc(res_all.res_fs.exclude_array,
1294 sizeof(char *) * res_all.res_fs.exclude_size);
1297 res_all.res_fs.exclude_array[res_all.res_fs.num_excludes++] =
1302 scan_err1(lc, "Expected a filename, got: %s", lc->str);
1305 } else { /* pass 2 */
1306 while (lex_get_token(lc, T_ALL) != T_EOB)
1310 lc->options = options;
1311 set_bit(index, res_all.hdr.item_present);