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=7ae9f0720fb48bc70da0fb0424620b622709c440;hb=74dafab798a163c251e09de7fcc21a267d1678a6;hpb=fc7ec1d96ee55d1bf42af3abce155ecb717b9e2b diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index 7ae9f07..56f4ff4 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -2,6 +2,92 @@ package Catalyst::Log; use strict; use base 'Class::Accessor::Fast'; +use Data::Dumper; + +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; + local $Data::Dumper::Terse = 1; + $self->info( Dumper( $_[0] ) ); +} + +sub _log { + my $self = shift; + my $level = shift; + my $time = localtime(time); + my $message = join( "\n", @_ ); + $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; + +__END__ =head1 NAME @@ -9,49 +95,117 @@ Catalyst::Log - Catalyst Log Class =head1 SYNOPSIS + $log = $c->log; + $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 -Simple logging functionality for Catalyst. +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.: -=head2 METHODS + $c->log( MyLogger->new ); -=head3 debug +Your logging object is expected to provide the interface described here. -Log debug informations. +=head1 LOG LEVELS -=cut +=over 4 -sub debug { _format( 'debug', $_[1] ) } +=item debug -=head3 error + $log->is_debug; + $log->debug($message); -Log error informations. +=item info -=cut + $log->is_info; + $log->info($message); -sub error { _format( 'error', $_[1] ) } +=item warn -=head3 info + $log->is_warn; + $log->warn($message); -Log informations. +=item error -=cut + $log->is_error; + $log->error($message); -sub info { _format( 'info', $_[1] ) } +=item fatal -=head3 warn + $log->is_fatal; + $log->fatal($message); -Log warnings. +=back -=cut +=head1 METHODS + +=over 4 + +=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 + +Set log levels + + $log->levels( 'warn', 'error', 'fatal' ); + +=item enable + +Enable log levels + + $log->enable( 'warn', 'error' ); + +=item disable + +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 -sub warn { _format( 'warn', $_[1] ) } -sub _format { - print STDERR '[' . localtime(time) . "] [catalyst] [$_[0]] $_[1]\n"; -} =head1 SEE ALSO @@ -60,11 +214,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