X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=66b87070a10731a5376afd6c39699d71384738b7;hp=1240a44ac420af518f0dba00e054e3eb92281512;hb=ancona-trace;hpb=5bb2a5b3a3703b0eb12f6be0983e7f4676c55545 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm old mode 100644 new mode 100755 index 1240a44..66b8707 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -41,13 +41,19 @@ use Plack::Middleware::ReverseProxy; use Plack::Middleware::IIS6ScriptNameFix; use Plack::Middleware::IIS7KeepAliveFix; use Plack::Middleware::LighttpdScriptNameFix; +use Plack::Middleware::ContentLength; +use Plack::Middleware::Head; +use Plack::Middleware::HTTPExceptions; +use Plack::Middleware::FixMissingBodyInRedirect; +use Plack::Middleware::MethodOverride; +use Plack::Middleware::RemoveRedundantBody; +use Catalyst::Middleware::Stash; use Plack::Util; use Class::Load 'load_class'; BEGIN { require 5.008003; } has stack => (is => 'ro', default => sub { [] }); -has stash => (is => 'rw', default => sub { {} }); has state => (is => 'rw', default => 0); has stats => (is => 'rw'); has action => (is => 'rw'); @@ -111,7 +117,7 @@ __PACKAGE__->mk_classdata($_) for qw/components arguments dispatcher engine log dispatcher_class engine_loader context_class request_class response_class stats_class setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware - _data_handlers/; + _data_handlers trace_level trace_logger/; __PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); __PACKAGE__->request_class('Catalyst::Request'); @@ -120,7 +126,7 @@ __PACKAGE__->stats_class('Catalyst::Stats'); # Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.90053'; +our $VERSION = '5.90069_002'; sub import { my ( $class, @arguments ) = @_; @@ -490,21 +496,18 @@ Catalyst). =cut -around stash => sub { - my $orig = shift; - my $c = shift; - my $stash = $orig->($c); - if (@_) { - my $new_stash = @_ > 1 ? {@_} : $_[0]; - croak('stash takes a hash or hashref') unless ref $new_stash; - foreach my $key ( keys %$new_stash ) { - $stash->{$key} = $new_stash->{$key}; - } +sub stash { + my $c = shift; + my $stash = Catalyst::Middleware::Stash->get($c->req->env); + if(@_) { + my $new_stash = @_ > 1 ? {@_} : $_[0]; + croak('stash takes a hash or hashref') unless ref $new_stash; + foreach my $key ( keys %$new_stash ) { + $stash->{$key} = $new_stash->{$key}; } - - return $stash; -}; - + } + return $stash; +} =head2 $c->error @@ -558,6 +561,14 @@ sub clear_errors { $c->error(0); } +=head2 $c->has_errors + +Returns true if you have errors + +=cut + +sub has_errors { scalar(@{shift->error}) ? 1:0 } + sub _comp_search_prefixes { my $c = shift; return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_); @@ -1017,6 +1028,24 @@ The first three also set the log level to 'debug'. Calling C<< $c->debug(1) >> has no effect. +=head2 Effects of debug mode + +On older versions of L (prior to version 5.90070) debug mode would +enable verbose application level logging (for example when starting in debug +you get the startup information at the console regarding loaded models, +controllers, etc. as well as additional request / response tracing. +It would also enable the default debugging error page that gives you error +details and a stack track. + +On newer versions of L we have a new application tracing +system. See L for details. In general trace replaces +debug, although trace will honor debug if debug is set. However the +debug switch still controls whether or not you see the detailed +error default page or the 'production' error debug. This will at +some point be clarified. + +Setting debugging (as well as trace) will also enable stats collection. + =cut sub debug { 0 } @@ -1071,8 +1100,7 @@ sub plugin { } $class->$name($obj); - $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) - if $class->debug; + $class->trace(1, qq/Initialized instant plugin "$plugin" as "$name"/); } =head2 MyApp->setup @@ -1125,17 +1153,9 @@ sub setup { $class->setup_home( delete $flags->{home} ); $class->setup_log( delete $flags->{log} ); + $class->setup_trace(); $class->setup_plugins( delete $flags->{plugins} ); - # Call plugins setup, this is stupid and evil. - # Also screws C3 badly on 5.10, hack to avoid. - { - no warnings qw/redefine/; - local *setup = sub { }; - $class->setup unless $Catalyst::__AM_RESTARTING; - } - - $class->setup_middleware(); $class->setup_data_handlers(); $class->setup_dispatcher( delete $flags->{dispatcher} ); if (my $engine = delete $flags->{engine}) { @@ -1168,19 +1188,29 @@ You are running an old script! EOF } + # Call plugins setup, this is stupid and evil. + # Also screws C3 badly on 5.10, hack to avoid. + { + no warnings qw/redefine/; + local *setup = sub { }; + $class->setup unless $Catalyst::__AM_RESTARTING; + } + + $class->setup_middleware(); + # Initialize our data structure $class->components( {} ); $class->setup_components; - if ( $class->debug ) { + if ( $class->trace_level ) { my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins; if (@plugins) { my $column_width = Catalyst::Utils::term_width() - 6; my $t = Text::SimpleTable->new($column_width); $t->row($_) for @plugins; - $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" ); + $class->trace(1, "Loaded plugins:\n" . $t->draw . "\n" ); } my @middleware = map { @@ -1193,7 +1223,7 @@ EOF my $column_width = Catalyst::Utils::term_width() - 6; my $t = Text::SimpleTable->new($column_width); $t->row($_) for @middleware; - $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" ); + $class->trace(1, "Loaded PSGI Middleware:\n" . $t->draw . "\n" ); } my %dh = $class->registered_data_handlers; @@ -1201,21 +1231,21 @@ EOF my $column_width = Catalyst::Utils::term_width() - 6; my $t = Text::SimpleTable->new($column_width); $t->row($_) for @data_handlers; - $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" ); + $class->trace(1, "Loaded Request Data Handlers:\n" . $t->draw . "\n" ); } my $dispatcher = $class->dispatcher; my $engine = $class->engine; my $home = $class->config->{home}; - $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher))); - $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine))); + $class->trace(1, sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher))); + $class->trace(1, sprintf(q/Loaded engine "%s"/, blessed($engine))); $home ? ( -d $home ) - ? $class->log->debug(qq/Found home "$home"/) - : $class->log->debug(qq/Home "$home" doesn't exist/) - : $class->log->debug(q/Couldn't find home/); + ? $class->trace(1, qq/Found home "$home"/) + : $class->trace(1, qq/Home "$home" doesn't exist/) + : $class->trace(1, q/Couldn't find home/); my $column_width = Catalyst::Utils::term_width() - 8 - 9; my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] ); @@ -1223,7 +1253,7 @@ EOF my $type = ref $class->components->{$comp} ? 'instance' : 'class'; $t->row( $comp, $type ); } - $class->log->debug( "Loaded components:\n" . $t->draw . "\n" ) + $class->trace(1, "Loaded components:\n" . $t->draw . "\n" ) if ( keys %{ $class->components } ); } @@ -1234,21 +1264,22 @@ EOF $class->setup_actions; - if ( $class->debug ) { + if ( $class->trace_level ) { my $name = $class->config->{name} || 'Application'; - $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); + $class->trace(1, "$name powered by Catalyst $Catalyst::VERSION"); } if ($class->config->{case_sensitive}) { - $class->log->warn($class . "->config->{case_sensitive} is set."); - $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81."); + $class->trace(1,$class . "->config->{case_sensitive} is set."); + $class->trace(1,"This setting is deprecated and planned to be removed in Catalyst 5.81."); } $class->setup_finalize; - # Should be the last thing we do so that user things hooking - # setup_finalize can log.. + + # Flush the log for good measure (in case something turned off 'autoflush' early) $class->log->_flush() if $class->log->can('_flush'); - return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE. + + return $class || 1; # Just in case someone named their Application 0... } =head2 $app->setup_finalize @@ -1361,8 +1392,7 @@ sub uri_for { $path = $c->dispatcher->uri_for_action($action, $captures); if (not defined $path) { - $c->log->debug(qq/Can't find uri_for action '$action' @$captures/) - if $c->debug; + $c->trace(1, qq/Can't find uri_for action '$action' @$captures/); return undef; } $path = '/' if $path eq ''; @@ -1731,6 +1761,16 @@ sub execute { my $last = pop( @{ $c->stack } ); if ( my $error = $@ ) { + #rethow if this can be handled by middleware + if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) { + foreach my $err (@{$c->error}) { + $c->log->error($err); + } + $c->clear_errors; + $c->log->_flush if $c->log->can('_flush'); + + $error->can('rethrow') ? $error->rethrow : croak $error; + } if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) { $error->rethrow if $c->depth > 1; } @@ -1857,11 +1897,6 @@ sub finalize { $c->finalize_headers unless $c->response->finalized_headers; - # HEAD request - if ( $c->request->method eq 'HEAD' ) { - $c->response->body(''); - } - $c->finalize_body; } @@ -1895,11 +1930,31 @@ sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) } =head2 $c->finalize_error -Finalizes error. +Finalizes error. If there is only one error in L and it is an object that +does C or C we rethrow the error and presume it caught by middleware +up the ladder. Otherwise we return the debugging error page (in debug mode) or we +return the default error page (production mode). =cut -sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) } +sub finalize_error { + my $c = shift; + if($#{$c->error} > 0) { + $c->engine->finalize_error( $c, @_ ); + } else { + my ($error) = @{$c->error}; + if( + blessed $error && + ($error->can('as_psgi') || $error->can('code')) + ) { + # In the case where the error 'knows what it wants', becauses its PSGI + # aware, just rethow and let middleware catch it + $error->can('rethrow') ? $error->rethrow : croak $error; + } else { + $c->engine->finalize_error( $c, @_ ) + } + } +} =head2 $c->finalize_headers @@ -1917,52 +1972,12 @@ sub finalize_headers { # Handle redirects if ( my $location = $response->redirect ) { - $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; + $c->trace(1, qq/Redirecting to "$location"/); $response->header( Location => $location ); - - if ( !$response->has_body ) { - # Add a default body if none is already present - my $encoded_location = encode_entities($location); - $response->body(<<"EOF"); - - - - Moved - - -

