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=e1953b23e84c1b1cdd7ab044556701cbf0ef3f55;hp=d9d03b88db7b46a6078389f55e1a82885d9cbd71;hb=4090e3bb3fea1a73ac369250e31584d61428b808;hpb=2f9e6321fd866918db5602f6e0b4f5c6c6c1b9e9 diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index d9d03b8..e1953b2 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -1,16 +1,18 @@ package Catalyst::Log; -use strict; -use base 'Class::Accessor::Fast'; -use Data::Dumper; +use Moose; +use Data::Dump; our %LEVELS = (); -__PACKAGE__->mk_accessors('level'); +has level => (is => 'rw'); +has _body => (is => 'rw'); +has abort => (is => 'rw'); { my @levels = qw[ debug info warn error fatal ]; + my $meta = __PACKAGE__->meta; for ( my $i = 0 ; $i < @levels ; $i++ ) { my $name = $levels[$i]; @@ -18,29 +20,28 @@ __PACKAGE__->mk_accessors('level'); $LEVELS{$name} = $level; - no strict 'refs'; - - *{$name} = sub { + $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; - }; + return $self->level & $level; + });; } } -sub new { +around new => sub { + my $orig = shift; my $class = shift; - my $self = $class->SUPER::new; + my $self = $class->$orig; $self->levels( scalar(@_) ? @_ : keys %LEVELS ); return $self; -} +}; sub levels { my ( $self, @levels ) = @_; @@ -50,28 +51,56 @@ sub levels { sub enable { my ( $self, @levels ) = @_; - $self->{level} |= $_ for map { $LEVELS{$_} } @levels; + my $level = $self->level; + for(map { $LEVELS{$_} } @levels){ + $level |= $_; + } + $self->level($level); } sub disable { my ( $self, @levels ) = @_; - $self->{level} &= ~$_ for map { $LEVELS{$_} } @levels; + my $level = $self->level; + for(map { $LEVELS{$_} } @levels){ + $level &= ~$_; + } + $self->level($level); } 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__ @@ -98,89 +127,113 @@ 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. -=head1 LOG LEVELS +If you want to be able to log arbitrary warnings, you can do something along +the lines of -=over 4 + $SIG{__WARN__} = sub { MyApp->log->warn(@_); }; -=item debug +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); -=item info +=head2 info $log->is_info; $log->info($message); -=item warn +=head2 warn $log->is_warn; $log->warn($message); -=item error +=head2 error $log->is_error; $log->error($message); -=item fatal +=head2 fatal $log->is_fatal; $log->fatal($message); -=back - =head1 METHODS -=over 4 - -=item new +=head2 new -Constructor, defaults to enable all levels unless levels a provieded in +Constructor. Defaults to enable all levels unless levels are provided in arguments. $log = Catalyst::Log->new; - $log = Catalyst::Log->new( 'warn', 'error', 'fatal' ); + $log = Catalyst::Log->new( 'warn', 'error' ); -=item levels +=head2 level + +Contains a bitmask of the currently set log levels. + +=head2 levels Set log levels $log->levels( 'warn', 'error', 'fatal' ); -=item enable +=head2 enable Enable log levels $log->enable( 'warn', 'error' ); -=item disable +=head2 disable Disable log levels $log->disable( 'warn', 'error' ); -=item is_debug +=head2 is_debug -=item is_error +=head2 is_error -=item is_fatal +=head2 is_fatal -=item is_info +=head2 is_info -=item is_warn +=head2 is_warn Is the log level active? -=back +=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 @@ -199,4 +252,6 @@ it under the same terms as Perl itself. =cut +__PACKAGE__->meta->make_immutable; + 1;