with 'MooseX::Emulate::Class::Accessor::Fast';
use Data::Dump;
-use Class::MOP ();
+use Moose::Util 'find_meta';
use Carp qw/ cluck /;
our %LEVELS = (); # Levels stored as bit field, ergo debug = 1, warn = 2 etc
has level => (is => 'rw');
has _body => (is => 'rw');
has abort => (is => 'rw');
-has psgi_logger => (is => 'rw', predicate => 'has_psgi_logger', clearer => '_clear_psgi_logger');
-has psgi_errors => (is => 'rw', predicate => 'has_psgi_errors', clearer => '_clear_psgi_errors');
+has autoflush => (is => 'rw', default => sub {1});
+has _psgi_logger => (is => 'rw', predicate => '_has_psgi_logger', clearer => '_clear_psgi_logger');
+has _psgi_errors => (is => 'rw', predicate => '_has_psgi_errors', clearer => '_clear_psgi_errors');
sub clear_psgi {
my $self = shift;
sub psgienv {
my ($self, $env) = @_;
- $self->psgi_logger($env->{'psgix.logger'}) if $env->{'psgix.logger'};
- $self->psgi_errors($env->{'psgi.errors'}) if $env->{'psgi.errors'};
+ $self->_psgi_logger($env->{'psgix.logger'}) if $env->{'psgix.logger'};
+ $self->_psgi_errors($env->{'psgi.errors'}) if $env->{'psgi.errors'};
}
{
my @levels = qw[ debug info warn error fatal ];
- my $meta = Class::MOP::get_metaclass_by_name(__PACKAGE__);
+ my $meta = find_meta(__PACKAGE__);
my $summed_level = 0;
for ( my $i = $#levels ; $i >= 0 ; $i-- ) {
my $self = shift;
my $level = shift;
my $message = join( "\n", @_ );
- if ($self->can('has_psgi_logger') and $self->has_psgi_logger) {
- $self->psgi_logger->({
+ if ($self->can('_has_psgi_logger') and $self->_has_psgi_logger) {
+ $self->_psgi_logger->({
level => $level,
message => $message,
});
$body .= sprintf( "[%s] %s", $level, $message );
$self->_body($body);
}
+ if( $self->autoflush && !$self->abort ) {
+ $self->_flush;
+ }
+ return 1;
}
sub _flush {
sub _send_to_log {
my $self = shift;
- if ($self->can('has_psgi_errors') and $self->has_psgi_errors) {
- $self->psgi_errors->print(@_);
+ if ($self->can('_has_psgi_errors') and $self->_has_psgi_errors) {
+ $self->_psgi_errors->print(@_);
} else {
+ binmode STDERR, ":utf8";
print STDERR @_;
}
}
__END__
+=for stopwords psgienv
+
=head1 NAME
Catalyst::Log - Catalyst Log Class
$c->log->abort(1) if $c->log->can('abort');
+=head2 autoflush
+
+When enabled (default), messages are written to the log immediately instead
+of queued until the end of the request.
+
+This option, as well as C<abort>, is provided for modules such as
+L<Catalyst::Plugin::Static::Simple> to be able to programmatically
+suppress the output of log messages. By turning off C<autoflush> (application-wide
+setting) and then setting the C<abort> flag within a given request, all log
+messages for the given request will be suppressed. C<abort> can still be set
+independently of turning off C<autoflush>, however. It just means any messages
+sent to the log up until that point in the request will obviously still be emitted,
+since C<autoflush> means they are written in real-time.
+
+If you need to turn off autoflush you should do it like this (in your main app
+class):
+
+ after setup_finalize => sub {
+ my $c = shift;
+ $c->log->autoflush(0) if $c->log->can('autoflush');
+ };
+
=head2 _send_to_log
$log->_send_to_log( @messages );
You may subclass this module and override this method to get finer control
over the log output.
+=head2 psgienv $env
+
+ $log->psgienv($env);
+
+NOTE: This is not meant for public consumption.
+
+Set the PSGI environment for this request. This ensures logs will be sent to
+the right place. If the environment has a C<psgix.logger>, it will be used. If
+not, we will send logs to C<psgi.errors> if that exists. As a last fallback, we
+will send to STDERR as before.
+
+=head2 clear_psgi
+
+Clears the PSGI environment attributes set by L</psgienv>.
+
=head2 meta
=head1 SEE ALSO