1 # This file was automatically generated by SWIG (http://www.swig.org).
4 # Don't modify this file, modify the SWIG interface instead.
6 package Amanda::Logfile;
9 @ISA = qw(Exporter DynaLoader);
10 require Amanda::Cmdline;
11 package Amanda::Logfilec;
12 bootstrap Amanda::Logfile;
13 package Amanda::Logfile;
16 # ---------- BASE METHODS -------------
18 package Amanda::Logfile;
21 my ($classname,$obj) = @_;
22 return bless $obj, $classname;
32 my ($self,$field) = @_;
33 my $member_func = "swig_${field}_get";
34 $self->$member_func();
38 my ($self,$field,$newval) = @_;
39 my $member_func = "swig_${field}_set";
40 $self->$member_func($newval);
49 # ------- FUNCTION WRAPPERS --------
51 package Amanda::Logfile;
53 *open_logfile = *Amanda::Logfilec::open_logfile;
54 *close_logfile = *Amanda::Logfilec::close_logfile;
55 *get_logline = *Amanda::Logfilec::get_logline;
56 *find_log = *Amanda::Logfilec::find_log;
57 *search_logfile = *Amanda::Logfilec::search_logfile;
58 *dumps_match = *Amanda::Logfilec::dumps_match;
59 *dumps_match_dumpspecs = *Amanda::Logfilec::dumps_match_dumpspecs;
61 ############# Class : Amanda::Logfile::find_result_t ##############
63 package Amanda::Logfile::find_result_t;
64 use vars qw(@ISA %OWNER %ITERATORS %BLESSEDMEMBERS);
65 @ISA = qw( Amanda::Logfile );
69 return unless $_[0]->isa('HASH');
70 my $self = tied(%{$_[0]});
71 return unless defined $self;
72 delete $ITERATORS{$self};
73 if (exists $OWNER{$self}) {
74 Amanda::Logfilec::delete_find_result_t($self);
79 *swig_timestamp_get = *Amanda::Logfilec::find_result_t_timestamp_get;
80 *swig_timestamp_set = *Amanda::Logfilec::find_result_t_timestamp_set;
81 *swig_hostname_get = *Amanda::Logfilec::find_result_t_hostname_get;
82 *swig_hostname_set = *Amanda::Logfilec::find_result_t_hostname_set;
83 *swig_diskname_get = *Amanda::Logfilec::find_result_t_diskname_get;
84 *swig_diskname_set = *Amanda::Logfilec::find_result_t_diskname_set;
85 *swig_level_get = *Amanda::Logfilec::find_result_t_level_get;
86 *swig_level_set = *Amanda::Logfilec::find_result_t_level_set;
87 *swig_label_get = *Amanda::Logfilec::find_result_t_label_get;
88 *swig_label_set = *Amanda::Logfilec::find_result_t_label_set;
89 *swig_filenum_get = *Amanda::Logfilec::find_result_t_filenum_get;
90 *swig_filenum_set = *Amanda::Logfilec::find_result_t_filenum_set;
91 *swig_status_get = *Amanda::Logfilec::find_result_t_status_get;
92 *swig_status_set = *Amanda::Logfilec::find_result_t_status_set;
93 *swig_partnum_get = *Amanda::Logfilec::find_result_t_partnum_get;
94 *swig_partnum_set = *Amanda::Logfilec::find_result_t_partnum_set;
95 *swig_sec_get = *Amanda::Logfilec::find_result_t_sec_get;
96 *swig_sec_set = *Amanda::Logfilec::find_result_t_sec_set;
97 *swig_kb_get = *Amanda::Logfilec::find_result_t_kb_get;
98 *swig_kb_set = *Amanda::Logfilec::find_result_t_kb_set;
101 my $self = Amanda::Logfilec::new_find_result_t(@_);
102 bless $self, $pkg if defined($self);
107 my $ptr = tied(%$self);
113 my $ptr = tied(%$self);
118 # ------- VARIABLE STUBS --------
120 package Amanda::Logfile;
122 *L_BOGUS = *Amanda::Logfilec::L_BOGUS;
123 *L_FATAL = *Amanda::Logfilec::L_FATAL;
124 *L_ERROR = *Amanda::Logfilec::L_ERROR;
125 *L_WARNING = *Amanda::Logfilec::L_WARNING;
126 *L_INFO = *Amanda::Logfilec::L_INFO;
127 *L_SUMMARY = *Amanda::Logfilec::L_SUMMARY;
128 *L_START = *Amanda::Logfilec::L_START;
129 *L_FINISH = *Amanda::Logfilec::L_FINISH;
130 *L_DISK = *Amanda::Logfilec::L_DISK;
131 *L_DONE = *Amanda::Logfilec::L_DONE;
132 *L_PART = *Amanda::Logfilec::L_PART;
133 *L_PARTPARTIAL = *Amanda::Logfilec::L_PARTPARTIAL;
134 *L_SUCCESS = *Amanda::Logfilec::L_SUCCESS;
135 *L_PARTIAL = *Amanda::Logfilec::L_PARTIAL;
136 *L_FAIL = *Amanda::Logfilec::L_FAIL;
137 *L_STRANGE = *Amanda::Logfilec::L_STRANGE;
138 *L_CHUNK = *Amanda::Logfilec::L_CHUNK;
139 *L_CHUNKSUCCESS = *Amanda::Logfilec::L_CHUNKSUCCESS;
140 *L_STATS = *Amanda::Logfilec::L_STATS;
141 *L_MARKER = *Amanda::Logfilec::L_MARKER;
142 *L_CONT = *Amanda::Logfilec::L_CONT;
143 *P_UNKNOWN = *Amanda::Logfilec::P_UNKNOWN;
144 *P_PLANNER = *Amanda::Logfilec::P_PLANNER;
145 *P_DRIVER = *Amanda::Logfilec::P_DRIVER;
146 *P_REPORTER = *Amanda::Logfilec::P_REPORTER;
147 *P_DUMPER = *Amanda::Logfilec::P_DUMPER;
148 *P_CHUNKER = *Amanda::Logfilec::P_CHUNKER;
149 *P_TAPER = *Amanda::Logfilec::P_TAPER;
150 *P_AMFLUSH = *Amanda::Logfilec::P_AMFLUSH;
157 Amanda::Logfile - manage Amanda trace logs
161 use Amanda::Logfile qw(:logtype_t);
162 use Amanda::Config qw( :getconf config_dir_relative );
164 for my $logfile (Amanda::Logfile::find_log()) {
165 $logfile = config_dir_relative(getconf($CNF_LOGDIR)) . "/" . $logfile;
167 my $hdl = Amanda::Logfile::open_logfile($logfile);
168 while (my ($type, $prog, $str) = Amanda::Logfile::get_logline($hdl)) {
169 if ($type == $L_INFO) {
170 my $pname = Amanda::Logfile::program_t_to_string($prog);
171 print "Found info line from $pname: $str\n";
174 Amanda::Logfile::close_logfile($log);
176 my @dumps = Amanda::Logfile::search_logfile("TapeLabel-001", "19780615", $logfile, 1);
178 my @matching = Amanda::Logfile::dumps_match([@dumps], "myhost", "/usr", undef, undef, 0);
179 for my $dump (@matching) {
180 print "$dump->{'label'}:$dump->{'filenum'} = $dump->{'hostname'}:$dump->{'disk'}\n";
188 =head1 RAW LOGFILE ACCESS
190 This section corresponds to the C C<logfile> module.
192 Raw access to logfiles is accomplished by opening a logfile and
193 fetching log lines one by one via the C<get_logline> function.
195 A log line is represented by a list C<($type, $prog, $string)>
196 where C<$type> is one of the C<L_*> constants (available in export
197 tag C<logtype_t>), C<$prog> is one of the C<P_*> constants (available
198 in export tag C<program_t>), and C<$str> is the remainder of the line.
200 Both families of constants can be converted to symbolic names with
201 C<logtype_t_to_string> and C<program_t_to_string>, respectively.
207 =item C<open_logfile($filename)>
209 Opens a logfile for reading, returning an opaque log file handle.
211 =item C<close_logfile($handle)>
213 Closes a log file handle.
215 =item C<get_logline($handle)>
217 Return a list as described above representing the next log line in
218 C<$handle>, or nothing at the end of the logfile.
222 All of these functions can be imported by name if desired.
224 =head1 Amanda::Find::find_result_t objects
226 These objects contain information about dumps, as read from logfiles.
227 Instance variables are:
253 Note that the format for these variables are based on that found in the
254 logfiles. In particular, C<partnum> is a string, usually with a slash (C</>)
255 in it. Also, C<timestamp> is the timestamp for the run in which the client
256 dump took place, and not for the timestamp of the logfile.
258 =head1 HIGHER-LEVEL FUNCTIONS
260 Functions in this section extract information from logfiles.
266 Return a list of logfiles for active tapes. The tapelist must be loaded before
267 this function is called (see L<Amanda::Tapelist>).
269 =item C<search_logfile($label, $datestamp, $logfile, $add_missing_disks)>
271 Return all results in C<$logfile> matching C<$label> and C<$datestamp>.
272 If C<$add_missing_disks> is true, then any disks in the logfile
273 not present in the disklist are added to the disklist; otherwise,
274 such dumps are skipped.
276 =item C<dumps_match([@results], $hostname, $diskname, $datestamp, $level, $ok)>
278 Return a filtered version of C<@results> containing only results that match the
279 given expressions. If C<$ok> is true, don't match partial results. Note that
280 C<$level> is given as a string, since it is a match expression.
282 All of these functions can be imported by name.
288 push @EXPORT_OK, qw(open_logfile get_logline close_logfile);
290 push @EXPORT_OK, qw(logtype_t_to_string);
291 push @{$EXPORT_TAGS{"logtype_t"}}, qw(logtype_t_to_string);
293 my %_logtype_t_VALUES;
294 #Convert an enum value to a single string
295 sub logtype_t_to_string {
298 for my $k (keys %_logtype_t_VALUES) {
299 my $v = $_logtype_t_VALUES{$k};
301 #is this a matching flag?
302 if ($enumval == $v) {
307 #default, just return the number
311 push @EXPORT_OK, qw($L_BOGUS);
312 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_BOGUS);
314 $_logtype_t_VALUES{"L_BOGUS"} = $L_BOGUS;
316 push @EXPORT_OK, qw($L_FATAL);
317 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_FATAL);
319 $_logtype_t_VALUES{"L_FATAL"} = $L_FATAL;
321 push @EXPORT_OK, qw($L_ERROR);
322 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_ERROR);
324 $_logtype_t_VALUES{"L_ERROR"} = $L_ERROR;
326 push @EXPORT_OK, qw($L_WARNING);
327 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_WARNING);
329 $_logtype_t_VALUES{"L_WARNING"} = $L_WARNING;
331 push @EXPORT_OK, qw($L_INFO);
332 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_INFO);
334 $_logtype_t_VALUES{"L_INFO"} = $L_INFO;
336 push @EXPORT_OK, qw($L_SUMMARY);
337 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_SUMMARY);
339 $_logtype_t_VALUES{"L_SUMMARY"} = $L_SUMMARY;
341 push @EXPORT_OK, qw($L_START);
342 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_START);
344 $_logtype_t_VALUES{"L_START"} = $L_START;
346 push @EXPORT_OK, qw($L_FINISH);
347 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_FINISH);
349 $_logtype_t_VALUES{"L_FINISH"} = $L_FINISH;
351 push @EXPORT_OK, qw($L_DISK);
352 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_DISK);
354 $_logtype_t_VALUES{"L_DISK"} = $L_DISK;
356 push @EXPORT_OK, qw($L_DONE);
357 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_DONE);
359 $_logtype_t_VALUES{"L_DONE"} = $L_DONE;
361 push @EXPORT_OK, qw($L_PART);
362 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_PART);
364 $_logtype_t_VALUES{"L_PART"} = $L_PART;
366 push @EXPORT_OK, qw($L_PARTPARTIAL);
367 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_PARTPARTIAL);
369 $_logtype_t_VALUES{"L_PARTPARTIAL"} = $L_PARTPARTIAL;
371 push @EXPORT_OK, qw($L_SUCCESS);
372 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_SUCCESS);
374 $_logtype_t_VALUES{"L_SUCCESS"} = $L_SUCCESS;
376 push @EXPORT_OK, qw($L_PARTIAL);
377 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_PARTIAL);
379 $_logtype_t_VALUES{"L_PARTIAL"} = $L_PARTIAL;
381 push @EXPORT_OK, qw($L_FAIL);
382 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_FAIL);
384 $_logtype_t_VALUES{"L_FAIL"} = $L_FAIL;
386 push @EXPORT_OK, qw($L_STRANGE);
387 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_STRANGE);
389 $_logtype_t_VALUES{"L_STRANGE"} = $L_STRANGE;
391 push @EXPORT_OK, qw($L_CHUNK);
392 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_CHUNK);
394 $_logtype_t_VALUES{"L_CHUNK"} = $L_CHUNK;
396 push @EXPORT_OK, qw($L_CHUNKSUCCESS);
397 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_CHUNKSUCCESS);
399 $_logtype_t_VALUES{"L_CHUNKSUCCESS"} = $L_CHUNKSUCCESS;
401 push @EXPORT_OK, qw($L_STATS);
402 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_STATS);
404 $_logtype_t_VALUES{"L_STATS"} = $L_STATS;
406 push @EXPORT_OK, qw($L_MARKER);
407 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_MARKER);
409 $_logtype_t_VALUES{"L_MARKER"} = $L_MARKER;
411 push @EXPORT_OK, qw($L_CONT);
412 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_CONT);
414 $_logtype_t_VALUES{"L_CONT"} = $L_CONT;
416 push @EXPORT_OK, qw(program_t_to_string);
417 push @{$EXPORT_TAGS{"program_t"}}, qw(program_t_to_string);
419 my %_program_t_VALUES;
420 #Convert an enum value to a single string
421 sub program_t_to_string {
424 for my $k (keys %_program_t_VALUES) {
425 my $v = $_program_t_VALUES{$k};
427 #is this a matching flag?
428 if ($enumval == $v) {
433 #default, just return the number
437 push @EXPORT_OK, qw($P_UNKNOWN);
438 push @{$EXPORT_TAGS{"program_t"}}, qw($P_UNKNOWN);
440 $_program_t_VALUES{"P_UNKNOWN"} = $P_UNKNOWN;
442 push @EXPORT_OK, qw($P_PLANNER);
443 push @{$EXPORT_TAGS{"program_t"}}, qw($P_PLANNER);
445 $_program_t_VALUES{"P_PLANNER"} = $P_PLANNER;
447 push @EXPORT_OK, qw($P_DRIVER);
448 push @{$EXPORT_TAGS{"program_t"}}, qw($P_DRIVER);
450 $_program_t_VALUES{"P_DRIVER"} = $P_DRIVER;
452 push @EXPORT_OK, qw($P_REPORTER);
453 push @{$EXPORT_TAGS{"program_t"}}, qw($P_REPORTER);
455 $_program_t_VALUES{"P_REPORTER"} = $P_REPORTER;
457 push @EXPORT_OK, qw($P_DUMPER);
458 push @{$EXPORT_TAGS{"program_t"}}, qw($P_DUMPER);
460 $_program_t_VALUES{"P_DUMPER"} = $P_DUMPER;
462 push @EXPORT_OK, qw($P_CHUNKER);
463 push @{$EXPORT_TAGS{"program_t"}}, qw($P_CHUNKER);
465 $_program_t_VALUES{"P_CHUNKER"} = $P_CHUNKER;
467 push @EXPORT_OK, qw($P_TAPER);
468 push @{$EXPORT_TAGS{"program_t"}}, qw($P_TAPER);
470 $_program_t_VALUES{"P_TAPER"} = $P_TAPER;
472 push @EXPORT_OK, qw($P_AMFLUSH);
473 push @{$EXPORT_TAGS{"program_t"}}, qw($P_AMFLUSH);
475 $_program_t_VALUES{"P_AMFLUSH"} = $P_AMFLUSH;
477 push @EXPORT_OK, qw(find_log search_logfile dumps_match);