]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/bls.c
Get FD Python running -- design Python backup interface.
[bacula/bacula] / 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-2005 Kern Sibbald
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 /* Dummy functions */
38 int generate_daemon_event(JCR *jcr, const char *event) { return 1; }
39
40 static void do_blocks(char *infname);
41 static void do_jobs(char *infname);
42 static void do_ls(char *fname);
43 static void do_close(JCR *jcr);
44 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec);
45 static bool record_cb(DCR *dcr, DEV_RECORD *rec);
46
47 static DEVICE *dev;
48 static DCR *dcr;
49 static bool dump_label = false;
50 static bool list_blocks = false;
51 static bool list_jobs = false;
52 static DEV_RECORD *rec;
53 static DEV_BLOCK *block;
54 static JCR *jcr;
55 static SESSION_LABEL sessrec;
56 static uint32_t num_files = 0;
57 static ATTR *attr;
58
59 #define CONFIG_FILE "bacula-sd.conf"
60 char *configfile;
61 STORES *me = NULL;                    /* our Global resource */
62 bool forge_on = false;
63 pthread_mutex_t device_release_mutex = PTHREAD_MUTEX_INITIALIZER;
64 pthread_cond_t wait_device_release = PTHREAD_COND_INITIALIZER;
65
66
67 static FF_PKT *ff;
68
69 static BSR *bsr = NULL;
70
71 static void usage()
72 {
73    fprintf(stderr,
74 "Copyright (C) 2000-2005 Kern Sibbald.\n"
75 "\nVersion: " VERSION " (" BDATE ")\n\n"
76 "Usage: bls [options] <device-name>\n"
77 "       -b <file>       specify a bootstrap file\n"
78 "       -c <file>       specify a config file\n"
79 "       -d <level>      specify debug level\n"
80 "       -e <file>       exclude list\n"
81 "       -i <file>       include list\n"
82 "       -j              list jobs\n"
83 "       -k              list blocks\n"
84 "    (no j or k option) list saved files\n"
85 "       -L              dump label\n"
86 "       -p              proceed inspite of errors\n"
87 "       -v              be verbose\n"
88 "       -V              specify Volume names (separated by |)\n"
89 "       -?              print this message\n\n");
90    exit(1);
91 }
92
93
94 int main (int argc, char *argv[])
95 {
96    int i, ch;
97    FILE *fd;
98    char line[1000];
99    char *VolumeName= NULL;
100    char *bsrName = NULL;
101    bool ignore_label_errors = false;
102
103    working_directory = "/tmp";
104    my_name_is(argc, argv, "bls");
105    init_msg(NULL, NULL);              /* initialize message handler */
106
107    ff = init_find_files();
108
109    while ((ch = getopt(argc, argv, "b:c:d:e:i:jkLpvV:?")) != -1) {
110       switch (ch) {
111       case 'b':
112          bsrName = optarg;
113          break;
114
115       case 'c':                    /* specify config file */
116          if (configfile != NULL) {
117             free(configfile);
118          }
119          configfile = bstrdup(optarg);
120          break;
121
122       case 'd':                    /* debug level */
123          debug_level = atoi(optarg);
124          if (debug_level <= 0)
125             debug_level = 1;
126          break;
127
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));
132             exit(1);
133          }
134          while (fgets(line, sizeof(line), fd) != NULL) {
135             strip_trailing_junk(line);
136             Dmsg1(100, "add_exclude %s\n", line);
137             add_fname_to_exclude_list(ff, line);
138          }
139          fclose(fd);
140          break;
141
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));
146             exit(1);
147          }
148          while (fgets(line, sizeof(line), fd) != NULL) {
149             strip_trailing_junk(line);
150             Dmsg1(100, "add_include %s\n", line);
151             add_fname_to_include_list(ff, 0, line);
152          }
153          fclose(fd);
154          break;
155
156       case 'j':
157          list_jobs = true;
158          break;
159
160       case 'k':
161          list_blocks = true;
162          break;
163
164       case 'L':
165          dump_label = true;
166          break;
167
168       case 'p':
169          ignore_label_errors = true;
170          forge_on = true;
171          break;
172
173       case 'v':
174          verbose++;
175          break;
176
177       case 'V':                    /* Volume name */
178          VolumeName = optarg;
179          break;
180
181       case '?':
182       default:
183          usage();
184
185       } /* end switch */
186    } /* end while */
187    argc -= optind;
188    argv += optind;
189
190    if (!argc) {
191       Pmsg0(0, _("No archive name specified\n"));
192       usage();
193    }
194
195    if (configfile == NULL) {
196       configfile = bstrdup(CONFIG_FILE);
197    }
198
199    parse_config(configfile);
200
201    if (ff->included_files_list == NULL) {
202       add_fname_to_include_list(ff, 0, "/");
203    }
204
205    for (i=0; i < argc; i++) {
206       if (bsrName) {
207          bsr = parse_bsr(NULL, bsrName);
208       }
209       jcr = setup_jcr("bls", argv[i], bsr, VolumeName, 1); /* acquire for read */
210       if (!jcr) {
211          exit(1);
212       }
213       jcr->ignore_label_errors = ignore_label_errors;
214       dev = jcr->dcr->dev;
215       if (!dev) {
216          exit(1);
217       }
218       dcr = jcr->dcr;
219       rec = new_record();
220       block = new_block(dev);
221       attr = new_attr();
222       /*
223        * Assume that we have already read the volume label.
224        * If on second or subsequent volume, adjust buffer pointer
225        */
226       if (dev->VolHdr.PrevVolName[0] != 0) { /* second volume */
227          Pmsg1(0, "\n"
228 "Warning, this Volume is a continuation of Volume %s\n",
229                 dev->VolHdr.PrevVolName);
230       }
231
232       if (list_blocks) {
233          do_blocks(argv[i]);
234       } else if (list_jobs) {
235          do_jobs(argv[i]);
236       } else {
237          do_ls(argv[i]);
238       }
239       do_close(jcr);
240    }
241    if (bsr) {
242       free_bsr(bsr);
243    }
244    term_include_exclude_files(ff);
245    term_find_files(ff);
246    return 0;
247 }
248
249
250 static void do_close(JCR *jcr)
251 {
252    release_device(jcr->dcr);
253    free_attr(attr);
254    free_record(rec);
255    free_block(block);
256    free_jcr(jcr);
257    term_dev(dev);
258 }
259
260
261 /* List just block information */
262 static void do_blocks(char *infname)
263 {
264    for ( ;; ) {
265       if (!read_block_from_device(dcr, NO_BLOCK_NUMBER_CHECK)) {
266          Dmsg1(100, "!read_block(): ERR=%s\n", dev->strerror());
267          if (dev->at_eot()) {
268             if (!mount_next_read_volume(dcr)) {
269                Jmsg(jcr, M_INFO, 0, _("Got EOM at file %u on device %s, Volume \"%s\"\n"),
270                   dev->file, dev->print_name(), dcr->VolumeName);
271                break;
272             }
273             /* Read and discard Volume label */
274             DEV_RECORD *record;
275             record = new_record();
276             read_block_from_device(dcr, NO_BLOCK_NUMBER_CHECK);
277             read_record_from_block(block, record);
278             get_session_record(dev, record, &sessrec);
279             free_record(record);
280             Jmsg(jcr, M_INFO, 0, _("Mounted Volume \"%s\".\n"), dcr->VolumeName);
281          } else if (dev->at_eof()) {
282             Jmsg(jcr, M_INFO, 0, _("Got EOF at file %u on device %s, Volume \"%s\"\n"),
283                dev->file, dev->print_name(), dcr->VolumeName);
284             Dmsg0(20, "read_record got eof. try again\n");
285             continue;
286          } else if (dev->state & ST_SHORT) {
287             Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
288             continue;
289          } else {
290             /* I/O error */
291             display_tape_error_status(jcr, dev);
292             break;
293          }
294       }
295       if (!match_bsr_block(bsr, block)) {
296          Dmsg5(100, "reject 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          continue;
300       }
301       Dmsg5(100, "Blk=%u blen=%u bVer=%d SessId=%u SessTim=%u\n",
302         block->BlockNumber, block->block_len, block->BlockVer,
303         block->VolSessionId, block->VolSessionTime);
304       if (verbose == 1) {
305          read_record_from_block(block, rec);
306          Pmsg9(-1, "File:blk=%u:%u blk_num=%u blen=%u First rec FI=%s SessId=%u SessTim=%u Strm=%s rlen=%d\n",
307               dev->file, dev->block_num,
308               block->BlockNumber, block->block_len,
309               FI_to_ascii(rec->FileIndex), rec->VolSessionId, rec->VolSessionTime,
310               stream_to_ascii(rec->Stream, rec->FileIndex), rec->data_len);
311          rec->remainder = 0;
312       } else if (verbose > 1) {
313          dump_block(block, "");
314       } else {
315          printf("Block: %d size=%d\n", block->BlockNumber, block->block_len);
316       }
317
318    }
319    return;
320 }
321
322 /*
323  * We are only looking for labels or in particular Job Session records
324  */
325 static bool jobs_cb(DCR *dcr, DEV_RECORD *rec)
326 {
327    if (rec->FileIndex < 0) {
328       dump_label_record(dcr->dev, rec, verbose);
329    }
330    rec->remainder = 0;
331    return true;
332 }
333
334 /* Do list job records */
335 static void do_jobs(char *infname)
336 {
337    read_records(dcr, jobs_cb, mount_next_read_volume);
338 }
339
340 /* Do an ls type listing of an archive */
341 static void do_ls(char *infname)
342 {
343    if (dump_label) {
344       dump_volume_label(dev);
345       return;
346    }
347    read_records(dcr, record_cb, mount_next_read_volume);
348    printf("%u files found.\n", num_files);
349 }
350
351 /*
352  * Called here for each record from read_records()
353  */
354 static bool record_cb(DCR *dcr, DEV_RECORD *rec)
355 {
356    if (rec->FileIndex < 0) {
357       get_session_record(dev, rec, &sessrec);
358       return true;
359    }
360    /* File Attributes stream */
361    if (rec->Stream == STREAM_UNIX_ATTRIBUTES ||
362        rec->Stream == STREAM_UNIX_ATTRIBUTES_EX) {
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          if (verbose) {
382             Pmsg5(-1, "FileIndex=%d VolSessionId=%d VolSessionTime=%d Stream=%d DataLen=%d\n",
383                   rec->FileIndex, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
384          }
385          print_ls_output(jcr, attr);
386          num_files++;
387       }
388    }
389    return true;
390 }
391
392
393 static void get_session_record(DEVICE *dev, DEV_RECORD *rec, SESSION_LABEL *sessrec)
394 {
395    const char *rtype;
396    memset(sessrec, 0, sizeof(sessrec));
397    switch (rec->FileIndex) {
398    case PRE_LABEL:
399       rtype = "Fresh Volume Label";
400       break;
401    case VOL_LABEL:
402       rtype = "Volume Label";
403       unser_volume_label(dev, rec);
404       break;
405    case SOS_LABEL:
406       rtype = "Begin Job Session";
407       unser_session_label(sessrec, rec);
408       break;
409    case EOS_LABEL:
410       rtype = "End Job Session";
411       break;
412    case EOM_LABEL:
413       rtype = "End of Medium";
414       break;
415    default:
416       rtype = "Unknown";
417       break;
418    }
419    Dmsg5(10, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
420          rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
421    if (verbose) {
422       Pmsg5(-1, "%s Record: VolSessionId=%d VolSessionTime=%d JobId=%d DataLen=%d\n",
423             rtype, rec->VolSessionId, rec->VolSessionTime, rec->Stream, rec->data_len);
424    }
425 }
426
427
428 /* Dummies to replace askdir.c */
429 bool    dir_get_volume_info(DCR *dcr, enum get_vol_info_rw  writing) { return 1;}
430 bool    dir_find_next_appendable_volume(DCR *dcr) { return 1;}
431 bool    dir_update_volume_info(DCR *dcr, bool relabel) { return 1; }
432 bool    dir_create_jobmedia_record(DCR *dcr) { return 1; }
433 bool    dir_ask_sysop_to_create_appendable_volume(DCR *dcr) { return 1; }
434 bool    dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec) { return 1;}
435 bool    dir_send_job_status(JCR *jcr) {return 1;}
436 int     generate_job_event(JCR *jcr, const char *event) { return 1; }
437 bool    python_set_prog(JCR*, char const*) { return false; }
438
439 bool dir_ask_sysop_to_mount_volume(DCR *dcr)
440 {
441    DEVICE *dev = dcr->dev;
442    fprintf(stderr, "Mount Volume \"%s\" on device %s and press return when ready: ",
443       dcr->VolumeName, dev->print_name());
444    getchar();
445    return true;
446 }