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/%03d", $thing;
76 $self->{fn} .= ".$self->{suffix}" if $self->{suffix};
78 $mode = 'r' if !$mode;
79 my $fh = new FileHandle $self->{fn}, $mode;
81 $fh->autoflush(1) if $mode ne 'r'; # make it autoflushing if writable
84 $self->{year} = $year;
85 $self->{thing} = $thing;
87 DXDebug::dbg("dxlog", "opening $self->{fn}\n");
92 # open the previous log file in sequence
96 if ($self->{sort} eq 'm') {
97 ($self->{year}, $self->{thing}) = Julian::subm($self->{year}, $self->{thing}, 1);
98 } elsif ($self->{sort} eq 'd') {
99 ($self->{year}, $self->{thing}) = Julian::sub($self->{year}, $self->{thing}, 1);
101 return $self->open($self->{year}, $self->{thing}, @_);
104 # open the next log file in sequence
108 if ($self->{sort} eq 'm') {
109 ($self->{year}, $self->{thing}) = Julian::addm($self->{year}, $self->{thing}, 1);
110 } elsif ($self->{sort} eq 'd') {
111 ($self->{year}, $self->{thing}) = Julian::add($self->{year}, $self->{thing}, 1);
113 return $self->open($self->{year}, $self->{thing}, @_);
116 # convert a date into the correct format from a unix date depending on its sort
121 if ($self->{sort} eq 'm') {
122 return Julian::unixtojm(shift);
123 } elsif ($self->{sort} eq 'd') {
124 return Julian::unixtoj(shift);
126 confess "shouldn't get here";
129 # write (actually append) to a file, opening new files as required
132 my ($self, $year, $thing, $line) = @_;
134 $self->{mode} ne ">>" ||
135 $year != $self->{year} ||
136 $thing != $self->{thing}) {
137 $self->open($year, $thing, ">>") or confess "can't open $self->{fn} $!";
140 return $self->{fh}->print("$line\n");
143 # write (actually append) using the current date to a file, opening new files as required
146 my ($self, $line) = @_;
147 my @date = $self->unixtoj(time);
148 return $self->write(@date, $line);
151 # write (actually append) using a unix time to a file, opening new files as required
154 my ($self, $t, $line) = @_;
155 my @date = $self->unixtoj($t);
156 return $self->write(@date, $line);
159 # close the log file handle
163 undef $self->{fh}; # close the filehandle
165 delete $self->{mode};
168 # log something in the system log
169 # this routine is exported to any module that declares DXLog
170 # it takes all its args and joins them together with the unixtime writes them out as one line
171 # The user is responsible for making sense of this!
174 $log->writeunix($main::systime, join('^', $main::systime, @_) );
177 sub DESTROY # catch undefs and do what is required further do the tree
180 DXDebug::dbg("dxlog", "closing $self->{fn}\n");
181 undef $self->{fh} if defined $self->{fh};