3 * Dumb program to do an "ls" of a Bacula 1.0 mortal file.
8 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
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.
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.
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,
29 #include "findlib/find.h"
31 static void do_blocks(char *infname);
32 static void do_jobs(char *infname);
33 static void do_ls(char *fname);
34 static void print_ls_output(char *fname, char *link, int type, struct stat *statp);
35 static void do_setup(char *infname);
36 static void do_close();
39 static int default_tape = FALSE;
40 static int dump_label = FALSE;
41 static int list_blocks = FALSE;
42 static int list_jobs = FALSE;
43 static int verbose = 0;
44 static char Vol[2000];
47 static DEV_RECORD *rec;
48 static DEV_BLOCK *block;
49 static int NumVolumes, CurVolume;
53 extern char BaculaId[];
57 static BSR *bsr = NULL;
62 "\nVersion: " VERSION " (" DATE ")\n\n"
63 "Usage: bls [-d debug_level] <physical-device-name>\n"
64 " -b <file> specify a bootstrap file\n"
65 " -e <file> exclude list\n"
66 " -i <file> include list\n"
69 " -L list tape label\n"
70 " (none of above) list saved files\n"
71 " -t use default tape device\n"
73 " -? print this message\n\n");
77 static char *rec_state_to_str(DEV_RECORD *rec)
81 if (rec->state & REC_NO_HEADER) {
82 strcat(buf, "Nohdr,");
84 if (is_partial_record(rec)) {
85 strcat(buf, "partial,");
87 if (rec->state & REC_BLOCK_EMPTY) {
88 strcat(buf, "empty,");
90 if (rec->state & REC_NO_MATCH) {
91 strcat(buf, "Nomatch,");
93 if (rec->state & REC_CONTINUATION) {
97 buf[strlen(buf)-1] = 0;
104 int main (int argc, char *argv[])
110 my_name_is(argc, argv, "bls");
111 init_msg(NULL, NULL); /* initialize message handler */
113 memset(&ff, 0, sizeof(ff));
114 init_include_exclude_files(&ff);
116 while ((ch = getopt(argc, argv, "b:d:e:i:jkLtv?")) != -1) {
119 bsr = parse_bsr(NULL, optarg);
122 case 'd': /* debug level */
123 debug_level = atoi(optarg);
124 if (debug_level <= 0)
128 case 'e': /* exclude list */
129 if ((fd = fopen(optarg, "r")) == NULL) {
130 Pmsg2(0, "Could not open exclude file: %s, ERR=%s\n",
131 optarg, strerror(errno));
134 while (fgets(line, sizeof(line), fd) != NULL) {
135 strip_trailing_junk(line);
136 Dmsg1(000, "add_exclude %s\n", line);
137 add_fname_to_exclude_list(&ff, line);
142 case 'i': /* include list */
143 if ((fd = fopen(optarg, "r")) == NULL) {
144 Pmsg2(0, "Could not open include file: %s, ERR=%s\n",
145 optarg, strerror(errno));
148 while (fgets(line, sizeof(line), fd) != NULL) {
149 strip_trailing_junk(line);
150 Dmsg1(000, "add_include %s\n", line);
151 add_fname_to_include_list(&ff, 0, line);
185 if (!argc && !default_tape) {
186 Pmsg0(0, "No archive name specified\n");
190 if (ff.included_files_list == NULL) {
191 add_fname_to_include_list(&ff, 0, "/");
194 /* Try default device */
196 do_ls(DEFAULT_TAPE_DRIVE);
200 for (i=0; i < argc; i++) {
204 } else if (list_jobs) {
217 static void my_free_jcr(JCR *jcr)
223 * Setup device, jcr, and prepare to read
225 static void do_setup(char *infname)
227 jcr = new_jcr(sizeof(JCR), my_free_jcr);
228 jcr->VolSessionId = 1;
229 jcr->VolSessionTime = (uint32_t)time(NULL);
231 strcpy(jcr->Job, "bls");
232 jcr->dev_name = get_pool_memory(PM_FNAME);
233 strcpy(jcr->dev_name, infname);
237 if (strncmp(infname, "/dev/", 5) != 0) {
238 /* Try stripping file part */
239 p = infname + strlen(infname);
240 while (p >= infname && *p != '/')
243 strcpy(VolName, p+1);
247 Dmsg2(10, "Device=%s, Vol=%s.\n", infname, VolName);
248 dev = init_dev(NULL, infname);
250 Emsg1(M_FATAL, 0, "Cannot open %s\n", infname);
253 /* ***FIXME**** init capabilities */
254 if (!open_device(dev)) {
255 Emsg1(M_FATAL, 0, "Cannot open %s\n", infname);
258 Dmsg0(90, "Device opened for read.\n");
261 block = new_block(dev);
265 for (p = VolName; p && *p; ) {
273 pm_strcpy(&jcr->VolumeName, VolName);
274 Dmsg1(100, "Volume=%s\n", jcr->VolumeName);
275 if (!acquire_device_for_read(jcr, dev, block)) {
276 Emsg0(M_ERROR, 0, dev->errmsg);
281 static void do_close()
289 static int mount_next_volume(char *infname)
291 if (rec->remainder) {
292 Dmsg0(20, "Not end of record. Next volume has more data for current record.\n");
294 Dmsg2(20, "NumVolumes=%d CurVolume=%d\n", NumVolumes, CurVolume);
295 if (NumVolumes > 1 && CurVolume < NumVolumes) {
300 Dmsg1(20, "There is another volume %s.\n", p);
302 pm_strcpy(&jcr->VolumeName, VolName);
305 dev->state &= ~ST_READ;
306 if (!acquire_device_for_read(jcr, dev, block)) {
307 Emsg2(M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", infname, VolName);
310 return 1; /* Next volume mounted */
312 printf("End of Device reached.\n");
317 * Device got an error, attempt to analyse it
319 static void display_error_status()
323 Emsg0(M_ERROR, 0, dev->errmsg);
324 status_dev(dev, &status);
325 Dmsg1(20, "Device status: %x\n", status);
327 Emsg0(M_ERROR_TERM, 0, "Unexpected End of Data\n");
328 else if (status & MT_EOT)
329 Emsg0(M_ERROR_TERM, 0, "Unexpected End of Tape\n");
330 else if (status & MT_EOF)
331 Emsg0(M_ERROR_TERM, 0, "Unexpected End of File\n");
332 else if (status & MT_DR_OPEN)
333 Emsg0(M_ERROR_TERM, 0, "Tape Door is Open\n");
334 else if (!(status & MT_ONLINE))
335 Emsg0(M_ERROR_TERM, 0, "Unexpected Tape is Off-line\n");
337 Emsg2(M_ERROR_TERM, 0, "Read error on Record Header %s: %s\n", dev_name(dev), strerror(errno));
341 /* List just block information */
342 static void do_blocks(char *infname)
345 dump_volume_label(dev);
347 /* Assume that we have already read the volume label.
348 * If on second or subsequent volume, adjust buffer pointer
350 if (dev->VolHdr.PrevVolName[0] != 0) { /* second volume */
352 Warning, this Volume is a continuation of Volume %s\n",
353 dev->VolHdr.PrevVolName);
360 if (!read_block_from_device(dev, block)) {
361 Dmsg0(20, "!read_block()\n");
362 if (dev->state & ST_EOT) {
363 if (!mount_next_volume(infname)) {
368 if (dev->state & ST_EOF) {
369 Emsg1(M_INFO, 0, "Got EOF on device %s\n", dev_name(dev));
370 Dmsg0(20, "read_record got eof. try again\n");
373 if (dev->state & ST_SHORT) {
374 Emsg0(M_INFO, 0, dev->errmsg);
377 display_error_status();
382 read_record_from_block(block, rec);
383 Pmsg6(-1, "Block: %d blen=%d First rec FI=%s SessId=%d Strm=%s rlen=%d\n",
384 block->BlockNumber, block->block_len,
385 FI_to_ascii(rec->FileIndex), rec->VolSessionId,
386 stream_to_ascii(rec->Stream), rec->data_len);
389 printf("Block: %d size=%d\n", block->BlockNumber, block->block_len);
396 /* Do list job records */
397 static void do_jobs(char *infname)
400 /* Assume that we have already read the volume label.
401 * If on second or subsequent volume, adjust buffer pointer
403 if (dev->VolHdr.PrevVolName[0] != 0) { /* second volume */
405 Warning, this Volume is a continuation of Volume %s\n",
406 dev->VolHdr.PrevVolName);
410 if (!read_block_from_device(dev, block)) {
411 Dmsg0(20, "!read_block()\n");
412 if (dev->state & ST_EOT) {
413 if (!mount_next_volume(infname)) {
418 if (dev->state & ST_EOF) {
419 Emsg1(M_INFO, 0, "Got EOF on device %s\n", dev_name(dev));
420 Dmsg0(20, "read_record got eof. try again\n");
423 if (dev->state & ST_SHORT) {
424 Pmsg0(000, "Got short block.\n");
425 Emsg0(M_INFO, 0, dev->errmsg);
428 display_error_status();
431 while (read_record_from_block(block, rec)) {
432 if (debug_level >= 30) {
433 Dmsg4(30, "VolSId=%ld FI=%s Strm=%s Size=%ld\n", rec->VolSessionId,
434 FI_to_ascii(rec->FileIndex), stream_to_ascii(rec->Stream),
440 * Check for End of File record (all zeros)
441 * NOTE: this no longer exists
443 if (rec->VolSessionId == 0 && rec->VolSessionTime == 0) {
444 Emsg0(M_ERROR_TERM, 0, "Zero VolSessionId and VolSessionTime. This shouldn't happen\n");
448 * Check for Start or End of Session Record
451 if (rec->FileIndex < 0) {
452 dump_label_record(dev, rec, verbose);
461 /* Do an ls type listing of an archive */
462 static void do_ls(char *infname)
467 long record_file_index;
468 uint32_t num_files = 0;
472 dump_volume_label(dev);
476 /* Assume that we have already read the volume label.
477 * If on second or subsequent volume, adjust buffer pointer
479 if (dev->VolHdr.PrevVolName[0] != 0) { /* second volume */
481 Warning, this Volume is a continuation of Volume %s\n",
482 dev->VolHdr.PrevVolName);
486 SESSION_LABEL sessrec;
488 if (!read_block_from_device(dev, block)) {
489 Dmsg0(20, "!read_record()\n");
490 if (dev->state & ST_EOT) {
491 if (!mount_next_volume(infname)) {
496 if (dev->state & ST_EOF) {
497 Emsg1(M_INFO, 0, "Got EOF on device %s\n", dev_name(dev));
498 Dmsg0(20, "read_record got eof. try again\n");
501 if (dev->state & ST_SHORT) {
502 Emsg0(M_INFO, 0, dev->errmsg);
505 display_error_status();
509 Dmsg2(10, "Block: %d blen=%d\n", block->BlockNumber, block->block_len);
513 for (rec->state=0; !is_block_empty(rec); ) {
514 if (!read_record_from_block(block, rec)) {
515 Dmsg3(10, "!read-break. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
516 block->BlockNumber, rec->remainder);
517 // rec->remainder = 0;
520 Dmsg3(10, "read-OK. stat=%s blk=%d rem=%d\n", rec_state_to_str(rec),
521 block->BlockNumber, rec->remainder);
523 * At this point, we have at least a record header.
524 * Now decide if we want this record or not, but remember
525 * before accessing the record, we may need to read again to
530 Dmsg6(30, "recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
531 rec_state_to_str(rec), block->BlockNumber,
532 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
534 if (debug_level >= 30) {
535 Dmsg4(30, "VolSId=%ld FI=%s Strm=%s Size=%ld\n", rec->VolSessionId,
536 FI_to_ascii(rec->FileIndex), stream_to_ascii(rec->Stream),
541 * Check for End of File record (all zeros)
542 * NOTE: this no longer exists
544 if (rec->VolSessionId == 0 && rec->VolSessionTime == 0) {
545 Emsg0(M_ERROR_TERM, 0, "Zero VolSessionId and VolSessionTime. This shouldn't happen\n");
549 * Check for Start or End of Session Record
552 if (rec->FileIndex < 0) {
554 memset(&sessrec, 0, sizeof(sessrec));
555 switch (rec->FileIndex) {
557 rtype = "Fresh Volume Label";
560 rtype = "Volume Label";
561 unser_volume_label(dev, rec);
564 rtype = "Begin Session";
565 unser_session_label(&sessrec, rec);
568 rtype = "End Session";
571 rtype = "End of Media";
577 if (debug_level > 0) {
578 printf("%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
579 rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
582 Dmsg1(40, "Got label = %d\n", rec->FileIndex);
583 if (rec->FileIndex == EOM_LABEL) { /* end of tape? */
584 Dmsg0(100, "EOM LABEL break\n");
586 break; /* yes, get out */
589 continue; /* we don't want record, read next one */
590 } /* end if label record */
595 if (bsr && !match_bsr(bsr, rec, &dev->VolHdr, &sessrec)) {
597 Dmsg5(10, "BSR no match rec=%d block=%d SessId=%d SessTime=%d FI=%d\n",
598 record, block->BlockNumber, rec->VolSessionId, rec->VolSessionTime,
602 continue; /* we don't want record, read next one */
604 if (is_partial_record(rec)) {
605 Dmsg6(10, "Partial, break. recno=%d state=%s blk=%d SI=%d ST=%d FI=%d\n", record,
606 rec_state_to_str(rec), block->BlockNumber,
607 rec->VolSessionId, rec->VolSessionTime, rec->FileIndex);
608 break; /* read second part of record */
611 /* File Attributes stream */
612 if (rec->Stream == STREAM_UNIX_ATTRIBUTES) {
614 sscanf(rec->data, "%ld %d", &record_file_index, &type);
615 if (record_file_index != rec->FileIndex) {
616 Emsg2(M_ERROR_TERM, 0, "Record header file index %ld not equal record index %ld\n",
617 rec->FileIndex, record_file_index);
621 while (*ap++ != ' ') /* skip record file index */
623 while (*ap++ != ' ') /* skip type */
625 /* Save filename and position to attributes */
630 *fp = *ap++; /* terminate filename & point to attribs */
632 decode_stat(ap, &statp);
633 /* Skip to link name */
636 print_ls_output(fname, ap, type, &statp);
642 printf("%u files found.\n", num_files);
647 extern char *getuser(uid_t uid);
648 extern char *getgroup(gid_t gid);
650 static void print_ls_output(char *fname, char *link, int type, struct stat *statp)
657 if (!file_is_included(&ff, fname) || file_is_excluded(&ff, fname)) {
660 p = encode_mode(statp->st_mode, buf);
661 n = sprintf(p, " %2d ", (uint32_t)statp->st_nlink);
663 n = sprintf(p, "%-8.8s %-8.8s", getuser(statp->st_uid), getgroup(statp->st_gid));
665 n = sprintf(p, "%8.8s ", edit_uint64(statp->st_size, ec1));
667 p = encode_time(statp->st_ctime, p);
671 for (f=fname; *f && (p-buf) < (int)sizeof(buf); )
673 if (type == FT_LNK) {
679 for (f=link; *f && (p-buf) < (int)sizeof(buf); )
687 /* Dummies to replace askdir.c */
688 int dir_get_volume_info(JCR *jcr) { return 1;}
689 int dir_find_next_appendable_volume(JCR *jcr) { return 1;}
690 int dir_update_volume_info(JCR *jcr, VOLUME_CAT_INFO *vol, int relabel) { return 1; }
691 int dir_create_jobmedia_record(JCR *jcr) { return 1; }
692 int dir_ask_sysop_to_mount_next_volume(JCR *jcr, DEVICE *dev) { return 1; }
693 int dir_update_file_attributes(JCR *jcr, DEV_RECORD *rec) { return 1;}
694 int dir_send_job_status(JCR *jcr) {return 1;}
697 int dir_ask_sysop_to_mount_volume(JCR *jcr, DEVICE *dev)
699 fprintf(stderr, "Mount Volume %s on device %s and press return when ready: ",
700 jcr->VolumeName, dev_name(dev));