2 # the general purpose logging machine
4 # This module is designed to allow you to log stuff in specific places
5 # and will rotate logs on a monthly, weekly or daily basis.
7 # The idea is that you give it a prefix which is a directory and then
8 # the system will log stuff to a directory structure which looks like:-
11 # spots/1998/<julian day no>[.<optional suffix>]
14 # log/1998/<week no>[.<optional suffix>]
17 # wwv/1998/<month>[.<optional suffix>]
19 # Routines are provided to read these files in and to append to them
21 # Copyright (c) - 1998 Dirk Koopman G1TLH
37 # create a log object that contains all the useful info needed
38 # prefix is the main directory off of the data directory
39 # sort is 'm' for monthly, 'd' for daily
42 my ($prefix, $suffix, $sort) = @_;
44 $ref->{prefix} = "$main::data/$prefix";
45 $ref->{suffix} = $suffix if $suffix;
48 # make sure the directory exists
49 mkdir($ref->{prefix}, 0777) if ! -e $ref->{prefix};
53 # open the appropriate data file
56 my ($self, $year, $thing, $mode) = @_;
58 # if we are writing, check that the directory exists
60 my $dir = "$self->{prefix}/$year";
61 mkdir($dir, 0777) if ! -e $dir;
62 $self->{mode} = $mode;
67 $self->{fn} = sprintf "$self->{prefix}/$year/%03d", $thing;
68 $self->{fn} .= ".$self->{suffix}" if $self->{suffix};
70 $mode = 'r' if !$mode;
71 my $fh = new FileHandle $self->{fn}, $mode;
73 $fh->autoflush(1) if $mode ne 'r'; # make it autoflushing if writable
76 $self->{year} = $year;
77 $self->{thing} = $thing;
79 dbg("dxlog", "opening $self->{fn}\n");
84 # open the previous log file in sequence
88 if ($self->{sort} eq 'm') {
89 ($self->{year}, $self->{thing}) = Julian::subm($self->{year}, $self->{thing}, 1);
90 } elsif ($self->{sort} eq 'd') {
91 ($self->{year}, $self->{thing}) = Julian::sub($self->{year}, $self->{thing}, 1);
93 return $self->open($self->{year}, $self->{thing}, @_);
96 # open the next log file in sequence
100 if ($self->{sort} eq 'm') {
101 ($self->{year}, $self->{thing}) = Julian::addm($self->{year}, $self->{thing}, 1);
102 } elsif ($self->{sort} eq 'd') {
103 ($self->{year}, $self->{thing}) = Julian::add($self->{year}, $self->{thing}, 1);
105 return $self->open($self->{year}, $self->{thing}, @_);
108 # write (actually append) to a file, opening new files as required
111 my ($self, $year, $thing, $line) = @_;
112 $self->open($year, $thing, ">>") if (!$self->{fh} ||
113 $self->{mode} ne ">>" ||
114 $year != $self->{year} ||
115 $thing != $self->{thing})
116 or confess "can't open $self->{fn} $!";
118 $self->{fh}->print("$line\n");
122 # write (actually append) using the current date to a file, opening new files as required
125 my ($self, $line) = @_;
126 my @date = unixtoj(time) if $self->{sort} = 'd';
127 @date = unixtojm(time) if $self->{sort} = 'm';
129 return $self->write(@date, $line);
132 # close the log file handle
136 undef $self->{fh}; # close the filehandle
138 delete $self->{mode};
141 sub DESTROY # catch undefs and do what is required further do the tree
144 dbg("dxlog", "closing $self->{fn}\n");
145 undef $self->{fh} if defined $self->{fh};