git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/ua_select.c

   1 /*
   2  *
   3  *   Bacula Director -- User Agent Prompt and Selection code
   4  *
   5  *     Kern Sibbald, October MMI
   6  *
   7  *   Version  $Id$
   8  */
   9
  10 /*
  11    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  12
  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.
  17
  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.
  22
  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,
  26    MA 02111-1307, USA.
  27
  28  */
  29
  30 #include "bacula.h"
  31 #include "dird.h"
  32 #include "ua.h"
  33
  34
  35 /* Imported variables */
  36
  37
  38 /*
  39  * Confirm a retention period
  40  */
  41 int confirm_retention(UAContext *ua, utime_t *ret, char *msg)
  42 {
  43    char ed1[30];
  44
  45    for ( ;; ) {
  46        bsendmsg(ua, _("The current %s retention period is: %s\n"),
  47           msg, edit_utime(*ret, ed1));
  48        if (!get_cmd(ua, _("Continue? (yes/mod/no): "))) {
  49           return 0;
  50        }
  51        if (strcasecmp(ua->cmd, _("mod")) == 0) {
  52           if (!get_cmd(ua, _("Enter new retention period: "))) {
  53              return 0;
  54           }
  55           if (!duration_to_utime(ua->cmd, ret)) {
  56              bsendmsg(ua, _("Invalid period.\n"));
  57              continue;
  58           }
  59           continue;
  60        }
  61        if (strcasecmp(ua->cmd, _("yes")) == 0) {
  62           break;
  63        }
  64     }
  65     return 1;
  66 }
  67
  68 /*
  69  * Given a list of keywords, find the first one
  70  *  that is in the argument list.
  71  * Returns: -1 if not found
  72  *          index into list (base 0) on success
  73  */
  74 int find_arg_keyword(UAContext *ua, char **list)
  75 {
  76    int i, j;
  77    for (i=1; i<ua->argc; i++) {
  78       for(j=0; list[j]; j++) {
  79          if (strcasecmp(_(list[j]), ua->argk[i]) == 0) {
  80             return j;
  81          }
  82       }
  83    }
  84    return -1;
  85 }
  86
  87 /*
  88  * Given a list of keywords, prompt the user
  89  * to choose one.
  90  *
  91  * Returns: -1 on failure
  92  *          index into list (base 0) on success
  93  */
  94 int do_keyword_prompt(UAContext *ua, char *msg, char **list)
  95 {
  96    int i;
  97    start_prompt(ua, _("You have the following choices:\n"));
  98    for (i=0; list[i]; i++) {
  99       add_prompt(ua, list[i]);
 100    }
 101    return do_prompt(ua, msg, NULL, 0);
 102 }
 103
 104
 105 /*
 106  * Select a Storage resource from prompt list
 107  */
 108 STORE *select_storage_resource(UAContext *ua)
 109 {
 110    char name[MAX_NAME_LENGTH];
 111    STORE *store = NULL;
 112
 113    start_prompt(ua, _("The defined Storage resources are:\n"));
 114    LockRes();
 115    while ((store = (STORE *)GetNextRes(R_STORAGE, (RES *)store))) {
 116       add_prompt(ua, store->hdr.name);
 117    }
 118    UnlockRes();
 119    do_prompt(ua, _("Select Storage resource"), name, sizeof(name));
 120    store = (STORE *)GetResWithName(R_STORAGE, name);
 121    return store;
 122 }
 123
 124 /*
 125  * Select a FileSet resource from prompt list
 126  */
 127 FILESET *select_fileset_resource(UAContext *ua)
 128 {
 129    char name[MAX_NAME_LENGTH];
 130    FILESET *fs = NULL;
 131
 132    start_prompt(ua, _("The defined FileSet resources are:\n"));
 133    LockRes();
 134    while ((fs = (FILESET *)GetNextRes(R_FILESET, (RES *)fs))) {
 135       add_prompt(ua, fs->hdr.name);
 136    }
 137    UnlockRes();
 138    do_prompt(ua, _("Select FileSet resource"), name, sizeof(name));
 139    fs = (FILESET *)GetResWithName(R_FILESET, name);
 140    return fs;
 141 }
 142
 143
 144 /*
 145  * Get a catalog resource from prompt list
 146  */
 147 CAT *get_catalog_resource(UAContext *ua)
 148 {
 149    char name[MAX_NAME_LENGTH];
 150    CAT *catalog = NULL;
 151    int i;
 152
 153    for (i=1; i<ua->argc; i++) {
 154       if (strcasecmp(ua->argk[i], _("catalog")) == 0 && ua->argv[i]) {
 155          catalog = (CAT *)GetResWithName(R_CATALOG, ua->argv[i]);
 156          break;
 157       }
 158    }
 159    if (!catalog) {
 160       start_prompt(ua, _("The defined Catalog resources are:\n"));
 161       LockRes();
 162       while ((catalog = (CAT *)GetNextRes(R_CATALOG, (RES *)catalog))) {
 163          add_prompt(ua, catalog->hdr.name);
 164       }
 165       UnlockRes();
 166       do_prompt(ua, _("Select Catalog resource"), name, sizeof(name));
 167       catalog = (CAT *)GetResWithName(R_CATALOG, name);
 168    }
 169    return catalog;
 170 }
 171
 172
 173 /*
 174  * Select a Job resource from prompt list
 175  */
 176 JOB *select_job_resource(UAContext *ua)
 177 {
 178    char name[MAX_NAME_LENGTH];
 179    JOB *job = NULL;
 180
 181    start_prompt(ua, _("The defined Job resources are:\n"));
 182    LockRes();
 183    while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
 184       add_prompt(ua, job->hdr.name);
 185    }
 186    UnlockRes();
 187    do_prompt(ua, _("Select Job resource"), name, sizeof(name));
 188    job = (JOB *)GetResWithName(R_JOB, name);
 189    return job;
 190 }
 191
 192 /*
 193  * Select a Restore Job resource from prompt list
 194  */
 195 JOB *select_restore_job_resource(UAContext *ua)
 196 {
 197    char name[MAX_NAME_LENGTH];
 198    JOB *job = NULL;
 199
 200    start_prompt(ua, _("The defined Restore Job resources are:\n"));
 201    LockRes();
 202    while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
 203       if (job->JobType == JT_RESTORE) {
 204          add_prompt(ua, job->hdr.name);
 205       }
 206    }
 207    UnlockRes();
 208    do_prompt(ua, _("Select Restore Job"), name, sizeof(name));
 209    job = (JOB *)GetResWithName(R_JOB, name);
 210    return job;
 211 }
 212
 213
 214
 215 /*
 216  * Select a client resource from prompt list
 217  */
 218 CLIENT *select_client_resource(UAContext *ua)
 219 {
 220    char name[MAX_NAME_LENGTH];
 221    CLIENT *client = NULL;
 222
 223    start_prompt(ua, _("The defined Client resources are:\n"));
 224    LockRes();
 225    while ( (client = (CLIENT *)GetNextRes(R_CLIENT, (RES *)client)) ) {
 226       add_prompt(ua, client->hdr.name);
 227    }
 228    UnlockRes();
 229    do_prompt(ua, _("Select Client (File daemon) resource"), name, sizeof(name));
 230    client = (CLIENT *)GetResWithName(R_CLIENT, name);
 231    return client;
 232 }
 233
 234 /*
 235  *  Get client resource, start by looking for
 236  *   client=<client-name>
 237  *  if we don't find the keyword, we prompt the user.
 238  */
 239 CLIENT *get_client_resource(UAContext *ua)
 240 {
 241    CLIENT *client = NULL;
 242    int i;
 243
 244    for (i=1; i<ua->argc; i++) {
 245       if (strcasecmp(ua->argk[i], _("client")) == 0 && ua->argv[i]) {
 246          client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[i]);
 247          if (client) {
 248             return client;
 249          }
 250          bsendmsg(ua, _("Error: Client resource %s does not exist.\n"), ua->argv[i]);
 251          break;
 252       }
 253    }
 254    return select_client_resource(ua);
 255 }
 256
 257 /* Scan what the user has entered looking for:
 258  *
 259  *  pool=<pool-name>
 260  *
 261  *  if error or not found, put up a list of pool DBRs
 262  *  to choose from.
 263  *
 264  *   returns: 0 on error
 265  *            poolid on success and fills in POOL_DBR
 266  */
 267 int get_pool_dbr(UAContext *ua, POOL_DBR *pr)
 268 {
 269    int i;
 270
 271    if (pr->Name[0]) {                 /* If name already supplied */
 272       if (db_get_pool_record(ua->db, pr)) {
 273          return pr->PoolId;
 274       }
 275       bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), pr->Name, db_strerror(ua->db));
 276    }
 277    for (i=1; i<ua->argc; i++) {
 278       if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
 279          bstrncpy(pr->Name, ua->argv[i], sizeof(pr->Name));
 280          if (!db_get_pool_record(ua->db, pr)) {
 281             bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), ua->argv[i],
 282                      db_strerror(ua->db));
 283             pr->PoolId = 0;
 284             break;
 285          }
 286          return pr->PoolId;
 287       }
 288    }
 289    if (!select_pool_dbr(ua, pr)) {  /* try once more */
 290       return 0;
 291    }
 292    return pr->PoolId;
 293 }
 294
 295 /*
 296  * Select a Pool record from the catalog
 297  */
 298 int select_pool_dbr(UAContext *ua, POOL_DBR *pr)
 299 {
 300    POOL_DBR opr;
 301    char name[MAX_NAME_LENGTH];
 302    int num_pools, i;
 303    uint32_t *ids;
 304
 305
 306    pr->PoolId = 0;
 307    if (!db_get_pool_ids(ua->db, &num_pools, &ids)) {
 308       bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"), db_strerror(ua->db));
 309       return 0;
 310    }
 311    if (num_pools <= 0) {
 312       bsendmsg(ua, _("No pools defined. Use the \"create\" command to create one.\n"));
 313       return 0;
 314    }
 315
 316    start_prompt(ua, _("Defined Pools:\n"));
 317    for (i=0; i < num_pools; i++) {
 318       opr.PoolId = ids[i];
 319       if (!db_get_pool_record(ua->db, &opr)) {
 320          continue;
 321       }
 322       add_prompt(ua, opr.Name);
 323    }
 324    free(ids);
 325    if (do_prompt(ua, _("Select the Pool"), name, sizeof(name)) < 0) {
 326       return 0;
 327    }
 328    memset(&opr, 0, sizeof(pr));
 329    bstrncpy(opr.Name, name, sizeof(opr.Name));
 330
 331    if (!db_get_pool_record(ua->db, &opr)) {
 332       bsendmsg(ua, _("Could not find Pool %s: ERR=%s"), name, db_strerror(ua->db));
 333       return 0;
 334    }
 335    memcpy(pr, &opr, sizeof(opr));
 336    return opr.PoolId;
 337 }
 338
 339 /*
 340  * Select a Pool and a Media (Volume) record from the database
 341  */
 342 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr)
 343 {
 344    int i;
 345    static char *kw[] = {
 346       N_("volume"),
 347       NULL};
 348
 349    memset(pr, 0, sizeof(POOL_DBR));
 350    memset(mr, 0, sizeof(MEDIA_DBR));
 351
 352    /* Get the pool, possibly from pool=<pool-name> */
 353    if (!get_pool_dbr(ua, pr)) {
 354       return 0;
 355    }
 356    mr->PoolId = pr->PoolId;
 357
 358    i = find_arg_keyword(ua, kw);
 359    if (i == 0 && ua->argv[i]) {
 360       bstrncpy(mr->VolumeName, ua->argv[i], sizeof(mr->VolumeName));
 361    }
 362    if (mr->VolumeName[0] == 0) {
 363       db_list_media_records(ua->db, mr, prtit, ua);
 364       if (!get_cmd(ua, _("Enter MediaId or Volume name: "))) {
 365          return 0;
 366       }
 367       if (is_a_number(ua->cmd)) {
 368          mr->MediaId = atoi(ua->cmd);
 369       } else {
 370          bstrncpy(mr->VolumeName, ua->cmd, sizeof(mr->VolumeName));
 371       }
 372    }
 373
 374    if (!db_get_media_record(ua->db, mr)) {
 375       bsendmsg(ua, "%s", db_strerror(ua->db));
 376       return 0;
 377    }
 378    return 1;
 379 }
 380
 381
 382 /*
 383  *  This routine is ONLY used in the create command.
 384  *  If you are thinking about using it, you
 385  *  probably want to use select_pool_dbr()
 386  *  or get_pool_dbr() above.
 387  */
 388 POOL *get_pool_resource(UAContext *ua)
 389 {
 390    POOL *pool = NULL;
 391    char name[MAX_NAME_LENGTH];
 392    int i;
 393
 394    for (i=1; i<ua->argc; i++) {
 395       if (strcasecmp(ua->argk[i], _("pool")) == 0 && ua->argv[i]) {
 396          pool = (POOL *)GetResWithName(R_POOL, ua->argv[i]);
 397          if (pool) {
 398             return pool;
 399          }
 400          bsendmsg(ua, _("Error: Pool resource %s does not exist.\n"), ua->argv[i]);
 401          break;
 402       }
 403    }
 404    start_prompt(ua, _("The defined Pool resources are:\n"));
 405    LockRes();
 406    while ((pool = (POOL *)GetNextRes(R_POOL, (RES *)pool))) {
 407       add_prompt(ua, pool->hdr.name);
 408    }
 409    UnlockRes();
 410    do_prompt(ua, _("Select Pool resource"), name, sizeof(name));
 411    pool = (POOL *)GetResWithName(R_POOL, name);
 412    return pool;
 413 }
 414
 415 /*
 416  * List all jobs and ask user to select one
 417  */
 418 int select_job_dbr(UAContext *ua, JOB_DBR *jr)
 419 {
 420    db_list_job_records(ua->db, jr, prtit, ua);
 421    if (!get_cmd(ua, _("Enter the JobId to select: "))) {
 422       return 0;
 423    }
 424    jr->JobId = atoi(ua->cmd);
 425    if (!db_get_job_record(ua->db, jr)) {
 426       bsendmsg(ua, "%s", db_strerror(ua->db));
 427       return 0;
 428    }
 429    return jr->JobId;
 430
 431 }
 432
 433
 434 /* Scan what the user has entered looking for:
 435  *
 436  *  jobid=nn
 437  *
 438  *  if error or not found, put up a list of Jobs
 439  *  to choose from.
 440  *
 441  *   returns: 0 on error
 442  *            JobId on success and fills in JOB_DBR
 443  */
 444 int get_job_dbr(UAContext *ua, JOB_DBR *jr)
 445 {
 446    int i;
 447
 448    for (i=1; i<ua->argc; i++) {
 449       if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
 450          jr->JobId = 0;
 451          bstrncpy(jr->Job, ua->argv[i], sizeof(jr->Job));
 452       } else if (strcasecmp(ua->argk[i], _("jobid")) == 0 && ua->argv[i]) {
 453          jr->JobId = atoi(ua->argv[i]);
 454       } else {
 455          continue;
 456       }
 457       if (!db_get_job_record(ua->db, jr)) {
 458          bsendmsg(ua, _("Could not find Job %s: ERR=%s"), ua->argv[i],
 459                   db_strerror(ua->db));
 460          jr->JobId = 0;
 461          break;
 462       }
 463       return jr->JobId;
 464    }
 465
 466    if (!select_job_dbr(ua, jr)) {  /* try once more */
 467       return 0;
 468    }
 469    return jr->JobId;
 470 }
 471
 472
 473
 474
 475 /*
 476  * Implement unique set of prompts
 477  */
 478 void start_prompt(UAContext *ua, char *msg)
 479 {
 480   if (ua->max_prompts == 0) {
 481      ua->max_prompts = 10;
 482      ua->prompt = (char **)bmalloc(sizeof(char *) * ua->max_prompts);
 483   }
 484   ua->num_prompts = 1;
 485   ua->prompt[0] = bstrdup(msg);
 486 }
 487
 488 /*
 489  * Add to prompts -- keeping them unique
 490  */
 491 void add_prompt(UAContext *ua, char *prompt)
 492 {
 493    int i;
 494    if (ua->num_prompts == ua->max_prompts) {
 495       ua->max_prompts *= 2;
 496       ua->prompt = (char **)brealloc(ua->prompt, sizeof(char *) *
 497          ua->max_prompts);
 498     }
 499     for (i=1; i < ua->num_prompts; i++) {
 500        if (strcmp(ua->prompt[i], prompt) == 0) {
 501           return;
 502        }
 503     }
 504     ua->prompt[ua->num_prompts++] = bstrdup(prompt);
 505 }
 506
 507 /*
 508  * Display prompts and get user's choice
 509  *
 510  *  Returns: -1 on error
 511  *            index base 0 on success, and choice
 512  *               is copied to prompt if not NULL
 513  */
 514 int do_prompt(UAContext *ua, char *msg, char *prompt, int max_prompt)
 515 {
 516    int i, item;
 517    char pmsg[MAXSTRING];
 518
 519    bsendmsg(ua, ua->prompt[0]);
 520    for (i=1; i < ua->num_prompts; i++) {
 521       bsendmsg(ua, "%6d: %s\n", i, ua->prompt[i]);
 522    }
 523
 524    if (prompt) {
 525       *prompt = 0;
 526    }
 527
 528    for ( ;; ) {
 529       /* First item is the prompt string, not the items */
 530       if (ua->num_prompts == 1) {
 531          item = 0;                    /* list is empty ! */
 532          break;
 533       }
 534       if (ua->num_prompts == 2) {
 535          item = 1;
 536          bsendmsg(ua, _("Item 1 selected automatically.\n"));
 537          if (prompt) {
 538             bstrncpy(prompt, ua->prompt[1], max_prompt);
 539          }
 540          break;
 541       } else {
 542          sprintf(pmsg, "%s (1-%d): ", msg, ua->num_prompts-1);
 543       }
 544       /* Either a . or an @ will get you out of the loop */
 545       if (!get_cmd(ua, pmsg) || *ua->cmd == '.' || *ua->cmd == '@') {
 546          item = -1;                   /* error */
 547          bsendmsg(ua, _("Selection aborted, nothing done.\n"));
 548          break;
 549       }
 550       item = atoi(ua->cmd);
 551       if (item < 1 || item >= ua->num_prompts) {
 552          bsendmsg(ua, _("Please enter a number between 1 and %d\n"), ua->num_prompts-1);
 553          continue;
 554       }
 555       if (prompt) {
 556          bstrncpy(prompt, ua->prompt[item], max_prompt);
 557       }
 558       break;
 559    }
 560
 561    for (i=0; i < ua->num_prompts; i++) {
 562       free(ua->prompt[i]);
 563    }
 564    ua->num_prompts = 0;
 565    return item - 1;
 566 }
 567
 568
 569 /*
 570  * We scan what the user has entered looking for
 571  *    <storage-resource>
 572  *    device=<device-name>      ???? does this work ????
 573  *    storage=<storage-resource>
 574  *    job=<job_name>
 575  *    jobid=<jobid>
 576  *    ?              (prompt him with storage list)
 577  *    <some-error>   (prompt him with storage list)
 578  */
 579 STORE *get_storage_resource(UAContext *ua, char *cmd)
 580 {
 581    char *store_name, *device_name;
 582    STORE *store;
 583    int jobid;
 584    JCR *jcr;
 585    int i;
 586
 587    if (ua->argc == 1) {
 588       return select_storage_resource(ua);
 589    }
 590
 591    device_name = NULL;
 592    store_name = NULL;
 593
 594    for (i=1; i<ua->argc; i++) {
 595       if (!ua->argv[i]) {
 596          /* Default argument is storage */
 597          if (store_name) {
 598             bsendmsg(ua, _("Storage name given twice.\n"));
 599             return NULL;
 600          }
 601          store_name = ua->argk[i];
 602          if (*store_name == '?') {
 603             return select_storage_resource(ua);
 604          }
 605       } else {
 606          if (strcasecmp(ua->argk[i], _("device")) == 0) {
 607             device_name = ua->argv[i];
 608
 609          } else if (strcasecmp(ua->argk[i], _("storage")) == 0) {
 610             store_name = ua->argv[i];
 611
 612          } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
 613             jobid = atoi(ua->argv[i]);
 614             if (jobid <= 0) {
 615                bsendmsg(ua, _("Expecting jobid=nn command, got: %s\n"), ua->argk[i]);
 616                return NULL;
 617             }
 618             if (!(jcr=get_jcr_by_id(jobid))) {
 619                bsendmsg(ua, _("JobId %d is not running.\n"), jobid);
 620                return NULL;
 621             }
 622             store = jcr->store;
 623             free_jcr(jcr);
 624             return store;
 625
 626          } else if (strcasecmp(ua->argk[i], _("job")) == 0) {
 627             if (!(jcr=get_jcr_by_partial_name(ua->argv[i]))) {
 628                bsendmsg(ua, _("Job %s is not running.\n"), ua->argv[i]);
 629                return NULL;
 630             }
 631             store = jcr->store;
 632             free_jcr(jcr);
 633             return store;
 634
 635          } else {
 636             bsendmsg(ua, _("Unknown keyword: %s\n"), ua->argk[i]);
 637             return NULL;
 638          }
 639       }
 640    }
 641
 642    if (!store_name) {
 643      bsendmsg(ua, _("A storage device name must be given.\n"));
 644      store = NULL;
 645    } else {
 646       store = (STORE *)GetResWithName(R_STORAGE, store_name);
 647       if (!store) {
 648          bsendmsg(ua, "Storage resource %s: not found\n", store_name);
 649       }
 650    }
 651    if (!store) {
 652       store = select_storage_resource(ua);
 653    }
 654    return store;
 655 }
 656
 657
 658 /*
 659  * Scan looking for mediatype=
 660  *
 661  *  if not found or error, put up selection list
 662  *
 663  *  Returns: 0 on error
 664  *           1 on success, MediaType is set
 665  */
 666 int get_media_type(UAContext *ua, char *MediaType, int max_media)
 667 {
 668    STORE *store;
 669    int i;
 670    static char *keyword[] = {
 671       "mediatype",
 672       NULL};
 673
 674    i = find_arg_keyword(ua, keyword);
 675    if (i >= 0 && ua->argv[i]) {
 676       bstrncpy(MediaType, ua->argv[i], max_media);
 677       return 1;
 678    }
 679
 680    start_prompt(ua, _("Media Types defined in conf file:\n"));
 681    LockRes();
 682    for (store = NULL; (store = (STORE *)GetNextRes(R_STORAGE, (RES *)store)); ) {
 683       add_prompt(ua, store->media_type);
 684    }
 685    UnlockRes();
 686    return (do_prompt(ua, _("Select the Media Type"), MediaType, max_media) < 0) ? 0 : 1;
 687 }