3 * Bacula Director -- User Agent Prompt and Selection code
5 * Kern Sibbald, October MMI
11 Copyright (C) 2000-2004 Kern Sibbald and John Walker
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
33 /* Imported variables */
34 extern struct s_jl joblevels[];
38 * Confirm a retention period
40 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg)
45 bsendmsg(ua, _("The current %s retention period is: %s\n"),
46 msg, edit_utime(*ret, ed1, sizeof(ed1)));
47 if (!get_cmd(ua, _("Continue? (yes/mod/no): "))) {
50 if (strcasecmp(ua->cmd, _("mod")) == 0) {
51 if (!get_cmd(ua, _("Enter new retention period: "))) {
54 if (!duration_to_utime(ua->cmd, ret)) {
55 bsendmsg(ua, _("Invalid period.\n"));
60 if (strcasecmp(ua->cmd, _("yes")) == 0) {
63 if (strcasecmp(ua->cmd, _("no")) == 0) {
71 * Given a list of keywords, find the first one
72 * that is in the argument list.
73 * Returns: -1 if not found
74 * index into list (base 0) on success
76 int find_arg_keyword(UAContext *ua, const char **list)
78 for (int i=1; i<ua->argc; i++) {
79 for(int j=0; list[j]; j++) {
80 if (strcasecmp(_(list[j]), ua->argk[i]) == 0) {
89 * Given one keyword, find the first one that
90 * is in the argument list.
91 * Returns: argk index (always gt 0)
94 int find_arg(UAContext *ua, const char *keyword)
96 for (int i=1; i<ua->argc; i++) {
97 if (strcasecmp(keyword, ua->argk[i]) == 0) {
105 * Given a single keyword, find it in the argument list, but
106 * it must have a value
107 * Returns: -1 if not found or no value
108 * list index (base 0) on success
110 int find_arg_with_value(UAContext *ua, const char *keyword)
112 for (int i=1; i<ua->argc; i++) {
113 if (strcasecmp(keyword, ua->argk[i]) == 0) {
125 * Given a list of keywords, prompt the user
128 * Returns: -1 on failure
129 * index into list (base 0) on success
131 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list)
134 start_prompt(ua, _("You have the following choices:\n"));
135 for (i=0; list[i]; i++) {
136 add_prompt(ua, list[i]);
138 return do_prompt(ua, "", msg, NULL, 0);
143 * Select a Storage resource from prompt list
145 STORE *select_storage_resource(UAContext *ua)
147 char name[MAX_NAME_LENGTH];
150 start_prompt(ua, _("The defined Storage resources are:\n"));
152 foreach_res(store, R_STORAGE) {
153 if (acl_access_ok(ua, Storage_ACL, store->hdr.name)) {
154 add_prompt(ua, store->hdr.name);
158 do_prompt(ua, _("Storage"), _("Select Storage resource"), name, sizeof(name));
159 store = (STORE *)GetResWithName(R_STORAGE, name);
164 * Select a FileSet resource from prompt list
166 FILESET *select_fileset_resource(UAContext *ua)
168 char name[MAX_NAME_LENGTH];
171 start_prompt(ua, _("The defined FileSet resources are:\n"));
173 foreach_res(fs, R_FILESET) {
174 if (acl_access_ok(ua, FileSet_ACL, fs->hdr.name)) {
175 add_prompt(ua, fs->hdr.name);
179 do_prompt(ua, _("FileSet"), _("Select FileSet resource"), name, sizeof(name));
180 fs = (FILESET *)GetResWithName(R_FILESET, name);
186 * Get a catalog resource from prompt list
188 CAT *get_catalog_resource(UAContext *ua)
190 char name[MAX_NAME_LENGTH];
194 for (i=1; i<ua->argc; i++) {
195 if (strcasecmp(ua->argk[i], _("catalog")) == 0 && ua->argv[i]) {
196 if (acl_access_ok(ua, Catalog_ACL, ua->argv[i])) {
197 catalog = (CAT *)GetResWithName(R_CATALOG, ua->argv[i]);
203 start_prompt(ua, _("The defined Catalog resources are:\n"));
205 foreach_res(catalog, R_CATALOG) {
206 if (acl_access_ok(ua, Catalog_ACL, catalog->hdr.name)) {
207 add_prompt(ua, catalog->hdr.name);
211 do_prompt(ua, _("Catalog"), _("Select Catalog resource"), name, sizeof(name));
212 catalog = (CAT *)GetResWithName(R_CATALOG, name);
219 * Select a Job resource from prompt list
221 JOB *select_job_resource(UAContext *ua)
223 char name[MAX_NAME_LENGTH];
226 start_prompt(ua, _("The defined Job resources are:\n"));
228 foreach_res(job, R_JOB) {
229 if (acl_access_ok(ua, Job_ACL, job->hdr.name)) {
230 add_prompt(ua, job->hdr.name);
234 do_prompt(ua, _("Job"), _("Select Job resource"), name, sizeof(name));
235 job = (JOB *)GetResWithName(R_JOB, name);
240 * Select a Restore Job resource from prompt list
242 JOB *select_restore_job_resource(UAContext *ua)
244 char name[MAX_NAME_LENGTH];
247 start_prompt(ua, _("The defined Restore Job resources are:\n"));
249 foreach_res(job, R_JOB) {
250 if (job->JobType == JT_RESTORE && acl_access_ok(ua, Job_ACL, job->hdr.name)) {
251 add_prompt(ua, job->hdr.name);
255 do_prompt(ua, _("Job"), _("Select Restore Job"), name, sizeof(name));
256 job = (JOB *)GetResWithName(R_JOB, name);
263 * Select a client resource from prompt list
265 CLIENT *select_client_resource(UAContext *ua)
267 char name[MAX_NAME_LENGTH];
270 start_prompt(ua, _("The defined Client resources are:\n"));
272 foreach_res(client, R_CLIENT) {
273 if (acl_access_ok(ua, Client_ACL, client->hdr.name)) {
274 add_prompt(ua, client->hdr.name);
278 do_prompt(ua, _("Client"), _("Select Client (File daemon) resource"), name, sizeof(name));
279 client = (CLIENT *)GetResWithName(R_CLIENT, name);
284 * Get client resource, start by looking for
285 * client=<client-name>
286 * if we don't find the keyword, we prompt the user.
288 CLIENT *get_client_resource(UAContext *ua)
290 CLIENT *client = NULL;
293 for (i=1; i<ua->argc; i++) {
294 if ((strcasecmp(ua->argk[i], _("client")) == 0 ||
295 strcasecmp(ua->argk[i], _("fd")) == 0) && ua->argv[i]) {
296 if (!acl_access_ok(ua, Client_ACL, ua->argv[i])) {
299 client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[i]);
303 bsendmsg(ua, _("Error: Client resource %s does not exist.\n"), ua->argv[i]);
307 return select_client_resource(ua);
310 /* Scan what the user has entered looking for:
312 * client=<client-name>
314 * if error or not found, put up a list of client DBRs
317 * returns: 0 on error
318 * 1 on success and fills in CLIENT_DBR
320 int get_client_dbr(UAContext *ua, CLIENT_DBR *cr)
324 if (cr->Name[0]) { /* If name already supplied */
325 if (db_get_client_record(ua->jcr, ua->db, cr)) {
328 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), cr->Name, db_strerror(ua->db));
330 for (i=1; i<ua->argc; i++) {
331 if ((strcasecmp(ua->argk[i], _("client")) == 0 ||
332 strcasecmp(ua->argk[i], _("fd")) == 0) && ua->argv[i]) {
333 if (!acl_access_ok(ua, Client_ACL, ua->argv[i])) {
336 bstrncpy(cr->Name, ua->argv[i], sizeof(cr->Name));
337 if (!db_get_client_record(ua->jcr, ua->db, cr)) {
338 bsendmsg(ua, _("Could not find Client \"%s\": ERR=%s"), ua->argv[i],
339 db_strerror(ua->db));
346 if (!select_client_dbr(ua, cr)) { /* try once more by proposing a list */
353 * Select a Client record from the catalog
354 * Returns 1 on success
357 int select_client_dbr(UAContext *ua, CLIENT_DBR *cr)
360 char name[MAX_NAME_LENGTH];
366 if (!db_get_client_ids(ua->jcr, ua->db, &num_clients, &ids)) {
367 bsendmsg(ua, _("Error obtaining client ids. ERR=%s\n"), db_strerror(ua->db));
370 if (num_clients <= 0) {
371 bsendmsg(ua, _("No clients defined. You must run a job before using this command.\n"));
375 start_prompt(ua, _("Defined Clients:\n"));
376 for (i=0; i < num_clients; i++) {
377 ocr.ClientId = ids[i];
378 if (!db_get_client_record(ua->jcr, ua->db, &ocr) ||
379 !acl_access_ok(ua, Client_ACL, ocr.Name)) {
382 add_prompt(ua, ocr.Name);
385 if (do_prompt(ua, _("Client"), _("Select the Client"), name, sizeof(name)) < 0) {
388 memset(&ocr, 0, sizeof(ocr));
389 bstrncpy(ocr.Name, name, sizeof(ocr.Name));
391 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
392 bsendmsg(ua, _("Could not find Client \"%s\": ERR=%s"), name, db_strerror(ua->db));
395 memcpy(cr, &ocr, sizeof(ocr));
401 /* Scan what the user has entered looking for:
405 * if error or not found, put up a list of pool DBRs
408 * returns: false on error
409 * true on success and fills in POOL_DBR
411 bool get_pool_dbr(UAContext *ua, POOL_DBR *pr)
413 if (pr->Name[0]) { /* If name already supplied */
414 if (db_get_pool_record(ua->jcr, ua->db, pr) &&
415 acl_access_ok(ua, Pool_ACL, pr->Name)) {
418 bsendmsg(ua, _("Could not find Pool \"%s\": ERR=%s"), pr->Name, db_strerror(ua->db));
420 if (!select_pool_dbr(ua, pr)) { /* try once more */
427 * Select a Pool record from the catalog
429 bool select_pool_dbr(UAContext *ua, POOL_DBR *pr)
432 char name[MAX_NAME_LENGTH];
436 for (i=1; i<ua->argc; i++) {
437 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i] &&
438 acl_access_ok(ua, Pool_ACL, ua->argv[i])) {
439 bstrncpy(pr->Name, ua->argv[i], sizeof(pr->Name));
440 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
441 bsendmsg(ua, _("Could not find Pool \"%s\": ERR=%s"), ua->argv[i],
442 db_strerror(ua->db));
451 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
452 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"), db_strerror(ua->db));
455 if (num_pools <= 0) {
456 bsendmsg(ua, _("No pools defined. Use the \"create\" command to create one.\n"));
460 start_prompt(ua, _("Defined Pools:\n"));
461 for (i=0; i < num_pools; i++) {
463 if (!db_get_pool_record(ua->jcr, ua->db, &opr) ||
464 !acl_access_ok(ua, Pool_ACL, opr.Name)) {
467 add_prompt(ua, opr.Name);
470 if (do_prompt(ua, _("Pool"), _("Select the Pool"), name, sizeof(name)) < 0) {
473 memset(&opr, 0, sizeof(opr));
474 bstrncpy(opr.Name, name, sizeof(opr.Name));
476 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
477 bsendmsg(ua, _("Could not find Pool \"%s\": ERR=%s"), name, db_strerror(ua->db));
480 memcpy(pr, &opr, sizeof(opr));
485 * Select a Pool and a Media (Volume) record from the database
487 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr)
490 if (!select_media_dbr(ua, mr)) {
493 memset(pr, 0, sizeof(POOL_DBR));
494 pr->PoolId = mr->PoolId;
495 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
496 bsendmsg(ua, "%s", db_strerror(ua->db));
499 if (!acl_access_ok(ua, Pool_ACL, pr->Name)) {
500 bsendmsg(ua, _("No access to Pool \"%s\"\n"), pr->Name);
506 /* Select a Media (Volume) record from the database */
507 int select_media_dbr(UAContext *ua, MEDIA_DBR *mr)
511 memset(mr, 0, sizeof(MEDIA_DBR));
513 i = find_arg_with_value(ua, "volume");
515 bstrncpy(mr->VolumeName, ua->argv[i], sizeof(mr->VolumeName));
517 if (mr->VolumeName[0] == 0) {
519 memset(&pr, 0, sizeof(pr));
520 /* Get the pool from pool=<pool-name> */
521 if (!get_pool_dbr(ua, &pr)) {
524 mr->PoolId = pr.PoolId;
525 db_list_media_records(ua->jcr, ua->db, mr, prtit, ua, HORZ_LIST);
526 if (!get_cmd(ua, _("Enter MediaId or Volume name: "))) {
529 if (is_a_number(ua->cmd)) {
530 mr->MediaId = str_to_int64(ua->cmd);
532 bstrncpy(mr->VolumeName, ua->cmd, sizeof(mr->VolumeName));
536 if (!db_get_media_record(ua->jcr, ua->db, mr)) {
537 bsendmsg(ua, "%s", db_strerror(ua->db));
545 * Select a pool resource from prompt list
547 POOL *select_pool_resource(UAContext *ua)
549 char name[MAX_NAME_LENGTH];
552 start_prompt(ua, _("The defined Pool resources are:\n"));
554 foreach_res(pool, R_POOL) {
555 if (acl_access_ok(ua, Pool_ACL, pool->hdr.name)) {
556 add_prompt(ua, pool->hdr.name);
560 do_prompt(ua, _("Pool"), _("Select Pool resource"), name, sizeof(name));
561 pool = (POOL *)GetResWithName(R_POOL, name);
567 * If you are thinking about using it, you
568 * probably want to use select_pool_dbr()
569 * or get_pool_dbr() above.
571 POOL *get_pool_resource(UAContext *ua)
576 i = find_arg_with_value(ua, "pool");
577 if (i >= 0 && acl_access_ok(ua, Pool_ACL, ua->argv[i])) {
578 pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
582 bsendmsg(ua, _("Error: Pool resource \"%s\" does not exist.\n"), ua->argv[i]);
584 return select_pool_resource(ua);
588 * List all jobs and ask user to select one
590 int select_job_dbr(UAContext *ua, JOB_DBR *jr)
592 db_list_job_records(ua->jcr, ua->db, jr, prtit, ua, HORZ_LIST);
593 if (!get_pint(ua, _("Enter the JobId to select: "))) {
596 jr->JobId = ua->int64_val;
597 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
598 bsendmsg(ua, "%s", db_strerror(ua->db));
606 /* Scan what the user has entered looking for:
610 * if error or not found, put up a list of Jobs
613 * returns: 0 on error
614 * JobId on success and fills in JOB_DBR
616 int get_job_dbr(UAContext *ua, JOB_DBR *jr)
620 for (i=1; i<ua->argc; i++) {
621 if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
623 bstrncpy(jr->Job, ua->argv[i], sizeof(jr->Job));
624 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0 && ua->argv[i]) {
625 jr->JobId = str_to_int64(ua->argv[i]);
629 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
630 bsendmsg(ua, _("Could not find Job \"%s\": ERR=%s"), ua->argv[i],
631 db_strerror(ua->db));
638 if (!select_job_dbr(ua, jr)) { /* try once more */
645 * Implement unique set of prompts
647 void start_prompt(UAContext *ua, const char *msg)
649 if (ua->max_prompts == 0) {
650 ua->max_prompts = 10;
651 ua->prompt = (char **)bmalloc(sizeof(char *) * ua->max_prompts);
654 ua->prompt[0] = bstrdup(msg);
658 * Add to prompts -- keeping them unique
660 void add_prompt(UAContext *ua, const char *prompt)
663 if (ua->num_prompts == ua->max_prompts) {
664 ua->max_prompts *= 2;
665 ua->prompt = (char **)brealloc(ua->prompt, sizeof(char *) *
668 for (i=1; i < ua->num_prompts; i++) {
669 if (strcmp(ua->prompt[i], prompt) == 0) {
673 ua->prompt[ua->num_prompts++] = bstrdup(prompt);
677 * Display prompts and get user's choice
679 * Returns: -1 on error
680 * index base 0 on success, and choice
681 * is copied to prompt if not NULL
683 int do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt)
686 char pmsg[MAXSTRING];
688 if (ua->num_prompts == 2) {
691 bstrncpy(prompt, ua->prompt[1], max_prompt);
693 bsendmsg(ua, _("Automatically selected %s: %s\n"), automsg, ua->prompt[1]);
696 /* If running non-interactive, bail out */
698 bsendmsg(ua, _("Cannot select %s in batch mode.\n"), automsg);
702 bsendmsg(ua, ua->prompt[0]);
703 for (i=1; i < ua->num_prompts; i++) {
704 bsendmsg(ua, "%6d: %s\n", i, ua->prompt[i]);
712 /* First item is the prompt string, not the items */
713 if (ua->num_prompts == 1) {
714 bsendmsg(ua, _("Selection is empty!\n"));
715 item = 0; /* list is empty ! */
718 if (ua->num_prompts == 2) {
720 bsendmsg(ua, _("Item 1 selected automatically.\n"));
722 bstrncpy(prompt, ua->prompt[1], max_prompt);
726 sprintf(pmsg, "%s (1-%d): ", msg, ua->num_prompts-1);
728 /* Either a . or an @ will get you out of the loop */
729 if (!get_pint(ua, pmsg)) {
730 item = -1; /* error */
731 bsendmsg(ua, _("Selection aborted, nothing done.\n"));
734 item = ua->pint32_val;
735 if (item < 1 || item >= ua->num_prompts) {
736 bsendmsg(ua, _("Please enter a number between 1 and %d\n"), ua->num_prompts-1);
740 bstrncpy(prompt, ua->prompt[item], max_prompt);
746 for (i=0; i < ua->num_prompts; i++) {
755 * We scan what the user has entered looking for
756 * storage=<storage-resource>
759 * ? (prompt him with storage list)
760 * <some-error> (prompt him with storage list)
762 * If use_default is set, we assume that any keyword without a value
763 * is the name of the Storage resource wanted.
765 STORE *get_storage_resource(UAContext *ua, int use_default)
767 char *store_name = NULL;
774 for (i=1; i<ua->argc; i++) {
775 if (use_default && !ua->argv[i]) {
776 /* Ignore slots, scan and barcode(s) keywords */
777 if (strncasecmp("scan", ua->argk[i], 4) == 0 ||
778 strncasecmp("barcode", ua->argk[i], 7) == 0 ||
779 strncasecmp("slots", ua->argk[i], 5) == 0) {
782 /* Default argument is storage */
784 bsendmsg(ua, _("Storage name given twice.\n"));
787 store_name = ua->argk[i];
788 if (*store_name == '?') {
793 if (strcasecmp(ua->argk[i], _("storage")) == 0 ||
794 strcasecmp(ua->argk[i], _("sd")) == 0) {
795 store_name = ua->argv[i];
798 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
799 jobid = str_to_int64(ua->argv[i]);
801 bsendmsg(ua, _("Expecting jobid=nn command, got: %s\n"), ua->argk[i]);
804 if (!(jcr=get_jcr_by_id(jobid))) {
805 bsendmsg(ua, _("JobId %d is not running.\n"), jobid);
812 } else if (strcasecmp(ua->argk[i], _("job")) == 0) {
814 bsendmsg(ua, _("Expecting job=xxx, got: %s.\n"), ua->argk[i]);
817 if (!(jcr=get_jcr_by_partial_name(ua->argv[i]))) {
818 bsendmsg(ua, _("Job \"%s\" is not running.\n"), ua->argv[i]);
827 if (store && !acl_access_ok(ua, Storage_ACL, store->hdr.name)) {
831 if (!store && store_name) {
832 store = (STORE *)GetResWithName(R_STORAGE, store_name);
834 bsendmsg(ua, "Storage resource \"%s\": not found\n", store_name);
837 if (store && !acl_access_ok(ua, Storage_ACL, store->hdr.name)) {
840 /* No keywords found, so present a selection list */
842 store = select_storage_resource(ua);
849 * Scan looking for mediatype=
851 * if not found or error, put up selection list
853 * Returns: 0 on error
854 * 1 on success, MediaType is set
856 int get_media_type(UAContext *ua, char *MediaType, int max_media)
861 i = find_arg_with_value(ua, "mediatype");
863 bstrncpy(MediaType, ua->argv[i], max_media);
867 start_prompt(ua, _("Media Types defined in conf file:\n"));
869 foreach_res(store, R_STORAGE) {
870 add_prompt(ua, store->media_type);
873 return (do_prompt(ua, _("Media Type"), _("Select the Media Type"), MediaType, max_media) < 0) ? 0 : 1;
876 bool get_level_from_name(JCR *jcr, const char *level_name)
878 /* Look up level name and pull code */
880 for (int i=0; joblevels[i].level_name; i++) {
881 if (strcasecmp(level_name, joblevels[i].level_name) == 0) {
882 jcr->JobLevel = joblevels[i].level;