3 * Bacula Director -- User Agent Prompt and Selection code
5 * Kern Sibbald, October MMI
11 Copyright (C) 2000, 2001, 2002 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,
35 /* Imported variables */
38 /* Exported functions */
40 int do_prompt(UAContext *ua, char *msg, char *prompt);
41 void add_prompt(UAContext *ua, char *prompt);
42 void start_prompt(UAContext *ua, char *msg);
43 STORE *select_storage_resource(UAContext *ua);
44 JOB *select_job_resource(UAContext *ua);
47 * Confirm a retention period
49 int confirm_retention(UAContext *ua, btime_t *ret, char *msg)
54 bsendmsg(ua, _("The current %s retention period is: %s\n"),
55 msg, edit_btime(*ret, ed1));
56 if (!get_cmd(ua, _("Continue? (yes/mod/no): "))) {
59 if (strcasecmp(ua->cmd, _("mod")) == 0) {
60 if (!get_cmd(ua, _("Enter new retention period: "))) {
63 if (!string_to_btime(ua->cmd, ret)) {
64 bsendmsg(ua, _("Invalid period.\n"));
69 if (strcasecmp(ua->cmd, _("yes")) == 0) {
77 * Given a list of keywords, find the first one
78 * that is in the argument list.
79 * Returns: -1 if not found
80 * index into list (base 0) on success
82 int find_arg_keyword(UAContext *ua, char **list)
85 for (i=1; i<ua->argc; i++) {
86 for(j=0; list[j]; j++) {
87 if (strcasecmp(_(list[j]), ua->argk[i]) == 0) {
96 * Given a list of keywords, prompt the user
99 * Returns: -1 on failure
100 * index into list (base 0) on success
102 int do_keyword_prompt(UAContext *ua, char *msg, char **list)
105 start_prompt(ua, _("You have the following choices:\n"));
106 for (i=0; list[i]; i++) {
107 add_prompt(ua, list[i]);
109 return do_prompt(ua, msg, NULL);
114 * Select a Storage resource from prompt list
116 STORE *select_storage_resource(UAContext *ua)
118 char name[MAX_NAME_LENGTH];
121 start_prompt(ua, _("The defined Storage resources are:\n"));
123 while ((store = (STORE *)GetNextRes(R_STORAGE, (RES *)store))) {
124 add_prompt(ua, store->hdr.name);
127 do_prompt(ua, _("Select Storage resource"), name);
128 store = (STORE *)GetResWithName(R_STORAGE, name);
133 * Select a FileSet resource from prompt list
135 FILESET *select_fileset_resource(UAContext *ua)
137 char name[MAX_NAME_LENGTH];
140 start_prompt(ua, _("The defined FileSet resources are:\n"));
142 while ((fs = (FILESET *)GetNextRes(R_FILESET, (RES *)fs))) {
143 add_prompt(ua, fs->hdr.name);
146 do_prompt(ua, _("Select FileSet resource"), name);
147 fs = (FILESET *)GetResWithName(R_FILESET, name);
153 * Get a catalog resource from prompt list
155 CAT *get_catalog_resource(UAContext *ua)
157 char name[MAX_NAME_LENGTH];
161 for (i=1; i<ua->argc; i++) {
162 if (strcasecmp(ua->argk[i], _("catalog")) == 0 && ua->argv[i]) {
163 catalog = (CAT *)GetResWithName(R_CATALOG, ua->argv[i]);
168 start_prompt(ua, _("The defined Catalog resources are:\n"));
170 while ((catalog = (CAT *)GetNextRes(R_CATALOG, (RES *)catalog))) {
171 add_prompt(ua, catalog->hdr.name);
174 do_prompt(ua, _("Select Catalog resource"), name);
175 catalog = (CAT *)GetResWithName(R_CATALOG, name);
182 * Select a Job resource from prompt list
184 JOB *select_job_resource(UAContext *ua)
186 char name[MAX_NAME_LENGTH];
189 start_prompt(ua, _("The defined Job resources are:\n"));
191 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
192 add_prompt(ua, job->hdr.name);
195 do_prompt(ua, _("Select Job resource"), name);
196 job = (JOB *)GetResWithName(R_JOB, name);
201 * Select a Restore Job resource from prompt list
203 JOB *select_restore_job_resource(UAContext *ua)
205 char name[MAX_NAME_LENGTH];
208 start_prompt(ua, _("The defined Restore Job resources are:\n"));
210 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
211 if (job->JobType == JT_RESTORE) {
212 add_prompt(ua, job->hdr.name);
216 do_prompt(ua, _("Select Restore Job"), name);
217 job = (JOB *)GetResWithName(R_JOB, name);
224 * Select a client resource from prompt list
226 CLIENT *select_client_resource(UAContext *ua)
228 char name[MAX_NAME_LENGTH];
229 CLIENT *client = NULL;
231 start_prompt(ua, _("The defined Client resources are:\n"));
233 while ( (client = (CLIENT *)GetNextRes(R_CLIENT, (RES *)client)) ) {
234 add_prompt(ua, client->hdr.name);
237 do_prompt(ua, _("Select Client (File daemon) resource"), name);
238 client = (CLIENT *)GetResWithName(R_CLIENT, name);
243 * Get client resource, start by looking for
244 * client=<client-name>
245 * if we don't find the keyword, we prompt the user.
247 CLIENT *get_client_resource(UAContext *ua)
249 CLIENT *client = NULL;
252 for (i=1; i<ua->argc; i++) {
253 if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
254 client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[i]);
258 bsendmsg(ua, _("Error: Client resource %s does not exist.\n"), ua->argv[i]);
262 return select_client_resource(ua);
265 /* Scan what the user has entered looking for:
269 * if error or not found, put up a list of pool DBRs
272 * returns: 0 on error
273 * poolid on success and fills in POOL_DBR
275 int get_pool_dbr(UAContext *ua, POOL_DBR *pr)
279 if (pr->Name[0]) { /* If name already supplied */
280 if (db_get_pool_record(ua->db, pr)) {
283 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), pr->Name, db_strerror(ua->db));
285 for (i=1; i<ua->argc; i++) {
286 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
287 strcpy(pr->Name, ua->argv[i]);
288 if (!db_get_pool_record(ua->db, pr)) {
289 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), ua->argv[i],
290 db_strerror(ua->db));
297 if (!select_pool_dbr(ua, pr)) { /* try once more */
304 * Select a Pool record from the catalog
306 int select_pool_dbr(UAContext *ua, POOL_DBR *pr)
309 char name[MAX_NAME_LENGTH];
315 if (!db_get_pool_ids(ua->db, &num_pools, &ids)) {
316 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"), db_strerror(ua->db));
319 if (num_pools <= 0) {
320 bsendmsg(ua, _("No pools defined. Use the \"create\" command to create one.\n"));
324 start_prompt(ua, _("Defined Pools:\n"));
325 for (i=0; i < num_pools; i++) {
327 if (!db_get_pool_record(ua->db, &opr)) {
330 add_prompt(ua, opr.Name);
333 if (do_prompt(ua, _("Select the Pool"), name) < 0) {
336 memset(&opr, 0, sizeof(pr));
337 strcpy(opr.Name, name);
339 if (!db_get_pool_record(ua->db, &opr)) {
340 bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), name, db_strerror(ua->db));
343 memcpy(pr, &opr, sizeof(opr));
348 * Select a Pool and a Media (Volume) record from the database
350 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr)
353 static char *kw[] = {
357 memset(pr, 0, sizeof(POOL_DBR));
358 memset(mr, 0, sizeof(MEDIA_DBR));
360 /* Get the pool, possibly from pool=<pool-name> */
361 if (!get_pool_dbr(ua, pr)) {
364 mr->PoolId = pr->PoolId;
366 i = find_arg_keyword(ua, kw);
367 if (i == 0 && ua->argv[i]) {
368 strcpy(mr->VolumeName, ua->argv[i]);
370 if (mr->VolumeName[0] == 0) {
371 db_list_media_records(ua->db, mr, prtit, ua);
372 if (!get_cmd(ua, _("Enter MediaId or Volume name to update: "))) {
375 if (is_a_number(ua->cmd)) {
376 mr->MediaId = atoi(ua->cmd);
378 strcpy(mr->VolumeName, ua->cmd);
382 if (!db_get_media_record(ua->db, mr)) {
383 bsendmsg(ua, "%s", db_strerror(ua->db));
391 * This routine is ONLY used in the create command.
392 * If you are thinking about using it, you
393 * probably want to use select_pool_dbr()
394 * or get_pool_dbr() above.
396 POOL *get_pool_resource(UAContext *ua)
399 char name[MAX_NAME_LENGTH];
402 for (i=1; i<ua->argc; i++) {
403 if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
404 pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
408 bsendmsg(ua, _("Error: Pool resource %s does not exist.\n"), ua->argv[i]);
412 start_prompt(ua, _("The defined Pool resources are:\n"));
414 while ((pool = (POOL *)GetNextRes(R_POOL, (RES *)pool))) {
415 add_prompt(ua, pool->hdr.name);
418 do_prompt(ua, _("Select Pool resource"), name);
419 pool = (POOL *)GetResWithName(R_POOL, name);
424 * List all jobs and ask user to select one
426 int select_job_dbr(UAContext *ua, JOB_DBR *jr)
428 db_list_job_records(ua->db, jr, prtit, ua);
429 if (!get_cmd(ua, _("Enter the JobId to select: "))) {
432 jr->JobId = atoi(ua->cmd);
433 if (!db_get_job_record(ua->db, jr)) {
434 bsendmsg(ua, "%s", db_strerror(ua->db));
442 /* Scan what the user has entered looking for:
446 * if error or not found, put up a list of Jobs
449 * returns: 0 on error
450 * JobId on success and fills in JOB_DBR
452 int get_job_dbr(UAContext *ua, JOB_DBR *jr)
456 for (i=1; i<ua->argc; i++) {
457 if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
459 strcpy(jr->Job, ua->argv[i]);
460 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0 && ua->argv[i]) {
461 jr->JobId = atoi(ua->argv[i]);
465 if (!db_get_job_record(ua->db, jr)) {
466 bsendmsg(ua, _("Could not find Job %s: ERR=%s"), ua->argv[i],
467 db_strerror(ua->db));
474 if (!select_job_dbr(ua, jr)) { /* try once more */
484 * Implement unique set of prompts
486 void start_prompt(UAContext *ua, char *msg)
488 if (ua->max_prompts == 0) {
489 ua->max_prompts = 10;
490 ua->prompt = (char **) bmalloc(sizeof(char *) * ua->max_prompts);
493 ua->prompt[0] = bstrdup(msg);
497 * Add to prompts -- keeping them unique
499 void add_prompt(UAContext *ua, char *prompt)
502 if (ua->num_prompts == ua->max_prompts) {
503 ua->max_prompts *= 2;
504 ua->prompt = (char **) brealloc(ua->prompt, sizeof(char *) *
507 for (i=1; i < ua->num_prompts; i++) {
508 if (strcmp(ua->prompt[i], prompt) == 0) {
512 ua->prompt[ua->num_prompts++] = bstrdup(prompt);
516 * Display prompts and get user's choice
518 * Returns: -1 on error
519 * index base 0 on success, and choice
520 * is copied to prompt if not NULL
522 int do_prompt(UAContext *ua, char *msg, char *prompt)
525 char pmsg[MAXSTRING];
527 bsendmsg(ua, ua->prompt[0]);
528 for (i=1; i < ua->num_prompts; i++) {
529 bsendmsg(ua, "%6d: %s\n", i, ua->prompt[i]);
537 if (ua->num_prompts == 2) {
539 bsendmsg(ua, _("Item 1 selected automatically.\n"));
541 strcpy(prompt, ua->prompt[1]);
545 sprintf(pmsg, "%s (1-%d): ", msg, ua->num_prompts-1);
547 /* Either a . or an @ will get you out of the loop */
548 if (!get_cmd(ua, pmsg) || *ua->cmd == '.' || *ua->cmd == '@') {
549 item = -1; /* error */
550 bsendmsg(ua, _("Selection aborted, nothing done.\n"));
553 item = atoi(ua->cmd);
554 if (item < 1 || item >= ua->num_prompts) {
555 bsendmsg(ua, _("Please enter a number between 1 and %d\n"), ua->num_prompts-1);
559 strcpy(prompt, ua->prompt[item]);
564 for (i=0; i < ua->num_prompts; i++) {
573 * We scan what the user has entered looking for
575 * device=<device-name> ???? does this work ????
576 * storage=<storage-resource>
579 * ? (prompt him with storage list)
580 * <some-error> (prompt him with storage list)
582 STORE *get_storage_resource(UAContext *ua, char *cmd)
584 char *store_name, *device_name;
591 return select_storage_resource(ua);
597 for (i=1; i<ua->argc; i++) {
599 /* Default argument is storage */
601 bsendmsg(ua, _("Storage name given twice.\n"));
604 store_name = ua->argk[i];
605 if (*store_name == '?') {
606 return select_storage_resource(ua);
609 if (strcasecmp(ua->argk[i], _("device")) == 0) {
610 device_name = ua->argv[i];
612 } else if (strcasecmp(ua->argk[i], _("storage")) == 0) {
613 store_name = ua->argv[i];
615 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
616 jobid = atoi(ua->argv[i]);
618 bsendmsg(ua, _("Expecting jobid=nn command, got: %s\n"), ua->argk[i]);
621 if (!(jcr=get_jcr_by_id(jobid))) {
622 bsendmsg(ua, _("JobId %d is not running.\n"), jobid);
629 } else if (strcasecmp(ua->argk[i], _("job")) == 0) {
630 if (!(jcr=get_jcr_by_partial_name(ua->argv[i]))) {
631 bsendmsg(ua, _("Job %s is not running.\n"), ua->argv[i]);
639 bsendmsg(ua, _("Unknown keyword: %s\n"), ua->argk[i]);
646 bsendmsg(ua, _("A storage device name must be given.\n"));
649 store = (STORE *)GetResWithName(R_STORAGE, store_name);
651 bsendmsg(ua, "Storage resource %s: not found\n", store_name);
655 store = select_storage_resource(ua);
662 * Scan looking for mediatype=
664 * if not found or error, put up selection list
666 * Returns: 0 on error
667 * 1 on success, MediaType is set
669 int get_media_type(UAContext *ua, char *MediaType)
673 static char *keyword[] = {
677 i = find_arg_keyword(ua, keyword);
678 if (i >= 0 && ua->argv[i]) {
679 strcpy(MediaType, ua->argv[i]);
683 start_prompt(ua, _("Media Types defined in conf file:\n"));
685 for (store = NULL; (store = (STORE *)GetNextRes(R_STORAGE, (RES *)store)); ) {
686 add_prompt(ua, store->media_type);
689 return (do_prompt(ua, _("Select the Media Type"), MediaType) < 0) ? 0 : 1;