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;
97 my $self = Amanda::Logfilec::new_find_result_t(@_);
98 bless $self, $pkg if defined($self);
103 my $ptr = tied(%$self);
109 my $ptr = tied(%$self);
114 # ------- VARIABLE STUBS --------
116 package Amanda::Logfile;
118 *L_BOGUS = *Amanda::Logfilec::L_BOGUS;
119 *L_FATAL = *Amanda::Logfilec::L_FATAL;
120 *L_ERROR = *Amanda::Logfilec::L_ERROR;
121 *L_WARNING = *Amanda::Logfilec::L_WARNING;
122 *L_INFO = *Amanda::Logfilec::L_INFO;
123 *L_SUMMARY = *Amanda::Logfilec::L_SUMMARY;
124 *L_START = *Amanda::Logfilec::L_START;
125 *L_FINISH = *Amanda::Logfilec::L_FINISH;
126 *L_DISK = *Amanda::Logfilec::L_DISK;
127 *L_DONE = *Amanda::Logfilec::L_DONE;
128 *L_PART = *Amanda::Logfilec::L_PART;
129 *L_PARTPARTIAL = *Amanda::Logfilec::L_PARTPARTIAL;
130 *L_SUCCESS = *Amanda::Logfilec::L_SUCCESS;
131 *L_PARTIAL = *Amanda::Logfilec::L_PARTIAL;
132 *L_FAIL = *Amanda::Logfilec::L_FAIL;
133 *L_STRANGE = *Amanda::Logfilec::L_STRANGE;
134 *L_CHUNK = *Amanda::Logfilec::L_CHUNK;
135 *L_CHUNKSUCCESS = *Amanda::Logfilec::L_CHUNKSUCCESS;
136 *L_STATS = *Amanda::Logfilec::L_STATS;
137 *L_MARKER = *Amanda::Logfilec::L_MARKER;
138 *L_CONT = *Amanda::Logfilec::L_CONT;
139 *P_UNKNOWN = *Amanda::Logfilec::P_UNKNOWN;
140 *P_PLANNER = *Amanda::Logfilec::P_PLANNER;
141 *P_DRIVER = *Amanda::Logfilec::P_DRIVER;
142 *P_REPORTER = *Amanda::Logfilec::P_REPORTER;
143 *P_DUMPER = *Amanda::Logfilec::P_DUMPER;
144 *P_CHUNKER = *Amanda::Logfilec::P_CHUNKER;
145 *P_TAPER = *Amanda::Logfilec::P_TAPER;
146 *P_AMFLUSH = *Amanda::Logfilec::P_AMFLUSH;
153 Amanda::Logfile - manage Amanda trace logs
157 use Amanda::Logfile qw(:logtype_t); # XXX change
158 use Amanda::Config qw( :getconf config_dir_relative );
160 for my $logfile (Amanda::Logfile::find_log()) {
161 $logfile = config_dir_relative(getconf($CNF_LOGDIR)) . "/" . $logfile;
163 my $hdl = Amanda::Logfile::open_logfile($logfile);
164 while (my ($type, $prog, $str) = Amanda::Logfile::get_logline($hdl)) {
165 if ($type == $L_INFO) {
166 my $pname = Amanda::Logfile::program_t_to_string($prog);
167 print "Found info line from $pname: $str\n";
170 Amanda::Logfile::close_logfile($log);
172 my @dumps = Amanda::Logfile::search_logfile("TapeLabel-001", "19780615", $logfile);
174 my @matching = Amanda::Logfile::dumps_match([@dumps], "myhost", "/usr", undef, undef, 0);
175 for my $dump (@matching) {
176 print "$dump->{'label'}:$dump->{'filenum'} = $dump->{'hostname'}:$dump->{'disk'}\n";
184 =head1 RAW LOGFILE ACCESS
186 This section corresponds to the C C<logfile> module.
188 Raw access to logfiles is accomplished by opening a logfile and
189 fetching log lines one by one via the C<get_logline> function.
191 A log line is represented by a list C<($type, $prog, $string)>
192 where C<$type> is one of the C<L_*> constants (available in export
193 tag C<logtype_t>), C<$prog> is one of the C<P_*> constants (available
194 in export tag C<program_t>), and C<$str> is the remainder of the line.
196 Both families of constants can be converted to symbolic names with
197 C<logtype_t_to_string> and C<program_t_to_string>, respectively.
203 =item C<open_logfile($filename)>
205 Opens a logfile for reading, returning an opaque log file handle.
207 =item C<close_logfile($handle)>
209 Closes a log file handle.
211 =item C<get_logline($handle)>
213 Return a list as described above representing the next log line in
214 C<$handle>, or nothing at the end of the logfile.
218 All of these functions can be imported by name if desired.
220 =head1 Amanda::Find::find_result_t objects
222 These objects contain information about dumps, as read from logfiles.
223 Instance variables are:
245 =head1 HIGHER-LEVEL FUNCTIONS
247 Functions in this section extract information from logfiles.
253 Return a list of logfiles for active tapes. The tapelist must be loaded before
254 this function is called (see L<Amanda::Tapefile>, and note that this module will be
255 renamed to L<Amanda::Tapelist> in Amanda-2.6.1).
257 =item C<search_logfile($label, $datestamp, $logfile, $add_missing_disks)>
259 Return all results in C<$logfile> matching C<$label> and C<$datestamp>.
260 If C<$add_missing_disks> is true, then any disks in the logfile
261 not present in the disklist are added to the disklist; otherwise,
262 such dumps are skipped.
264 =item C<dumps_match([@results], $hostname, $diskname, $datestamp, $level, $ok)>
266 Return a filtered version of C<@results> containing only results that match the
267 given expressions. If C<$ok> is true, don't match partial results. Note that
268 C<$level> is given as a string, since it is a match expression.
270 All of these functions can be imported by name.
276 push @EXPORT_OK, qw(open_logfile get_logline close_logfile);
278 push @EXPORT_OK, qw(logtype_t_to_string);
279 push @{$EXPORT_TAGS{"logtype_t"}}, qw(logtype_t_to_string);
281 my %_logtype_t_VALUES;
282 #Convert an enum value to a single string
283 sub logtype_t_to_string {
286 for my $k (keys %_logtype_t_VALUES) {
287 my $v = $_logtype_t_VALUES{$k};
289 #is this a matching flag?
290 if ($enumval == $v) {
295 #default, just return the number
299 push @EXPORT_OK, qw($L_BOGUS);
300 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_BOGUS);
302 $_logtype_t_VALUES{"L_BOGUS"} = $L_BOGUS;
304 push @EXPORT_OK, qw($L_FATAL);
305 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_FATAL);
307 $_logtype_t_VALUES{"L_FATAL"} = $L_FATAL;
309 push @EXPORT_OK, qw($L_ERROR);
310 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_ERROR);
312 $_logtype_t_VALUES{"L_ERROR"} = $L_ERROR;
314 push @EXPORT_OK, qw($L_WARNING);
315 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_WARNING);
317 $_logtype_t_VALUES{"L_WARNING"} = $L_WARNING;
319 push @EXPORT_OK, qw($L_INFO);
320 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_INFO);
322 $_logtype_t_VALUES{"L_INFO"} = $L_INFO;
324 push @EXPORT_OK, qw($L_SUMMARY);
325 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_SUMMARY);
327 $_logtype_t_VALUES{"L_SUMMARY"} = $L_SUMMARY;
329 push @EXPORT_OK, qw($L_START);
330 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_START);
332 $_logtype_t_VALUES{"L_START"} = $L_START;
334 push @EXPORT_OK, qw($L_FINISH);
335 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_FINISH);
337 $_logtype_t_VALUES{"L_FINISH"} = $L_FINISH;
339 push @EXPORT_OK, qw($L_DISK);
340 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_DISK);
342 $_logtype_t_VALUES{"L_DISK"} = $L_DISK;
344 push @EXPORT_OK, qw($L_DONE);
345 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_DONE);
347 $_logtype_t_VALUES{"L_DONE"} = $L_DONE;
349 push @EXPORT_OK, qw($L_PART);
350 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_PART);
352 $_logtype_t_VALUES{"L_PART"} = $L_PART;
354 push @EXPORT_OK, qw($L_PARTPARTIAL);
355 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_PARTPARTIAL);
357 $_logtype_t_VALUES{"L_PARTPARTIAL"} = $L_PARTPARTIAL;
359 push @EXPORT_OK, qw($L_SUCCESS);
360 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_SUCCESS);
362 $_logtype_t_VALUES{"L_SUCCESS"} = $L_SUCCESS;
364 push @EXPORT_OK, qw($L_PARTIAL);
365 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_PARTIAL);
367 $_logtype_t_VALUES{"L_PARTIAL"} = $L_PARTIAL;
369 push @EXPORT_OK, qw($L_FAIL);
370 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_FAIL);
372 $_logtype_t_VALUES{"L_FAIL"} = $L_FAIL;
374 push @EXPORT_OK, qw($L_STRANGE);
375 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_STRANGE);
377 $_logtype_t_VALUES{"L_STRANGE"} = $L_STRANGE;
379 push @EXPORT_OK, qw($L_CHUNK);
380 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_CHUNK);
382 $_logtype_t_VALUES{"L_CHUNK"} = $L_CHUNK;
384 push @EXPORT_OK, qw($L_CHUNKSUCCESS);
385 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_CHUNKSUCCESS);
387 $_logtype_t_VALUES{"L_CHUNKSUCCESS"} = $L_CHUNKSUCCESS;
389 push @EXPORT_OK, qw($L_STATS);
390 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_STATS);
392 $_logtype_t_VALUES{"L_STATS"} = $L_STATS;
394 push @EXPORT_OK, qw($L_MARKER);
395 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_MARKER);
397 $_logtype_t_VALUES{"L_MARKER"} = $L_MARKER;
399 push @EXPORT_OK, qw($L_CONT);
400 push @{$EXPORT_TAGS{"logtype_t"}}, qw($L_CONT);
402 $_logtype_t_VALUES{"L_CONT"} = $L_CONT;
404 push @EXPORT_OK, qw(program_t_to_string);
405 push @{$EXPORT_TAGS{"program_t"}}, qw(program_t_to_string);
407 my %_program_t_VALUES;
408 #Convert an enum value to a single string
409 sub program_t_to_string {
412 for my $k (keys %_program_t_VALUES) {
413 my $v = $_program_t_VALUES{$k};
415 #is this a matching flag?
416 if ($enumval == $v) {
421 #default, just return the number
425 push @EXPORT_OK, qw($P_UNKNOWN);
426 push @{$EXPORT_TAGS{"program_t"}}, qw($P_UNKNOWN);
428 $_program_t_VALUES{"P_UNKNOWN"} = $P_UNKNOWN;
430 push @EXPORT_OK, qw($P_PLANNER);
431 push @{$EXPORT_TAGS{"program_t"}}, qw($P_PLANNER);
433 $_program_t_VALUES{"P_PLANNER"} = $P_PLANNER;
435 push @EXPORT_OK, qw($P_DRIVER);
436 push @{$EXPORT_TAGS{"program_t"}}, qw($P_DRIVER);
438 $_program_t_VALUES{"P_DRIVER"} = $P_DRIVER;
440 push @EXPORT_OK, qw($P_REPORTER);
441 push @{$EXPORT_TAGS{"program_t"}}, qw($P_REPORTER);
443 $_program_t_VALUES{"P_REPORTER"} = $P_REPORTER;
445 push @EXPORT_OK, qw($P_DUMPER);
446 push @{$EXPORT_TAGS{"program_t"}}, qw($P_DUMPER);
448 $_program_t_VALUES{"P_DUMPER"} = $P_DUMPER;
450 push @EXPORT_OK, qw($P_CHUNKER);
451 push @{$EXPORT_TAGS{"program_t"}}, qw($P_CHUNKER);
453 $_program_t_VALUES{"P_CHUNKER"} = $P_CHUNKER;
455 push @EXPORT_OK, qw($P_TAPER);
456 push @{$EXPORT_TAGS{"program_t"}}, qw($P_TAPER);
458 $_program_t_VALUES{"P_TAPER"} = $P_TAPER;
460 push @EXPORT_OK, qw($P_AMFLUSH);
461 push @{$EXPORT_TAGS{"program_t"}}, qw($P_AMFLUSH);
463 $_program_t_VALUES{"P_AMFLUSH"} = $P_AMFLUSH;
465 push @EXPORT_OK, qw(find_log search_logfile dumps_match);