/usr/share/perl5/Log/Log4perl/Config/BaseConfigurator.pm is in liblog-log4perl-perl 1.41-1.1ubuntu1.
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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | package Log::Log4perl::Config::BaseConfigurator;
use warnings;
use strict;
use constant _INTERNAL_DEBUG => 0;
*eval_if_perl = \&Log::Log4perl::Config::eval_if_perl;
*compile_if_perl = \&Log::Log4perl::Config::compile_if_perl;
*leaf_path_to_hash = \&Log::Log4perl::Config::leaf_path_to_hash;
################################################
sub new {
################################################
my($class, %options) = @_;
my $self = {
utf8 => 0,
%options,
};
bless $self, $class;
$self->file($self->{file}) if exists $self->{file};
$self->text($self->{text}) if exists $self->{text};
return $self;
}
################################################
sub text {
################################################
my($self, $text) = @_;
# $text is an array of scalars (lines)
if(defined $text) {
if(ref $text eq "ARRAY") {
$self->{text} = $text;
} else {
$self->{text} = [split "\n", $text];
}
}
return $self->{text};
}
################################################
sub file {
################################################
my($self, $filename) = @_;
open my $fh, "$filename" or die "Cannot open $filename ($!)";
if( $self->{ utf8 } ) {
binmode $fh, ":utf8";
}
$self->file_h_read( $fh );
close $fh;
}
################################################
sub file_h_read {
################################################
my($self, $fh) = @_;
# Dennis Gregorovic <dgregor@redhat.com> added this
# to protect apps which are tinkering with $/ globally.
local $/ = "\n";
$self->{text} = [<$fh>];
}
################################################
sub parse {
################################################
die __PACKAGE__ . "::parse() is a virtual method. " .
"It must be implemented " .
"in a derived class (currently: ", ref(shift), ")";
}
################################################
sub parse_post_process {
################################################
my($self, $data, $leaf_paths) = @_;
# [
# 'category',
# 'value',
# 'WARN, Logfile'
# ],
# [
# 'appender',
# 'Logfile',
# 'value',
# 'Log::Log4perl::Appender::File'
# ],
# [
# 'appender',
# 'Logfile',
# 'filename',
# 'value',
# 'test.log'
# ],
# [
# 'appender',
# 'Logfile',
# 'layout',
# 'value',
# 'Log::Log4perl::Layout::PatternLayout'
# ],
# [
# 'appender',
# 'Logfile',
# 'layout',
# 'ConversionPattern',
# 'value',
# '%d %F{1} %L> %m %n'
# ]
for my $path ( @{ Log::Log4perl::Config::leaf_paths( $data )} ) {
print "path=@$path\n" if _INTERNAL_DEBUG;
if(0) {
} elsif(
$path->[0] eq "appender" and
$path->[2] eq "trigger"
) {
my $ref = leaf_path_to_hash( $path, $data );
my $code = compile_if_perl( $$ref );
if(_INTERNAL_DEBUG) {
if($code) {
print "Code compiled: $$ref\n";
} else {
print "Not compiled: $$ref\n";
}
}
$$ref = $code if defined $code;
} elsif (
$path->[0] eq "filter"
) {
# do nothing
} elsif (
$path->[0] eq "appender" and
$path->[2] eq "warp_message"
) {
# do nothing
} elsif (
$path->[0] eq "appender" and
$path->[3] eq "cspec" or
$path->[1] eq "cspec"
) {
# could be either
# appender appndr layout cspec
# or
# PatternLayout cspec U value ...
#
# do nothing
} else {
my $ref = leaf_path_to_hash( $path, $data );
if(_INTERNAL_DEBUG) {
print "Calling eval_if_perl on $$ref\n";
}
$$ref = eval_if_perl( $$ref );
}
}
return $data;
}
1;
__END__
=head1 NAME
Log::Log4perl::Config::BaseConfigurator - Configurator Base Class
=head1 SYNOPSIS
This is a virtual base class, all configurators should be derived from it.
=head1 DESCRIPTION
=head2 METHODS
=over 4
=item C<< new >>
Constructor, typically called like
my $config_parser = SomeConfigParser->new(
file => $file,
);
my $data = $config_parser->parse();
Instead of C<file>, the derived class C<SomeConfigParser> may define any
type of configuration input medium (e.g. C<url =E<gt> 'http://foobar'>).
It just has to make sure its C<parse()> method will later pull the input
data from the medium specified.
The base class accepts a filename or a reference to an array
of text lines:
=over 4
=item C<< file >>
Specifies a file which the C<parse()> method later parses.
=item C<< text >>
Specifies a reference to an array of scalars, representing configuration
records (typically lines of a file). Also accepts a simple scalar, which it
splits at its newlines and transforms it into an array:
my $config_parser = MyYAMLParser->new(
text => ['foo: bar',
'baz: bam',
],
);
my $data = $config_parser->parse();
=back
If either C<file> or C<text> parameters have been specified in the
constructor call, a later call to the configurator's C<text()> method
will return a reference to an array of configuration text lines.
This will typically be used by the C<parse()> method to process the
input.
=item C<< parse >>
Virtual method, needs to be defined by the derived class.
=back
=head2 Parser requirements
=over 4
=item *
If the parser provides variable substitution functionality, it has
to implement it.
=item *
The parser's C<parse()> method returns a reference to a hash of hashes (HoH).
The top-most hash contains the
top-level keywords (C<category>, C<appender>) as keys, associated
with values which are references to more deeply nested hashes.
=item *
The C<log4perl.> prefix (e.g. as used in the PropertyConfigurator class)
is stripped, it's not part in the HoH structure.
=item *
Each Log4perl config value is indicated by the C<value> key, as in
$data->{category}->{Bar}->{Twix}->{value} = "WARN, Logfile"
=back
=head2 EXAMPLES
The following Log::Log4perl configuration:
log4perl.category.Bar.Twix = WARN, Screen
log4perl.appender.Screen = Log::Log4perl::Appender::File
log4perl.appender.Screen.filename = test.log
log4perl.appender.Screen.layout = Log::Log4perl::Layout::SimpleLayout
needs to be transformed by the parser's C<parse()> method
into this data structure:
{ appender => {
Screen => {
layout => {
value => "Log::Log4perl::Layout::SimpleLayout" },
value => "Log::Log4perl::Appender::Screen",
},
},
category => {
Bar => {
Twix => {
value => "WARN, Screen" }
} }
}
For a full-fledged example, check out the sample YAML parser implementation
in C<eg/yamlparser>. It uses a simple YAML syntax to specify the Log4perl
configuration to illustrate the concept.
=head1 SEE ALSO
Log::Log4perl::Config::PropertyConfigurator
Log::Log4perl::Config::DOMConfigurator
Log::Log4perl::Config::LDAPConfigurator (tbd!)
=head1 LICENSE
Copyright 2002-2013 by Mike Schilli E<lt>m@perlmeister.comE<gt>
and Kevin Goess E<lt>cpan@goess.orgE<gt>.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHOR
Please contribute patches to the project on Github:
http://github.com/mschilli/log4perl
Send bug reports or requests for enhancements to the authors via our
MAILING LIST (questions, bug reports, suggestions/patches):
log4perl-devel@lists.sourceforge.net
Authors (please contact them via the list above, not directly):
Mike Schilli <m@perlmeister.com>,
Kevin Goess <cpan@goess.org>
Contributors (in alphabetical order):
Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton
Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony
Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy
Grundman, Paul Harrington, Alexander Hartmaier David Hull,
Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter,
Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope,
Lars Thegler, David Viner, Mac Yang.
|