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
30 @EXPORT = qw(Log LogDbg Logclose);
37 use Carp qw(confess cluck);
41 use vars qw($log %logs);
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) = @_;
51 my $ref = bless {}, __PACKAGE__;
52 $ref->{prefix} = "$main::data/$prefix";
53 $ref->{suffix} = $suffix if $suffix;
56 # make sure the directory exists
57 mkdir($ref->{prefix}, 0777) unless -e $ref->{prefix};
59 $ref->{jdate} = $ref->unixtoj($main::systime);
66 my ($self, $jdate) = @_;
67 my $year = $jdate->year;
68 my $thing = $jdate->thing;
70 my $fn = sprintf "$self->{prefix}/$year/%02d", $thing if $jdate->isa('Julian::Month');
71 $fn = sprintf "$self->{prefix}/$year/%03d", $thing if $jdate->isa('Julian::Day');
72 $fn .= ".$self->{suffix}" if $self->{suffix};
76 # open the appropriate data file
79 my ($self, $jdate, $mode) = @_;
81 # if we are writing, check that the directory exists
83 my $year = $jdate->year;
84 my $dir = "$self->{prefix}/$year";
85 mkdir($dir, 0777) if ! -e $dir;
88 $self->{fn} = $self->_genfn($jdate);
90 $mode = 'r' if !$mode;
91 $self->{mode} = $mode;
92 $self->{jdate} = $jdate;
94 my $fh = new IO::File $self->{fn}, $mode, 0666;
96 $fh->autoflush(0); # autofluahing off
99 # print "opening $self->{fn}\n";
106 my ($self, $jdate) = @_;
107 my $fn = $self->_genfn($jdate);
113 my ($self, $jdate) = @_;
115 my $fn = $self->_genfn($jdate);
116 return (stat $fn)[9];
119 # open the previous log file in sequence
123 my $jdate = $self->{jdate}->sub(1);
124 return $self->open($jdate, @_);
127 # open the next log file in sequence
131 my $jdate = $self->{jdate}->add(1);
132 return $self->open($jdate, @_);
135 # convert a date into the correct format from a unix date depending on its sort
140 if ($self->{'sort'} eq 'm') {
141 return Julian::Month->new(shift);
142 } elsif ($self->{'sort'} eq 'd') {
143 return Julian::Day->new(shift);
145 confess "shouldn't get here";
148 # write (actually append) to a file, opening new files as required
151 my ($self, $jdate, $line) = @_;
152 cluck("Log::write \$jdate undefined") unless $jdate;
153 # cluck("Log::write \$self->jdate undefined") unless $self->{jdate};
155 $self->{mode} ne ">>" ||
157 $self->{jdate}->year ||
159 != $self->{jdate}->thing) {
160 $self->open($jdate, ">>") or confess "can't open $self->{fn} $!";
163 return $self->{fh}->print("$line\n");
166 # write (actually append) using the current date to a file, opening new files as required
169 my ($self, $line) = @_;
171 my $date = $self->unixtoj($t);
172 return $self->write($date, $line);
175 # write (actually append) using a unix time to a file, opening new files as required
178 my ($self, $t, $line) = @_;
179 my $date = $self->unixtoj($t);
180 return $self->write($date, $line);
183 # close the log file handle
187 undef $self->{fh}; # close the filehandle
193 foreach my $l (values %logs) {
194 $l->{fh}->flush if exists $l->{fh};
198 # log something in the system log
199 # this routine is exported to any module that declares DXLog
200 # it takes all its args and joins them together with the unixtime writes them out as one line
201 # The user is responsible for making sense of this!
204 my $t = $main::systime;
205 $log->writeunix($t, join('^', $t, @_) );
210 DXDebug::dbg($_) for @_;