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
43 $log = new('log', 'dat', 'm');
45 # create a log object that contains all the useful info needed
46 # prefix is the main directory off of the data directory
47 # sort is 'm' for monthly, 'd' for daily
50 my ($prefix, $suffix, $sort) = @_;
52 $ref->{prefix} = "$main::data/$prefix";
53 $ref->{suffix} = $suffix if $suffix;
56 # make sure the directory exists
57 mkdir($ref->{prefix}, 0777) if ! -e $ref->{prefix};
61 # open the appropriate data file
64 my ($self, $year, $thing, $mode) = @_;
66 # if we are writing, check that the directory exists
68 my $dir = "$self->{prefix}/$year";
69 mkdir($dir, 0777) if ! -e $dir;
70 $self->{mode} = $mode;
75 $self->{fn} = sprintf "$self->{prefix}/$year/%02d", $thing if $self->{sort} eq 'm';
76 $self->{fn} = sprintf "$self->{prefix}/$year/%03d", $thing if $self->{sort} eq 'd';
77 $self->{fn} .= ".$self->{suffix}" if $self->{suffix};
79 $mode = 'r' if !$mode;
80 my $fh = new FileHandle $self->{fn}, $mode;
82 $fh->autoflush(1) if $mode ne 'r'; # make it autoflushing if writable
85 $self->{year} = $year;
86 $self->{thing} = $thing;
88 DXDebug::dbg("dxlog", "opening $self->{fn}\n");
93 # open the previous log file in sequence
97 if ($self->{sort} eq 'm') {
98 ($self->{year}, $self->{thing}) = Julian::subm($self->{year}, $self->{thing}, 1);
99 } elsif ($self->{sort} eq 'd') {
100 ($self->{year}, $self->{thing}) = Julian::sub($self->{year}, $self->{thing}, 1);
102 return $self->open($self->{year}, $self->{thing}, @_);
105 # open the next log file in sequence
109 if ($self->{sort} eq 'm') {
110 ($self->{year}, $self->{thing}) = Julian::addm($self->{year}, $self->{thing}, 1);
111 } elsif ($self->{sort} eq 'd') {
112 ($self->{year}, $self->{thing}) = Julian::add($self->{year}, $self->{thing}, 1);
114 return $self->open($self->{year}, $self->{thing}, @_);
117 # convert a date into the correct format from a unix date depending on its sort
122 if ($self->{sort} eq 'm') {
123 return Julian::unixtojm(shift);
124 } elsif ($self->{sort} eq 'd') {
125 return Julian::unixtoj(shift);
127 confess "shouldn't get here";
130 # write (actually append) to a file, opening new files as required
133 my ($self, $year, $thing, $line) = @_;
135 $self->{mode} ne ">>" ||
136 $year != $self->{year} ||
137 $thing != $self->{thing}) {
138 $self->open($year, $thing, ">>") or confess "can't open $self->{fn} $!";
141 return $self->{fh}->print("$line\n");
144 # write (actually append) using the current date to a file, opening new files as required
147 my ($self, $line) = @_;
149 my @date = $self->unixtoj($t);
150 return $self->write(@date, $line);
153 # write (actually append) using a unix time to a file, opening new files as required
156 my ($self, $t, $line) = @_;
157 my @date = $self->unixtoj($t);
158 return $self->write(@date, $line);
161 # close the log file handle
165 undef $self->{fh}; # close the filehandle
167 delete $self->{mode};
170 # log something in the system log
171 # this routine is exported to any module that declares DXLog
172 # it takes all its args and joins them together with the unixtime writes them out as one line
173 # The user is responsible for making sense of this!
177 $log->writeunix($t, join('^', $t, @_) );
180 sub DESTROY # catch undefs and do what is required further do the tree
183 DXDebug::dbg("dxlog", "closing $self->{fn}\n");
184 undef $self->{fh} if defined $self->{fh};