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=7a69d039b3f66bbc94aebb90e38c9c178daddc77;hp=1bd646a6cc69f4a6a63261f7353c8d7f0ba39f9f;hb=2f3812528068bc1d9f7840067f0c03d36cd47e6d;hpb=f4dbb0d955dfe912f33c9c41a964a2c7921d5dda diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index 1bd646a..7a69d03 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -1,59 +1,106 @@ package Catalyst::Log; -use strict; -use base 'Class::Accessor::Fast'; -use Data::Dumper; +use Moose; +use Data::Dump; -our @levels = qw[ debug info warn error fatal ]; +our %LEVELS = (); + +has level => (is => 'rw'); +has _body => (is => 'rw'); +has abort => (is => 'rw'); { - no strict 'refs'; + my @levels = qw[ debug info warn error fatal ]; + my $meta = __PACKAGE__->meta; for ( my $i = 0 ; $i < @levels ; $i++ ) { my $name = $levels[$i]; my $level = 1 << $i; - *{$name} = sub { + $LEVELS{$name} = $level; + + $meta->add_method($name, sub { my $self = shift; - if ( $self->{level} & $level ) { + if ( $self->level & $level ) { $self->_log( $name, @_ ); } - }; + }); - *{"is_$name"} = sub { + $meta->add_method("is_$name", sub { my $self = shift; + return $self->level & $level; + });; + } +} - if (@_) { - if ( $_[0] ) { - $self->{level} |= $level; - } - else { - $self->{level} &= ~$level; - } - } - 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 { $LEVELS{$_} } @levels){ + $level |= $_; } + $self->level($level); +} - *new = sub { bless( { level => ( 1 << @levels ) - 1 }, shift ) } +sub disable { + my ( $self, @levels ) = @_; + my $level = $self->level; + for(map { $LEVELS{$_} } @levels){ + $level &= ~$_; + } + $self->level($level); } -sub _dump { +sub _dump { my $self = shift; - local $Data::Dumper::Terse = 1; - $self->info( Dumper( $_[0] ) ); + $self->info( Data::Dump::dump(@_) ); } sub _log { my $self = shift; my $level = shift; - my $time = localtime(time); my $message = join( "\n", @_ ); - printf( STDERR "[%s] [catalyst] [%s] %s\n", $time, $level, $message ); + $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 @_; +} + +no Moose; +__PACKAGE__->meta->make_immutable(); + 1; __END__ @@ -70,67 +117,139 @@ 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 -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 + +Constructor. Defaults to enable all levels unless levels are provided in +arguments. + + $log = Catalyst::Log->new; + $log = Catalyst::Log->new( 'warn', 'error' ); + +=head2 level + +Contains a bitmask of the currently set log levels. + +=head2 levels -=item $log->debug($message) +Set log levels -Logs a debugging message. + $log->levels( 'warn', 'error', 'fatal' ); -=item $log->error($message) +=head2 enable -Logs an error message. +Enable log levels -=item $log->info($message) + $log->enable( 'warn', 'error' ); -Logs an informational message. +=head2 disable -=item $log->warn($message) +Disable log levels -Logs a warning message. + $log->disable( 'warn', 'error' ); -=back +=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 + + $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 program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut +__PACKAGE__->meta->make_immutable; + 1;