package Catalyst::Log;
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose;
+use Data::Dump;
+
+our %LEVELS = ();
+
+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];
+ my $level = 1 << $i;
+
+ $LEVELS{$name} = $level;
+
+ $meta->add_method($name, sub {
+ my $self = shift;
+
+ if ( $self->level & $level ) {
+ $self->_log( $name, @_ );
+ }
+ });
+
+ $meta->add_method("is_$name", sub {
+ my $self = shift;
+ 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);
+}
+
+sub disable {
+ my ( $self, @levels ) = @_;
+ my $level = $self->level;
+ for(map { $LEVELS{$_} } @levels){
+ $level &= ~$_;
+ }
+ $self->level($level);
+}
+
+sub _dump {
+ my $self = shift;
+ $self->info( Data::Dump::dump(@_) );
+}
+
+sub _log {
+ my $self = shift;
+ my $level = shift;
+ my $message = join( "\n", @_ );
+ $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__
=head1 NAME
=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<Catalyst>.
=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.
+Good alternatives to consider are Log::Log4Perl and Log::Dispatch.
-Log debug informations.
+If you want to be able to log arbitrary warnings, you can do something along
+the lines of
-=cut
+ $SIG{__WARN__} = sub { MyApp->log->warn(@_); };
-sub debug { _format( 'debug', $_[1] ) }
+however this is (a) global, (b) hairy and (c) may have unexpected side effects.
+Don't say we didn't warn you.
-=head3 error
+=head1 LOG LEVELS
-Log error informations.
+=head2 debug
-=cut
+ $log->is_debug;
+ $log->debug($message);
-sub error { _format( 'error', $_[1] ) }
+=head2 info
-=head3 info
+ $log->is_info;
+ $log->info($message);
-Log informations.
+=head2 warn
-=cut
+ $log->is_warn;
+ $log->warn($message);
-sub info { _format( 'info', $_[1] ) }
+=head2 error
-=head3 warn
+ $log->is_error;
+ $log->error($message);
-Log warnings.
+=head2 fatal
-=cut
+ $log->is_fatal;
+ $log->fatal($message);
-sub warn { _format( 'warn', $_[1] ) }
+=head1 METHODS
-sub _format {
- print STDERR '[' . localtime(time) . "] [catalyst] [$_[0]] $_[1]\n";
-}
+=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
+
+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
+
+=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
=head1 AUTHOR
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 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
+__PACKAGE__->meta->make_immutable;
+
1;
projects / catagits/Catalyst-Runtime.git / blobdiff