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=822ea32b0312676c207ae0bd9e1f2c1dbe45c538;hp=f2a6aee5aca243690f171ce3cdfb80804257eee0;hb=e8b9f2a92084b3b9dab6b2b879900481b8548b3b;hpb=61b1e958102e2371a79e07a7e2cdbb371797d202 diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index f2a6aee..822ea32 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -2,9 +2,96 @@ 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", @_ ); + $message .= "\n" unless $message =~ /\n$/; + $self->{body} .= sprintf( "[%s] %s", $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,76 +100,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.: +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 levels -sub debug { shift->_format( 'debug', @_ ) } +Set log levels -=item $log->error(@message) + $log->levels( 'warn', 'error', 'fatal' ); -Logs an error message. +=head2 enable -=cut +Enable log levels -sub error { shift->_format( 'error', @_ ) } + $log->enable( 'warn', 'error' ); -=item $log->info(@message) +=head2 disable -Logs an informational message. +Disable log levels -=cut + $log->disable( 'warn', 'error' ); -sub info { shift->_format( 'info', @_ ) } +=head2 is_debug -=item $log->warn(@message) +=head2 is_error -Logs a warning message. +=head2 is_fatal -=cut +=head2 is_info -sub warn { shift->_format( 'warn', @_ ) } +=head2 is_warn -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 ); -} +Is the log level active? -=back +=head2 abort -=cut +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 -# Private - Logs a Data::Dumper of reference. -sub _dump { shift->_format( 'dump', Dumper( $_[0] ) ) } + $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. =head1 SEE ALSO @@ -92,10 +225,11 @@ L. Sebastian Riedel, C Marcus Ramberg, C +Christian Hansen, C =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify +This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut