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
|
package Log::Dispatch::Email;
use strict;
use warnings;
our $VERSION = '2.45';
use Log::Dispatch::Output;
use base qw( Log::Dispatch::Output );
use Devel::GlobalDestruction qw( in_global_destruction );
use Params::Validate qw(validate SCALAR ARRAYREF BOOLEAN);
Params::Validate::validation_options( allow_extra => 1 );
# need to untaint this value
my ($program) = $0 =~ /(.+)/;
sub new {
my $proto = shift;
my $class = ref $proto || $proto;
my %p = validate(
@_, {
subject => {
type => SCALAR,
default => "$program: log email"
},
to => { type => SCALAR | ARRAYREF },
from => {
type => SCALAR,
optional => 1
},
buffered => {
type => BOOLEAN,
default => 1
},
}
);
my $self = bless {}, $class;
$self->_basic_init(%p);
$self->{subject} = $p{subject} || "$0: log email";
$self->{to} = ref $p{to} ? $p{to} : [ $p{to} ];
$self->{from} = $p{from};
# Default to buffered for obvious reasons!
$self->{buffered} = $p{buffered};
$self->{buffer} = [] if $self->{buffered};
return $self;
}
sub log_message {
my $self = shift;
my %p = @_;
if ( $self->{buffered} ) {
push @{ $self->{buffer} }, $p{message};
}
else {
$self->send_email(@_);
}
}
sub send_email {
my $self = shift;
my $class = ref $self;
die "The send_email method must be overridden in the $class subclass";
}
sub flush {
my $self = shift;
if ( $self->{buffered} && @{ $self->{buffer} } ) {
my $message = join '', @{ $self->{buffer} };
$self->send_email( message => $message );
$self->{buffer} = [];
}
}
sub DESTROY {
my $self = shift;
if ( in_global_destruction()
&& $self->{buffered}
&& @{ $self->{buffer} } ) {
my $name = $self->name();
my $class = ref $self;
my $message
= "Log messages for the $name output (a $class object) remain unsent but the program is terminating.\n";
$message .= "The messages are:\n";
$message .= " $_\n" for @{ $self->{buffer} };
}
else {
$self->flush();
}
}
1;
# ABSTRACT: Base class for objects that send log messages via email
__END__
=pod
=head1 NAME
Log::Dispatch::Email - Base class for objects that send log messages via email
=head1 VERSION
version 2.45
=head1 SYNOPSIS
package Log::Dispatch::Email::MySender;
use Log::Dispatch::Email;
use base qw( Log::Dispatch::Email );
sub send_email {
my $self = shift;
my %p = @_;
# Send email somehow. Message is in $p{message}
}
=head1 DESCRIPTION
This module should be used as a base class to implement
Log::Dispatch::* objects that send their log messages via email.
Implementing a subclass simply requires the code shown in the
L<SYNOPSIS> with a real implementation of the C<send_email()> method.
=for Pod::Coverage new log_message
=head1 CONSTRUCTOR
The constructor takes the following parameters in addition to the standard
parameters documented in L<Log::Dispatch::Output>:
=over 4
=item * subject ($)
The subject of the email messages which are sent. Defaults to "$0:
log email"
=item * to ($ or \@)
Either a string or a list reference of strings containing email
addresses. Required.
=item * from ($)
A string containing an email address. This is optional and may not
work with all mail sending methods.
=item * buffered (0 or 1)
This determines whether the object sends one email per message it is
given or whether it stores them up and sends them all at once. The
default is to buffer messages.
=back
=head1 METHODS
This class provides the following methods:
=head2 $email->send_email(%p)
This is the method that must be subclassed. For now the only
parameter in the hash is 'message'.
=head2 $email->flush
If the object is buffered, then this method will call the
C<send_email()> method to send the contents of the buffer and then
clear the buffer.
=head2 $email->DESTROY
On destruction, the object will call C<flush()> to send any pending
email.
=head1 AUTHOR
Dave Rolsky <autarch@urth.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2015 by Dave Rolsky.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
=cut
|
