git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/bls.c

   1 /*
   2  *
   3  *  Dumb program to do an "ls" of a Bacula 1.0 mortal file.
   4  *
   5  *   Version $Id$
   6  */
   7 /*
   8    Copyright (C) 2000-2004 Kern Sibbald and John Walker
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2 of
  13    the License, or (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public
  21    License along with this program; if not, write to the Free
  22    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  23    MA 02111-1307, USA.
  24
  25  */
  26
  27 #include "bacula.h"
  28 #include "stored.h"
  29 #include "findlib/find.h"
  30
  31 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
  32 int win32_client = 1;
  33 #else
  34 int win32_client = 0;
  35 #endif
  36
  37 static void do_blocks(char *infname);
  38 static void do_jobs(char *infname);
  39 static void do_ls(char *fname);
  40 static void do_close(JCR *jcr);
  41 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec);
  42 static bool record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec);
  43
  44 static DEVICE *dev;
  45 static DCR *dcr;
  46 static bool dump_label = false;
  47 static bool list_blocks = false;
  48 static bool list_jobs = false;
  49 static DEV_RECORD *rec;
  50 static DEV_BLOCK *block;
  51 static JCR *jcr;
  52 static SESSION_LABEL sessrec;
  53 static uint32_t num_files = 0;
  54 static ATTR *attr;
  55
  56 #define CONFIG_FILE "bacula-sd.conf"
  57 char *configfile;
  58 bool forge_on = false;
  59
  60
  61 static FF_PKT ff;
  62
  63 static BSR *bsr = NULL;
  64
  65 static void usage()
  66 {
  67    fprintf(stderr,
  68 "Copyright (C) 2000-2004 Kern Sibbald and John Walker.\n"
  69 "\nVersion: " VERSION " (" BDATE ")\n\n"
  70 "Usage: bls [-d debug_level] <physical-device-name>\n"
  71 "       -b <file>       specify a bootstrap file\n"
  72 "       -c <file>       specify a config file\n"
  73 "       -d <level>      specify debug level\n"
  74 "       -e <file>       exclude list\n"
  75 "       -i <file>       include list\n"
  76 "       -j              list jobs\n"
  77 "       -k              list blocks\n"
  78 "    (no j or k option) list saved files\n"
  79 "       -L              dump label\n"
  80 "       -p              proceed inspite of errors\n"
  81 "       -v              be verbose\n"
  82 "       -V              specify Volume names (separated by |)\n"
  83 "       -?              print this message\n\n");
  84    exit(1);
  85 }
  86
  87
  88 int main (int argc, char *argv[])
  89 {
  90    int i, ch;
  91    FILE *fd;
  92    char line[1000];
  93    char *VolumeName= NULL;
  94    char *bsrName = NULL;
  95    bool ignore_label_errors = false;
  96
  97    working_directory = "/tmp";
  98    my_name_is(argc, argv, "bls");
  99    init_msg(NULL, NULL);              /* initialize message handler */
 100
 101    memset(&ff, 0, sizeof(ff));
 102    init_include_exclude_files(&ff);
 103
 104    while ((ch = getopt(argc, argv, "b:c:d:e:i:jkLpvV:?")) != -1) {
 105       switch (ch) {
 106       case 'b':
 107          bsrName = optarg;
 108          break;
 109
 110       case 'c':                    /* specify config file */
 111          if (configfile != NULL) {
 112             free(configfile);
 113          }
 114          configfile = bstrdup(optarg);
 115          break;
 116
 117       case 'd':                    /* debug level */
 118          debug_level = atoi(optarg);
 119          if (debug_level <= 0)
 120             debug_level = 1;
 121          break;
 122
 123       case 'e':                    /* exclude list */
 124          if ((fd = fopen(optarg, "r")) == NULL) {
 125             Pmsg2(0, _("Could not open exclude file: %s, ERR=%s\n"),
 126                optarg, strerror(errno));
 127             exit(1);
 128          }
 129          while (fgets(line, sizeof(line), fd) != NULL) {
 130             strip_trailing_junk(line);
 131             Dmsg1(100, "add_exclude %s\n", line);
 132             add_fname_to_exclude_list(&ff, line);
 133          }
 134          fclose(fd);
 135          break;
 136
 137       case 'i':                    /* include list */
 138          if ((fd = fopen(optarg, "r")) == NULL) {
 139             Pmsg2(0, "Could not open include file: %s, ERR=%s\n",
 140                optarg, strerror(errno));
 141             exit(1);
 142          }
 143          while (fgets(line, sizeof(line), fd) != NULL) {
 144             strip_trailing_junk(line);
 145             Dmsg1(100, "add_include %s\n", line);
 146             add_fname_to_include_list(&ff, 0, line);
 147          }
 148          fclose(fd);
 149          break;
 150
 151       case 'j':
 152          list_jobs = true;
 153          break;
 154
 155       case 'k':
 156          list_blocks = true;
 157          break;
 158
 159       case 'L':
 160          dump_label = true;
 161          break;
 162
 163       case 'p':
 164          ignore_label_errors = true;
 165          forge_on = true;
 166          break;
 167
 168       case 'v':
 169          verbose++;
 170          break;
 171
 172       case 'V':                    /* Volume name */
 173          VolumeName = optarg;
 174          break;
 175
 176       case '?':
 177       default:
 178          usage();
 179
 180       } /* end switch */
 181    } /* end while */
 182    argc -= optind;
 183    argv += optind;
 184
 185    if (!argc) {
 186       Pmsg0(0, _("No archive name specified\n"));
 187       usage();
 188    }
 189
 190    if (configfile == NULL) {
 191       configfile = bstrdup(CONFIG_FILE);
 192    }
 193
 194    parse_config(configfile);
 195
 196    if (ff.included_files_list == NULL) {
 197       add_fname_to_include_list(&ff, 0, "/");
 198    }
 199
 200    for (i=0; i < argc; i++) {
 201       if (bsrName) {
 202          bsr = parse_bsr(NULL, bsrName);
 203       }
 204       jcr = setup_jcr("bls", argv[i], bsr, VolumeName);
 205       jcr->ignore_label_errors = ignore_label_errors;
 206       dev = setup_to_access_device(jcr, 1);   /* acquire for read */
 207       if (!dev) {
 208          exit(1);
 209       }
 210       dcr = jcr->dcr;
 211       rec = new_record();
 212       block = new_block(dev);
 213       attr = new_attr();
 214       /*
 215        * Assume that we have already read the volume label.
 216        * If on second or subsequent volume, adjust buffer pointer
 217        */
 218       if (dev->VolHdr.PrevVolName[0] != 0) { /* second volume */
 219          Pmsg1(0, "\n\
 220 Warning, this Volume is a continuation of Volume %s\n",
 221                 dev->VolHdr.PrevVolName);
 222       }
 223
 224       if (list_blocks) {
 225          do_blocks(argv[i]);
 226       } else if (list_jobs) {
 227          do_jobs(argv[i]);
 228       } else {
 229          do_ls(argv[i]);
 230       }
 231       do_close(jcr);
 232    }
 233    if (bsr) {
 234       free_bsr(bsr);
 235    }
 236    return 0;
 237 }
 238
 239
 240 static void do_close(JCR *jcr)
 241 {
 242    release_device(jcr);
 243    free_attr(attr);
 244    free_record(rec);
 245    free_block(block);
 246    free_jcr(jcr);
 247    term_dev(dev);
 248 }
 249
 250
 251 /* List just block information */
 252 static void do_blocks(char *infname)
 253 {
 254    if (verbose) {
 255       dump_volume_label(dev);
 256       rec = new_record();
 257    }
 258    for ( ;; ) {
 259       if (!read_block_from_device(dcr, block, NO_BLOCK_NUMBER_CHECK)) {
 260          Dmsg1(100, "!read_block(): ERR=%s\n", strerror_dev(dev));
 261          if (dev->state & ST_EOT) {
 262             if (!mount_next_read_volume(jcr, dev, block)) {
 263                Jmsg(jcr, M_INFO, 0, _("Got EOM at file %u on device %s, Volume \"%s\"\n"),
 264                   dev->file, dev_name(dev), jcr->VolumeName);
 265                break;
 266             }
 267             /* Read and discard Volume label */
 268             DEV_RECORD *record;
 269             record = new_record();
 270             read_block_from_device(dcr, block, NO_BLOCK_NUMBER_CHECK);
 271             read_record_from_block(block, record);
 272             get_session_record(dev, record, &sessrec);
 273             free_record(record);
 274             Jmsg(jcr, M_INFO, 0, _("Mounted Volume \"%s\".\n"), jcr->VolumeName);
 275
 276          } else if (dev->state & ST_EOF) {
 277             Jmsg(jcr, M_INFO, 0, _("Got EOF at file %u on device %s, Volume \"%s\"\n"),
 278                dev->file, dev_name(dev), jcr->VolumeName);
 279             Dmsg0(20, "read_record got eof. try again\n");
 280             continue;
 281          } else if (dev->state & ST_SHORT) {
 282             Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
 283             continue;
 284          } else {
 285             /* I/O error */
 286             display_tape_error_status(jcr, dev);
 287             break;
 288          }
 289       }
 290       if (!match_bsr_block(bsr, block)) {
 291          Dmsg5(100, "reject Blk=%u blen=%u bVer=%d SessId=%u SessTim=%u\n",
 292             block->BlockNumber, block->block_len, block->BlockVer,
 293             block->VolSessionId, block->VolSessionTime);
 294          continue;
 295       }
 296       Dmsg5(100, "Blk=%u blen=%u bVer=%d SessId=%u SessTim=%u\n",
 297         block->BlockNumber, block->block_len, block->BlockVer,
 298         block->VolSessionId, block->VolSessionTime);
 299       if (verbose == 1) {
 300          read_record_from_block(block, rec);
 301          Pmsg9(-1, "File:blk=%u:%u blk_num=%u blen=%u First rec FI=%s SessId=%u SessTim=%u Strm=%s rlen=%d\n",
 302               dev->file, dev->block_num,
 303               block->BlockNumber, block->block_len,
 304               FI_to_ascii(rec->FileIndex), rec->VolSessionId, rec->VolSessionTime,
 305               stream_to_ascii(rec->Stream, rec->FileIndex), rec->data_len);
 306          rec->remainder = 0;
 307       } else if (verbose > 1) {
 308          dump_block(block, "");
 309       } else {
 310          printf("Block: %d size=%d\n", block->BlockNumber, block->block_len);
 311       }
 312
 313    }
 314    return;
 315 }
 316
 317 /*
 318  * We are only looking for labels or in particular Job Session records
 319  */
 320 static bool jobs_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec)
 321 {
 322    if (rec->FileIndex < 0) {
 323       dump_label_record(dev, rec, verbose);
 324    }
 325    rec->remainder = 0;
 326    return true;
 327 }
 328
 329 /* Do list job records */
 330 static void do_jobs(char *infname)
 331 {
 332    read_records(dcr, jobs_cb, mount_next_read_volume);
 333 }
 334
 335 /* Do an ls type listing of an archive */
 336 static void do_ls(char *infname)
 337 {
 338    if (dump_label) {
 339       dump_volume_label(dev);
 340       return;
 341    }
 342    read_records(dcr, record_cb, mount_next_read_volume);
 343    printf("%u files found.\n", num_files);
 344 }
 345
 346 /*
 347  * Called here for each record from read_records()
 348  */
 349 static bool record_cb(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, DEV_RECORD *rec)
 350 {
 351    if (rec->FileIndex < 0) {
 352       get_session_record(dev, rec, &sessrec);
 353       return true;
 354    }
 355    /* File Attributes stream */
 356    if (rec->Stream == STREAM_UNIX_ATTRIBUTES ||
 357        rec->Stream == STREAM_UNIX_ATTRIBUTES_EX) {
 358
 359       if (verbose > 1) {
 360          const char *rtype = "Attributes";
 361          Pmsg5(-1, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
 362                rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
 363       }
 364       if (!unpack_attributes_record(jcr, rec->Stream, rec->data, attr)) {
 365          if (!forge_on) {
 366             Emsg0(M_ERROR_TERM, 0, _("Cannot continue.\n"));
 367          }
 368          num_files++;
 369          return true;
 370       }
 371
 372       if (attr->file_index != rec->FileIndex) {
 373          Emsg2(forge_on?M_WARNING:M_ERROR_TERM, 0, _("Record header file index %ld not equal record index %ld\n"),
 374                rec->FileIndex, attr->file_index);
 375       }
 376
 377       attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI);
 378       build_attr_output_fnames(jcr, attr);
 379
 380       if (file_is_included(&ff, attr->fname) && !file_is_excluded(&ff, attr->fname)) {
 381          print_ls_output(jcr, attr);
 382          num_files++;
 383       }
 384    }
 385    return true;
 386 }
 387
 388
 389 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
 390 {
 391    const char *rtype;
 392    memset(sessrec, 0, sizeof(sessrec));
 393    switch (rec->FileIndex) {
 394    case PRE_LABEL:
 395       rtype = "Fresh Volume Label";
 396       break;
 397    case VOL_LABEL:
 398       rtype = "Volume Label";
 399       unser_volume_label(dev, rec);
 400       break;
 401    case SOS_LABEL:
 402       rtype = "Begin Job Session";
 403       unser_session_label(sessrec, rec);
 404       break;
 405    case EOS_LABEL:
 406       rtype = "End Job Session";
 407       break;
 408    case EOM_LABEL:
 409       rtype = "End of Medium";
 410       break;
 411    default:
 412       rtype = "Unknown";
 413       break;
 414    }
 415    Dmsg5(10, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
 416          rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
 417    if (verbose) {
 418       Pmsg5(-1, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
 419             rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
 420    }
 421 }
 422
 423
 424 /* Dummies to replace askdir.c */
 425 bool    dir_get_volume_info(DCR *dcr, enum get_vol_info_rw  writing) { return 1;}
 426 bool    dir_find_next_appendable_volume(DCR *dcr) { return 1;}
 427 bool    dir_update_volume_info(DCR *dcr, bool relabel) { return 1; }
 428 bool    dir_create_jobmedia_record(DCR *dcr) { return 1; }
 429 bool    dir_ask_sysop_to_create_appendable_volume(DCR *dcr) { return 1; }
 430 bool    dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec) { return 1;}
 431 bool    dir_send_job_status(JCR *jcr) {return 1;}
 432
 433
 434 bool dir_ask_sysop_to_mount_volume(DCR *dcr)
 435 {
 436    JCR *jcr = dcr->jcr;
 437    DEVICE *dev = dcr->dev;
 438    fprintf(stderr, "Mount Volume \"%s\" on device %s and press return when ready: ",
 439       jcr->VolumeName, dev_name(dev));
 440    getchar();
 441    return true;
 442 }