X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FLog.pm;h=b035d893914f8b89977a4db102926256a5ebe0be;hp=f2a6aee5aca243690f171ce3cdfb80804257eee0;hb=d0cacee71a316290bc01f0e12681c16bdc1e84e2;hpb=61b1e958102e2371a79e07a7e2cdbb371797d202 diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index f2a6aee..b035d89 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -1,10 +1,139 @@ package Catalyst::Log; -use strict; -use base 'Class::Accessor::Fast'; -use Data::Dumper; +use Moose; +with 'MooseX::Emulate::Class::Accessor::Fast'; -$Data::Dumper::Terse = 1; +use Data::Dump; +use Class::MOP (); +use Carp qw/ cluck /; + +our %LEVELS = (); # Levels stored as bit field, ergo debug = 1, warn = 2 etc +our %LEVEL_MATCH = (); # Stored as additive, thus debug = 31, warn = 30 etc + +has level => (is => 'rw'); +has _body => (is => 'rw'); +has abort => (is => 'rw'); + +{ + my @levels = qw[ debug info warn error fatal ]; + + my $meta = Class::MOP::get_metaclass_by_name(__PACKAGE__); + my $summed_level = 0; + for ( my $i = $#levels ; $i >= 0 ; $i-- ) { + + my $name = $levels[$i]; + + my $level = 1 << $i; + $summed_level |= $level; + + $LEVELS{$name} = $level; + $LEVEL_MATCH{$name} = $summed_level; + + $meta->add_method($name, sub { + my $self = shift; + + if ( $self->level & $level ) { + $self->_log( $name, @_ ); + } + }); + + $meta->add_method("is_$name", sub { + my $self = shift; + return $self->level & $level; + });; + } +} + +around new => sub { + my $orig = shift; + my $class = shift; + my $self = $class->$orig; + + $self->levels( scalar(@_) ? @_ : keys %LEVELS ); + + return $self; +}; + +sub levels { + my ( $self, @levels ) = @_; + $self->level(0); + $self->enable(@levels); +} + +sub enable { + my ( $self, @levels ) = @_; + my $level = $self->level; + for(map { $LEVEL_MATCH{$_} } @levels){ + $level |= $_; + } + $self->level($level); +} + +sub disable { + my ( $self, @levels ) = @_; + my $level = $self->level; + for(map { $LEVELS{$_} } @levels){ + $level &= ~$_; + } + $self->level($level); +} + +our $HAS_DUMPED; +sub _dump { + my $self = shift; + unless ($HAS_DUMPED++) { + cluck("Catalyst::Log::_dump is deprecated and will be removed. Please change to using your own Dumper.\n"); + } + $self->info( Data::Dump::dump(@_) ); +} + +sub _log { + my $self = shift; + my $level = shift; + my $message = join( "\n", @_ ); + $message .= "\n" unless $message =~ /\n$/; + my $body = $self->_body; + $body .= sprintf( "[%s] %s", $level, $message ); + $self->_body($body); +} + +sub _flush { + my $self = shift; + if ( $self->abort || !$self->_body ) { + $self->abort(undef); + } + else { + $self->_send_to_log( $self->_body ); + } + $self->_body(undef); +} + +sub _send_to_log { + my $self = shift; + print STDERR @_; +} + +# 5.7 compat code. +# Alias _body to body, add a before modifier to warn.. +my $meta = __PACKAGE__->meta; # Calling meta method here fine as we happen at compile time. +$meta->add_method('body', $meta->get_method('_body')); +my %package_hash; # Only warn once per method, per package. + # I haven't provided a way to disable them, patches welcome. +$meta->add_before_method_modifier('body', sub { + my $class = blessed(shift); + $package_hash{$class}++ || do { + warn("Class $class is calling the deprecated method Catalyst::Log->body method,\n" + . "this will be removed in Catalyst 5.81"); + }; +}); +# End 5.70 backwards compatibility hacks. + +no Moose; +__PACKAGE__->meta->make_immutable(inline_constructor => 0); + +1; + +__END__ =head1 NAME @@ -13,91 +142,144 @@ Catalyst::Log - Catalyst Log Class =head1 SYNOPSIS $log = $c->log; - $log->debug(@message); - $log->error(@message); - $log->info(@message); - $log->warn(@message); + $log->debug($message); + $log->info($message); + $log->warn($message); + $log->error($message); + $log->fatal($message); + + if ( $log->is_debug ) { + # expensive debugging + } + See L. =head1 DESCRIPTION -This module provides the default, simple logging functionality for -Catalyst. -If you want something different set C<$c->log> in your application -module, e.g.: +This module provides the default, simple logging functionality for Catalyst. +If you want something different set C<< $c->log >> in your application module, +e.g.: $c->log( MyLogger->new ); Your logging object is expected to provide the interface described here. +Good alternatives to consider are Log::Log4Perl and Log::Dispatch. + +If you want to be able to log arbitrary warnings, you can do something along +the lines of + + $SIG{__WARN__} = sub { MyApp->log->warn(@_); }; + +however this is (a) global, (b) hairy and (c) may have unexpected side effects. +Don't say we didn't warn you. + +=head1 LOG LEVELS + +=head2 debug + + $log->is_debug; + $log->debug($message); + +=head2 info + + $log->is_info; + $log->info($message); + +=head2 warn + + $log->is_warn; + $log->warn($message); + +=head2 error + + $log->is_error; + $log->error($message); +=head2 fatal + + $log->is_fatal; + $log->fatal($message); =head1 METHODS -=over 4 +=head2 new -=item $log->debug(@message) +Constructor. Defaults to enable all levels unless levels are provided in +arguments. -Logs a debugging message. + $log = Catalyst::Log->new; + $log = Catalyst::Log->new( 'warn', 'error' ); -=cut +=head2 level -sub debug { shift->_format( 'debug', @_ ) } +Contains a bitmask of the currently set log levels. -=item $log->error(@message) +=head2 levels -Logs an error message. +Set log levels -=cut + $log->levels( 'warn', 'error', 'fatal' ); -sub error { shift->_format( 'error', @_ ) } +=head2 enable -=item $log->info(@message) +Enable log levels -Logs an informational message. + $log->enable( 'warn', 'error' ); -=cut +=head2 disable -sub info { shift->_format( 'info', @_ ) } +Disable log levels -=item $log->warn(@message) + $log->disable( 'warn', 'error' ); -Logs a warning message. +=head2 is_debug -=cut +=head2 is_error -sub warn { shift->_format( 'warn', @_ ) } +=head2 is_fatal -sub _format { - my $class = shift; - my $level = shift; - my $time = localtime(time); - my $message = join( "\n", @_ ); - printf( STDERR "[%s] [catalyst] [%s] %s\n", $time, $level, $message ); -} +=head2 is_info -=back +=head2 is_warn -=cut +Is the log level active? + +=head2 abort + +Should Catalyst emit logs for this request? Will be reset at the end of +each request. + +*NOTE* This method is not compatible with other log apis, so if you plan +to use Log4Perl or another logger, you should call it like this: -# Private - Logs a Data::Dumper of reference. -sub _dump { shift->_format( 'dump', Dumper( $_[0] ) ) } + $c->log->abort(1) if $c->log->can('abort'); +=head2 _send_to_log + + $log->_send_to_log( @messages ); + +This protected method is what actually sends the log information to STDERR. +You may subclass this module and override this method to get finer control +over the log output. + +=head2 meta =head1 SEE ALSO L. -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C -Marcus Ramberg, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut +__PACKAGE__->meta->make_immutable; + 1;