Log.pm

filter: Statementstmt 77.2% 34 / 44 Branchbran 25.0% 1 / 4 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 69.2% 9 / 13 Podpod 28.5% 2 / 7 totaltotal 67.6% 46 / 68 CC 3 SCAR 7.1
CC
3
Cov
73%
debug_nolf
6.0
debug
2.3
debug_value
2.0
CRAP 2.0
« Log/Set.pm ↑ Summary
1 #!/usr/bin/perl
2  
3 #=======================================================================
4 # Log.pm / IPTables::Log
5 # $Id: Log.pm 21 2010-12-17 21:07:37Z andys $
6 # $HeadURL: https://daedalus.dmz.dn7.org.uk/svn/IPTables-Log/trunk/IPTables-Log/lib/IPTables/Log.pm $
7 # (c)2009 Andy Smith <andy.smith@netprojects.org.uk>
8 #-----------------------------------------------------------------------
9 #:Description
10 # This is the main IPTables::Log class.
11 #-----------------------------------------------------------------------
12 #:Synopsis
13 #
14 # use IPTables::Log;
15 # my $l = IPTables::Log->new;
16 # my $s = $l->create_set;
17 # my $r = $s->create_record({text => '...IN=eth0 OUT=eth1 MAC=00:...'});
18 # $r->parse;
19 # $s->add($r);
20 #=======================================================================
21  
22 # The pod (Perl Documentation) for this module is provided inline. For a
23 # better-formatted version, please run:-
24 # $ perldoc Log.pm
25  
26 =head1 NAME
27  
28 IPTables::Log - Parse iptables/netfilter syslog messages.
29  
30 =head1 SYNOPSIS
31  
32 use IPTables::Log;
33 my $l = IPTables::Log->new;
34 my $s = $l->create_set;
35 my $r = $s->create_record({text => '...IN=eth0 OUT=eth1 MAC=00:...'});
36 $r->parse;
37 $s->add($r);
38
39 =head1 DEPENDENCIES
40  
41 =over 4
42  
43 =item * Carp - for error generation
44  
45 =item * Class::Accessor - for accessor methods
46  
47 =item * Data::GUID - for GUID generation
48  
49 =item * NetAddr::IP - for the C<src> and C<dst> methods
50  
51 =back
52  
53 =cut
54  
55 # Set our package name
56 package IPTables::Log;
57  
58 # Set minimum version of Perl
59 3 ▶use 5.010000;
Subroutine BEGIN: called CC=1 SCAR=0.0
60 # Use strict and warnings
61 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
62 3 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
63  
64 # Use Carp for errors
65 3 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
66 # Use IPTables::Log::Set
67 3 ▶use IPTables::Log::Set;
Subroutine BEGIN: called CC=1 SCAR=0.0
68  
69 # Inherit from Class::Accessor to simplify accessor methods.
70 3 ▶use base qw(Class::Accessor);
Subroutine BEGIN: called CC=1 SCAR=0.0
71 3 __PACKAGE__->follow_best_practice;
72 3 __PACKAGE__->mk_accessors( qw(raw debug) );
73  
74 # Set version information
75 3 our $VERSION;
76 3 $VERSION = "0.0005";
77  
78 # Hashes of colour
79 3 my $clr = "";
80 3 my $bold = "";
81 3 my $fclr = {'red' => '',
82 'green' => '',
83 'yellow' => '',
84 'blue' => '',
85 'purple' => '',
86 'cyan' => ''};
87  
88 3 my $bclr = {'red' => '',
89 'green' => '',
90 'yellow' => '',
91 'blue' => '',
92 'purple' => '',
93 'cyan' => ''};
94  
95 # Generates a debug message if $self->debug == 1
96 sub debug
97 8 ▶{
Subroutine debug: called CC=2 SCAR=8.1
Pod undocumented
98 8 my ($self, $msg) = @_;
99  
100 8 ▶ if($self->get_debug)
Branch: 1 branch
BranchTrueFalseTotal
if ($self->get_debug) 0 8 8
101 {
102 0 print $bclr->{blue}.$fclr->{yellow}."D".$clr." ".$fclr->{green}.__PACKAGE__.$clr." ".$fclr->{purple}.$VERSION.$clr." | ".$msg."\n";
103 }
104 }
105  
106 # As above, but doesn't append a newline
107 sub debug_nolf
108 0 ▶{
Subroutine debug_nolf: not called CC=2 SCAR=17.9
Pod undocumented
109 0 my ($self, $msg) = @_;
110  
111 0 ▶ if($self->get_debug)
Branch: 1 branch
BranchTrueFalseTotal
if ($self->get_debug) 0 0 0
112 {
113 0 print $bclr->{blue}.$fclr->{yellow}."D".$clr." ".$msg;
114 }
115 }
116  
117 # As per $self->debug, but prints additional information in a chosen colour
118 sub debug_value
119 0 ▶{
Subroutine debug_value: not called CC=1 SCAR=6.9
Pod undocumented
120 0 my ($self, $text, $colour, $value) = @_;
121  
122 0 $self->debug($text." ".$self->fcolour($colour, $value));
123 }
124  
125 # Prints an error to STDERR
126 sub error
127 0 ▶{
Subroutine error: not called CC=1 SCAR=6.9
Pod documented
128 0 my ($self, $msg) = @_;
129  
130 0 print STDERR $fclr->{red}."E".$clr." ".$msg."\n";
131 }
132  
133 # Prints and error to STDERR, then 'croak's
134 sub fatal
135 0 ▶{
Subroutine fatal: not called CC=1 SCAR=6.9
Pod undocumented
136 0 my ($self, $msg) = @_;
137  
138 0 croak $bclr->{red}.$bold."!".$clr." ".$msg."\n";
139 }
140  
141 # Wrap given message in ANSI colour codes
142 sub fcolour
143 8 ▶{
Subroutine fcolour: called CC=1 SCAR=0.0
Pod undocumented
144 8 my ($self, $colour, $text) = @_;
145  
146 8 return $fclr->{$colour}.$text.$clr;
147 }
148  
149 =head1 CONSTRUCTORS
150  
151 =head2 Log->new
152  
153 Creates a new C<IPTables::Log> object.
154  
155 =head1 METHODS
156  
157 =head2 $log->create_set(I<no_header => 0|1>)
158  
159 Creates a new C<IPTables::Log::Set> object.
160  
161 Setting I<no_header> to B<1> makes L<IPTables::Log::Set::Record> assume that the timestamp and hostname at the beginning of the message is missing (for example, if it's already been processed by another utility).
162  
163 See L<IPTables::Log::Set> and L<IPTables::Log::Set::Record> for further details.
164  
165 =cut
166  
167 sub create_set
168 2 ▶{
Subroutine create_set: called CC=1 SCAR=0.0
Pod documented
169 2 my ($self, $args) = @_;
170  
171 2 $args->{'log'} = $self;
172  
173 2 my $set = IPTables::Log::Set->create($args);
174  
175 2 return $set;
176 }
177  
178 =head1 CAVEATS
179  
180 It parses log entries. It doesn't do much else, yet.
181  
182 =head1 BUGS
183  
184 None that I'm aware of ;-)
185  
186 =head1 AUTHOR
187  
188 This module was written by B<Andy Smith> <andy.smith@netprojects.org.uk>.
189  
190 =head1 COPYRIGHT
191  
192 $Id: Log.pm 21 2010-12-17 21:07:37Z andys $
193  
194 (c)2009 Andy Smith (L<http://andys.org.uk/>)
195  
196 This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
197  
198 =cut
199  
200 3 1
« Log/Set.pm ↑ Summary