]> scm.dxcluster.org Git - spider.git/blob - perl/DXLog.pm
added even more colouration in an attempt to make it as clear as possible
[spider.git] / perl / DXLog.pm
1 #
2 # the general purpose logging machine
3 #
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. 
6 #
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:-
9 #
10 # daily:-
11 #   spots/1998/<julian day no>[.<optional suffix>]
12 #
13 # weekly :-
14 #   log/1998/<week no>[.<optional suffix>]
15 #
16 # monthly
17 #   wwv/1998/<month>[.<optional suffix>]
18 #
19 # Routines are provided to read these files in and to append to them
20
21 # Copyright (c) - 1998 Dirk Koopman G1TLH
22 #
23 # $Id$
24 #
25
26 package DXLog;
27
28 require Exporter;
29 @ISA = qw(Exporter);
30 @EXPORT = qw(Log Logclose);
31
32 use IO::File;
33 use DXVars;
34 use DXUtil;
35 use Julian;
36
37 use Carp;
38
39 use strict;
40
41 use vars qw($VERSION $BRANCH);
42 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
43 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
44 $main::build += $VERSION;
45 $main::branch += $BRANCH;
46
47 use vars qw($log);
48
49 $log = new('log', 'dat', 'm');
50
51 # create a log object that contains all the useful info needed
52 # prefix is the main directory off of the data directory
53 # sort is 'm' for monthly, 'd' for daily 
54 sub new
55 {
56         my ($prefix, $suffix, $sort) = @_;
57         my $ref = {};
58         $ref->{prefix} = "$main::data/$prefix";
59         $ref->{suffix} = $suffix if $suffix;
60         $ref->{sort} = $sort;
61         
62         # make sure the directory exists
63         mkdir($ref->{prefix}, 0777) unless -e $ref->{prefix};
64         return bless $ref;
65 }
66
67 sub _genfn
68 {
69         my ($self, $jdate) = @_;
70         my $year = $jdate->year;
71         my $thing = $jdate->thing;
72         
73         my $fn = sprintf "$self->{prefix}/$year/%02d", $thing if $jdate->isa('Julian::Month');
74         $fn = sprintf "$self->{prefix}/$year/%03d", $thing if $jdate->isa('Julian::Day');
75         $fn .= ".$self->{suffix}" if $self->{suffix};
76         return $fn;
77 }
78
79 # open the appropriate data file
80 sub open
81 {
82         my ($self, $jdate, $mode) = @_;
83         
84         # if we are writing, check that the directory exists
85         if (defined $mode) {
86                 my $year = $jdate->year;
87                 my $dir = "$self->{prefix}/$year";
88                 mkdir($dir, 0777) if ! -e $dir;
89         }
90
91         $self->{fn} = $self->_genfn($jdate);
92         
93         $mode = 'r' if !$mode;
94         $self->{mode} = $mode;
95         
96         my $fh = new IO::File $self->{fn}, $mode, 0666;
97         return undef if !$fh;
98         $fh->autoflush(1) if $mode ne 'r'; # make it autoflushing if writable
99         $self->{fh} = $fh;
100
101         $self->{jdate} = $jdate;
102         
103 #       DXDebug::dbg("opening $self->{fn}\n") if isdbg("dxlog");
104         
105         return $self->{fh};
106 }
107
108 sub delete($$)
109 {
110         my ($self, $jdate) = @_;
111         my $fn = $self->_genfn($jdate);
112         unlink $fn;
113 }
114
115 sub mtime($$)
116 {
117         my ($self, $jdate) = @_;
118         
119         my $fn = $self->_genfn($jdate);
120         return (stat $fn)[9];
121 }
122
123 # open the previous log file in sequence
124 sub openprev($$)
125 {
126         my $self = shift;
127         my $jdate = $self->{jdate}->sub(1);
128         return $self->open($jdate, @_);
129 }
130
131 # open the next log file in sequence
132 sub opennext($$)
133 {
134         my $self = shift;
135         my $jdate = $self->{jdate}->add(1);
136         return $self->open($jdate, @_);
137 }
138
139 # convert a date into the correct format from a unix date depending on its sort
140 sub unixtoj($$)
141 {
142         my $self = shift;
143         
144         if ($self->{'sort'} eq 'm') {
145                 return Julian::Month->new(shift);
146         } elsif ($self->{'sort'} eq 'd') {
147                 return Julian::Day->new(shift);
148         }
149         confess "shouldn't get here";
150 }
151
152 # write (actually append) to a file, opening new files as required
153 sub write($$$)
154 {
155         my ($self, $jdate, $line) = @_;
156         if (!$self->{fh} || 
157                 $self->{mode} ne ">>" || 
158                 $jdate->year != $self->{jdate}->year || 
159                 $jdate->thing != $self->{jdate}->year) {
160                 $self->open($jdate, ">>") or confess "can't open $self->{fn} $!";
161         }
162
163         return $self->{fh}->print("$line\n");
164 }
165
166 # write (actually append) using the current date to a file, opening new files as required
167 sub writenow($$)
168 {
169         my ($self, $line) = @_;
170         my $t = time;
171         my $date = $self->unixtoj($t);
172         return $self->write($date, $line);
173 }
174
175 # write (actually append) using a unix time to a file, opening new files as required
176 sub writeunix($$$)
177 {
178         my ($self, $t, $line) = @_;
179         my $date = $self->unixtoj($t);
180         return $self->write($date, $line);
181 }
182
183 # close the log file handle
184 sub close
185 {
186         my $self = shift;
187         undef $self->{fh};                      # close the filehandle
188         delete $self->{fh};     
189 }
190
191 sub DESTROY
192 {
193         my $self = shift;
194         undef $self->{fh};                      # close the filehandle
195         delete $self->{fh} if $self->{fh};
196 }
197
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!
202 sub Log
203 {
204         my $t = time;
205         $log->writeunix($t, join('^', $t, @_) );
206 }
207
208 sub Logclose
209 {
210         $log->close();
211 }
212 1;