summaryrefslogtreecommitdiff
path: root/lib/Log
diff options
context:
space:
mode:
authorLorry Tar Creator <lorry-tar-importer@lorry>2015-06-14 16:34:55 +0000
committerLorry Tar Creator <lorry-tar-importer@lorry>2015-06-14 16:34:55 +0000
commit2e0d2bec52bd345ef05ea12ea9052643ef135029 (patch)
treed128cd9759bc672fa01bac1561911aa8a895981b /lib/Log
downloadLog-Dispatch-tarball-master.tar.gz
Diffstat (limited to 'lib/Log')
-rw-r--r--lib/Log/Dispatch.pm755
-rw-r--r--lib/Log/Dispatch/ApacheLog.pm115
-rw-r--r--lib/Log/Dispatch/Base.pm91
-rw-r--r--lib/Log/Dispatch/Code.pm122
-rw-r--r--lib/Log/Dispatch/Conflicts.pm33
-rw-r--r--lib/Log/Dispatch/Email.pm207
-rw-r--r--lib/Log/Dispatch/Email/MIMELite.pm83
-rw-r--r--lib/Log/Dispatch/Email/MailSend.pm102
-rw-r--r--lib/Log/Dispatch/Email/MailSender.pm130
-rw-r--r--lib/Log/Dispatch/Email/MailSendmail.pm83
-rw-r--r--lib/Log/Dispatch/File.pm285
-rw-r--r--lib/Log/Dispatch/File/Locked.pm96
-rw-r--r--lib/Log/Dispatch/Handle.pm102
-rw-r--r--lib/Log/Dispatch/Null.pm69
-rw-r--r--lib/Log/Dispatch/Output.pm315
-rw-r--r--lib/Log/Dispatch/Screen.pm118
-rw-r--r--lib/Log/Dispatch/Syslog.pm220
17 files changed, 2926 insertions, 0 deletions
diff --git a/lib/Log/Dispatch.pm b/lib/Log/Dispatch.pm
new file mode 100644
index 0000000..a611d6b
--- /dev/null
+++ b/lib/Log/Dispatch.pm
@@ -0,0 +1,755 @@
+package Log::Dispatch;
+
+use 5.006;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use base qw( Log::Dispatch::Base );
+
+use Module::Runtime qw( use_package_optimistically );
+use Params::Validate 0.15 qw(validate_with ARRAYREF CODEREF);
+use Carp ();
+
+our %LEVELS;
+
+BEGIN {
+ my %level_map = (
+ (
+ map { $_ => $_ }
+ qw(
+ debug
+ info
+ notice
+ warning
+ error
+ critical
+ alert
+ emergency
+ )
+ ),
+ warn => 'warning',
+ err => 'error',
+ crit => 'critical',
+ emerg => 'emergency',
+ );
+
+ foreach my $l ( keys %level_map ) {
+ my $sub = sub {
+ my $self = shift;
+ $self->log(
+ level => $level_map{$l},
+ message => @_ > 1 ? "@_" : $_[0],
+ );
+ };
+
+ $LEVELS{$l} = 1;
+
+ no strict 'refs';
+ *{$l} = $sub;
+ }
+}
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = validate_with(
+ params => \@_,
+ spec => {
+ outputs => { type => ARRAYREF, optional => 1 },
+ callbacks => { type => ARRAYREF | CODEREF, optional => 1 }
+ },
+ allow_extra => 1, # for backward compatibility
+ );
+
+ my $self = bless {}, $class;
+
+ my @cb = $self->_get_callbacks(%p);
+ $self->{callbacks} = \@cb if @cb;
+
+ if ( my $outputs = $p{outputs} ) {
+ if ( ref $outputs->[1] eq 'HASH' ) {
+
+ # 2.23 API
+ # outputs => [
+ # File => { min_level => 'debug', filename => 'logfile' },
+ # Screen => { min_level => 'warning' }
+ # ]
+ while ( my ( $class, $params ) = splice @$outputs, 0, 2 ) {
+ $self->_add_output( $class, %$params );
+ }
+ }
+ else {
+
+ # 2.24+ syntax
+ # outputs => [
+ # [ 'File', min_level => 'debug', filename => 'logfile' ],
+ # [ 'Screen', min_level => 'warning' ]
+ # ]
+ foreach my $arr (@$outputs) {
+ die "expected arrayref, not '$arr'"
+ unless ref $arr eq 'ARRAY';
+ $self->_add_output(@$arr);
+ }
+ }
+ }
+
+ return $self;
+}
+
+sub clone {
+ my $self = shift;
+
+ my %clone = (
+ callbacks => [ @{ $self->{callbacks} || [] } ],
+ outputs => { %{ $self->{outputs} || {} } },
+ );
+
+ return bless \%clone, ref $self;
+}
+
+sub _add_output {
+ my $self = shift;
+ my $class = shift;
+
+ my $full_class
+ = substr( $class, 0, 1 ) eq '+'
+ ? substr( $class, 1 )
+ : "Log::Dispatch::$class";
+
+ use_package_optimistically($full_class);
+
+ $self->add( $full_class->new(@_) );
+}
+
+sub add {
+ my $self = shift;
+ my $object = shift;
+
+ # Once 5.6 is more established start using the warnings module.
+ if ( exists $self->{outputs}{ $object->name } && $^W ) {
+ Carp::carp(
+ "Log::Dispatch::* object ", $object->name,
+ " already exists."
+ );
+ }
+
+ $self->{outputs}{ $object->name } = $object;
+}
+
+sub remove {
+ my $self = shift;
+ my $name = shift;
+
+ return delete $self->{outputs}{$name};
+}
+
+sub outputs {
+ my $self = shift;
+
+ return values %{ $self->{outputs} };
+}
+
+sub callbacks {
+ my $self = shift;
+
+ return @{ $self->{callbacks} };
+}
+
+sub log {
+ my $self = shift;
+ my %p = @_;
+
+ return unless $self->would_log( $p{level} );
+
+ $self->_log_to_outputs( $self->_prepare_message(%p) );
+}
+
+sub _prepare_message {
+ my $self = shift;
+ my %p = @_;
+
+ $p{message} = $p{message}->()
+ if ref $p{message} eq 'CODE';
+
+ $p{message} = $self->_apply_callbacks(%p)
+ if $self->{callbacks};
+
+ return %p;
+}
+
+sub _log_to_outputs {
+ my $self = shift;
+ my %p = @_;
+
+ foreach ( keys %{ $self->{outputs} } ) {
+ $p{name} = $_;
+ $self->_log_to(%p);
+ }
+}
+
+sub log_and_die {
+ my $self = shift;
+
+ my %p = $self->_prepare_message(@_);
+
+ $self->_log_to_outputs(%p) if $self->would_log( $p{level} );
+
+ $self->_die_with_message(%p);
+}
+
+sub log_and_croak {
+ my $self = shift;
+
+ $self->log_and_die( @_, carp_level => 3 );
+}
+
+sub _die_with_message {
+ my $self = shift;
+ my %p = @_;
+
+ my $msg = $p{message};
+
+ local $Carp::CarpLevel = ( $Carp::CarpLevel || 0 ) + $p{carp_level}
+ if exists $p{carp_level};
+
+ Carp::croak($msg);
+}
+
+sub log_to {
+ my $self = shift;
+ my %p = @_;
+
+ $p{message} = $self->_apply_callbacks(%p)
+ if $self->{callbacks};
+
+ $self->_log_to(%p);
+}
+
+sub _log_to {
+ my $self = shift;
+ my %p = @_;
+ my $name = $p{name};
+
+ if ( exists $self->{outputs}{$name} ) {
+ $self->{outputs}{$name}->log(@_);
+ }
+ elsif ($^W) {
+ Carp::carp(
+ "Log::Dispatch::* object named '$name' not in dispatcher\n");
+ }
+}
+
+sub output {
+ my $self = shift;
+ my $name = shift;
+
+ return unless exists $self->{outputs}{$name};
+
+ return $self->{outputs}{$name};
+}
+
+sub level_is_valid {
+ shift;
+ my $level = shift
+ or Carp::croak('Logging level was not provided');
+
+ return $LEVELS{$level};
+}
+
+sub would_log {
+ my $self = shift;
+ my $level = shift;
+
+ return 0 unless $self->level_is_valid($level);
+
+ foreach ( values %{ $self->{outputs} } ) {
+ return 1 if $_->_should_log($level);
+ }
+
+ return 0;
+}
+
+sub is_debug { $_[0]->would_log('debug') }
+sub is_info { $_[0]->would_log('info') }
+sub is_notice { $_[0]->would_log('notice') }
+sub is_warning { $_[0]->would_log('warning') }
+sub is_warn { $_[0]->would_log('warn') }
+sub is_error { $_[0]->would_log('error') }
+sub is_err { $_[0]->would_log('err') }
+sub is_critical { $_[0]->would_log('critical') }
+sub is_crit { $_[0]->would_log('crit') }
+sub is_alert { $_[0]->would_log('alert') }
+sub is_emerg { $_[0]->would_log('emerg') }
+sub is_emergency { $_[0]->would_log('emergency') }
+
+1;
+
+# ABSTRACT: Dispatches messages to one or more outputs
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch - Dispatches messages to one or more outputs
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ # Simple API
+ #
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [ 'File', min_level => 'debug', filename => 'logfile' ],
+ [ 'Screen', min_level => 'warning' ],
+ ],
+ );
+
+ $log->info('Blah, blah');
+
+ # More verbose API
+ #
+ my $log = Log::Dispatch->new();
+ $log->add(
+ Log::Dispatch::File->new(
+ name => 'file1',
+ min_level => 'debug',
+ filename => 'logfile'
+ )
+ );
+ $log->add(
+ Log::Dispatch::Screen->new(
+ name => 'screen',
+ min_level => 'warning',
+ )
+ );
+
+ $log->log( level => 'info', message => 'Blah, blah' );
+
+ my $sub = sub { my %p = @_; return reverse $p{message}; };
+ my $reversing_dispatcher = Log::Dispatch->new( callbacks => $sub );
+
+=head1 DESCRIPTION
+
+This module manages a set of Log::Dispatch::* output objects that can be
+logged to via a unified interface.
+
+The idea is that you create a Log::Dispatch object and then add various
+logging objects to it (such as a file logger or screen logger). Then you
+call the C<log> method of the dispatch object, which passes the message to
+each of the objects, which in turn decide whether or not to accept the
+message and what to do with it.
+
+This makes it possible to call single method and send a message to a
+log file, via email, to the screen, and anywhere else, all with very
+little code needed on your part, once the dispatching object has been
+created.
+
+=encoding UTF-8
+
+=head1 METHODS
+
+This class provides the following methods:
+
+=head2 Log::Dispatch->new(...)
+
+This method takes the following parameters:
+
+=over 4
+
+=item * outputs( [ [ class, params, ... ], [ class, params, ... ], ... ] )
+
+This parameter is a reference to a list of lists. Each inner list consists of
+a class name and a set of constructor params. The class is automatically
+prefixed with 'Log::Dispatch::' unless it begins with '+', in which case the
+string following '+' is taken to be a full classname. e.g.
+
+ outputs => [ [ 'File', min_level => 'debug', filename => 'logfile' ],
+ [ '+My::Dispatch', min_level => 'info' ] ]
+
+For each inner list, a new output object is created and added to the
+dispatcher (via the C<add()> method).
+
+See L<OUTPUT CLASSES> for the parameters that can be used when creating an
+output object.
+
+=item * callbacks( \& or [ \&, \&, ... ] )
+
+This parameter may be a single subroutine reference or an array
+reference of subroutine references. These callbacks will be called in
+the order they are given and passed a hash containing the following keys:
+
+ ( message => $log_message, level => $log_level )
+
+In addition, any key/value pairs passed to a logging method will be
+passed onto your callback.
+
+The callbacks are expected to modify the message and then return a
+single scalar containing that modified message. These callbacks will
+be called when either the C<log> or C<log_to> methods are called and
+will only be applied to a given message once. If they do not return
+the message then you will get no output. Make sure to return the
+message!
+
+=back
+
+=head2 $dispatch->clone()
+
+This returns a I<shallow> clone of the original object. The underlying output
+objects and callbacks are shared between the two objects. However any changes
+made to the outputs or callbacks that the object contains are not shared.
+
+=head2 $dispatch->log( level => $, message => $ or \& )
+
+Sends the message (at the appropriate level) to all the
+output objects that the dispatcher contains (by calling the
+C<log_to> method repeatedly).
+
+This method also accepts a subroutine reference as the message
+argument. This reference will be called only if there is an output
+that will accept a message of the specified level.
+
+=head2 $dispatch->debug (message), info (message), ...
+
+You may call any valid log level (including valid abbreviations) as a method
+with a single argument that is the message to be logged. This is converted
+into a call to the C<log> method with the appropriate level.
+
+For example:
+
+ $log->alert('Strange data in incoming request');
+
+translates to:
+
+ $log->log( level => 'alert', message => 'Strange data in incoming request' );
+
+If you pass an array to these methods, it will be stringified as is:
+
+ my @array = ('Something', 'bad', 'is', 'here');
+ $log->alert(@array);
+
+ # is equivalent to
+
+ $log->alert("@array");
+
+You can also pass a subroutine reference, just like passing one to the
+C<log()> method.
+
+=head2 $dispatch->log_and_die( level => $, message => $ or \& )
+
+Has the same behavior as calling C<log()> but calls
+C<_die_with_message()> at the end.
+
+=head2 $dispatch->log_and_croak( level => $, message => $ or \& )
+
+This method adjusts the C<$Carp::CarpLevel> scalar so that the croak
+comes from the context in which it is called.
+
+You can throw exception objects by subclassing this method.
+
+If the C<carp_level> parameter is present its value will be added to
+the current value of C<$Carp::CarpLevel>.
+
+=head2 $dispatch->log_to( name => $, level => $, message => $ )
+
+Sends the message only to the named object. Note: this will not properly
+handle a subroutine reference as the message.
+
+=head2 $dispatch->add_callback( $code )
+
+Adds a callback (like those given during construction). It is added to the end
+of the list of callbacks. Note that this can also be called on individual
+output objects.
+
+=head2 $dispatch->callbacks()
+
+Returns a list of the callbacks in a given output.
+
+=head2 $dispatch->level_is_valid( $string )
+
+Returns true or false to indicate whether or not the given string is a
+valid log level. Can be called as either a class or object method.
+
+=head2 $dispatch->would_log( $string )
+
+Given a log level, returns true or false to indicate whether or not
+anything would be logged for that log level.
+
+=head2 $dispatch->is_C<$level>
+
+There are methods for every log level: C<is_debug()>, C<is_warning()>, etc.
+
+This returns true if the logger will log a message at the given level.
+
+=head2 $dispatch->add( Log::Dispatch::* OBJECT )
+
+Adds a new L<output object|OUTPUT CLASSES> to the dispatcher. If an object
+of the same name already exists, then that object is replaced, with
+a warning if C<$^W> is true.
+
+=head2 $dispatch->remove($)
+
+Removes the object that matches the name given to the remove method.
+The return value is the object being removed or undef if no object
+matched this.
+
+=head2 $dispatch->outputs()
+
+Returns a list of output objects.
+
+=head2 $dispatch->output( $name )
+
+Returns the output object of the given name. Returns undef or an empty
+list, depending on context, if the given output does not exist.
+
+=head2 $dispatch->_die_with_message( message => $, carp_level => $ )
+
+This method is used by C<log_and_die> and will either die() or croak()
+depending on the value of C<message>: if it's a reference or it ends
+with a new line then a plain die will be used, otherwise it will
+croak.
+
+=head1 OUTPUT CLASSES
+
+An output class - e.g. L<Log::Dispatch::File> or
+L<Log::Dispatch::Screen> - implements a particular way
+of dispatching logs. Many output classes come with this distribution,
+and others are available separately on CPAN.
+
+The following common parameters can be used when creating an output class.
+All are optional. Most output classes will have additional parameters beyond
+these, see their documentation for details.
+
+=over 4
+
+=item * name ($)
+
+A name for the object (not the filename!). This is useful if you want to
+refer to the object later, e.g. to log specifically to it or remove it.
+
+By default a unique name will be generated. You should not depend on the
+form of generated names, as they may change.
+
+=item * min_level ($)
+
+The minimum L<logging level|LOG LEVELS> this object will accept. Required.
+
+=item * max_level ($)
+
+The maximum L<logging level|LOG LEVELS> this object will accept. By default
+the maximum is the highest possible level (which means functionally that the
+object has no maximum).
+
+=item * callbacks( \& or [ \&, \&, ... ] )
+
+This parameter may be a single subroutine reference or an array
+reference of subroutine references. These callbacks will be called in
+the order they are given and passed a hash containing the following keys:
+
+ ( message => $log_message, level => $log_level )
+
+The callbacks are expected to modify the message and then return a
+single scalar containing that modified message. These callbacks will
+be called when either the C<log> or C<log_to> methods are called and
+will only be applied to a given message once. If they do not return
+the message then you will get no output. Make sure to return the
+message!
+
+=item * newline (0|1)
+
+If true, a callback will be added to the end of the callbacks list that adds
+a newline to the end of each message. Default is false, but some
+output classes may decide to make the default true.
+
+=back
+
+=head1 LOG LEVELS
+
+The log levels that Log::Dispatch uses are taken directly from the
+syslog man pages (except that I expanded them to full words). Valid
+levels are:
+
+=over 4
+
+=item debug
+
+=item info
+
+=item notice
+
+=item warning
+
+=item error
+
+=item critical
+
+=item alert
+
+=item emergency
+
+=back
+
+Alternately, the numbers 0 through 7 may be used (debug is 0 and emergency is
+7). The syslog standard of 'err', 'crit', and 'emerg' is also acceptable. We
+also allow 'warn' as a synonym for 'warning'.
+
+=head1 SUBCLASSING
+
+This module was designed to be easy to subclass. If you want to handle
+messaging in a way not implemented in this package, you should be able to add
+this with minimal effort. It is generally as simple as subclassing
+Log::Dispatch::Output and overriding the C<new> and C<log_message>
+methods. See the L<Log::Dispatch::Output> docs for more details.
+
+If you would like to create your own subclass for sending email then
+it is even simpler. Simply subclass L<Log::Dispatch::Email> and
+override the C<send_email> method. See the L<Log::Dispatch::Email>
+docs for more details.
+
+The logging levels that Log::Dispatch uses are borrowed from the standard
+UNIX syslog levels, except that where syslog uses partial words ("err")
+Log::Dispatch also allows the use of the full word as well ("error").
+
+=head1 RELATED MODULES
+
+=head2 Log::Dispatch::DBI
+
+Written by Tatsuhiko Miyagawa. Log output to a database table.
+
+=head2 Log::Dispatch::FileRotate
+
+Written by Mark Pfeiffer. Rotates log files periodically as part of
+its usage.
+
+=head2 Log::Dispatch::File::Stamped
+
+Written by Eric Cholet. Stamps log files with date and time
+information.
+
+=head2 Log::Dispatch::Jabber
+
+Written by Aaron Straup Cope. Logs messages via Jabber.
+
+=head2 Log::Dispatch::Tk
+
+Written by Dominique Dumont. Logs messages to a Tk window.
+
+=head2 Log::Dispatch::Win32EventLog
+
+Written by Arthur Bergman. Logs messages to the Windows event log.
+
+=head2 Log::Log4perl
+
+An implementation of Java's log4j API in Perl. Log messages can be limited by
+fine-grained controls, and if they end up being logged, both native Log4perl
+and Log::Dispatch appenders can be used to perform the actual logging
+job. Created by Mike Schilli and Kevin Goess.
+
+=head2 Log::Dispatch::Config
+
+Written by Tatsuhiko Miyagawa. Allows configuration of logging via a
+text file similar (or so I'm told) to how it is done with log4j.
+Simpler than Log::Log4perl.
+
+=head2 Log::Agent
+
+A very different API for doing many of the same things that
+Log::Dispatch does. Originally written by Raphael Manfredi.
+
+=head1 SUPPORT
+
+Please submit bugs and patches to the CPAN RT system at
+http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Log%3A%3ADispatch
+or via email at bug-log-dispatch@rt.cpan.org.
+
+Support questions can be sent to me at my email address, shown below.
+
+=head1 DONATIONS
+
+If you'd like to thank me for the work I've done on this module,
+please consider making a "donation" to me via PayPal. I spend a lot of
+free time creating free software, and would appreciate any support
+you'd care to offer.
+
+Please note that B<I am not suggesting that you must do this> in order
+for me to continue working on this particular software. I will
+continue to do so, inasmuch as I have in the past, for as long as it
+interests me.
+
+Similarly, a donation made in this way will probably not make me work
+on this software much more, unless I get so many donations that I can
+consider working on free software full time, which seems unlikely at
+best.
+
+To donate, log into PayPal and send money to autarch@urth.org or use
+the button on this page:
+L<http://www.urth.org/~autarch/fs-donation.html>
+
+=head1 SEE ALSO
+
+L<Log::Dispatch::ApacheLog>, L<Log::Dispatch::Email>,
+L<Log::Dispatch::Email::MailSend>, L<Log::Dispatch::Email::MailSender>,
+L<Log::Dispatch::Email::MailSendmail>, L<Log::Dispatch::Email::MIMELite>,
+L<Log::Dispatch::File>, L<Log::Dispatch::File::Locked>,
+L<Log::Dispatch::Handle>, L<Log::Dispatch::Output>, L<Log::Dispatch::Screen>,
+L<Log::Dispatch::Syslog>
+
+=head1 AUTHOR
+
+Dave Rolsky <autarch@urth.org>
+
+=head1 CONTRIBUTORS
+
+=for stopwords Karen Etheridge Olaf Alders Olivier Mengué Ross Attrill swartz@jonathan-swartzs-macbook-4.local swartz@pobox.com Whitney Jackson
+
+=over 4
+
+=item *
+
+Karen Etheridge <ether@cpan.org>
+
+=item *
+
+Olaf Alders <olaf@wundersolutions.com>
+
+=item *
+
+Olivier Mengué <dolmen@cpan.org>
+
+=item *
+
+Ross Attrill <ross.attrill@gmail.com>
+
+=item *
+
+swartz@jonathan-swartzs-macbook-4.local <swartz@jonathan-swartzs-macbook-4.local>
+
+=item *
+
+swartz@pobox.com <swartz@pobox.com>
+
+=item *
+
+Whitney Jackson <whitney.jackson@baml.com>
+
+=back
+
+=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
diff --git a/lib/Log/Dispatch/ApacheLog.pm b/lib/Log/Dispatch/ApacheLog.pm
new file mode 100644
index 0000000..4c5ccb9
--- /dev/null
+++ b/lib/Log/Dispatch/ApacheLog.pm
@@ -0,0 +1,115 @@
+package Log::Dispatch::ApacheLog;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Output;
+
+use base qw( Log::Dispatch::Output );
+
+use Params::Validate qw(validate);
+Params::Validate::validation_options( allow_extra => 1 );
+
+BEGIN {
+ if ( $ENV{MOD_PERL} && $ENV{MOD_PERL} =~ /2\./ ) {
+ require Apache2::Log;
+ }
+ else {
+ require Apache::Log;
+ }
+}
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = validate( @_, { apache => { can => 'log' } } );
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(%p);
+ $self->{apache_log} = $p{apache}->log;
+
+ return $self;
+}
+
+{
+ my %methods = (
+ emergency => 'emerg',
+ critical => 'crit',
+ warning => 'warn',
+ );
+
+ sub log_message {
+ my $self = shift;
+ my %p = @_;
+
+ my $level = $self->_level_as_name( $p{level} );
+
+ my $method = $methods{$level} || $level;
+
+ $self->{apache_log}->$method( $p{message} );
+ }
+}
+
+1;
+
+# ABSTRACT: Object for logging to Apache::Log objects
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::ApacheLog - Object for logging to Apache::Log objects
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [ 'ApacheLog', apache => $r ],
+ ],
+ );
+
+ $log->emerg('Kaboom');
+
+=head1 DESCRIPTION
+
+This module allows you to pass messages to Apache's log object,
+represented by the L<Apache::Log> class.
+
+=head1 CONSTRUCTOR
+
+The constructor takes the following parameters in addition to the standard
+parameters documented in L<Log::Dispatch::Output>:
+
+=over 4
+
+=item * apache ($)
+
+An object of either the L<Apache> or L<Apache::Server> classes. Required.
+
+=back
+
+=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
diff --git a/lib/Log/Dispatch/Base.pm b/lib/Log/Dispatch/Base.pm
new file mode 100644
index 0000000..368c6fa
--- /dev/null
+++ b/lib/Log/Dispatch/Base.pm
@@ -0,0 +1,91 @@
+package Log::Dispatch::Base;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+sub _get_callbacks {
+ shift;
+ my %p = @_;
+
+ return unless exists $p{callbacks};
+
+ return @{ $p{callbacks} }
+ if ref $p{callbacks} eq 'ARRAY';
+
+ return $p{callbacks}
+ if ref $p{callbacks} eq 'CODE';
+
+ return;
+}
+
+sub _apply_callbacks {
+ my $self = shift;
+ my %p = @_;
+
+ my $msg = delete $p{message};
+ foreach my $cb ( @{ $self->{callbacks} } ) {
+ $msg = $cb->( message => $msg, %p );
+ }
+
+ return $msg;
+}
+
+sub add_callback {
+ my $self = shift;
+ my $value = shift;
+
+ Carp::carp("given value $value is not a valid callback")
+ unless ref $value eq 'CODE';
+
+ $self->{callbacks} ||= [];
+ push @{ $self->{callbacks} }, $value;
+
+ return;
+}
+
+1;
+
+# ABSTRACT: Code shared by dispatch and output objects.
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Base - Code shared by dispatch and output objects.
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch::Base;
+
+ ...
+
+ @ISA = qw(Log::Dispatch::Base);
+
+=head1 DESCRIPTION
+
+Unless you are me, you probably don't need to know what this class
+does.
+
+=for Pod::Coverage add_callback
+
+=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
diff --git a/lib/Log/Dispatch/Code.pm b/lib/Log/Dispatch/Code.pm
new file mode 100644
index 0000000..e06bbfd
--- /dev/null
+++ b/lib/Log/Dispatch/Code.pm
@@ -0,0 +1,122 @@
+package Log::Dispatch::Code;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Output;
+
+use base qw( Log::Dispatch::Output );
+
+use Params::Validate qw(validate CODEREF);
+Params::Validate::validation_options( allow_extra => 1 );
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = validate( @_, { code => CODEREF } );
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(%p);
+ $self->{code} = $p{code};
+
+ return $self;
+}
+
+sub log_message {
+ my $self = shift;
+ my %p = @_;
+
+ delete $p{name};
+
+ $self->{code}->(%p);
+}
+
+1;
+
+# ABSTRACT: Object for logging to a subroutine reference
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Code - Object for logging to a subroutine reference
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Code',
+ min_level => 'emerg',
+ code => \&_log_it,
+ ],
+ ]
+ );
+
+ sub _log_it {
+ my %p = @_;
+
+ warn $p{message};
+ }
+
+=head1 DESCRIPTION
+
+This module supplies a simple object for logging to a subroutine reference.
+
+=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 * code ($)
+
+The subroutine reference.
+
+=back
+
+=head1 HOW IT WORKS
+
+The subroutine you provide will be called with a hash of named arguments. The
+two arguments are:
+
+=over 4
+
+=item * level
+
+The log level of the message. This will be a string like "info" or "error".
+
+=item * message
+
+The message being logged.
+
+=back
+
+=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
diff --git a/lib/Log/Dispatch/Conflicts.pm b/lib/Log/Dispatch/Conflicts.pm
new file mode 100644
index 0000000..9f528e5
--- /dev/null
+++ b/lib/Log/Dispatch/Conflicts.pm
@@ -0,0 +1,33 @@
+package # hide from PAUSE
+ Log::Dispatch::Conflicts;
+
+use strict;
+use warnings;
+
+# this module was generated with Dist::Zilla::Plugin::Conflicts 0.17
+
+use Dist::CheckConflicts
+ -dist => 'Log::Dispatch',
+ -conflicts => {
+ 'Log::Dispatch::File::Stamped' => '0.10',
+ },
+ -also => [ qw(
+ Carp
+ Devel::GlobalDestruction
+ Dist::CheckConflicts
+ Fcntl
+ Module::Runtime
+ Params::Validate
+ Scalar::Util
+ Sys::Syslog
+ base
+ strict
+ warnings
+ ) ],
+
+;
+
+1;
+
+# ABSTRACT: Provide information on conflicts for Log::Dispatch
+# Dist::Zilla: -PodWeaver
diff --git a/lib/Log/Dispatch/Email.pm b/lib/Log/Dispatch/Email.pm
new file mode 100644
index 0000000..b10604a
--- /dev/null
+++ b/lib/Log/Dispatch/Email.pm
@@ -0,0 +1,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
diff --git a/lib/Log/Dispatch/Email/MIMELite.pm b/lib/Log/Dispatch/Email/MIMELite.pm
new file mode 100644
index 0000000..aadf5de
--- /dev/null
+++ b/lib/Log/Dispatch/Email/MIMELite.pm
@@ -0,0 +1,83 @@
+package Log::Dispatch::Email::MIMELite;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Email;
+
+use base qw( Log::Dispatch::Email );
+
+use MIME::Lite;
+
+sub send_email {
+ my $self = shift;
+ my %p = @_;
+
+ my %mail = (
+ To => ( join ',', @{ $self->{to} } ),
+ Subject => $self->{subject},
+ Type => 'TEXT',
+ Data => $p{message},
+ );
+
+ $mail{From} = $self->{from} if defined $self->{from};
+
+ local $?;
+ unless ( MIME::Lite->new(%mail)->send ) {
+ warn "Error sending mail with MIME::Lite";
+ }
+}
+
+1;
+
+# ABSTRACT: Subclass of Log::Dispatch::Email that uses the MIME::Lite module
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Email::MIMELite - Subclass of Log::Dispatch::Email that uses the MIME::Lite module
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Email::MIMELite',
+ min_level => 'emerg',
+ to => [qw( foo@example.com bar@example.org )],
+ subject => 'Big error!'
+ ]
+ ],
+ );
+
+ $log->emerg("Something bad is happening");
+
+=head1 DESCRIPTION
+
+This is a subclass of L<Log::Dispatch::Email> that implements the
+send_email method using the L<MIME::Lite> module.
+
+=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
diff --git a/lib/Log/Dispatch/Email/MailSend.pm b/lib/Log/Dispatch/Email/MailSend.pm
new file mode 100644
index 0000000..10a7018
--- /dev/null
+++ b/lib/Log/Dispatch/Email/MailSend.pm
@@ -0,0 +1,102 @@
+package Log::Dispatch::Email::MailSend;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Email;
+
+use base qw( Log::Dispatch::Email );
+
+use Mail::Send;
+
+sub send_email {
+ my $self = shift;
+ my %p = @_;
+
+ my $msg = Mail::Send->new;
+
+ $msg->to( join ',', @{ $self->{to} } );
+ $msg->subject( $self->{subject} );
+
+ # Does this ever work for this module?
+ $msg->set( 'From', $self->{from} ) if $self->{from};
+
+ local $?;
+ eval {
+ my $fh = $msg->open
+ or die "Cannot open handle to mail program";
+
+ $fh->print( $p{message} )
+ or die "Cannot print message to mail program handle";
+
+ $fh->close
+ or die "Cannot close handle to mail program";
+ };
+
+ warn $@ if $@;
+}
+
+1;
+
+# ABSTRACT: Subclass of Log::Dispatch::Email that uses the Mail::Send module
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Email::MailSend - Subclass of Log::Dispatch::Email that uses the Mail::Send module
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Email::MailSend',
+ min_level => 'emerg',
+ to => [qw( foo@example.com bar@example.org )],
+ subject => 'Big error!'
+ ]
+ ],
+ );
+
+ $log->emerg("Something bad is happening");
+
+=head1 DESCRIPTION
+
+This is a subclass of L<Log::Dispatch::Email> that implements the send_email
+method using the L<Mail::Send> module.
+
+=head1 CHANGING HOW MAIL IS SENT
+
+Since L<Mail::Send> is a subclass of L<Mail::Mailer>, you can change
+how mail is sent from this module by simply C<use>ing L<Mail::Mailer>
+in your code before mail is sent. For example, to send mail via smtp,
+you could do:
+
+ use Mail::Mailer 'smtp', Server => 'foo.example.com';
+
+For more details, see the L<Mail::Mailer> docs.
+
+=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
diff --git a/lib/Log/Dispatch/Email/MailSender.pm b/lib/Log/Dispatch/Email/MailSender.pm
new file mode 100644
index 0000000..8d561c7
--- /dev/null
+++ b/lib/Log/Dispatch/Email/MailSender.pm
@@ -0,0 +1,130 @@
+package Log::Dispatch::Email::MailSender;
+
+# By: Joseph Annino
+# (c) 2002
+# Licensed under the same terms as Perl
+#
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Email;
+
+use base qw( Log::Dispatch::Email );
+
+use Mail::Sender ();
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = @_;
+
+ my $smtp = delete $p{smtp} || 'localhost';
+ my $port = delete $p{port} || '25';
+
+ my $self = $class->SUPER::new(%p);
+
+ $self->{smtp} = $smtp;
+ $self->{port} = $port;
+
+ return $self;
+}
+
+sub send_email {
+ my $self = shift;
+ my %p = @_;
+
+ local $?;
+ eval {
+ my $sender = Mail::Sender->new(
+ {
+ from => $self->{from} || 'LogDispatch@foo.bar',
+ replyto => $self->{from} || 'LogDispatch@foo.bar',
+ to => ( join ',', @{ $self->{to} } ),
+ subject => $self->{subject},
+ smtp => $self->{smtp},
+ port => $self->{port},
+ }
+ );
+
+ die "Error sending mail ($sender): $Mail::Sender::Error"
+ unless ref $sender;
+
+ ref $sender->MailMsg( { msg => $p{message} } )
+ or die "Error sending mail: $Mail::Sender::Error";
+ };
+
+ warn $@ if $@;
+}
+
+1;
+
+# ABSTRACT: Subclass of Log::Dispatch::Email that uses the Mail::Sender module
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Email::MailSender - Subclass of Log::Dispatch::Email that uses the Mail::Sender module
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Email::MailSender',
+ min_level => 'emerg',
+ to => [qw( foo@example.com bar@example.org )],
+ subject => 'Big error!'
+ ]
+ ],
+ );
+
+ $log->emerg("Something bad is happening");
+
+=head1 DESCRIPTION
+
+This is a subclass of L<Log::Dispatch::Email> that implements the send_email
+method using the L<Mail::Sender> module.
+
+=head1 CONSTRUCTOR
+
+The constructor takes the following parameters in addition to the parameters
+documented in L<Log::Dispatch::Output> and L<Log::Dispatch::Email>:
+
+=over 4
+
+=item * smtp ($)
+
+The smtp server to connect to. This defaults to "localhost".
+
+=item * port ($)
+
+The port to use when connecting. This defaults to 25.
+
+=back
+
+=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
diff --git a/lib/Log/Dispatch/Email/MailSendmail.pm b/lib/Log/Dispatch/Email/MailSendmail.pm
new file mode 100644
index 0000000..c00f8c4
--- /dev/null
+++ b/lib/Log/Dispatch/Email/MailSendmail.pm
@@ -0,0 +1,83 @@
+package Log::Dispatch::Email::MailSendmail;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Email;
+
+use base qw( Log::Dispatch::Email );
+
+use Mail::Sendmail ();
+
+sub send_email {
+ my $self = shift;
+ my %p = @_;
+
+ my %mail = (
+ To => ( join ',', @{ $self->{to} } ),
+ Subject => $self->{subject},
+ Message => $p{message},
+
+ # Mail::Sendmail insists on having this parameter.
+ From => $self->{from} || 'LogDispatch@foo.bar',
+ );
+
+ local $?;
+ unless ( Mail::Sendmail::sendmail(%mail) ) {
+ warn "Error sending mail: $Mail::Sendmail::error";
+ }
+}
+
+1;
+
+# ABSTRACT: Subclass of Log::Dispatch::Email that uses the Mail::Sendmail module
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Email::MailSendmail - Subclass of Log::Dispatch::Email that uses the Mail::Sendmail module
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Email::MailSendmail',
+ min_level => 'emerg',
+ to => [qw( foo@example.com bar@example.org )],
+ subject => 'Big error!'
+ ]
+ ],
+ );
+
+ $log->emerg("Something bad is happening");
+
+=head1 DESCRIPTION
+
+This is a subclass of L<Log::Dispatch::Email> that implements the
+send_email method using the L<Mail::Sendmail> module.
+
+=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
diff --git a/lib/Log/Dispatch/File.pm b/lib/Log/Dispatch/File.pm
new file mode 100644
index 0000000..4b39ecb
--- /dev/null
+++ b/lib/Log/Dispatch/File.pm
@@ -0,0 +1,285 @@
+package Log::Dispatch::File;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Output;
+
+use base qw( Log::Dispatch::Output );
+
+use Params::Validate qw(validate SCALAR BOOLEAN);
+Params::Validate::validation_options( allow_extra => 1 );
+
+use Scalar::Util qw( openhandle );
+
+# Prevents death later on if IO::File can't export this constant.
+*O_APPEND = \&APPEND unless defined &O_APPEND;
+
+sub APPEND {0}
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = @_;
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(%p);
+ $self->_make_handle;
+
+ return $self;
+}
+
+sub _basic_init {
+ my $self = shift;
+
+ $self->SUPER::_basic_init(@_);
+
+ my %p = validate(
+ @_, {
+ filename => { type => SCALAR },
+ mode => {
+ type => SCALAR,
+ default => '>'
+ },
+ binmode => {
+ type => SCALAR,
+ default => undef
+ },
+ autoflush => {
+ type => BOOLEAN,
+ default => 1
+ },
+ close_after_write => {
+ type => BOOLEAN,
+ default => 0
+ },
+ permissions => {
+ type => SCALAR,
+ optional => 1
+ },
+ syswrite => {
+ type => BOOLEAN,
+ default => 0
+ },
+ }
+ );
+
+ $self->{filename} = $p{filename};
+ $self->{binmode} = $p{binmode};
+ $self->{autoflush} = $p{autoflush};
+ $self->{close} = $p{close_after_write};
+ $self->{permissions} = $p{permissions};
+ $self->{syswrite} = $p{syswrite};
+
+ if ( $self->{close} ) {
+ $self->{mode} = '>>';
+ }
+ elsif (
+ exists $p{mode}
+ && defined $p{mode}
+ && (
+ $p{mode} =~ /^(?:>>|append)$/
+ || ( $p{mode} =~ /^\d+$/
+ && $p{mode} == O_APPEND() )
+ )
+ ) {
+ $self->{mode} = '>>';
+ }
+ else {
+ $self->{mode} = '>';
+ }
+
+}
+
+sub _make_handle {
+ my $self = shift;
+
+ $self->_open_file() unless $self->{close};
+}
+
+sub _open_file {
+ my $self = shift;
+
+ open my $fh, $self->{mode}, $self->{filename}
+ or die "Cannot write to '$self->{filename}': $!";
+
+ if ( $self->{autoflush} ) {
+ my $oldfh = select $fh;
+ $| = 1;
+ select $oldfh;
+ }
+
+ if ( $self->{permissions}
+ && !$self->{chmodded} ) {
+ my $current_mode = ( stat $self->{filename} )[2] & 07777;
+ if ( $current_mode ne $self->{permissions} ) {
+ chmod $self->{permissions}, $self->{filename}
+ or die
+ "Cannot chmod $self->{filename} to $self->{permissions}: $!";
+ }
+
+ $self->{chmodded} = 1;
+ }
+
+ if ( $self->{binmode} ) {
+ binmode $fh, $self->{binmode};
+ }
+
+ $self->{fh} = $fh;
+}
+
+sub log_message {
+ my $self = shift;
+ my %p = @_;
+
+ if ( $self->{close} ) {
+ $self->_open_file;
+ }
+
+ my $fh = $self->{fh};
+
+ if ( $self->{syswrite} ) {
+ defined syswrite( $fh, $p{message} )
+ or die "Cannot write to '$self->{filename}': $!";
+ }
+ else {
+ print $fh $p{message}
+ or die "Cannot write to '$self->{filename}': $!";
+ }
+
+ if ( $self->{close} ) {
+ close $fh
+ or die "Cannot close '$self->{filename}': $!";
+ }
+}
+
+sub DESTROY {
+ my $self = shift;
+
+ if ( $self->{fh} ) {
+ my $fh = $self->{fh};
+ close $fh if openhandle($fh);
+ }
+}
+
+1;
+
+# ABSTRACT: Object for logging to files
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::File - Object for logging to files
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'File',
+ min_level => 'info',
+ filename => 'Somefile.log',
+ mode => '>>',
+ newline => 1
+ ]
+ ],
+ );
+
+ $log->emerg("I've fallen and I can't get up");
+
+=head1 DESCRIPTION
+
+This module provides a simple object for logging to files under the
+Log::Dispatch::* system.
+
+Note that a newline will I<not> be added automatically at the end of a message
+by default. To do that, pass C<< newline => 1 >>.
+
+=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 * filename ($)
+
+The filename to be opened for writing.
+
+=item * mode ($)
+
+The mode the file should be opened with. Valid options are 'write',
+'>', 'append', '>>', or the relevant constants from Fcntl. The
+default is 'write'.
+
+=item * binmode ($)
+
+A layer name to be passed to binmode, like ":encoding(UTF-8)" or ":raw".
+
+=item * close_after_write ($)
+
+Whether or not the file should be closed after each write. This
+defaults to false.
+
+If this is true, then the mode will always be append, so that the file is not
+re-written for each new message.
+
+=item * autoflush ($)
+
+Whether or not the file should be autoflushed. This defaults to true.
+
+=item * syswrite ($)
+
+Whether or not to perform the write using L<perlfunc/syswrite>(),
+as opposed to L<perlfunc/print>(). This defaults to false.
+The usual caveats and warnings as documented in L<perlfunc/syswrite> apply.
+
+=item * permissions ($)
+
+If the file does not already exist, the permissions that it should
+be created with. Optional. The argument passed must be a valid
+octal value, such as 0600 or the constants available from Fcntl, like
+S_IRUSR|S_IWUSR.
+
+See L<perlfunc/chmod> for more on potential traps when passing octal
+values around. Most importantly, remember that if you pass a string
+that looks like an octal value, like this:
+
+ my $mode = '0644';
+
+Then the resulting file will end up with permissions like this:
+
+ --w----r-T
+
+which is probably not what you want.
+
+=back
+
+=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
diff --git a/lib/Log/Dispatch/File/Locked.pm b/lib/Log/Dispatch/File/Locked.pm
new file mode 100644
index 0000000..aac9496
--- /dev/null
+++ b/lib/Log/Dispatch/File/Locked.pm
@@ -0,0 +1,96 @@
+package Log::Dispatch::File::Locked;
+
+use strict;
+use warnings;
+
+use base qw( Log::Dispatch::File );
+
+our $VERSION = '2.45';
+
+use Fcntl qw(:DEFAULT :flock);
+
+sub _open_file {
+ my $self = shift;
+
+ $self->SUPER::_open_file();
+
+ my $fh = $self->{fh};
+
+ flock( $fh, LOCK_EX )
+ or die "Cannot lock '$self->{filename}' for writing: $!";
+
+ # just in case there was an append while we waited for the lock
+ seek( $fh, 0, 2 )
+ or die "Cannot seek to end of '$self->{filename}': $!";
+}
+
+1;
+
+# ABSTRACT: Subclass of Log::Dispatch::File to facilitate locking
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::File::Locked - Subclass of Log::Dispatch::File to facilitate locking
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'File::Locked',
+ min_level => 'info',
+ filename => 'Somefile.log',
+ mode => '>>',
+ newline => 1
+ ]
+ ],
+ );
+
+ $log->emerg("I've fallen and I can't get up");
+
+=head1 DESCRIPTION
+
+This module acts exactly like L<Log::Dispatch::File> except that it
+obtains an exclusive lock on the file while opening it.
+
+=head1 CAVEATS
+
+B<DANGER!> Use very carefully in multi-process environments. Because the lock
+is obtained at file open time, not at write time, you may experience deadlocks
+in your system.
+
+You can partially work around this by using the C<close_after_write> option,
+which causes the file to be re-opened every time a log message is written.
+
+Alternatively, the C<syswrite> option does atomic writes, which may mean that
+you don't need locking at all.
+
+See L<Log::Dispatch::File>) for details on these options.
+
+=head1 SEE ALSO
+
+L<perlfunc/flock>
+
+=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
diff --git a/lib/Log/Dispatch/Handle.pm b/lib/Log/Dispatch/Handle.pm
new file mode 100644
index 0000000..3e3ed45
--- /dev/null
+++ b/lib/Log/Dispatch/Handle.pm
@@ -0,0 +1,102 @@
+package Log::Dispatch::Handle;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Output;
+
+use base qw( Log::Dispatch::Output );
+
+use Params::Validate qw(validate SCALAR ARRAYREF BOOLEAN);
+Params::Validate::validation_options( allow_extra => 1 );
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = validate( @_, { handle => { can => 'print' } } );
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(%p);
+ $self->{handle} = $p{handle};
+
+ return $self;
+}
+
+sub log_message {
+ my $self = shift;
+ my %p = @_;
+
+ $self->{handle}->print( $p{message} )
+ or die "Cannot write to handle: $!";
+}
+
+1;
+
+# ABSTRACT: Object for logging to IO::Handle classes
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Handle - Object for logging to IO::Handle classes
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Handle',
+ min_level => 'emerg',
+ handle => $io_socket_object,
+ ],
+ ]
+ );
+
+ $log->emerg('I am the Lizard King!');
+
+=head1 DESCRIPTION
+
+This module supplies a very simple object for logging to some sort of
+handle object. Basically, anything that implements a C<print()>
+method can be passed the object constructor and it should work.
+
+=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 * handle ($)
+
+The handle object. This object must implement a C<print()> method.
+
+=back
+
+=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
diff --git a/lib/Log/Dispatch/Null.pm b/lib/Log/Dispatch/Null.pm
new file mode 100644
index 0000000..09495b7
--- /dev/null
+++ b/lib/Log/Dispatch/Null.pm
@@ -0,0 +1,69 @@
+package Log::Dispatch::Null;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Output;
+
+use base qw( Log::Dispatch::Output );
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(@_);
+
+ return $self;
+}
+
+sub log_message { }
+
+1;
+
+# ABSTRACT: Object that accepts messages and does nothing
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Null - Object that accepts messages and does nothing
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $null
+ = Log::Dispatch->new( outputs => [ [ 'Null', min_level => 'debug' ] ] );
+
+ $null->emerg( "I've fallen and I can't get up" );
+
+=head1 DESCRIPTION
+
+This class provides a null logging object. Messages can be sent to the
+object but it does nothing with them.
+
+=for Pod::Coverage new log_message
+
+=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
diff --git a/lib/Log/Dispatch/Output.pm b/lib/Log/Dispatch/Output.pm
new file mode 100644
index 0000000..7c6ca09
--- /dev/null
+++ b/lib/Log/Dispatch/Output.pm
@@ -0,0 +1,315 @@
+package Log::Dispatch::Output;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch;
+
+use base qw( Log::Dispatch::Base );
+
+use Params::Validate qw(validate SCALAR ARRAYREF CODEREF BOOLEAN);
+Params::Validate::validation_options( allow_extra => 1 );
+
+use Carp ();
+
+my $level_names
+ = [qw( debug info notice warning error critical alert emergency )];
+my $ln = 0;
+my $level_numbers = {
+ ( map { $_ => $ln++ } @{$level_names} ),
+ warn => 3,
+ err => 4,
+ crit => 5,
+ emerg => 7
+};
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ die "The new method must be overridden in the $class subclass";
+}
+
+sub log {
+ my $self = shift;
+
+ my %p = validate(
+ @_, {
+ level => { type => SCALAR },
+ message => { type => SCALAR },
+ }
+ );
+
+ return unless $self->_should_log( $p{level} );
+
+ $p{message} = $self->_apply_callbacks(%p)
+ if $self->{callbacks};
+
+ $self->log_message(%p);
+}
+
+sub _basic_init {
+ my $self = shift;
+
+ my %p = validate(
+ @_, {
+ name => { type => SCALAR, optional => 1 },
+ min_level => { type => SCALAR, required => 1 },
+ max_level => {
+ type => SCALAR,
+ optional => 1
+ },
+ callbacks => {
+ type => ARRAYREF | CODEREF,
+ optional => 1
+ },
+ newline => { type => BOOLEAN, optional => 1 },
+ }
+ );
+
+ $self->{level_names} = $level_names;
+ $self->{level_numbers} = $level_numbers;
+
+ $self->{name} = $p{name} || $self->_unique_name();
+
+ $self->{min_level} = $self->_level_as_number( $p{min_level} );
+ die "Invalid level specified for min_level"
+ unless defined $self->{min_level};
+
+ # Either use the parameter supplied or just the highest possible level.
+ $self->{max_level} = (
+ exists $p{max_level}
+ ? $self->_level_as_number( $p{max_level} )
+ : $#{ $self->{level_names} }
+ );
+
+ die "Invalid level specified for max_level"
+ unless defined $self->{max_level};
+
+ my @cb = $self->_get_callbacks(%p);
+ $self->{callbacks} = \@cb if @cb;
+
+ if ( $p{newline} ) {
+ push @{ $self->{callbacks} }, \&_add_newline_callback;
+ }
+}
+
+sub name {
+ my $self = shift;
+
+ return $self->{name};
+}
+
+sub min_level {
+ my $self = shift;
+
+ return $self->{level_names}[ $self->{min_level} ];
+}
+
+sub max_level {
+ my $self = shift;
+
+ return $self->{level_names}[ $self->{max_level} ];
+}
+
+sub accepted_levels {
+ my $self = shift;
+
+ return @{ $self->{level_names} }
+ [ $self->{min_level} .. $self->{max_level} ];
+}
+
+sub _should_log {
+ my $self = shift;
+
+ my $msg_level = $self->_level_as_number(shift);
+ return ( ( $msg_level >= $self->{min_level} )
+ && ( $msg_level <= $self->{max_level} ) );
+}
+
+sub _level_as_number {
+ my $self = shift;
+ my $level = shift;
+
+ unless ( defined $level ) {
+ Carp::croak "undefined value provided for log level";
+ }
+
+ return $level if $level =~ /^\d$/;
+
+ unless ( Log::Dispatch->level_is_valid($level) ) {
+ Carp::croak "$level is not a valid Log::Dispatch log level";
+ }
+
+ return $self->{level_numbers}{$level};
+}
+
+sub _level_as_name {
+ my $self = shift;
+ my $level = shift;
+
+ unless ( defined $level ) {
+ Carp::croak "undefined value provided for log level";
+ }
+
+ return $level unless $level =~ /^\d$/;
+
+ return $self->{level_names}[$level];
+}
+
+my $_unique_name_counter = 0;
+
+sub _unique_name {
+ my $self = shift;
+
+ return '_anon_' . $_unique_name_counter++;
+}
+
+sub _add_newline_callback {
+
+ # This weird construct is an optimization since this might be called a lot
+ # - see https://github.com/autarch/Log-Dispatch/pull/7
+ +{@_}->{message} . "\n";
+}
+
+1;
+
+# ABSTRACT: Base class for all Log::Dispatch::* objects
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Output - Base class for all Log::Dispatch::* objects
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ package Log::Dispatch::MySubclass;
+
+ use Log::Dispatch::Output;
+ use base qw( Log::Dispatch::Output );
+
+ sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = @_;
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(%p);
+
+ # Do more if you like
+
+ return $self;
+ }
+
+ sub log_message {
+ my $self = shift;
+ my %p = @_;
+
+ # Do something with message in $p{message}
+ }
+
+ 1;
+
+=head1 DESCRIPTION
+
+This module is the base class from which all Log::Dispatch::* objects
+should be derived.
+
+=head1 CONSTRUCTOR
+
+The constructor, C<new>, must be overridden in a subclass. See L<Output
+Classes|Log::Dispatch/OUTPUT CLASSES> for a description of the common
+parameters accepted by this constructor.
+
+=head1 METHODS
+
+This class provides the following methods:
+
+=head2 $output->_basic_init(%p)
+
+This should be called from a subclass's constructor. Make sure to
+pass the arguments in @_ to it. It sets the object's name and minimum
+level from the passed parameters It also sets up two other attributes which
+are used by other Log::Dispatch::Output methods, level_names and level_numbers.
+Subclasses will perform parameter validation in this method, and must also call
+the superclass's method.
+
+=head2 $output->name
+
+Returns the object's name.
+
+=head2 $output->min_level
+
+Returns the object's minimum log level.
+
+=head2 $output->max_level
+
+Returns the object's maximum log level.
+
+=head2 $output->accepted_levels
+
+Returns a list of the object's accepted levels (by name) from minimum
+to maximum.
+
+=head2 $output->log( level => $, message => $ )
+
+Sends a message if the level is greater than or equal to the object's
+minimum level. This method applies any message formatting callbacks
+that the object may have.
+
+=head2 $output->_should_log ($)
+
+This method is called from the C<log()> method with the log level of
+the message to be logged as an argument. It returns a boolean value
+indicating whether or not the message should be logged by this
+particular object. The C<log()> method will not process the message
+if the return value is false.
+
+=head2 $output->_level_as_number ($)
+
+This method will take a log level as a string (or a number) and return
+the number of that log level. If not given an argument, it returns
+the calling object's log level instead. If it cannot determine the
+level then it will croak.
+
+=head2 $output->add_callback( $code )
+
+Adds a callback (like those given during construction). It is added to the end
+of the list of callbacks.
+
+=head1 SUBCLASSING
+
+This class should be used as the base class for all logging objects
+you create that you would like to work under the Log::Dispatch
+architecture. Subclassing is fairly trivial. For most subclasses, if
+you simply copy the code in the SYNOPSIS and then put some
+functionality into the C<log_message> method then you should be all
+set. Please make sure to use the C<_basic_init> method as described above.
+
+The actual logging implementation should be done in a C<log_message>
+method that you write. B<Do not override C<log>!>.
+
+=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
diff --git a/lib/Log/Dispatch/Screen.pm b/lib/Log/Dispatch/Screen.pm
new file mode 100644
index 0000000..4b93464
--- /dev/null
+++ b/lib/Log/Dispatch/Screen.pm
@@ -0,0 +1,118 @@
+package Log::Dispatch::Screen;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Output;
+
+use base qw( Log::Dispatch::Output );
+
+use Params::Validate qw(validate BOOLEAN);
+Params::Validate::validation_options( allow_extra => 1 );
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = validate(
+ @_, {
+ stderr => {
+ type => BOOLEAN,
+ default => 1
+ },
+ }
+ );
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(%p);
+ $self->{stderr} = exists $p{stderr} ? $p{stderr} : 1;
+
+ return $self;
+}
+
+sub log_message {
+ my $self = shift;
+ my %p = @_;
+
+ if ( $self->{stderr} ) {
+ print STDERR $p{message};
+ }
+ else {
+ print STDOUT $p{message};
+ }
+}
+
+1;
+
+# ABSTRACT: Object for logging to the screen
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Screen - Object for logging to the screen
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Screen',
+ min_level => 'debug',
+ stderr => 1,
+ newline => 1
+ ]
+ ],
+ );
+
+ $log->alert("I'm searching the city for sci-fi wasabi");
+
+=head1 DESCRIPTION
+
+This module provides an object for logging to the screen (really
+STDOUT or STDERR).
+
+Note that a newline will I<not> be added automatically at the end of a
+message by default. To do that, pass C<< newline => 1 >>.
+
+=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 * stderr (0 or 1)
+
+Indicates whether or not logging information should go to STDERR. If
+false, logging information is printed to STDOUT instead. This
+defaults to true.
+
+=back
+
+=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
diff --git a/lib/Log/Dispatch/Syslog.pm b/lib/Log/Dispatch/Syslog.pm
new file mode 100644
index 0000000..6084025
--- /dev/null
+++ b/lib/Log/Dispatch/Syslog.pm
@@ -0,0 +1,220 @@
+package Log::Dispatch::Syslog;
+
+use strict;
+use warnings;
+
+our $VERSION = '2.45';
+
+use Log::Dispatch::Output;
+
+use base qw( Log::Dispatch::Output );
+
+use Params::Validate qw(validate ARRAYREF BOOLEAN HASHREF SCALAR);
+Params::Validate::validation_options( allow_extra => 1 );
+
+use Scalar::Util qw( reftype );
+use Sys::Syslog 0.28 ();
+
+sub new {
+ my $proto = shift;
+ my $class = ref $proto || $proto;
+
+ my %p = @_;
+
+ my $self = bless {}, $class;
+
+ $self->_basic_init(%p);
+ $self->_init(%p);
+
+ return $self;
+}
+
+my ($Ident) = $0 =~ /(.+)/;
+
+sub _init {
+ my $self = shift;
+
+ my %p = validate(
+ @_, {
+ ident => {
+ type => SCALAR,
+ default => $Ident
+ },
+ logopt => {
+ type => SCALAR,
+ default => ''
+ },
+ facility => {
+ type => SCALAR,
+ default => 'user'
+ },
+ socket => {
+ type => SCALAR | ARRAYREF | HASHREF,
+ default => undef
+ },
+ lock => {
+ type => BOOLEAN,
+ default => 0,
+ },
+ }
+ );
+
+ $self->{$_} = $p{$_} for qw( ident logopt facility socket lock );
+ if ( $self->{lock} ) {
+ require threads;
+ require threads::shared;
+ }
+
+ $self->{priorities} = [
+ 'DEBUG',
+ 'INFO',
+ 'NOTICE',
+ 'WARNING',
+ 'ERR',
+ 'CRIT',
+ 'ALERT',
+ 'EMERG'
+ ];
+}
+
+my $thread_lock : shared = 0;
+
+sub log_message {
+ my $self = shift;
+ my %p = @_;
+
+ my $pri = $self->_level_as_number( $p{level} );
+
+ lock($thread_lock) if $self->{lock};
+
+ eval {
+ if ( defined $self->{socket} ) {
+ Sys::Syslog::setlogsock(
+ ref $self->{socket} && reftype( $self->{socket} ) eq 'ARRAY'
+ ? @{ $self->{socket} }
+ : $self->{socket}
+ );
+ }
+
+ Sys::Syslog::openlog(
+ $self->{ident},
+ $self->{logopt},
+ $self->{facility}
+ );
+ Sys::Syslog::syslog( $self->{priorities}[$pri], $p{message} );
+ Sys::Syslog::closelog;
+ };
+
+ warn $@ if $@ and $^W;
+}
+
+1;
+
+# ABSTRACT: Object for logging to system log.
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Log::Dispatch::Syslog - Object for logging to system log.
+
+=head1 VERSION
+
+version 2.45
+
+=head1 SYNOPSIS
+
+ use Log::Dispatch;
+
+ my $log = Log::Dispatch->new(
+ outputs => [
+ [
+ 'Syslog',
+ min_level => 'info',
+ ident => 'Yadda yadda'
+ ]
+ ]
+ );
+
+ $log->emerg("Time to die.");
+
+=head1 DESCRIPTION
+
+This module provides a simple object for sending messages to the
+system log (via UNIX syslog calls).
+
+Note that logging may fail if you try to pass UTF-8 characters in the
+log message. If logging fails and warnings are enabled, the error
+message will be output using Perl's C<warn>.
+
+=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 * ident ($)
+
+This string will be prepended to all messages in the system log.
+Defaults to $0.
+
+=item * logopt ($)
+
+A string containing the log options (separated by any separator you
+like). See the openlog(3) and Sys::Syslog docs for more details.
+Defaults to ''.
+
+=item * facility ($)
+
+Specifies what type of program is doing the logging to the system log.
+Valid options are 'auth', 'authpriv', 'cron', 'daemon', 'kern',
+'local0' through 'local7', 'mail, 'news', 'syslog', 'user',
+'uucp'. Defaults to 'user'
+
+=item * socket ($, \@, or \%)
+
+Tells what type of socket to use for sending syslog messages. Valid
+options are listed in C<Sys::Syslog>.
+
+If you don't provide this, then we let C<Sys::Syslog> simply pick one
+that works, which is the preferred option, as it makes your code more
+portable.
+
+If you pass an array reference, it is dereferenced and passed to
+C<Sys::Syslog::setlogsock()>.
+
+If you pass a hash reference, it is passed to C<Sys::Syslog::setlogsock()> as
+is.
+
+=item * lock ($)
+
+If this is set to a true value, then the calls to C<setlogsock()>,
+C<openlog()>, C<syslog()>, and C<closelog()> will all be guarded by a
+thread-locked variable.
+
+This is only relevant when running you are using Perl threads in your
+application. Setting this to a true value will cause the L<threads> and
+L<threads::shared> modules to be loaded.
+
+This defaults to false.
+
+=back
+
+=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