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 while ((store = (STORE *)GetNextRes(R_STORAGE, (RES *)store))) {
152 add_prompt(ua, store->hdr.name);
155 do_prompt(ua, _("Storage"), _("Select Storage resource"), name, sizeof(name));
156 store = (STORE *)GetResWithName(R_STORAGE, name);
161 * Select a FileSet resource from prompt list
163 FILESET *select_fileset_resource(UAContext *ua)
165 char name[MAX_NAME_LENGTH];
168 start_prompt(ua, _("The defined FileSet resources are:\n"));
170 while ((fs = (FILESET *)GetNextRes(R_FILESET, (RES *)fs))) {
171 add_prompt(ua, fs->hdr.name);
174 do_prompt(ua, _("FileSet"), _("Select FileSet resource"), name, sizeof(name));
175 fs = (FILESET *)GetResWithName(R_FILESET, name);
181 * Get a catalog resource from prompt list
183 CAT *get_catalog_resource(UAContext *ua)
185 char name[MAX_NAME_LENGTH];
189 for (i=1; i<ua->argc; i++) {
190 if (strcasecmp(ua->argk[i], _("catalog")) == 0 && ua->argv[i]) {
191 catalog = (CAT *)GetResWithName(R_CATALOG, ua->argv[i]);
196 start_prompt(ua, _("The defined Catalog resources are:\n"));
198 while ((catalog = (CAT *)GetNextRes(R_CATALOG, (RES *)catalog))) {
199 add_prompt(ua, catalog->hdr.name);
202 do_prompt(ua, _("Catalog"), _("Select Catalog resource"), name, sizeof(name));
203 catalog = (CAT *)GetResWithName(R_CATALOG, name);
210 * Select a Job resource from prompt list
212 JOB *select_job_resource(UAContext *ua)
214 char name[MAX_NAME_LENGTH];
217 start_prompt(ua, _("The defined Job resources are:\n"));
219 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
220 add_prompt(ua, job->hdr.name);
223 do_prompt(ua, _("Job"), _("Select Job resource"), name, sizeof(name));
224 job = (JOB *)GetResWithName(R_JOB, name);
229 * Select a Restore Job resource from prompt list
231 JOB *select_restore_job_resource(UAContext *ua)
233 char name[MAX_NAME_LENGTH];
236 start_prompt(ua, _("The defined Restore Job resources are:\n"));
238 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
239 if (job->JobType == JT_RESTORE) {
240 add_prompt(ua, job->hdr.name);
244 do_prompt(ua, _("Job"), _("Select Restore Job"), name, sizeof(name));
245 job = (JOB *)GetResWithName(R_JOB, name);
252 * Select a client resource from prompt list
254 CLIENT *select_client_resource(UAContext *ua)
256 char name[MAX_NAME_LENGTH];
257 CLIENT *client = NULL;
259 start_prompt(ua, _("The defined Client resources are:\n"));
261 while ( (client = (CLIENT *)GetNextRes(R_CLIENT, (RES *)client)) ) {
262 add_prompt(ua, client->hdr.name);
265 do_prompt(ua, _("Client"), _("Select Client (File daemon) resource"), name, sizeof(name));
266 client = (CLIENT *)GetResWithName(R_CLIENT, name);
271 * Get client resource, start by looking for
272 * client=<client-name>
273 * if we don't find the keyword, we prompt the user.
275 CLIENT *get_client_resource(UAContext *ua)
277 CLIENT *client = NULL;
280 for (i=1; i<ua->argc; i++) {
281 if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
282 client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[i]);
286 bsendmsg(ua, _("Error: Client resource %s does not exist.\n"), ua->argv[i]);
290 return select_client_resource(ua);
293 /* Scan what the user has entered looking for:
295 * client=<client-name>
297 * if error or not found, put up a list of client DBRs
300 * returns: 0 on error
301 * 1 on success and fills in CLIENT_DBR
303 int get_client_dbr(UAContext *ua, CLIENT_DBR *cr)
307 if (cr->Name[0]) { /* If name already supplied */
308 if (db_get_client_record(ua->jcr, ua->db, cr)) {
311 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), cr->Name, db_strerror(ua->db));
313 for (i=1; i<ua->argc; i++) {
314 if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
315 bstrncpy(cr->Name, ua->argv[i], sizeof(cr->Name));
316 if (!db_get_client_record(ua->jcr, ua->db, cr)) {
317 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), ua->argv[i],
318 db_strerror(ua->db));
325 if (!select_client_dbr(ua, cr)) { /* try once more by proposing a list */
332 * Select a Client record from the catalog
333 * Returns 1 on success
336 int select_client_dbr(UAContext *ua, CLIENT_DBR *cr)
339 char name[MAX_NAME_LENGTH];
345 if (!db_get_client_ids(ua->jcr, ua->db, &num_clients, &ids)) {
346 bsendmsg(ua, _("Error obtaining client ids. ERR=%s\n"), db_strerror(ua->db));
349 if (num_clients <= 0) {
350 bsendmsg(ua, _("No clients defined. You must run a job before using this command.\n"));
354 start_prompt(ua, _("Defined Clients:\n"));
355 for (i=0; i < num_clients; i++) {
356 ocr.ClientId = ids[i];
357 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
360 add_prompt(ua, ocr.Name);
363 if (do_prompt(ua, _("Client"), _("Select the Client"), name, sizeof(name)) < 0) {
366 memset(&ocr, 0, sizeof(ocr));
367 bstrncpy(ocr.Name, name, sizeof(ocr.Name));
369 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
370 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), name, db_strerror(ua->db));
373 memcpy(cr, &ocr, sizeof(ocr));
379 /* Scan what the user has entered looking for:
383 * if error or not found, put up a list of pool DBRs
386 * returns: 0 on error
387 * 1 on success and fills in POOL_DBR
389 int get_pool_dbr(UAContext *ua, POOL_DBR *pr)
391 if (pr->Name[0]) { /* If name already supplied */
392 if (db_get_pool_record(ua->jcr, ua->db, pr)) {
395 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), pr->Name, db_strerror(ua->db));
397 if (!select_pool_dbr(ua, pr)) { /* try once more */
404 * Select a Pool record from the catalog
406 int select_pool_dbr(UAContext *ua, POOL_DBR *pr)
409 char name[MAX_NAME_LENGTH];
413 for (i=1; i<ua->argc; i++) {
414 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
415 bstrncpy(pr->Name, ua->argv[i], sizeof(pr->Name));
416 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
417 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), ua->argv[i],
418 db_strerror(ua->db));
427 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
428 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"), db_strerror(ua->db));
431 if (num_pools <= 0) {
432 bsendmsg(ua, _("No pools defined. Use the \"create\" command to create one.\n"));
436 start_prompt(ua, _("Defined Pools:\n"));
437 for (i=0; i < num_pools; i++) {
439 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
442 add_prompt(ua, opr.Name);
445 if (do_prompt(ua, _("Pool"), _("Select the Pool"), name, sizeof(name)) < 0) {
448 memset(&opr, 0, sizeof(opr));
449 bstrncpy(opr.Name, name, sizeof(opr.Name));
451 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
452 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), name, db_strerror(ua->db));
455 memcpy(pr, &opr, sizeof(opr));
460 * Select a Pool and a Media (Volume) record from the database
462 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr)
465 if (!select_media_dbr(ua, mr)) {
468 memset(pr, 0, sizeof(POOL_DBR));
469 pr->PoolId = mr->PoolId;
470 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
471 bsendmsg(ua, "%s", db_strerror(ua->db));
477 /* Select a Media (Volume) record from the database */
478 int select_media_dbr(UAContext *ua, MEDIA_DBR *mr)
482 memset(mr, 0, sizeof(MEDIA_DBR));
484 i = find_arg_with_value(ua, "volume");
486 bstrncpy(mr->VolumeName, ua->argv[i], sizeof(mr->VolumeName));
488 if (mr->VolumeName[0] == 0) {
490 memset(&pr, 0, sizeof(pr));
491 /* Get the pool from pool=<pool-name> */
492 if (!get_pool_dbr(ua, &pr)) {
495 mr->PoolId = pr.PoolId;
496 db_list_media_records(ua->jcr, ua->db, mr, prtit, ua, HORZ_LIST);
497 if (!get_cmd(ua, _("Enter MediaId or Volume name: "))) {
500 if (is_a_number(ua->cmd)) {
501 mr->MediaId = atoi(ua->cmd);
503 bstrncpy(mr->VolumeName, ua->cmd, sizeof(mr->VolumeName));
507 if (!db_get_media_record(ua->jcr, ua->db, mr)) {
508 bsendmsg(ua, "%s", db_strerror(ua->db));
516 * Select a pool resource from prompt list
518 POOL *select_pool_resource(UAContext *ua)
520 char name[MAX_NAME_LENGTH];
523 start_prompt(ua, _("The defined Pool resources are:\n"));
525 while ((pool = (POOL *)GetNextRes(R_POOL, (RES *)pool))) {
526 add_prompt(ua, pool->hdr.name);
529 do_prompt(ua, _("Pool"), _("Select Pool resource"), name, sizeof(name));
530 pool = (POOL *)GetResWithName(R_POOL, name);
536 * If you are thinking about using it, you
537 * probably want to use select_pool_dbr()
538 * or get_pool_dbr() above.
540 POOL *get_pool_resource(UAContext *ua)
545 i = find_arg_with_value(ua, "pool");
547 pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
551 bsendmsg(ua, _("Error: Pool resource %s does not exist.\n"), ua->argv[i]);
553 return select_pool_resource(ua);
557 * List all jobs and ask user to select one
559 int select_job_dbr(UAContext *ua, JOB_DBR *jr)
561 db_list_job_records(ua->jcr, ua->db, jr, prtit, ua, HORZ_LIST);
562 if (!get_pint(ua, _("Enter the JobId to select: "))) {
565 jr->JobId = ua->pint32_val;
566 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
567 bsendmsg(ua, "%s", db_strerror(ua->db));
575 /* Scan what the user has entered looking for:
579 * if error or not found, put up a list of Jobs
582 * returns: 0 on error
583 * JobId on success and fills in JOB_DBR
585 int get_job_dbr(UAContext *ua, JOB_DBR *jr)
589 for (i=1; i<ua->argc; i++) {
590 if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
592 bstrncpy(jr->Job, ua->argv[i], sizeof(jr->Job));
593 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0 && ua->argv[i]) {
594 jr->JobId = atoi(ua->argv[i]);
598 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
599 bsendmsg(ua, _("Could not find Job %s: ERR=%s"), ua->argv[i],
600 db_strerror(ua->db));
607 if (!select_job_dbr(ua, jr)) { /* try once more */
614 * Implement unique set of prompts
616 void start_prompt(UAContext *ua, char *msg)
618 if (ua->max_prompts == 0) {
619 ua->max_prompts = 10;
620 ua->prompt = (char **)bmalloc(sizeof(char *) * ua->max_prompts);
623 ua->prompt[0] = bstrdup(msg);
627 * Add to prompts -- keeping them unique
629 void add_prompt(UAContext *ua, char *prompt)
632 if (ua->num_prompts == ua->max_prompts) {
633 ua->max_prompts *= 2;
634 ua->prompt = (char **)brealloc(ua->prompt, sizeof(char *) *
637 for (i=1; i < ua->num_prompts; i++) {
638 if (strcmp(ua->prompt[i], prompt) == 0) {
642 ua->prompt[ua->num_prompts++] = bstrdup(prompt);
646 * Display prompts and get user's choice
648 * Returns: -1 on error
649 * index base 0 on success, and choice
650 * is copied to prompt if not NULL
652 int do_prompt(UAContext *ua, char *automsg, char *msg, char *prompt, int max_prompt)
655 char pmsg[MAXSTRING];
657 if (ua->num_prompts == 2) {
660 bstrncpy(prompt, ua->prompt[1], max_prompt);
662 bsendmsg(ua, _("Automatically selected %s: %s\n"), automsg, ua->prompt[1]);
665 bsendmsg(ua, ua->prompt[0]);
666 for (i=1; i < ua->num_prompts; i++) {
667 bsendmsg(ua, "%6d: %s\n", i, ua->prompt[i]);
675 /* First item is the prompt string, not the items */
676 if (ua->num_prompts == 1) {
677 bsendmsg(ua, _("Selection is empty!\n"));
678 item = 0; /* list is empty ! */
681 if (ua->num_prompts == 2) {
683 bsendmsg(ua, _("Item 1 selected automatically.\n"));
685 bstrncpy(prompt, ua->prompt[1], max_prompt);
689 sprintf(pmsg, "%s (1-%d): ", msg, ua->num_prompts-1);
691 /* Either a . or an @ will get you out of the loop */
692 if (!get_pint(ua, pmsg)) {
693 item = -1; /* error */
694 bsendmsg(ua, _("Selection aborted, nothing done.\n"));
697 item = ua->pint32_val;
698 if (item < 1 || item >= ua->num_prompts) {
699 bsendmsg(ua, _("Please enter a number between 1 and %d\n"), ua->num_prompts-1);
703 bstrncpy(prompt, ua->prompt[item], max_prompt);
709 for (i=0; i < ua->num_prompts; i++) {
718 * We scan what the user has entered looking for
719 * storage=<storage-resource>
722 * ? (prompt him with storage list)
723 * <some-error> (prompt him with storage list)
725 * If use_default is set, we assume that any keyword without a value
726 * is the name of the Storage resource wanted.
728 STORE *get_storage_resource(UAContext *ua, int use_default)
730 char *store_name = NULL;
737 for (i=1; i<ua->argc; i++) {
738 if (use_default && !ua->argv[i]) {
739 /* Default argument is storage */
741 bsendmsg(ua, _("Storage name given twice.\n"));
744 /* Ignore barcode(s) keywords */
745 if (strncasecmp("barcode", ua->argk[i], 7) == 0) {
748 store_name = ua->argk[i];
749 if (*store_name == '?') {
754 if (strcasecmp(ua->argk[i], _("storage")) == 0) {
755 store_name = ua->argv[i];
758 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
759 jobid = atoi(ua->argv[i]);
761 bsendmsg(ua, _("Expecting jobid=nn command, got: %s\n"), ua->argk[i]);
764 if (!(jcr=get_jcr_by_id(jobid))) {
765 bsendmsg(ua, _("JobId %d is not running.\n"), jobid);
772 } else if (strcasecmp(ua->argk[i], _("job")) == 0) {
773 if (!(jcr=get_jcr_by_partial_name(ua->argv[i]))) {
774 bsendmsg(ua, _("Job %s is not running.\n"), ua->argv[i]);
784 if (!store && store_name) {
785 store = (STORE *)GetResWithName(R_STORAGE, store_name);
787 bsendmsg(ua, "Storage resource %s: not found\n", store_name);
790 /* No keywords found, so present a selection list */
792 store = select_storage_resource(ua);
799 * Scan looking for mediatype=
801 * if not found or error, put up selection list
803 * Returns: 0 on error
804 * 1 on success, MediaType is set
806 int get_media_type(UAContext *ua, char *MediaType, int max_media)
811 i = find_arg_with_value(ua, "mediatype");
813 bstrncpy(MediaType, ua->argv[i], max_media);
817 start_prompt(ua, _("Media Types defined in conf file:\n"));
819 for (store = NULL; (store = (STORE *)GetNextRes(R_STORAGE, (RES *)store)); ) {
820 add_prompt(ua, store->media_type);
823 return (do_prompt(ua, _("Media Type"), _("Select the Media Type"), MediaType, max_media) < 0) ? 0 : 1;