This item has moved here.

- - -EOF - $response->content_type('text/html; charset=utf-8'); - } } - # Content-Length - if ( defined $response->body && length $response->body && !$response->content_length ) { - - # get the length from a filehandle - if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' ) - { - my $size = -s $response->body; - if ( $size ) { - $response->content_length( $size ); - } - else { - $c->log->warn('Serving filehandle without a content-length'); - } - } - else { - # everything should be bytes at this point, but just in case - $response->content_length( length( $response->body ) ); - } - } - - # Errors - if ( $response->status =~ /^(1\d\d|[23]04)$/ ) { - $response->headers->remove_header("Content-Length"); - $response->body(''); - } + # Remove incorrectly added body and content related meta data when returning + # an information response, or a response the is required to not include a body $c->finalize_cookies; @@ -2021,18 +2036,21 @@ sub handle_request { # Always expect worst case! my $status = -1; try { - if ($class->debug) { + if ($class->trace_level) { my $secs = time - $START || 1; my $av = sprintf '%.3f', $COUNT / $secs; my $time = localtime time; - $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***"); + $class->trace(1, "*** Request $COUNT ($av/s) [$$] [$time] ***"); } my $c = $class->prepare(@arguments); $c->dispatch; $status = $c->finalize; - } - catch { + } catch { + #rethow if this can be handled by middleware + if(blessed $_ && ($_->can('as_psgi') || $_->can('code'))) { + $_->can('rethrow') ? $_->rethrow : croak $_; + } chomp(my $error = $_); $class->log->error(qq/Caught exception in engine "$error"/); }; @@ -2072,6 +2090,8 @@ sub prepare { #surely this is not the most efficient way to do things... $c->stats($class->stats_class->new)->enable($c->use_stats); + # We'll leave this use of debug since somehow this setting will move + # to middleware - jnap if ( $c->debug || $c->config->{enable_catalyst_header} ) { $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); } @@ -2179,9 +2199,7 @@ Prepares connection. sub prepare_connection { my $c = shift; - # XXX - This is called on the engine (not the request) to maintain - # Engine::PSGI back compat. - $c->engine->prepare_connection($c); + $c->request->prepare_connection($c); } =head2 $c->prepare_cookies @@ -2250,12 +2268,15 @@ Writes information about the request to the debug logs. This includes: =back +Starting in Catalyst 5.90070, debug logs are handled by the new trace +feature. See L. + =cut sub log_request { my $c = shift; - return unless $c->debug; + return unless $c->trace_level; my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these; my $request = $dump->[1]; @@ -2264,12 +2285,12 @@ sub log_request { $method ||= ''; $path = '/' unless length $path; $address ||= ''; - $c->log->debug(qq/"$method" request for "$path" from "$address"/); + $c->trace(1, qq/"$method" request for "$path" from "$address"/); $c->log_request_headers($request->headers); if ( my $keywords = $request->query_keywords ) { - $c->log->debug("Query keywords are: $keywords"); + $c->trace(1, "Query keywords are: $keywords"); } $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () ); @@ -2287,7 +2308,7 @@ C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>. sub log_response { my $c = shift; - return unless $c->debug; + return unless $c->trace_level; my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these; my $response = $dump->[1]; @@ -2315,7 +2336,7 @@ Writes one line of information about the response to the debug logs. This inclu sub log_response_status_line { my ($c, $response) = @_; - $c->log->debug( + $c->trace(1, sprintf( 'Response Code: %s; Content-Type: %s; Content-Length: %s', $response->status || 'unknown', @@ -2344,7 +2365,7 @@ sub log_request_parameters { my $c = shift; my %all_params = @_; - return unless $c->debug; + return unless $c->trace_level; my $column_width = Catalyst::Utils::term_width() - 44; foreach my $type (qw(query body)) { @@ -2356,7 +2377,7 @@ sub log_request_parameters { my $value = defined($param) ? $param : ''; $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); } - $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw ); + $c->trace(1, ucfirst($type) . " Parameters are:\n" . $t->draw ); } } @@ -2371,7 +2392,7 @@ the debug logs. sub log_request_uploads { my $c = shift; my $request = shift; - return unless $c->debug; + return unless $c->trace_level; my $uploads = $request->uploads; if ( keys %$uploads ) { my $t = Text::SimpleTable->new( @@ -2386,7 +2407,7 @@ sub log_request_uploads { $t->row( $key, $u->filename, $u->type, $u->size ); } } - $c->log->debug( "File Uploads are:\n" . $t->draw ); + $c->trace(1, "File Uploads are:\n" . $t->draw ); } } @@ -2410,7 +2431,7 @@ sub log_headers { my $type = shift; my $headers = shift; # an HTTP::Headers instance - return unless $c->debug; + return unless $c->trace_level; my $column_width = Catalyst::Utils::term_width() - 28; my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] ); @@ -2420,7 +2441,7 @@ sub log_headers { $t->row( $name, $value ); } ); - $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw ); + $c->trace(1, ucfirst($type) . " Headers:\n" . $t->draw ); } @@ -2603,18 +2624,15 @@ sub locate_components { my $class = shift; my $config = shift; - my @paths = qw( ::Controller ::C ::Model ::M ::View ::V ); + my @paths = qw( ::M ::Model ::V ::View ::C ::Controller ); my $extra = delete $config->{ search_extra } || []; - push @paths, @$extra; - - my $locator = Module::Pluggable::Object->new( - search_path => [ map { s/^(?=::)/$class/; $_; } @paths ], - %$config - ); + unshift @paths, @$extra; - # XXX think about ditching this sort entirely - my @comps = sort { length $a <=> length $b } $locator->plugins; + my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new( + search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ], + %$config + )->plugins } @paths; return @comps; } @@ -2902,6 +2920,85 @@ sub psgi_app { return $app->Catalyst::Utils::apply_registered_middleware($psgi); } + +=head2 trace_level + +Class attribute which is a positive number and defines the noiseness of the +application trace. This attribute is defined at application startup, trying +to change it in a running app is considered an error. See L. + +=head2 trace_logger + +Class attribute which is a handler for reporting your traces. See L. + +=head2 $c->setup_trace + +Examples your %ENV, configuation and application settings to setup how and if +application tracing is enabled. See L. + +=head2 $c->trace + +Accepts a string $message and level for a trace message. The configured +trace level must equal or exceed the level given. Level is required and should +be a positive integer. For more see L. + +=cut + +sub setup_trace { + my ($app, @args) = @_; + + # first we look for %ENV + if(my $trace = Catalyst::Utils::env_value( $app, 'TRACE' )) { + # extract a file path if it exists; + my ($level,$op, $path) = ($trace=~m/^(.+)(\=|\+\=)(.+)$/); + if($level && $op && $path) { + open(my $fh, '>', $path) + ||die "Cannot open trace file at $path: $!"; + $app->trace_logger($fh); + $app->trace_level($level); + } else { + $app->trace_level($trace); + } + } + + # Next, we look at config + $app->trace_level($app->config->{trace_level}) unless defined($app->trace_level); + $app->trace_logger($app->config->{trace_logger}) unless defined($app->trace_logger); + + # We do setup_trace AFTER setup_log, so this stuff should be all good to + # use by this point in application setup. For BackCompat, we will try to + # respect ->debug + + if($app->debug) { + $app->trace_level(1) unless defined($app->trace_level); + $app->trace_logger(sub { shift->log->debug }) unless defined($app->trace_logger); + $app->trace(1, 'Debug messages enabled (via Debug state)'); + } + + # Last, we set defaults if the settings are still emtpy + # Setup the defaults + + $app->trace_level(0) unless defined($app->trace_level); + $app->trace_logger(sub { shift->log->debug }) unless defined($app->trace_logger); + + $app->trace(1, "Tracing enabled at level ${\$app->trace_level}") + if defined($app->trace_level); + + return; +} + +sub trace { + my ($class, $level, $message) = @_; + die "Level is required" unless defined $level; + die "Message is required" unless defined $message; + return unless $class->trace_level; + if($class->trace_level >= $level) { + ref($class->trace_logger) eq 'CODE' ? + $class->trace_logger->($class, $message, $level) : + $class->trace_logger->print($message); + } +} + =head2 $c->setup_home Sets up the home directory. @@ -2960,7 +3057,6 @@ sub setup_log { if ( $levels{debug} ) { Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 }); - $class->log->debug('Debug messages enabled'); } } @@ -2982,9 +3078,11 @@ sub setup_stats { Catalyst::Utils::ensure_class_loaded($class->stats_class); my $env = Catalyst::Utils::env_value( $class, 'STATS' ); - if ( defined($env) ? $env : ($stats || $class->debug ) ) { + # Will grandfather using debug to turn on stats since there's a complicated + # order of events here when trace mode tries to guess its state from debug. + if ( defined($env) ? $env : ($stats || $class->trace_level || $class->debug ) ) { Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 }); - $class->log->debug('Statistics enabled'); + $class->trace(1,'Statistics enabled'); } } @@ -3117,12 +3215,24 @@ which sounds odd but is likely how you expect it to work if you have prior experience with L or if you previously used the plugin L (which is now considered deprecated) +So basically your middleware handles an incoming request from the first +registered middleware, down and handles the response from the last middleware +up. + =cut sub registered_middlewares { my $class = shift; if(my $middleware = $class->_psgi_middleware) { - return @$middleware; + return ( + Catalyst::Middleware::Stash->new, + Plack::Middleware::HTTPExceptions->new, + Plack::Middleware::RemoveRedundantBody->new, + Plack::Middleware::FixMissingBodyInRedirect->new, + Plack::Middleware::ContentLength->new, + Plack::Middleware::MethodOverride->new, + Plack::Middleware::Head->new, + @$middleware); } else { die "You cannot call ->registered_middlewares until middleware has been setup"; } @@ -3131,7 +3241,7 @@ sub registered_middlewares { sub setup_middleware { my $class = shift; my @middleware_definitions = @_ ? - @_ : reverse(@{$class->config->{'psgi_middleware'}||[]}); + reverse(@_) : reverse(@{$class->config->{'psgi_middleware'}||[]}); my @middleware = (); while(my $next = shift(@middleware_definitions)) { @@ -3197,7 +3307,8 @@ sub registered_data_handlers { if(my $data_handlers = $class->_data_handlers) { return %$data_handlers; } else { - die "You cannot call ->registered_data_handlers until data_handers has been setup"; + $class->setup_data_handlers; + return $class->registered_data_handlers; } } @@ -3436,14 +3547,44 @@ backwardly compatible). =item * -C - See L. +C - See L. =item * -C - See L. +C - See L. + +=item * + +trace_level - This sets your application trace level - See L. + +=item * + +trace_logger - This sets your application trace logger - See L. =back +=head1 EXCEPTIONS + +Generally when you throw an exception inside an Action (or somewhere in +your stack, such as in a model that an Action is calling) that exception +is caught by Catalyst and unless you either catch it yourself (via eval +or something like L or by reviewing the L stack, it +will eventually reach L and return either the debugging +error stack page, or the default error page. However, if your exception +can be caught by L, L will +instead rethrow it so that it can be handled by that middleware (which +is part of the default middleware). For example this would allow + + use HTTP::Throwable::Factory 'http_throw'; + + sub throws_exception :Local { + my ($self, $c) = @_; + + http_throw(SeeOther => { location => + $c->uri_for($self->action_for('redirect')) }); + + } + =head1 INTERNAL ACTIONS Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>, @@ -3564,7 +3705,7 @@ example given above, which uses L to provide either L it installed (if you want the faster XS parser, add it to you project Makefile.PL or dist.ini, cpanfile, etc.) -The C configuation is a hashref whose keys are HTTP Content-Types +The C configuration is a hashref whose keys are HTTP Content-Types (matched against the incoming request type using a regexp such as to be case insensitive) and whose values are coderefs that receive a localized version of C<$_> which is a filehandle object pointing to received body. @@ -3612,6 +3753,23 @@ So the general form is: Where C<@middleware> is one or more of the following, applied in the REVERSE of the order listed (to make it function similarly to L: + +Alternatively, you may also define middleware by calling the L +package method: + + package MyApp::Web; + + use Catalyst; + + __PACKAGE__->setup_middleware( \@middleware_definitions); + __PACKAGE__->setup; + +In the case where you do both (use 'setup_middleware' and configuration) the +package call to setup_middleware will be applied earlier (in other words its +middleware will wrap closer to the application). Keep this in mind since in +some cases the order of middleware is important. + +The two approaches are not exclusive. =over 4 @@ -3698,6 +3856,164 @@ to initialize the middleware object. Please see L for more on middleware. +=head1 TRACING + +B Tracing replaces the functionality of L. For now both +interfaces will be supported but it is suggested that you become familiar with +the new interface and begin using it. + +Application tracing is debugging information about the state of your L +application and a request / response cycle. This is often used when you want a +peek into the 'Catalyst Black Box' without needing to actually hack into the +core code and add debugging statements. Examples of application tracing include +startup information about loaded plugins, middleware, models, controllers and +views. It also includes details about how a request is dispatched (what actions +in what controllers are hit, and approximately how long each took) and how a +response is generated. Additional trace information includes details about errors +and some basic statistics on your running application. + +It is often the case when running an application in a development environment +for development purposes that you will enable tracing to assist you in your work. +However, application tracing is not strictly tied to environment so trace levels +are not automatically enabled based on any environment settings (although you are +allowed to set trace levels via configuration, which can be environment specific, +if you choose so). + +Application tracing is also not the same thing as logging. Logging is custom messages +that you've added to your custom application for the purposes of better understanding +your application and how effective your application is in achieving its goals. +Often logging is extended, unstructured meta data around your core business logic +such as details about when a user account is created or failed to be created, what +types of validation issues are occuring in your forms, page views, user engagement +and timestamps to help you understand your application performance. Basically this +is often information of business value that doesn't cleanly or meaningfully fit +into a database. Catalyst provides an interface for adding various kinds of +Loggers which can assist you in these tasks. Most Loggers allow one to log +messages at different levels of priority, such as debug, warning, critical, etc. +This is a useful feature since it permits one to turn the logging level down in +high traffic environments. In the past Catalyst tracing (previously called +'Debug') was conflated with log levels of debug, in that in order to enable +application tracing (or debugging) one was required to turn log level debug on +globally. Additionally, the Catalyst application tracing (or debugging) used +the defined logger to 'record' its messages. Neither is ideal since it leads +one to be forced to accept more logging than may be wished, and it also does +not allow one to separate development tracing from application debug logging. + +Application tracing fixes this issues by allowing you to turn on tracing +independently of setting your log level. It also lets you define a trace +log message handler separately from your logger. So for example you might +wish to send trace messages to STDOUT, but send your logging to Elasticsearch. +Here's an example: + + package MyApp; + + use Catalyst; + + __PACKAGE__->trace_level(1); + __PACKAGE__->trace_logger(sub { my $class = shift; ...}); + __PACKAGE__->setup; + +You may also configure tracing via configuration: + + package MyApp; + + use Catalyst; + + __PACKAGE__->config({ + trace_level => 1, + trace_logger => sub { my $class = shift; ...}, + }); + + __PACKAGE__->setup; + +B You cannot set tracing via configuration files if you are using +the L plugin, as that plugin is loaded too +late for it to be applied during all phases of setup. + +Or, you may set tracing via environment varables, for example: + + CATALYST_TRACE=1 perl script/myapp_server.pl + MYAPP_TRACE=1 perl script/myapp_server.pl + MYAPP_TRACE=1=/var/log/traces perl script/myapp_server.pl + +The order of precidence is that custom application environment variables +('MYAPP_TRACE') come first, followed by global environment variables +('CATALYST_TRACE'), followed by configuration settings and lastly application +defaults. + +For backwards compatiblity, we respect classic Catalyst debugging (L) in +the following way. If debugging is true, we automatically set +C and set the C to your the debug method of your +defined log object (basically it works just as described in L). In this +case $c->debug will also be set to true. + +Please note that if you set C but not debugging then debugging +($c->debug) will NOT be set to true. + +Please note that if you set BOTH trace_level and 'class' debugging, your trace +level and trace configuation is respected at a high priority, however the state +of the debug method will be set as requested (although overridden). This is +done for backcompatibility with applications that overloaded the debug method +in custom applications. + +Please note that when setting trace levels via environment, you may use an +extended form of the value, which opens a filehandled to a specified path +and sends all trace information there: + + MYAPP_TRACE=1=/var/log/traces perl script/myapp_server.pl + +This would override any other settings for L<\trace_logger>. I + +=head2 trace_level + +This is a number that defaults to 0. It indicates the level of application +tracing that is desired. Larger numbers indicate greater level of tracing. +Currently trace levels are defined, although at this time respect is limited, +as this is a new feature. + +Levels 1,2 and 3 are reserved for Catalyst core code (code that is part of the +L distribution). + +Levels 4,5 and 6 are reserved for Catalyst extended ecosystem (Catalyst plugins, +models, views and distributions under the CatalystX namespace). + +Levels 7,8 and 9 are reserved but not currently defined. + +Levels 10 and higher are reserved for local (not on CPAN) application use. + +=head2 trace_logger + +This handles a trace message, if it is determined that one should be sent based +on the running L<\trace_level>. This can accept the following values + +=over 4 + +=item a CodeRef + +This is a code reference that gets the application class (your Catalyst.pm +subclass) as argument0, the message as argument1 and the level as argument3. +The message is expected to be a string. For example: + + __PACKAGE__->trace_logger( sub { + my ($app, $message, $level) = @_; + $app->log->debug($message); + }); + +Would send trace messages to the debug log handler (This is currently the +default behavior). + +=item A Filehandle or Object + +This must be an open filehandle setup to received output. We really +just look for a 'print' method, so strictly speaking this could be +any object that satisfies the duck type. + +=item A String + +A path that be be resolved as a file that we open a filehandle to. + +=back + =head1 ENCODING On request, decodes all params from encoding into a sequence of @@ -3912,6 +4228,8 @@ t0m: Tomas Doran Ulf Edvinsson +vanstyn: Henry Van Styn + Viljo Marrandi C Will Hawes C @@ -3926,9 +4244,11 @@ rainboxx: Matthias Dietrich, C dd070: Dhaval Dhanani +Upasana + =head1 COPYRIGHT -Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS. +Copyright (c) 2005-2014, the above named PROJECT FOUNDER and CONTRIBUTORS. =head1 LICENSE