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