/usr/share/perl5/Device/Modem/Log/File.pm is in libdevice-modem-perl 1.47-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | # Device::Modem::Log::File - Text files logging plugin for Device::Modem class
#
# Copyright (C) 2002-2004 Cosimo Streppone, cosimo@cpan.org
#
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
#
# Additionally, this is ALPHA software, still needs extensive
# testing and support for generic AT commads, so use it at your own risk,
# and without ANY warranty! Have fun.
#
# $Id: File.pm,v 2.1 2004/11/10 09:12:14 cosimo Exp $
#
package Device::Modem::Log::File;
$VERSION = sprintf '%d.%02d', q$Revision: 2.1 $ =~ /(\d+)\.(\d+)/;
use strict;
use File::Path ();
use File::Basename ();
# Define log levels like syslog service
use vars '%levels';
%levels = ( debug => 7, info => 6, notice => 5, warning => 4, err => 3, error => 3, crit => 2, alert => 1, emerg => 0 );
sub new {
my( $class, $package, $filename ) = @_;
# Get a decent default if no file available
$filename ||= default_filename();
my %obj = (
file => $filename,
loglevel => 'info'
);
my $self = bless \%obj, 'Device::Modem::Log::File';
# Open file at the start and save reference
if( open( LOGFILE, '>>'.$self->{'file'} ) ) {
$self->{'fh'} = \*LOGFILE;
# Unbuffer writes to logfile
my $oldfh = select $self->{'fh'};
$| = 1;
select $oldfh;
} else {
warn('Could not open '.$self->{'file'}.' to start logging');
}
return $self;
}
# provide a suitable filename default
sub default_filename() {
my $cDir = '/var/log';
# If this is windoze (XXX 2000/XP? WINBOOTDIR?), not darwin, cygwin, ...
if( index($^O, 'Win') >= 0 ) {
$cDir = $ENV{'WINBOOTDIR'} || '/windows';
$cDir .= '/temp';
}
return $cDir.'/modem.log';
}
sub filename {
my $self = shift();
$self->{'file'} ||= $self->default_filename();
if( ! -d File::Basename::dirname($self->{'file'}) ) {
File::Path::mkpath( File::Basename::dirname($self->{'file'}), 0, 0755 );
}
return $self->{'file'};
}
sub loglevel {
my($self, $newlevel) = @_;
if( defined $newlevel ) {
$newlevel = lc $newlevel;
if( ! exists $levels{$newlevel} ) {
$newlevel = 'warning';
}
$self->{'loglevel'} = $newlevel;
} else {
return $self->{'loglevel'};
}
}
sub write($$) {
my($self, $level, @msg) = @_;
# If log level mask allows it, log given message
#warn('message level='.$level.' ('.$levels{$level}.') loglevel='.$self->{loglevel}.' ('.$levels{$self->{loglevel}}.')');
if( $levels{$level} <= $levels{$self->{'loglevel'}} ) {
if( my $fh = $self->fh() ) {
map { tr/\r\n/^M/s } @msg;
print $fh join("\t", scalar localtime, $0, $level, @msg), "\n";
} else {
warn('cannot log '.$level.' '.join("\t",@msg).' to file: '.$! );
}
}
}
sub fh {
my $self = shift;
return $self->{'fh'};
}
# Closes log file opened in new()
sub close {
my $self = shift;
my $fh = $self->{'FH'};
close $fh;
undef $self->{'FH'};
}
1;
__END__
=head1 NAME
Device::Modem::Log::File - Text files logging plugin for Device::Modem class
=head1 SYNOPSIS
use Device::Modem;
my $box = Device::Modem->new( log => 'file', ... );
my $box = Device::Modem->new( log => 'file,name=/var/log/mymodem.log', ... );
...
=head1 DESCRIPTION
This is meant for an example log class to be hooked to C<Device::Modem>
to provide one's favourite logging mechanism.
You just have to implement your own C<new()>, C<write()> and C<close()> methods.
Default text file is C</var/log/modem.log>. On Windows platforms, this
goes into C<%WINBOOTDIR%/temp/modem.log>. By default, if the folder of the
log file does not exist, it is created.
This class is loaded automatically by C<Device::Modem> class when an object
is instantiated, and it is the B<default> logging mechanism for
C<Device::Modem> class.
Normally, you should B<not> need to use this class directly, because there
are many other zillions of modules that do logging better than this.
Also, it should be pondered whether to replace C<Device::Modem::Log::File>
and mates with those better classes in a somewhat distant future.
=head2 REQUIRES
Device::Modem
=head2 EXPORTS
None
=head1 AUTHOR
Cosimo Streppone, cosimo@cpan.org
=head1 COPYRIGHT
(C) 2002 Cosimo Streppone, <cosimo@cpan.org>
This library is free software; you can only redistribute it and/or
modify it under the same terms as Perl itself.
=head1 SEE ALSO
L<Device::Modem>
L<Device::Modem::Log::Syslog>
=cut
|