- Fixes for rt.cpan #17322 and #17331

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Log.pm

diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm
index e1cbca9..de7a447 100644 (file)
--- 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,26 +32,38 @@ 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] ) );
+    $self->info( Dumper( @_ ) );
 }
 
 sub _log {
@@ -51,7 +71,24 @@ 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 {
+        $self->_send_to_log( $self->body );
+    }
+    $self->body(undef);
+}
+
+sub _send_to_log {
+    my $self = shift;
+    print STDERR @_;
 }
 
 1;
@@ -70,52 +107,108 @@ Catalyst::Log - Catalyst Log Class
     $log->warn($message);
     $log->error($message);
     $log->fatal($message);
-    
-    $log->is_debug;   # true if dubug 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_info ) {
+
+    if ( $log->is_debug ) {
          # expensive debugging
     }
 
+
 See L<Catalyst>.
 
 =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.
 
+=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 levels
+
+Set log levels
+
+    $log->levels( 'warn', 'error', 'fatal' );
+
+=head2 enable
+
+Enable log levels
+
+    $log->enable( 'warn', 'error' );
+
+=head2 disable
+
+Disable log levels
+
+    $log->disable( 'warn', 'error' );
+
+=head2 is_debug
+
+=head2 is_error
+
+=head2 is_fatal
+
+=head2 is_info
 
-=item $log->debug($message)
+=head2 is_warn
 
-Logs a debugging message.
+Is the log level active?
 
-=item $log->error($message)
+=head2 abort
 
-Logs an error message.
+Should Catalyst emit logs for this request? Will be reset at the end of 
+each request. 
 
-=item $log->info($message)
+*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:
 
-Logs an informational message.
+    $c->log->abort(1) if $c->log->can('abort');
 
-=item $log->warn($message)
+=head2 _send_to_log
 
-Logs a warning message.
+ $log->_send_to_log( @messages );
 
-=back
+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
 
@@ -125,10 +218,11 @@ L<Catalyst>.
 
 Sebastian Riedel, C<sri@cpan.org>
 Marcus Ramberg, C<mramberg@cpan.org>
+Christian Hansen, C<ch@ngmedia.com>
 
 =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