/usr/share/perl5/Apache/LogFormat/Compiler.pm is in libapache-logformat-compiler-perl 0.30-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 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 | package Apache::LogFormat::Compiler;
use strict;
use warnings;
use 5.008004;
use Carp;
use POSIX::strftime::Compiler qw//;
use constant {
ENVS => 0,
RES => 1,
LENGTH => 2,
REQTIME => 3,
TIME => 4,
};
our $VERSION = '0.30';
# copy from Plack::Middleware::AccessLog
our %formats = (
common => '%h %l %u %t "%r" %>s %b',
combined => '%h %l %u %t "%r" %>s %b "%{Referer}i" "%{User-agent}i"',
);
sub _safe {
my $string = shift;
return unless defined $string;
$string =~ s/([^[:print:]])/"\\x" . unpack("H*", $1)/eg;
return $string;
}
sub _string {
my $string = shift;
return '-' if ! defined $string;
return '-' if ! length $string;
$string =~ s/([^[:print:]])/"\\x" . unpack("H*", $1)/eg;
return $string;
}
sub header_get {
my ($headers, $key) = @_;
$key = lc $key;
my @headers = @$headers; # copy
my $value;
while (my($hdr, $val) = splice @headers, 0, 2) {
if ( lc $hdr eq $key ) {
$value = $val;
last;
}
}
return $value;
}
my $psgi_reserved = { CONTENT_LENGTH => 1, CONTENT_TYPE => 1 };
my $block_handler = sub {
my($block, $type, $extra) = @_;
my $cb;
if ($type eq 'i') {
$block =~ s/-/_/g;
$block = uc($block);
$block = "HTTP_${block}" unless $psgi_reserved->{$block};
$cb = q!_string($_[ENVS]->{'!.$block.q!'})!;
} elsif ($type eq 'o') {
$cb = q!_string(header_get($_[RES]->[1],'!.$block.q!'))!;
} elsif ($type eq 't') {
$cb = q!"[" . POSIX::strftime::Compiler::strftime('!.$block.q!', @lt) . "]"!;
} elsif (exists $extra->{$type}) {
$cb = q!_string($extra_block_handlers->{'!.$type.q!'}->('!.$block.q!',$_[ENVS],$_[RES],$_[LENGTH],$_[REQTIME]))!;
} else {
Carp::croak("{$block}$type not supported");
$cb = "-";
}
return q|! . | . $cb . q|
. q!|;
};
our %char_handler = (
'%' => q!'%'!,
h => q!($_[ENVS]->{REMOTE_ADDR} || '-')!,
l => q!'-'!,
u => q!($_[ENVS]->{REMOTE_USER} || '-')!,
t => q!'[' . $t . ']'!,
r => q!_safe($_[ENVS]->{REQUEST_METHOD}) . " " . _safe($_[ENVS]->{REQUEST_URI}) .
" " . $_[ENVS]->{SERVER_PROTOCOL}!,
s => q!$_[RES]->[0]!,
b => q!(defined $_[LENGTH] ? $_[LENGTH] : '-')!,
T => q!(defined $_[REQTIME] ? int($_[REQTIME]*1_000_000) : '-')!,
D => q!(defined $_[REQTIME] ? $_[REQTIME] : '-')!,
v => q!($_[ENVS]->{SERVER_NAME} || '-')!,
V => q!($_[ENVS]->{HTTP_HOST} || $_[ENVS]->{SERVER_NAME} || '-')!,
p => q!$_[ENVS]->{SERVER_PORT}!,
P => q!$$!,
m => q!_safe($_[ENVS]->{REQUEST_METHOD})!,
U => q!_safe($_[ENVS]->{PATH_INFO})!,
q => q!(($_[ENVS]->{QUERY_STRING} ne '') ? '?' . _safe($_[ENVS]->{QUERY_STRING}) : '' )!,
H => q!$_[ENVS]->{SERVER_PROTOCOL}!,
);
my $char_handler = sub {
my ($char, $extra) = @_;
my $cb = $char_handler{$char};
if (!$cb && exists $extra->{$char}) {
$cb = q!_string($extra_char_handlers->{'!.$char.q!'}->($_[ENVS],$_[RES],$_[LENGTH],$_[REQTIME]))!;
}
unless ($cb) {
Carp::croak "\%$char not supported.";
return "-";
}
q|! . | . $cb . q|
. q!|;
};
sub new {
my $class = shift;
my $fmt = shift || "combined";
$fmt = $formats{$fmt} if exists $formats{$fmt};
my %opts = @_;
my ($code_ref, $code) = compile($fmt, $opts{block_handlers} || {}, $opts{char_handlers} || {});
bless [$code_ref, $code], $class;
}
sub compile {
my $fmt = shift;
my $extra_block_handlers = shift;
my $extra_char_handlers = shift;
$fmt =~ s/!/\\!/g;
$fmt =~ s!
(?:
\%\{(.+?)\}([a-zA-Z]) |
\%(?:[<>])?([a-zA-Z\%])
)
! $1 ? $block_handler->($1, $2, $extra_block_handlers) : $char_handler->($3, $extra_char_handlers) !egx;
my @abbr = qw( Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec );
my $c = {};
$fmt = q~sub {
$_[TIME] = time() if ! defined $_[TIME];
my @lt = localtime($_[TIME]);
if ( ! exists $c->{tz_cache} || ! exists $c->{isdst_cache} || $lt[8] != $c->{isdst_cache} ) {
$c->{tz_cache} = POSIX::strftime::Compiler::strftime('%z',@lt);
$c->{isdst_cache} = $lt[8];
}
my $t = sprintf '%02d/%s/%04d:%02d:%02d:%02d %s', $lt[3], $abbr[$lt[4]], $lt[5]+1900,
$lt[2], $lt[1], $lt[0], $c->{tz_cache};
q!~ . $fmt . q~!
}~;
my $code_ref = eval $fmt; ## no critic
die $@ . "\n===\n" . $fmt if $@;
wantarray ? ($code_ref, $fmt) : $code_ref;
}
sub log_line {
my $self = shift;
$self->[0]->(@_) . "\n";
}
sub code {
my $self = shift;
$self->[1];
}
sub code_ref {
my $self = shift;
$self->[0];
}
1;
__END__
=encoding utf8
=head1 NAME
Apache::LogFormat::Compiler - Compile a log format string to perl-code
=head1 SYNOPSIS
use Apache::LogFormat::Compiler;
my $log_handler = Apache::LogFormat::Compiler->new("combined");
my $log = $log_handler->log_line(
$env,
$res,
$length,
$reqtime,
$time
);
=head1 DESCRIPTION
Compile a log format string to perl-code. For faster generation of access_log lines.
=head1 METHOD
=over 4
=item new($fmt:String)
Takes a format string (or a preset template C<combined> or C<custom>)
to specify the log format. This module implements a subset of
L<Apache's LogFormat templates|http://httpd.apache.org/docs/2.0/mod/mod_log_config.html>:
%% a percent sign
%h REMOTE_ADDR from the PSGI environment, or -
%l remote logname not implemented (currently always -)
%u REMOTE_USER from the PSGI environment, or -
%t [local timestamp, in default format]
%r REQUEST_METHOD, REQUEST_URI and SERVER_PROTOCOL from the PSGI environment
%s the HTTP status code of the response
%b content length of the response
%T custom field for handling times in subclasses
%D custom field for handling sub-second times in subclasses
%v SERVER_NAME from the PSGI environment, or -
%V HTTP_HOST or SERVER_NAME from the PSGI environment, or -
%p SERVER_PORT from the PSGI environment
%P the worker's process id
%m REQUEST_METHOD from the PSGI environment
%U PATH_INFO from the PSGI environment
%q QUERY_STRING from the PSGI environment
%H SERVER_PROTOCOL from the PSGI environment
In addition, custom values can be referenced, using C<%{name}>,
with one of the mandatory modifier flags C<i>, C<o> or C<t>:
%{variable-name}i HTTP_VARIABLE_NAME value from the PSGI environment
%{header-name}o header-name header in the response
%{time-format]t localtime in the specified strftime format
=item log_line($env:HashRef, $res:ArrayRef, $length:Integer, $reqtime:Integer, $time:Integer): $log:String
Generates log line.
$env PSGI env request HashRef
$res PSGI response ArrayRef
$length Content-Length
$reqtime The time taken to serve request in microseconds. optional
$time Time the request was received. optional. If $time is undefined. current timestamp is used.
Sample psgi
use Plack::Builder;
use Time::HiRes;
use Apache::LogFormat::Compiler;
my $log_handler = Apache::LogFormat::Compiler->new(
'%h %l %u %t "%r" %>s %b "%{Referer}i" "%{User-agent}i" %D'
);
my $compile_log_app = builder {
enable sub {
my $app = shift;
sub {
my $env = shift;
my $t0 = [gettimeofday];
my $res = $app->();
my $reqtime = int(Time::HiRes::tv_interval($t0) * 1_000_000);
$env->{psgi.error}->print($log_handler->log_line(
$env,$res,6,$reqtime, $t0->[0]));
}
};
$app
};
=back
=head1 ABOUT POSIX::strftime::Compiler
This module uses L<POSIX::strftime::Compiler> for generate datetime string. POSIX::strftime::Compiler provides GNU C library compatible strftime(3). But this module will not affected by the system locale. This feature is useful when you want to write loggers, servers and portable applications.
=head1 ADD CUSTOM FORMAT STRING
Apache::LogFormat::Compiler allows one to add a custom format string
my $log_handler = Apache::LogFormat::Compiler->new(
'%z %{HTTP_X_FORWARDED_FOR|REMOTE_ADDR}Z',
char_handlers => +{
'z' => sub {
my ($env,$req) = @_;
return $env->{HTTP_X_FORWARDED_FOR};
}
},
block_handlers => +{
'Z' => sub {
my ($block,$env,$req) = @_;
# block eq 'HTTP_X_FORWARDED_FOR|REMOTE_ADDR'
my ($main, $alt) = split('\|', $args);
return exists $env->{$main} ? $env->{$main} : $env->{$alt};
}
},
);
Any single letter can be used, other than those already defined by Apache::LogFormat::Compiler.
Your sub is called with two or three arguments: the content inside the C<{}>
from the format (block_handlers only), the PSGI environment (C<$env>),
and the ArrayRef of the response. It should return the string to be logged.
=head1 AUTHOR
Masahiro Nagano E<lt>kazeburo@gmail.comE<gt>
=head1 SEE ALSO
L<Plack::Middleware::AccessLog>, L<http://httpd.apache.org/docs/2.2/mod/mod_log_config.html>
=head1 LICENSE
Copyright (C) Masahiro Nagano
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|