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=56f4ff4272d7ee8879bb49b520b14289be78a48e;hp=1bd646a6cc69f4a6a63261f7353c8d7f0ba39f9f;hb=74dafab798a163c251e09de7fcc21a267d1678a6;hpb=f4dbb0d955dfe912f33c9c41a964a2c7921d5dda diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index 1bd646a..56f4ff4 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -4,16 +4,24 @@ use strict; use base 'Class::Accessor::Fast'; use Data::Dumper; -our @levels = qw[ debug info warn error fatal ]; +our %LEVELS = (); + +__PACKAGE__->mk_accessors('level'); +__PACKAGE__->mk_accessors('body'); +__PACKAGE__->mk_accessors('abort'); { - no strict 'refs'; + 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; @@ -24,23 +32,35 @@ our @levels = qw[ debug info warn error fatal ]; *{"is_$name"} = sub { my $self = shift; - - if (@_) { - if ( $_[0] ) { - $self->{level} |= $level; - } - else { - $self->{level} &= ~$level; - } - } return $self->{level} & $level; }; } +} - *new = sub { bless( { level => ( 1 << @levels ) - 1 }, shift ) } +sub new { + my $class = shift; + my $self = $class->SUPER::new; + $self->levels( scalar(@_) ? @_ : keys %LEVELS ); + return $self; } -sub _dump { +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; local $Data::Dumper::Terse = 1; $self->info( Dumper( $_[0] ) ); @@ -51,7 +71,18 @@ sub _log { my $level = shift; my $time = localtime(time); my $message = join( "\n", @_ ); - printf( STDERR "[%s] [catalyst] [%s] %s\n", $time, $level, $message ); + $self->{body} .= sprintf( "[%s] [catalyst] [%s] %s\n", + $time, $level, $message ) ; +} + +sub _flush { + my $self = shift; + if ( $self->abort || ! $self->body ) { + $self->abort(undef); + } else { + print( STDERR $self->body); + } + $self->body(undef); } 1; @@ -70,53 +101,112 @@ Catalyst::Log - Catalyst Log Class $log->warn($message); $log->error($message); $log->fatal($message); - - $log->is_debug; # true if debug messages is enabled - $log->is_info; # true if info messages is enabled - $log->is_warn; # true if warn messages is enabled - $log->is_error; # true if error messages is enabled - $log->is_fatal; # true if fatal messages is enabled if ( $log->is_debug ) { # expensive debugging } + See L. =head1 DESCRIPTION -This module provides the default, simple logging functionality for +This module provides the default, simple logging functionality for Catalyst. -If you want something different set C<$c->log> in your application +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. +=head1 LOG LEVELS + +=over 4 + +=item debug + + $log->is_debug; + $log->debug($message); + +=item info + + $log->is_info; + $log->info($message); + +=item warn + + $log->is_warn; + $log->warn($message); + +=item error + + $log->is_error; + $log->error($message); + +=item fatal + + $log->is_fatal; + $log->fatal($message); + +=back =head1 METHODS =over 4 -=item $log->debug($message) +=item new + +Constructor. Defaults to enable all levels unless levels are provided in +arguments. + + $log = Catalyst::Log->new; + $log = Catalyst::Log->new( 'warn', 'error' ); + +=item levels -Logs a debugging message. +Set log levels -=item $log->error($message) + $log->levels( 'warn', 'error', 'fatal' ); -Logs an error message. +=item enable -=item $log->info($message) +Enable log levels -Logs an informational message. + $log->enable( 'warn', 'error' ); -=item $log->warn($message) +=item disable -Logs a warning message. +Disable log levels + + $log->disable( 'warn', 'error' ); + +=item is_debug + +=item is_error + +=item is_fatal + +=item is_info + +=item is_warn + +Is the log level active? + +=item 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'); =back + + =head1 SEE ALSO L. @@ -125,10 +215,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