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)
78 for (i=1; i<ua->argc; i++) {
79 for(j=0; list[j]; j++) {
80 if (strcasecmp(_(list[j]), ua->argk[i]) == 0) {
89 * Given a single keyword, find it in the argument list.
90 * Returns: -1 if not found
91 * list index (base 0) on success
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) {
103 int find_arg_with_value(UAContext *ua, char *keyword)
105 for (int i=1; i<ua->argc; i++) {
106 if (strcasecmp(keyword, ua->argk[i]) == 0) {
120 * Given a list of keywords, prompt the user
123 * Returns: -1 on failure
124 * index into list (base 0) on success
126 int do_keyword_prompt(UAContext *ua, char *msg, char **list)
129 start_prompt(ua, _("You have the following choices:\n"));
130 for (i=0; list[i]; i++) {
131 add_prompt(ua, list[i]);
133 return do_prompt(ua, msg, NULL, 0);
138 * Select a Storage resource from prompt list
140 STORE *select_storage_resource(UAContext *ua)
142 char name[MAX_NAME_LENGTH];
145 start_prompt(ua, _("The defined Storage resources are:\n"));
147 while ((store = (STORE *)GetNextRes(R_STORAGE, (RES *)store))) {
148 add_prompt(ua, store->hdr.name);
151 do_prompt(ua, _("Select Storage resource"), name, sizeof(name));
152 store = (STORE *)GetResWithName(R_STORAGE, name);
157 * Select a FileSet resource from prompt list
159 FILESET *select_fileset_resource(UAContext *ua)
161 char name[MAX_NAME_LENGTH];
164 start_prompt(ua, _("The defined FileSet resources are:\n"));
166 while ((fs = (FILESET *)GetNextRes(R_FILESET, (RES *)fs))) {
167 add_prompt(ua, fs->hdr.name);
170 do_prompt(ua, _("Select FileSet resource"), name, sizeof(name));
171 fs = (FILESET *)GetResWithName(R_FILESET, name);
177 * Get a catalog resource from prompt list
179 CAT *get_catalog_resource(UAContext *ua)
181 char name[MAX_NAME_LENGTH];
185 for (i=1; i<ua->argc; i++) {
186 if (strcasecmp(ua->argk[i], _("catalog")) == 0 && ua->argv[i]) {
187 catalog = (CAT *)GetResWithName(R_CATALOG, ua->argv[i]);
192 start_prompt(ua, _("The defined Catalog resources are:\n"));
194 while ((catalog = (CAT *)GetNextRes(R_CATALOG, (RES *)catalog))) {
195 add_prompt(ua, catalog->hdr.name);
198 do_prompt(ua, _("Select Catalog resource"), name, sizeof(name));
199 catalog = (CAT *)GetResWithName(R_CATALOG, name);
206 * Select a Job resource from prompt list
208 JOB *select_job_resource(UAContext *ua)
210 char name[MAX_NAME_LENGTH];
213 start_prompt(ua, _("The defined Job resources are:\n"));
215 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
216 add_prompt(ua, job->hdr.name);
219 do_prompt(ua, _("Select Job resource"), name, sizeof(name));
220 job = (JOB *)GetResWithName(R_JOB, name);
225 * Select a Restore Job resource from prompt list
227 JOB *select_restore_job_resource(UAContext *ua)
229 char name[MAX_NAME_LENGTH];
232 start_prompt(ua, _("The defined Restore Job resources are:\n"));
234 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
235 if (job->JobType == JT_RESTORE) {
236 add_prompt(ua, job->hdr.name);
240 do_prompt(ua, _("Select Restore Job"), name, sizeof(name));
241 job = (JOB *)GetResWithName(R_JOB, name);
248 * Select a client resource from prompt list
250 CLIENT *select_client_resource(UAContext *ua)
252 char name[MAX_NAME_LENGTH];
253 CLIENT *client = NULL;
255 start_prompt(ua, _("The defined Client resources are:\n"));
257 while ( (client = (CLIENT *)GetNextRes(R_CLIENT, (RES *)client)) ) {
258 add_prompt(ua, client->hdr.name);
261 do_prompt(ua, _("Select Client (File daemon) resource"), name, sizeof(name));
262 client = (CLIENT *)GetResWithName(R_CLIENT, name);
267 * Get client resource, start by looking for
268 * client=<client-name>
269 * if we don't find the keyword, we prompt the user.
271 CLIENT *get_client_resource(UAContext *ua)
273 CLIENT *client = NULL;
276 for (i=1; i<ua->argc; i++) {
277 if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
278 client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[i]);
282 bsendmsg(ua, _("Error: Client resource %s does not exist.\n"), ua->argv[i]);
286 return select_client_resource(ua);
289 /* Scan what the user has entered looking for:
291 * client=<client-name>
293 * if error or not found, put up a list of client DBRs
296 * returns: 0 on error
297 * 1 on success and fills in CLIENT_DBR
299 int get_client_dbr(UAContext *ua, CLIENT_DBR *cr)
303 if (cr->Name[0]) { /* If name already supplied */
304 if (db_get_client_record(ua->jcr, ua->db, cr)) {
307 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), cr->Name, db_strerror(ua->db));
309 for (i=1; i<ua->argc; i++) {
310 if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
311 bstrncpy(cr->Name, ua->argv[i], sizeof(cr->Name));
312 if (!db_get_client_record(ua->jcr, ua->db, cr)) {
313 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), ua->argv[i],
314 db_strerror(ua->db));
321 if (!select_client_dbr(ua, cr)) { /* try once more by proposing a list */
328 * Select a Client record from the catalog
329 * Returns 1 on success
332 int select_client_dbr(UAContext *ua, CLIENT_DBR *cr)
335 char name[MAX_NAME_LENGTH];
341 if (!db_get_client_ids(ua->jcr, ua->db, &num_clients, &ids)) {
342 bsendmsg(ua, _("Error obtaining client ids. ERR=%s\n"), db_strerror(ua->db));
345 if (num_clients <= 0) {
346 bsendmsg(ua, _("No clients defined. Run a job to create one.\n"));
350 start_prompt(ua, _("Defined Clients:\n"));
351 for (i=0; i < num_clients; i++) {
352 ocr.ClientId = ids[i];
353 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
356 add_prompt(ua, ocr.Name);
359 if (do_prompt(ua, _("Select the Client"), name, sizeof(name)) < 0) {
362 memset(&ocr, 0, sizeof(ocr));
363 bstrncpy(ocr.Name, name, sizeof(ocr.Name));
365 if (!db_get_client_record(ua->jcr, ua->db, &ocr)) {
366 bsendmsg(ua, _("Could not find Client %s: ERR=%s"), name, db_strerror(ua->db));
369 memcpy(cr, &ocr, sizeof(ocr));
375 /* Scan what the user has entered looking for:
379 * if error or not found, put up a list of pool DBRs
382 * returns: 0 on error
383 * 1 on success and fills in POOL_DBR
385 int get_pool_dbr(UAContext *ua, POOL_DBR *pr)
387 if (pr->Name[0]) { /* If name already supplied */
388 if (db_get_pool_record(ua->jcr, ua->db, pr)) {
391 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), pr->Name, db_strerror(ua->db));
393 if (!select_pool_dbr(ua, pr)) { /* try once more */
400 * Select a Pool record from the catalog
402 int select_pool_dbr(UAContext *ua, POOL_DBR *pr)
405 char name[MAX_NAME_LENGTH];
409 for (i=1; i<ua->argc; i++) {
410 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
411 bstrncpy(pr->Name, ua->argv[i], sizeof(pr->Name));
412 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
413 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), ua->argv[i],
414 db_strerror(ua->db));
423 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
424 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"), db_strerror(ua->db));
427 if (num_pools <= 0) {
428 bsendmsg(ua, _("No pools defined. Use the \"create\" command to create one.\n"));
432 start_prompt(ua, _("Defined Pools:\n"));
433 for (i=0; i < num_pools; i++) {
435 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
438 add_prompt(ua, opr.Name);
441 if (do_prompt(ua, _("Select the Pool"), name, sizeof(name)) < 0) {
444 memset(&opr, 0, sizeof(opr));
445 bstrncpy(opr.Name, name, sizeof(opr.Name));
447 if (!db_get_pool_record(ua->jcr, ua->db, &opr)) {
448 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), name, db_strerror(ua->db));
451 memcpy(pr, &opr, sizeof(opr));
456 * Select a Pool and a Media (Volume) record from the database
458 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr)
461 if (!select_media_dbr(ua, mr)) {
464 memset(pr, 0, sizeof(POOL_DBR));
465 pr->PoolId = mr->PoolId;
466 if (!db_get_pool_record(ua->jcr, ua->db, pr)) {
467 bsendmsg(ua, "%s", db_strerror(ua->db));
473 /* Select a Media (Volume) record from the database */
474 int select_media_dbr(UAContext *ua, MEDIA_DBR *mr)
478 memset(mr, 0, sizeof(MEDIA_DBR));
480 i = find_arg_with_value(ua, "volume");
482 bstrncpy(mr->VolumeName, ua->argv[i], sizeof(mr->VolumeName));
484 if (mr->VolumeName[0] == 0) {
486 memset(&pr, 0, sizeof(pr));
487 /* Get the pool from pool=<pool-name> */
488 if (!get_pool_dbr(ua, &pr)) {
491 mr->PoolId = pr.PoolId;
492 db_list_media_records(ua->jcr, ua->db, mr, prtit, ua, 0);
493 if (!get_cmd(ua, _("Enter MediaId or Volume name: "))) {
496 if (is_a_number(ua->cmd)) {
497 mr->MediaId = atoi(ua->cmd);
499 bstrncpy(mr->VolumeName, ua->cmd, sizeof(mr->VolumeName));
503 if (!db_get_media_record(ua->jcr, ua->db, mr)) {
504 bsendmsg(ua, "%s", db_strerror(ua->db));
512 * Select a pool resource from prompt list
514 POOL *select_pool_resource(UAContext *ua)
516 char name[MAX_NAME_LENGTH];
519 start_prompt(ua, _("The defined Pool resources are:\n"));
521 while ((pool = (POOL *)GetNextRes(R_POOL, (RES *)pool))) {
522 add_prompt(ua, pool->hdr.name);
525 do_prompt(ua, _("Select Pool resource"), name, sizeof(name));
526 pool = (POOL *)GetResWithName(R_POOL, name);
532 * If you are thinking about using it, you
533 * probably want to use select_pool_dbr()
534 * or get_pool_dbr() above.
536 POOL *get_pool_resource(UAContext *ua)
541 i = find_arg_with_value(ua, "pool");
543 pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
547 bsendmsg(ua, _("Error: Pool resource %s does not exist.\n"), ua->argv[i]);
549 return select_pool_resource(ua);
553 * List all jobs and ask user to select one
555 int select_job_dbr(UAContext *ua, JOB_DBR *jr)
557 db_list_job_records(ua->jcr, ua->db, jr, prtit, ua, 0);
558 if (!get_pint(ua, _("Enter the JobId to select: "))) {
561 jr->JobId = ua->pint32_val;
562 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
563 bsendmsg(ua, "%s", db_strerror(ua->db));
571 /* Scan what the user has entered looking for:
575 * if error or not found, put up a list of Jobs
578 * returns: 0 on error
579 * JobId on success and fills in JOB_DBR
581 int get_job_dbr(UAContext *ua, JOB_DBR *jr)
585 for (i=1; i<ua->argc; i++) {
586 if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
588 bstrncpy(jr->Job, ua->argv[i], sizeof(jr->Job));
589 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0 && ua->argv[i]) {
590 jr->JobId = atoi(ua->argv[i]);
594 if (!db_get_job_record(ua->jcr, ua->db, jr)) {
595 bsendmsg(ua, _("Could not find Job %s: ERR=%s"), ua->argv[i],
596 db_strerror(ua->db));
603 if (!select_job_dbr(ua, jr)) { /* try once more */
610 * Implement unique set of prompts
612 void start_prompt(UAContext *ua, char *msg)
614 if (ua->max_prompts == 0) {
615 ua->max_prompts = 10;
616 ua->prompt = (char **)bmalloc(sizeof(char *) * ua->max_prompts);
619 ua->prompt[0] = bstrdup(msg);
623 * Add to prompts -- keeping them unique
625 void add_prompt(UAContext *ua, char *prompt)
628 if (ua->num_prompts == ua->max_prompts) {
629 ua->max_prompts *= 2;
630 ua->prompt = (char **)brealloc(ua->prompt, sizeof(char *) *
633 for (i=1; i < ua->num_prompts; i++) {
634 if (strcmp(ua->prompt[i], prompt) == 0) {
638 ua->prompt[ua->num_prompts++] = bstrdup(prompt);
642 * Display prompts and get user's choice
644 * Returns: -1 on error
645 * index base 0 on success, and choice
646 * is copied to prompt if not NULL
648 int do_prompt(UAContext *ua, char *msg, char *prompt, int max_prompt)
651 char pmsg[MAXSTRING];
653 if (ua->num_prompts == 2) {
656 bstrncpy(prompt, ua->prompt[1], max_prompt);
658 bsendmsg(ua, _("Automatically selected: %s\n"), ua->prompt[1]);
661 bsendmsg(ua, ua->prompt[0]);
662 for (i=1; i < ua->num_prompts; i++) {
663 bsendmsg(ua, "%6d: %s\n", i, ua->prompt[i]);
671 /* First item is the prompt string, not the items */
672 if (ua->num_prompts == 1) {
673 bsendmsg(ua, _("Selection is empty!\n"));
674 item = 0; /* list is empty ! */
677 if (ua->num_prompts == 2) {
679 bsendmsg(ua, _("Item 1 selected automatically.\n"));
681 bstrncpy(prompt, ua->prompt[1], max_prompt);
685 sprintf(pmsg, "%s (1-%d): ", msg, ua->num_prompts-1);
687 /* Either a . or an @ will get you out of the loop */
688 if (!get_pint(ua, pmsg)) {
689 item = -1; /* error */
690 bsendmsg(ua, _("Selection aborted, nothing done.\n"));
693 item = ua->pint32_val;
694 if (item < 1 || item >= ua->num_prompts) {
695 bsendmsg(ua, _("Please enter a number between 1 and %d\n"), ua->num_prompts-1);
699 bstrncpy(prompt, ua->prompt[item], max_prompt);
705 for (i=0; i < ua->num_prompts; i++) {
714 * We scan what the user has entered looking for
715 * storage=<storage-resource>
718 * ? (prompt him with storage list)
719 * <some-error> (prompt him with storage list)
721 * If use_default is set, we assume that any keyword without a value
722 * is the name of the Storage resource wanted.
724 STORE *get_storage_resource(UAContext *ua, int use_default)
726 char *store_name = NULL;
733 for (i=1; i<ua->argc; i++) {
734 if (use_default && !ua->argv[i]) {
735 /* Default argument is storage */
737 bsendmsg(ua, _("Storage name given twice.\n"));
740 /* Ignore barcode(s) keywords */
741 if (strncasecmp("barcode", ua->argk[i], 7) == 0) {
744 store_name = ua->argk[i];
745 if (*store_name == '?') {
750 if (strcasecmp(ua->argk[i], _("storage")) == 0) {
751 store_name = ua->argv[i];
754 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
755 jobid = atoi(ua->argv[i]);
757 bsendmsg(ua, _("Expecting jobid=nn command, got: %s\n"), ua->argk[i]);
760 if (!(jcr=get_jcr_by_id(jobid))) {
761 bsendmsg(ua, _("JobId %d is not running.\n"), jobid);
768 } else if (strcasecmp(ua->argk[i], _("job")) == 0) {
769 if (!(jcr=get_jcr_by_partial_name(ua->argv[i]))) {
770 bsendmsg(ua, _("Job %s is not running.\n"), ua->argv[i]);
780 if (!store && store_name) {
781 store = (STORE *)GetResWithName(R_STORAGE, store_name);
783 bsendmsg(ua, "Storage resource %s: not found\n", store_name);
786 /* No keywords found, so present a selection list */
788 store = select_storage_resource(ua);
795 * Scan looking for mediatype=
797 * if not found or error, put up selection list
799 * Returns: 0 on error
800 * 1 on success, MediaType is set
802 int get_media_type(UAContext *ua, char *MediaType, int max_media)
807 i = find_arg_with_value(ua, "mediatype");
809 bstrncpy(MediaType, ua->argv[i], max_media);
813 start_prompt(ua, _("Media Types defined in conf file:\n"));
815 for (store = NULL; (store = (STORE *)GetNextRes(R_STORAGE, (RES *)store)); ) {
816 add_prompt(ua, store->media_type);
819 return (do_prompt(ua, _("Select the Media Type"), MediaType, max_media) < 0) ? 0 : 1;