89fd516d8e
representation from the numeric (for logging purposes). Add new logging
plugin, logging/adaptive, which logs at different levels depending on
whether the message was accepted/rejected.
* lib/Qpsmtpd/Constants.pm
use hashes for storing return_codes and log_levels
export accessor methods to retrieve the text representations
* lib/Qpsmtpd.pm
Rename log_level() to trace_level() so as to not conflict with the same
name in Qpsmtpd::Constants.
Call return_code() to display the text form when logging
* plugins/logging/adaptive
Better documentation
Support named parameters and prefix
Call return_code() to display the text form when logging
* plugins/logging/warn
Include POD
* README.logging
First pass at documenting the logging plugin API
* config.sample/loglevel
New numbering scheme to map directly to syslog levels
git-svn-id: https://svn.perl.org/qpsmtpd/trunk@401 958fd67b-6ff1-0310-b445-bb7760255be9
80 lines
2.0 KiB
Perl
80 lines
2.0 KiB
Perl
#!/usr/bin/perl
|
|
# this is a simple 'warn' plugin like the default builtin logging
|
|
#
|
|
# It demonstrates that a logging plugin can call ->log itself as well
|
|
# as how to ignore log entries from itself
|
|
|
|
sub register {
|
|
my ($self, $qp, $loglevel) = @_;
|
|
|
|
$self->{_level} = LOGWARN;
|
|
if ( defined($loglevel) ) {
|
|
if ($loglevel =~ /^\d+$/) {
|
|
$self->{_level} = $loglevel;
|
|
}
|
|
else {
|
|
$self->{_level} = log_level($loglevel);
|
|
}
|
|
}
|
|
$self->register_hook('logging', 'wlog');
|
|
|
|
# If you want to capture this log entry with this plugin, you need to
|
|
# wait until after you register the plugin
|
|
$self->log(LOGINFO,'Initializing logging::warn plugin');
|
|
}
|
|
|
|
sub wlog {
|
|
my ($self, $transaction, $trace, $hook, $plugin, @log) = @_;
|
|
|
|
# Don't log your own log entries! If this is the only logging plugin
|
|
# then these lines will not be logged at all. You can safely comment
|
|
# out this line and it will not cause an infinite loop.
|
|
return DECLINED if defined $plugin and $plugin eq $self->plugin_name;
|
|
|
|
warn
|
|
join(" ", $$ .
|
|
(defined $plugin ? " $plugin plugin:" :
|
|
defined $hook ? " running plugin ($hook):" : ""),
|
|
@log), "\n"
|
|
if ($trace <= $self->{_level});
|
|
|
|
return DECLINED;
|
|
}
|
|
|
|
=cut
|
|
|
|
=head1 NAME
|
|
|
|
warn - Default logging plugin for qpsmtpd
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
A qpsmtpd plugin which replicates the built in logging functionality, which
|
|
is to send all logging messages to STDERR below a specific log level.
|
|
|
|
=head1 INSTALL AND CONFIG
|
|
|
|
Place this plugin in the plugin/logging directory beneath the standard
|
|
qpsmtpd installation. Edit the config/logging file and add a line like
|
|
this:
|
|
|
|
logging/warn [loglevel]
|
|
|
|
where the optional parameters C<loglevel> is either the numeric or text
|
|
representation of the maximum log level, as shown in the
|
|
L<config.sample/loglevel> file.
|
|
|
|
=head1 AUTHOR
|
|
|
|
John Peacock <jpeacock@cpan.org>
|
|
|
|
=head1 COPYRIGHT AND LICENSE
|
|
|
|
Copyright (c) 2005 John Peacock
|
|
|
|
This plugin is licensed under the same terms as the qpsmtpd package itself.
|
|
Please see the LICENSE file included with qpsmtpd for details.
|
|
|
|
=cut
|
|
|