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
|
# <@LICENSE>
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to you under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# </@LICENSE>
=head1 NAME
Mail::SpamAssassin::Logger::File - log to file
=head1 SYNOPSIS
loadplugin Mail::SpamAssassin::Logger::File
=head1 DESCRIPTION
=cut
package Mail::SpamAssassin::Logger::File;
use strict;
use warnings;
# use bytes;
use re 'taint';
use POSIX ();
use Time::HiRes ();
use Mail::SpamAssassin::Logger;
our @ISA = ();
# ADDING OS-DEPENDENT LINE TERMINATOR - BUG 6456
# Using Mail::SpamAssassin::Util::am_running_on_windows() leads to circular
# dependencies. So, we are duplicating the code instead.
use constant RUNNING_ON_WINDOWS => ($^O =~ /^(?:mswin|dos|os2)/oi);
my $eol = "\n";
if (RUNNING_ON_WINDOWS) {
$eol = "\r\n";
}
sub new {
my $class = shift;
$class = ref($class) || $class;
my $self = { };
bless ($self, $class);
# parameters
my %params = @_;
$self->{filename} = $params{filename} || 'spamassassin.log';
$self->{timestamp_fmt} = $params{timestamp_fmt};
$self->{escape} = $params{escape} if exists $params{escape};
if (! $self->init()) {
die "logger: file initialization failed$eol";
}
return($self);
}
# logging via file is requested
sub init {
my ($self) = @_;
if (open(STDLOG, ">> $self->{filename}")) {
dbg("logger: successfully opened file $self->{filename}");
# ensure it's unbuffered
my $oldfh = select STDLOG;
$| = 1;
select $oldfh;
return 1;
}
else {
warn "logger: failed to open file $self->{filename}: $!$eol";
return 0;
}
}
sub log_message {
my ($self, $level, $msg, $ts) = @_;
my $timestamp;
my $fmt = $self->{timestamp_fmt};
my $now = defined $ts ? $ts : Time::HiRes::time;
if (!defined $fmt) {
$timestamp = scalar localtime($now); # default, backward compatibility
} elsif ($fmt eq '') {
$timestamp = '';
} else {
$timestamp = POSIX::strftime($fmt, localtime($now));
}
$timestamp .= ' ' if $timestamp ne '';
if ($self->{escape}) {
# Bug 6583, escape
Mail::SpamAssassin::Logger::escape_str($msg);
} elsif (!exists $self->{escape}) {
# Backwards compatible pre-4.0 escaping, if $escape not given.
# replace control characters with "_", tabs and spaces get
# replaced with a single space.
$msg =~ tr/\x09\x20\x00-\x1f/ _/s;
}
my($nwrite) = syswrite(STDLOG, sprintf("%s[%s] %s: %s%s",
$timestamp, $$, $level, $msg, $eol));
defined $nwrite or warn "error writing to log file: $!";
}
sub close_log {
my ($self) = @_;
if (defined $self->{filename}) {
close(STDLOG) or die "error closing log file: $!";
}
}
1;
|
