X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FLog.pm;h=616a67833f1681ffceef516d04451e3171fe4a55;hb=d4f67841aca20946ee3e6e32609a22d633d961e9;hp=6bb131a98eee3ff026eac3bd0cbd0775b1b7b621;hpb=c9afa5fc4ed6c36afe6653d7d8fbb9909994c1a8;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index 6bb131a..616a678 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -2,9 +2,95 @@ package Catalyst::Log; use strict; use base 'Class::Accessor::Fast'; -use Data::Dumper; +use Data::Dump; -$Data::Dumper::Terse = 1; +our %LEVELS = (); + +__PACKAGE__->mk_accessors('level'); +__PACKAGE__->mk_accessors('body'); +__PACKAGE__->mk_accessors('abort'); + +{ + my @levels = qw[ debug info warn error fatal ]; + + for ( my $i = 0 ; $i < @levels ; $i++ ) { + + my $name = $levels[$i]; + my $level = 1 << $i; + + $LEVELS{$name} = $level; + + no strict 'refs'; + + *{$name} = sub { + my $self = shift; + + if ( $self->{level} & $level ) { + $self->_log( $name, @_ ); + } + }; + + *{"is_$name"} = sub { + my $self = shift; + return $self->{level} & $level; + }; + } +} + +sub new { + my $class = shift; + my $self = $class->SUPER::new; + $self->levels( scalar(@_) ? @_ : keys %LEVELS ); + return $self; +} + +sub levels { + my ( $self, @levels ) = @_; + $self->level(0); + $self->enable(@levels); +} + +sub enable { + my ( $self, @levels ) = @_; + $self->{level} |= $_ for map { $LEVELS{$_} } @levels; +} + +sub disable { + my ( $self, @levels ) = @_; + $self->{level} &= ~$_ for map { $LEVELS{$_} } @levels; +} + +sub _dump { + my $self = shift; + $self->info( Data::Dump::dump(@_) ); +} + +sub _log { + my $self = shift; + my $level = shift; + my $message = join( "\n", @_ ); + $self->{body} .= sprintf( "[%s] %s\n", $level, $message ); +} + +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 @_; +} + +1; + +__END__ =head1 NAME @@ -13,82 +99,122 @@ 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.: +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 -=head1 METHODS + $SIG{__WARN__} = sub { MyApp->log->warn(@_); }; -=over 4 +however this is (a) global, (b) hairy and (c) may have unexpected side effects. +Don't say we didn't warn you. -=item $log->debug(@message) +=head1 LOG LEVELS -Logs a debugging message. +=head2 debug -=cut + $log->is_debug; + $log->debug($message); -sub debug { shift->_format( 'debug', @_ ) } +=head2 info -=item $log->error(@message) + $log->is_info; + $log->info($message); -Logs an error message. +=head2 warn -=cut + $log->is_warn; + $log->warn($message); -sub error { shift->_format( 'error', @_ ) } +=head2 error -=item $log->info(@message) + $log->is_error; + $log->error($message); -Logs an informational message. +=head2 fatal -=cut + $log->is_fatal; + $log->fatal($message); -sub info { shift->_format( 'info', @_ ) } +=head1 METHODS -=item $log->warn(@message) +=head2 new -Logs a warning message. +Constructor. Defaults to enable all levels unless levels are provided in +arguments. -=cut + $log = Catalyst::Log->new; + $log = Catalyst::Log->new( 'warn', 'error' ); -sub warn { shift->_format( 'warn', @_ ) } +=head2 levels -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 ); -} +Set log levels -=back + $log->levels( 'warn', 'error', 'fatal' ); -=head1 DEPRECATED METHODS +=head2 enable -=over 4 +Enable log levels -=item $log->dump($reference) + $log->enable( 'warn', 'error' ); -Logs a Data::Dumper of reference. +=head2 disable -=cut +Disable log levels + + $log->disable( 'warn', 'error' ); + +=head2 is_debug + +=head2 is_error + +=head2 is_fatal + +=head2 is_info + +=head2 is_warn + +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: + + $c->log->abort(1) if $c->log->can('abort'); + +=head2 _send_to_log -sub dump { shift->_format( 'dump', Dumper( $_[1] ) ) } + $log->_send_to_log( @messages ); -=back +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. =head1 SEE ALSO @@ -97,11 +223,13 @@ L. =head1 AUTHOR Sebastian Riedel, C +Marcus Ramberg, C +Christian Hansen, C =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under -the same terms as Perl itself. +This program is free software, you can redistribute it and/or modify +it under the same terms as Perl itself. =cut