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) {
67 * Given a list of keywords, find the first one
68 * that is in the argument list.
69 * Returns: -1 if not found
70 * index into list (base 0) on success
72 int find_arg_keyword(UAContext *ua, char **list)
75 for (i=1; i<ua->argc; i++) {
76 for(j=0; list[j]; j++) {
77 if (strcasecmp(_(list[j]), ua->argk[i]) == 0) {
86 * Given a list of keywords, prompt the user
89 * Returns: -1 on failure
90 * index into list (base 0) on success
92 int do_keyword_prompt(UAContext *ua, char *msg, char **list)
95 start_prompt(ua, _("You have the following choices:\n"));
96 for (i=0; list[i]; i++) {
97 add_prompt(ua, list[i]);
99 return do_prompt(ua, msg, NULL, 0);
104 * Select a Storage resource from prompt list
106 STORE *select_storage_resource(UAContext *ua)
108 char name[MAX_NAME_LENGTH];
111 start_prompt(ua, _("The defined Storage resources are:\n"));
113 while ((store = (STORE *)GetNextRes(R_STORAGE, (RES *)store))) {
114 add_prompt(ua, store->hdr.name);
117 do_prompt(ua, _("Select Storage resource"), name, sizeof(name));
118 store = (STORE *)GetResWithName(R_STORAGE, name);
123 * Select a FileSet resource from prompt list
125 FILESET *select_fileset_resource(UAContext *ua)
127 char name[MAX_NAME_LENGTH];
130 start_prompt(ua, _("The defined FileSet resources are:\n"));
132 while ((fs = (FILESET *)GetNextRes(R_FILESET, (RES *)fs))) {
133 add_prompt(ua, fs->hdr.name);
136 do_prompt(ua, _("Select FileSet resource"), name, sizeof(name));
137 fs = (FILESET *)GetResWithName(R_FILESET, name);
143 * Get a catalog resource from prompt list
145 CAT *get_catalog_resource(UAContext *ua)
147 char name[MAX_NAME_LENGTH];
151 for (i=1; i<ua->argc; i++) {
152 if (strcasecmp(ua->argk[i], _("catalog")) == 0 && ua->argv[i]) {
153 catalog = (CAT *)GetResWithName(R_CATALOG, ua->argv[i]);
158 start_prompt(ua, _("The defined Catalog resources are:\n"));
160 while ((catalog = (CAT *)GetNextRes(R_CATALOG, (RES *)catalog))) {
161 add_prompt(ua, catalog->hdr.name);
164 do_prompt(ua, _("Select Catalog resource"), name, sizeof(name));
165 catalog = (CAT *)GetResWithName(R_CATALOG, name);
172 * Select a Job resource from prompt list
174 JOB *select_job_resource(UAContext *ua)
176 char name[MAX_NAME_LENGTH];
179 start_prompt(ua, _("The defined Job resources are:\n"));
181 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
182 add_prompt(ua, job->hdr.name);
185 do_prompt(ua, _("Select Job resource"), name, sizeof(name));
186 job = (JOB *)GetResWithName(R_JOB, name);
191 * Select a Restore Job resource from prompt list
193 JOB *select_restore_job_resource(UAContext *ua)
195 char name[MAX_NAME_LENGTH];
198 start_prompt(ua, _("The defined Restore Job resources are:\n"));
200 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
201 if (job->JobType == JT_RESTORE) {
202 add_prompt(ua, job->hdr.name);
206 do_prompt(ua, _("Select Restore Job"), name, sizeof(name));
207 job = (JOB *)GetResWithName(R_JOB, name);
214 * Select a client resource from prompt list
216 CLIENT *select_client_resource(UAContext *ua)
218 char name[MAX_NAME_LENGTH];
219 CLIENT *client = NULL;
221 start_prompt(ua, _("The defined Client resources are:\n"));
223 while ( (client = (CLIENT *)GetNextRes(R_CLIENT, (RES *)client)) ) {
224 add_prompt(ua, client->hdr.name);
227 do_prompt(ua, _("Select Client (File daemon) resource"), name, sizeof(name));
228 client = (CLIENT *)GetResWithName(R_CLIENT, name);
233 * Get client resource, start by looking for
234 * client=<client-name>
235 * if we don't find the keyword, we prompt the user.
237 CLIENT *get_client_resource(UAContext *ua)
239 CLIENT *client = NULL;
242 for (i=1; i<ua->argc; i++) {
243 if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
244 client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[i]);
248 bsendmsg(ua, _("Error: Client resource %s does not exist.\n"), ua->argv[i]);
252 return select_client_resource(ua);
255 /* Scan what the user has entered looking for:
257 * client=<client-name>
259 * if error or not found, put up a list of client DBRs
262 * returns: 0 on error
263 * 1 on success and fills in CLIENT_DBR
265 int get_client_dbr(UAContext *ua, CLIENT_DBR *cr)
269 if (cr->Name[0]) { /* If name already supplied */
270 if (db_get_client_record(ua->jcr, ua->db, cr)) {
273 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), cr->Name, db_strerror(ua->db));
275 for (i=1; i<ua->argc; i++) {
276 if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
277 bstrncpy(cr->Name, ua->argv[i], sizeof(cr->Name));
278 if (!db_get_client_record(ua->jcr, ua->db, cr)) {
279 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), ua->argv[i],
280 db_strerror(ua->db));
287 if (!select_client_dbr(ua, cr)) { /* try once more by proposing a list */
294 * Select a Client record from the catalog
295 * Returns 1 on success
298 int select_client_dbr(UAContext *ua, CLIENT_DBR *cr)
301 char name[MAX_NAME_LENGTH];
307 if (!db_get_client_ids(ua->jcr, ua->db, &num_clients, &ids)) {
308 bsendmsg(ua, _("Error obtaining client ids. ERR=%s\n"), db_strerror(ua->db));
311 if (num_clients <= 0) {
312 bsendmsg(ua, _("No clients defined. Run a job to create one.\n"));
316 start_prompt(ua, _("Defined Clients:\n"));
317 for (i=0; i < num_clients; i++) {
318 ocr.ClientId = ids[i];
319 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
322 add_prompt(ua, ocr.Name);
325 if (do_prompt(ua, _("Select the Client"), name, sizeof(name)) < 0) {
328 memset(&ocr, 0, sizeof(ocr));
329 bstrncpy(ocr.Name, name, sizeof(ocr.Name));
331 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
332 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), name, db_strerror(ua->db));
335 memcpy(cr, &ocr, sizeof(ocr));
341 /* Scan what the user has entered looking for:
345 * if error or not found, put up a list of pool DBRs
348 * returns: 0 on error
349 * 1 on success and fills in POOL_DBR
351 int get_pool_dbr(UAContext *ua, POOL_DBR *pr)
355 if (pr->Name[0]) { /* If name already supplied */
356 if (db_get_pool_record(ua->jcr, ua->db, pr)) {
359 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), pr->Name, db_strerror(ua->db));
361 for (i=1; i<ua->argc; i++) {
362 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
363 bstrncpy(pr->Name, ua->argv[i], sizeof(pr->Name));
364 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
365 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), ua->argv[i],
366 db_strerror(ua->db));
373 if (!select_pool_dbr(ua, pr)) { /* try once more */
380 * Select a Pool record from the catalog
382 int select_pool_dbr(UAContext *ua, POOL_DBR *pr)
385 char name[MAX_NAME_LENGTH];
391 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
392 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"), db_strerror(ua->db));
395 if (num_pools <= 0) {
396 bsendmsg(ua, _("No pools defined. Use the \"create\" command to create one.\n"));
400 start_prompt(ua, _("Defined Pools:\n"));
401 for (i=0; i < num_pools; i++) {
403 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
406 add_prompt(ua, opr.Name);
409 if (do_prompt(ua, _("Select the Pool"), name, sizeof(name)) < 0) {
412 memset(&opr, 0, sizeof(opr));
413 bstrncpy(opr.Name, name, sizeof(opr.Name));
415 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
416 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), name, db_strerror(ua->db));
419 memcpy(pr, &opr, sizeof(opr));
424 * Select a Pool and a Media (Volume) record from the database
426 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr)
429 static char *kw[] = {
433 memset(pr, 0, sizeof(POOL_DBR));
434 memset(mr, 0, sizeof(MEDIA_DBR));
436 /* Get the pool, possibly from pool=<pool-name> */
437 if (!get_pool_dbr(ua, pr)) {
440 mr->PoolId = pr->PoolId;
442 i = find_arg_keyword(ua, kw);
443 if (i == 0 && ua->argv[i]) {
444 bstrncpy(mr->VolumeName, ua->argv[i], sizeof(mr->VolumeName));
446 if (mr->VolumeName[0] == 0) {
447 db_list_media_records(ua->jcr, ua->db, mr, prtit, ua, 0);
448 if (!get_cmd(ua, _("Enter MediaId or Volume name: "))) {
451 if (is_a_number(ua->cmd)) {
452 mr->MediaId = atoi(ua->cmd);
454 bstrncpy(mr->VolumeName, ua->cmd, sizeof(mr->VolumeName));
458 if (!db_get_media_record(ua->jcr, ua->db, mr)) {
459 bsendmsg(ua, "%s", db_strerror(ua->db));
467 * Select a pool resource from prompt list
469 POOL *select_pool_resource(UAContext *ua)
471 char name[MAX_NAME_LENGTH];
474 start_prompt(ua, _("The defined Pool resources are:\n"));
476 while ((pool = (POOL *)GetNextRes(R_POOL, (RES *)pool))) {
477 add_prompt(ua, pool->hdr.name);
480 do_prompt(ua, _("Select Pool resource"), name, sizeof(name));
481 pool = (POOL *)GetResWithName(R_POOL, name);
487 * If you are thinking about using it, you
488 * probably want to use select_pool_dbr()
489 * or get_pool_dbr() above.
491 POOL *get_pool_resource(UAContext *ua)
496 for (i=1; i<ua->argc; i++) {
497 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
498 pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
502 bsendmsg(ua, _("Error: Pool resource %s does not exist.\n"), ua->argv[i]);
506 return select_pool_resource(ua);
510 * List all jobs and ask user to select one
512 int select_job_dbr(UAContext *ua, JOB_DBR *jr)
514 db_list_job_records(ua->jcr, ua->db, jr, prtit, ua, 0);
515 if (!get_cmd(ua, _("Enter the JobId to select: "))) {
518 jr->JobId = atoi(ua->cmd);
519 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
520 bsendmsg(ua, "%s", db_strerror(ua->db));
528 /* Scan what the user has entered looking for:
532 * if error or not found, put up a list of Jobs
535 * returns: 0 on error
536 * JobId on success and fills in JOB_DBR
538 int get_job_dbr(UAContext *ua, JOB_DBR *jr)
542 for (i=1; i<ua->argc; i++) {
543 if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
545 bstrncpy(jr->Job, ua->argv[i], sizeof(jr->Job));
546 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0 && ua->argv[i]) {
547 jr->JobId = atoi(ua->argv[i]);
551 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
552 bsendmsg(ua, _("Could not find Job %s: ERR=%s"), ua->argv[i],
553 db_strerror(ua->db));
560 if (!select_job_dbr(ua, jr)) { /* try once more */
567 * Implement unique set of prompts
569 void start_prompt(UAContext *ua, char *msg)
571 if (ua->max_prompts == 0) {
572 ua->max_prompts = 10;
573 ua->prompt = (char **)bmalloc(sizeof(char *) * ua->max_prompts);
576 ua->prompt[0] = bstrdup(msg);
580 * Add to prompts -- keeping them unique
582 void add_prompt(UAContext *ua, char *prompt)
585 if (ua->num_prompts == ua->max_prompts) {
586 ua->max_prompts *= 2;
587 ua->prompt = (char **)brealloc(ua->prompt, sizeof(char *) *
590 for (i=1; i < ua->num_prompts; i++) {
591 if (strcmp(ua->prompt[i], prompt) == 0) {
595 ua->prompt[ua->num_prompts++] = bstrdup(prompt);
599 * Display prompts and get user's choice
601 * Returns: -1 on error
602 * index base 0 on success, and choice
603 * is copied to prompt if not NULL
605 int do_prompt(UAContext *ua, char *msg, char *prompt, int max_prompt)
608 char pmsg[MAXSTRING];
610 bsendmsg(ua, ua->prompt[0]);
611 for (i=1; i < ua->num_prompts; i++) {
612 bsendmsg(ua, "%6d: %s\n", i, ua->prompt[i]);
620 /* First item is the prompt string, not the items */
621 if (ua->num_prompts == 1) {
622 bsendmsg(ua, _("Selection is empty!\n"));
623 item = 0; /* list is empty ! */
626 if (ua->num_prompts == 2) {
628 bsendmsg(ua, _("Item 1 selected automatically.\n"));
630 bstrncpy(prompt, ua->prompt[1], max_prompt);
634 sprintf(pmsg, "%s (1-%d): ", msg, ua->num_prompts-1);
636 /* Either a . or an @ will get you out of the loop */
637 if (!get_cmd(ua, pmsg) || *ua->cmd == '.' || *ua->cmd == '@') {
638 item = -1; /* error */
639 bsendmsg(ua, _("Selection aborted, nothing done.\n"));
642 item = atoi(ua->cmd);
643 if (item < 1 || item >= ua->num_prompts) {
644 bsendmsg(ua, _("Please enter a number between 1 and %d\n"), ua->num_prompts-1);
648 bstrncpy(prompt, ua->prompt[item], max_prompt);
653 for (i=0; i < ua->num_prompts; i++) {
662 * We scan what the user has entered looking for
663 * storage=<storage-resource>
666 * ? (prompt him with storage list)
667 * <some-error> (prompt him with storage list)
669 * If use_default is set, we assume that any keyword without a value
670 * is the name of the Storage resource wanted.
672 STORE *get_storage_resource(UAContext *ua, int use_default)
674 char *store_name = NULL;
681 for (i=1; i<ua->argc; i++) {
682 if (use_default && !ua->argv[i]) {
683 /* Default argument is storage */
685 bsendmsg(ua, _("Storage name given twice.\n"));
688 /* Ignore barcode(s) keywords */
689 if (strncasecmp("barcode", ua->argk[i], 7) == 0) {
692 store_name = ua->argk[i];
693 if (*store_name == '?') {
698 if (strcasecmp(ua->argk[i], _("storage")) == 0) {
699 store_name = ua->argv[i];
702 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
703 jobid = atoi(ua->argv[i]);
705 bsendmsg(ua, _("Expecting jobid=nn command, got: %s\n"), ua->argk[i]);
708 if (!(jcr=get_jcr_by_id(jobid))) {
709 bsendmsg(ua, _("JobId %d is not running.\n"), jobid);
716 } else if (strcasecmp(ua->argk[i], _("job")) == 0) {
717 if (!(jcr=get_jcr_by_partial_name(ua->argv[i]))) {
718 bsendmsg(ua, _("Job %s is not running.\n"), ua->argv[i]);
728 if (!store && store_name) {
729 store = (STORE *)GetResWithName(R_STORAGE, store_name);
731 bsendmsg(ua, "Storage resource %s: not found\n", store_name);
734 /* No keywords found, so present a selection list */
736 store = select_storage_resource(ua);
743 * Scan looking for mediatype=
745 * if not found or error, put up selection list
747 * Returns: 0 on error
748 * 1 on success, MediaType is set
750 int get_media_type(UAContext *ua, char *MediaType, int max_media)
754 static char *keyword[] = {
758 i = find_arg_keyword(ua, keyword);
759 if (i >= 0 && ua->argv[i]) {
760 bstrncpy(MediaType, ua->argv[i], max_media);
764 start_prompt(ua, _("Media Types defined in conf file:\n"));
766 for (store = NULL; (store = (STORE *)GetNextRes(R_STORAGE, (RES *)store)); ) {
767 add_prompt(ua, store->media_type);
770 return (do_prompt(ua, _("Select the Media Type"), MediaType, max_media) < 0) ? 0 : 1;