3 * Bacula Director -- User Agent Prompt and Selection code
5 * Kern Sibbald, October MMI
11 Copyright (C) 2000-2003 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 */
37 * Confirm a retention period
39 int confirm_retention(UAContext *ua, utime_t *ret, char *msg)
44 bsendmsg(ua, _("The current %s retention period is: %s\n"),
45 msg, edit_utime(*ret, ed1));
46 if (!get_cmd(ua, _("Continue? (yes/mod/no): "))) {
49 if (strcasecmp(ua->cmd, _("mod")) == 0) {
50 if (!get_cmd(ua, _("Enter new retention period: "))) {
53 if (!duration_to_utime(ua->cmd, ret)) {
54 bsendmsg(ua, _("Invalid period.\n"));
59 if (strcasecmp(ua->cmd, _("yes")) == 0) {
62 if (strcasecmp(ua->cmd, _("no")) == 0) {
70 * Given a list of keywords, find the first one
71 * that is in the argument list.
72 * Returns: -1 if not found
73 * index into list (base 0) on success
75 int find_arg_keyword(UAContext *ua, char **list)
77 for (int i=1; i<ua->argc; i++) {
78 for(int j=0; list[j]; j++) {
79 if (strcasecmp(_(list[j]), ua->argk[i]) == 0) {
88 * Given one keyword, find the first one that
89 * is in the argument list.
90 * Returns: argk index (always gt 0)
93 int find_arg(UAContext *ua, char *keyword)
95 for (int i=1; i<ua->argc; i++) {
96 if (strcasecmp(keyword, ua->argk[i]) == 0) {
104 * Given a single keyword, find it in the argument list, but
105 * it must have a value
106 * Returns: -1 if not found or no value
107 * list index (base 0) on success
109 int find_arg_with_value(UAContext *ua, char *keyword)
111 for (int i=1; i<ua->argc; i++) {
112 if (strcasecmp(keyword, ua->argk[i]) == 0) {
124 * Given a list of keywords, prompt the user
127 * Returns: -1 on failure
128 * index into list (base 0) on success
130 int do_keyword_prompt(UAContext *ua, char *msg, char **list)
133 start_prompt(ua, _("You have the following choices:\n"));
134 for (i=0; list[i]; i++) {
135 add_prompt(ua, list[i]);
137 return do_prompt(ua, "", msg, NULL, 0);
142 * Select a Storage resource from prompt list
144 STORE *select_storage_resource(UAContext *ua)
146 char name[MAX_NAME_LENGTH];
149 start_prompt(ua, _("The defined Storage resources are:\n"));
151 foreach_res(store, R_STORAGE) {
152 if (acl_access_ok(ua, Storage_ACL, store->hdr.name)) {
153 add_prompt(ua, store->hdr.name);
157 do_prompt(ua, _("Storage"), _("Select Storage resource"), name, sizeof(name));
158 store = (STORE *)GetResWithName(R_STORAGE, name);
163 * Select a FileSet resource from prompt list
165 FILESET *select_fileset_resource(UAContext *ua)
167 char name[MAX_NAME_LENGTH];
170 start_prompt(ua, _("The defined FileSet resources are:\n"));
172 foreach_res(fs, R_FILESET) {
173 if (acl_access_ok(ua, FileSet_ACL, fs->hdr.name)) {
174 add_prompt(ua, fs->hdr.name);
178 do_prompt(ua, _("FileSet"), _("Select FileSet resource"), name, sizeof(name));
179 fs = (FILESET *)GetResWithName(R_FILESET, name);
185 * Get a catalog resource from prompt list
187 CAT *get_catalog_resource(UAContext *ua)
189 char name[MAX_NAME_LENGTH];
193 for (i=1; i<ua->argc; i++) {
194 if (strcasecmp(ua->argk[i], _("catalog")) == 0 && ua->argv[i]) {
195 if (acl_access_ok(ua, Catalog_ACL, ua->argv[i])) {
196 catalog = (CAT *)GetResWithName(R_CATALOG, ua->argv[i]);
202 start_prompt(ua, _("The defined Catalog resources are:\n"));
204 foreach_res(catalog, R_CATALOG) {
205 if (acl_access_ok(ua, Catalog_ACL, catalog->hdr.name)) {
206 add_prompt(ua, catalog->hdr.name);
210 do_prompt(ua, _("Catalog"), _("Select Catalog resource"), name, sizeof(name));
211 catalog = (CAT *)GetResWithName(R_CATALOG, name);
218 * Select a Job resource from prompt list
220 JOB *select_job_resource(UAContext *ua)
222 char name[MAX_NAME_LENGTH];
225 start_prompt(ua, _("The defined Job resources are:\n"));
227 foreach_res(job, R_JOB) {
228 if (acl_access_ok(ua, Job_ACL, job->hdr.name)) {
229 add_prompt(ua, job->hdr.name);
233 do_prompt(ua, _("Job"), _("Select Job resource"), name, sizeof(name));
234 job = (JOB *)GetResWithName(R_JOB, name);
239 * Select a Restore Job resource from prompt list
241 JOB *select_restore_job_resource(UAContext *ua)
243 char name[MAX_NAME_LENGTH];
246 start_prompt(ua, _("The defined Restore Job resources are:\n"));
248 foreach_res(job, R_JOB) {
249 if (job->JobType == JT_RESTORE && acl_access_ok(ua, Job_ACL, job->hdr.name)) {
250 add_prompt(ua, job->hdr.name);
254 do_prompt(ua, _("Job"), _("Select Restore Job"), name, sizeof(name));
255 job = (JOB *)GetResWithName(R_JOB, name);
262 * Select a client resource from prompt list
264 CLIENT *select_client_resource(UAContext *ua)
266 char name[MAX_NAME_LENGTH];
269 start_prompt(ua, _("The defined Client resources are:\n"));
271 foreach_res(client, R_CLIENT) {
272 if (acl_access_ok(ua, Client_ACL, client->hdr.name)) {
273 add_prompt(ua, client->hdr.name);
277 do_prompt(ua, _("Client"), _("Select Client (File daemon) resource"), name, sizeof(name));
278 client = (CLIENT *)GetResWithName(R_CLIENT, name);
283 * Get client resource, start by looking for
284 * client=<client-name>
285 * if we don't find the keyword, we prompt the user.
287 CLIENT *get_client_resource(UAContext *ua)
289 CLIENT *client = NULL;
292 for (i=1; i<ua->argc; i++) {
293 if ((strcasecmp(ua->argk[i], _("client")) == 0 ||
294 strcasecmp(ua->argk[i], _("fd")) == 0) && ua->argv[i]) {
295 if (!acl_access_ok(ua, Client_ACL, ua->argv[i])) {
298 client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[i]);
302 bsendmsg(ua, _("Error: Client resource %s does not exist.\n"), ua->argv[i]);
306 return select_client_resource(ua);
309 /* Scan what the user has entered looking for:
311 * client=<client-name>
313 * if error or not found, put up a list of client DBRs
316 * returns: 0 on error
317 * 1 on success and fills in CLIENT_DBR
319 int get_client_dbr(UAContext *ua, CLIENT_DBR *cr)
323 if (cr->Name[0]) { /* If name already supplied */
324 if (db_get_client_record(ua->jcr, ua->db, cr)) {
327 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), cr->Name, db_strerror(ua->db));
329 for (i=1; i<ua->argc; i++) {
330 if ((strcasecmp(ua->argk[i], _("client")) == 0 ||
331 strcasecmp(ua->argk[i], _("fd")) == 0) && ua->argv[i]) {
332 if (!acl_access_ok(ua, Client_ACL, ua->argv[i])) {
335 bstrncpy(cr->Name, ua->argv[i], sizeof(cr->Name));
336 if (!db_get_client_record(ua->jcr, ua->db, cr)) {
337 bsendmsg(ua, _("Could not find Client \"%s\": ERR=%s"), ua->argv[i],
338 db_strerror(ua->db));
345 if (!select_client_dbr(ua, cr)) { /* try once more by proposing a list */
352 * Select a Client record from the catalog
353 * Returns 1 on success
356 int select_client_dbr(UAContext *ua, CLIENT_DBR *cr)
359 char name[MAX_NAME_LENGTH];
365 if (!db_get_client_ids(ua->jcr, ua->db, &num_clients, &ids)) {
366 bsendmsg(ua, _("Error obtaining client ids. ERR=%s\n"), db_strerror(ua->db));
369 if (num_clients <= 0) {
370 bsendmsg(ua, _("No clients defined. You must run a job before using this command.\n"));
374 start_prompt(ua, _("Defined Clients:\n"));
375 for (i=0; i < num_clients; i++) {
376 ocr.ClientId = ids[i];
377 if (!db_get_client_record(ua->jcr, ua->db, &ocr) ||
378 !acl_access_ok(ua, Client_ACL, ocr.Name)) {
381 add_prompt(ua, ocr.Name);
384 if (do_prompt(ua, _("Client"), _("Select the Client"), name, sizeof(name)) < 0) {
387 memset(&ocr, 0, sizeof(ocr));
388 bstrncpy(ocr.Name, name, sizeof(ocr.Name));
390 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
391 bsendmsg(ua, _("Could not find Client \"%s\": ERR=%s"), name, db_strerror(ua->db));
394 memcpy(cr, &ocr, sizeof(ocr));
400 /* Scan what the user has entered looking for:
404 * if error or not found, put up a list of pool DBRs
407 * returns: 0 on error
408 * 1 on success and fills in POOL_DBR
410 int get_pool_dbr(UAContext *ua, POOL_DBR *pr)
412 if (pr->Name[0]) { /* If name already supplied */
413 if (db_get_pool_record(ua->jcr, ua->db, pr) &&
414 acl_access_ok(ua, Pool_ACL, pr->Name)) {
417 bsendmsg(ua, _("Could not find Pool \"%s\": ERR=%s"), pr->Name, db_strerror(ua->db));
419 if (!select_pool_dbr(ua, pr)) { /* try once more */
426 * Select a Pool record from the catalog
428 int select_pool_dbr(UAContext *ua, POOL_DBR *pr)
431 char name[MAX_NAME_LENGTH];
435 for (i=1; i<ua->argc; i++) {
436 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i] &&
437 acl_access_ok(ua, Pool_ACL, ua->argv[i])) {
438 bstrncpy(pr->Name, ua->argv[i], sizeof(pr->Name));
439 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
440 bsendmsg(ua, _("Could not find Pool \"%s\": ERR=%s"), ua->argv[i],
441 db_strerror(ua->db));
450 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
451 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"), db_strerror(ua->db));
454 if (num_pools <= 0) {
455 bsendmsg(ua, _("No pools defined. Use the \"create\" command to create one.\n"));
459 start_prompt(ua, _("Defined Pools:\n"));
460 for (i=0; i < num_pools; i++) {
462 if (!db_get_pool_record(ua->jcr, ua->db, &opr) ||
463 !acl_access_ok(ua, Pool_ACL, opr.Name)) {
466 add_prompt(ua, opr.Name);
469 if (do_prompt(ua, _("Pool"), _("Select the Pool"), name, sizeof(name)) < 0) {
472 memset(&opr, 0, sizeof(opr));
473 bstrncpy(opr.Name, name, sizeof(opr.Name));
475 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
476 bsendmsg(ua, _("Could not find Pool \"%s\": ERR=%s"), name, db_strerror(ua->db));
479 memcpy(pr, &opr, sizeof(opr));
484 * Select a Pool and a Media (Volume) record from the database
486 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr)
489 if (!select_media_dbr(ua, mr)) {
492 memset(pr, 0, sizeof(POOL_DBR));
493 pr->PoolId = mr->PoolId;
494 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
495 bsendmsg(ua, "%s", db_strerror(ua->db));
501 /* Select a Media (Volume) record from the database */
502 int select_media_dbr(UAContext *ua, MEDIA_DBR *mr)
506 memset(mr, 0, sizeof(MEDIA_DBR));
508 i = find_arg_with_value(ua, "volume");
510 bstrncpy(mr->VolumeName, ua->argv[i], sizeof(mr->VolumeName));
512 if (mr->VolumeName[0] == 0) {
514 memset(&pr, 0, sizeof(pr));
515 /* Get the pool from pool=<pool-name> */
516 if (!get_pool_dbr(ua, &pr)) {
519 mr->PoolId = pr.PoolId;
520 db_list_media_records(ua->jcr, ua->db, mr, prtit, ua, HORZ_LIST);
521 if (!get_cmd(ua, _("Enter MediaId or Volume name: "))) {
524 if (is_a_number(ua->cmd)) {
525 mr->MediaId = atoi(ua->cmd);
527 bstrncpy(mr->VolumeName, ua->cmd, sizeof(mr->VolumeName));
531 if (!db_get_media_record(ua->jcr, ua->db, mr)) {
532 bsendmsg(ua, "%s", db_strerror(ua->db));
540 * Select a pool resource from prompt list
542 POOL *select_pool_resource(UAContext *ua)
544 char name[MAX_NAME_LENGTH];
547 start_prompt(ua, _("The defined Pool resources are:\n"));
549 foreach_res(pool, R_POOL) {
550 if (acl_access_ok(ua, Pool_ACL, pool->hdr.name)) {
551 add_prompt(ua, pool->hdr.name);
555 do_prompt(ua, _("Pool"), _("Select Pool resource"), name, sizeof(name));
556 pool = (POOL *)GetResWithName(R_POOL, name);
562 * If you are thinking about using it, you
563 * probably want to use select_pool_dbr()
564 * or get_pool_dbr() above.
566 POOL *get_pool_resource(UAContext *ua)
571 i = find_arg_with_value(ua, "pool");
572 if (i >= 0 && acl_access_ok(ua, Pool_ACL, ua->argv[i])) {
573 pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
577 bsendmsg(ua, _("Error: Pool resource \"%s\" does not exist.\n"), ua->argv[i]);
579 return select_pool_resource(ua);
583 * List all jobs and ask user to select one
585 int select_job_dbr(UAContext *ua, JOB_DBR *jr)
587 db_list_job_records(ua->jcr, ua->db, jr, prtit, ua, HORZ_LIST);
588 if (!get_pint(ua, _("Enter the JobId to select: "))) {
591 jr->JobId = ua->pint32_val;
592 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
593 bsendmsg(ua, "%s", db_strerror(ua->db));
601 /* Scan what the user has entered looking for:
605 * if error or not found, put up a list of Jobs
608 * returns: 0 on error
609 * JobId on success and fills in JOB_DBR
611 int get_job_dbr(UAContext *ua, JOB_DBR *jr)
615 for (i=1; i<ua->argc; i++) {
616 if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
618 bstrncpy(jr->Job, ua->argv[i], sizeof(jr->Job));
619 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0 && ua->argv[i]) {
620 jr->JobId = str_to_int64(ua->argv[i]);
624 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
625 bsendmsg(ua, _("Could not find Job \"%s\": ERR=%s"), ua->argv[i],
626 db_strerror(ua->db));
633 if (!select_job_dbr(ua, jr)) { /* try once more */
640 * Implement unique set of prompts
642 void start_prompt(UAContext *ua, char *msg)
644 if (ua->max_prompts == 0) {
645 ua->max_prompts = 10;
646 ua->prompt = (char **)bmalloc(sizeof(char *) * ua->max_prompts);
649 ua->prompt[0] = bstrdup(msg);
653 * Add to prompts -- keeping them unique
655 void add_prompt(UAContext *ua, char *prompt)
658 if (ua->num_prompts == ua->max_prompts) {
659 ua->max_prompts *= 2;
660 ua->prompt = (char **)brealloc(ua->prompt, sizeof(char *) *
663 for (i=1; i < ua->num_prompts; i++) {
664 if (strcmp(ua->prompt[i], prompt) == 0) {
668 ua->prompt[ua->num_prompts++] = bstrdup(prompt);
672 * Display prompts and get user's choice
674 * Returns: -1 on error
675 * index base 0 on success, and choice
676 * is copied to prompt if not NULL
678 int do_prompt(UAContext *ua, char *automsg, char *msg, char *prompt, int max_prompt)
681 char pmsg[MAXSTRING];
683 if (ua->num_prompts == 2) {
686 bstrncpy(prompt, ua->prompt[1], max_prompt);
688 bsendmsg(ua, _("Automatically selected %s: %s\n"), automsg, ua->prompt[1]);
691 bsendmsg(ua, ua->prompt[0]);
692 for (i=1; i < ua->num_prompts; i++) {
693 bsendmsg(ua, "%6d: %s\n", i, ua->prompt[i]);
701 /* First item is the prompt string, not the items */
702 if (ua->num_prompts == 1) {
703 bsendmsg(ua, _("Selection is empty!\n"));
704 item = 0; /* list is empty ! */
707 if (ua->num_prompts == 2) {
709 bsendmsg(ua, _("Item 1 selected automatically.\n"));
711 bstrncpy(prompt, ua->prompt[1], max_prompt);
715 sprintf(pmsg, "%s (1-%d): ", msg, ua->num_prompts-1);
717 /* Either a . or an @ will get you out of the loop */
718 if (!get_pint(ua, pmsg)) {
719 item = -1; /* error */
720 bsendmsg(ua, _("Selection aborted, nothing done.\n"));
723 item = ua->pint32_val;
724 if (item < 1 || item >= ua->num_prompts) {
725 bsendmsg(ua, _("Please enter a number between 1 and %d\n"), ua->num_prompts-1);
729 bstrncpy(prompt, ua->prompt[item], max_prompt);
735 for (i=0; i < ua->num_prompts; i++) {
744 * We scan what the user has entered looking for
745 * storage=<storage-resource>
748 * ? (prompt him with storage list)
749 * <some-error> (prompt him with storage list)
751 * If use_default is set, we assume that any keyword without a value
752 * is the name of the Storage resource wanted.
754 STORE *get_storage_resource(UAContext *ua, int use_default)
756 char *store_name = NULL;
763 for (i=1; i<ua->argc; i++) {
764 if (use_default && !ua->argv[i]) {
765 /* Ignore scan and barcode(s) keywords */
766 if (strncasecmp("scan", ua->argk[i], 4) == 0 ||
767 strncasecmp("barcode", ua->argk[i], 7) == 0) {
770 /* Default argument is storage */
772 bsendmsg(ua, _("Storage name given twice.\n"));
775 store_name = ua->argk[i];
776 if (*store_name == '?') {
781 if (strcasecmp(ua->argk[i], _("storage")) == 0 ||
782 strcasecmp(ua->argk[i], _("sd")) == 0) {
783 store_name = ua->argv[i];
786 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
787 jobid = str_to_int64(ua->argv[i]);
789 bsendmsg(ua, _("Expecting jobid=nn command, got: %s\n"), ua->argk[i]);
792 if (!(jcr=get_jcr_by_id(jobid))) {
793 bsendmsg(ua, _("JobId %d is not running.\n"), jobid);
800 } else if (strcasecmp(ua->argk[i], _("job")) == 0) {
801 if (!(jcr=get_jcr_by_partial_name(ua->argv[i]))) {
802 bsendmsg(ua, _("Job \"%s\" is not running.\n"), ua->argv[i]);
811 if (store && !acl_access_ok(ua, Storage_ACL, store->hdr.name)) {
815 if (!store && store_name) {
816 store = (STORE *)GetResWithName(R_STORAGE, store_name);
818 bsendmsg(ua, "Storage resource \"%s\": not found\n", store_name);
821 if (store && !acl_access_ok(ua, Storage_ACL, store->hdr.name)) {
824 /* No keywords found, so present a selection list */
826 store = select_storage_resource(ua);
833 * Scan looking for mediatype=
835 * if not found or error, put up selection list
837 * Returns: 0 on error
838 * 1 on success, MediaType is set
840 int get_media_type(UAContext *ua, char *MediaType, int max_media)
845 i = find_arg_with_value(ua, "mediatype");
847 bstrncpy(MediaType, ua->argv[i], max_media);
851 start_prompt(ua, _("Media Types defined in conf file:\n"));
853 foreach_res(store, R_STORAGE) {
854 add_prompt(ua, store->media_type);
857 return (do_prompt(ua, _("Media Type"), _("Select the Media Type"), MediaType, max_media) < 0) ? 0 : 1;