use Path::Class::File ();
use Time::HiRes qw/gettimeofday tv_interval/;
use URI ();
+use URI::http;
+use URI::https;
use Scalar::Util qw/weaken blessed/;
use Tree::Simple qw/use_weak_refs/;
use Tree::Simple::Visitor::FindByUID;
use attributes;
use utf8;
-use Carp qw/croak/;
+use Carp qw/croak carp/;
BEGIN { require 5.008001; }
__PACKAGE__->mk_classdata($_)
for qw/components arguments dispatcher engine log dispatcher_class
- engine_class context_class request_class response_class setup_finished/;
+ engine_class context_class request_class response_class stats_class
+ setup_finished/;
__PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
__PACKAGE__->engine_class('Catalyst::Engine::CGI');
__PACKAGE__->request_class('Catalyst::Request');
__PACKAGE__->response_class('Catalyst::Response');
+__PACKAGE__->stats_class('Catalyst::Stats');
# Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.7000';
+our $VERSION = '5.7013';
sub import {
my ( $class, @arguments ) = @_;
=head1 SYNOPSIS
+See the L<Catalyst::Manual> distribution for comprehensive
+documentation and tutorials.
+
# Install Catalyst::Devel for helpers and other development tools
# use the helper to create a new application
catalyst.pl MyApp
# add models, views, controllers
- script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
- script/myapp_create.pl view TT TT
+ script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
+ script/myapp_create.pl view MyTemplate TT
script/myapp_create.pl controller Search
# built in testserver -- use -r to restart automatically on changes
+ # --help to see all available options
script/myapp_server.pl
# command line testing interface
### in lib/MyApp.pm
use Catalyst qw/-Debug/; # include plugins here as well
- ### In lib/MyApp/Controller/Root.pm (autocreated)
+ ### In lib/MyApp/Controller/Root.pm (autocreated)
sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc.
my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
$c->stash->{template} = 'foo.tt'; # set the template
use Catalyst qw[-Home=/usr/mst];
+This can also be done in the shell environment by setting either the
+C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
+is replaced with the uppercased name of your application, any "::" in
+the name will be replaced with underscores, e.g. MyApp::Web should use
+MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
+
=head2 -Log
Specifies log level.
+=head2 -Stats
+
+Enables statistics collection and reporting. You can also force this setting
+from the system environment with CATALYST_STATS or <MYAPP>_STATS. The
+environment settings override the application, with <MYAPP>_STATS having the
+highest priority.
+
+e.g.
+
+ use Catalyst qw/-Stats=1/
+
=head1 METHODS
=head2 INFORMATION ABOUT THE CURRENT REQUEST
Forwards processing to another action, by its private name. If you give a
class name but no method, C<process()> is called. You may also optionally
pass arguments in an arrayref. The action will receive the arguments in
-C<@_> and C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
-C<$c-E<gt>req-E<gt>args> will be restored to the previous values.
+C<@_> and C<< $c->req->args >>. Upon returning from the function,
+C<< $c->req->args >> will be restored to the previous values.
Any data C<return>ed from the action forwarded to, will be returned by the
call to forward.
=head2 $c->detach( $class, $method, [, \@arguments ] )
+=head2 $c->detach()
+
The same as C<forward>, but doesn't return to the previous action when
processing is finished.
+When called with no arguments it escapes the processing chain entirely.
+
=cut
sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
=head2 $c->res
-Returns the current L<Catalyst::Response> object, q.v.
+Returns the current L<Catalyst::Response> object, see there for details.
=head2 $c->stash
$c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
# stash is automatically passed to the view for use in a template
- $c->forward( 'MyApp::V::TT' );
+ $c->forward( 'MyApp::View::TT' );
=cut
my $c = shift;
if (@_) {
my $stash = @_ > 1 ? {@_} : $_[0];
- croak('stash takes a hash or hashref') unless ref $stash;
+ croak('stash takes a hash or hashref') unless ref $stash;
foreach my $key ( keys %$stash ) {
$c->{stash}->{$key} = $stash->{$key};
}
Returns an arrayref containing error messages. If Catalyst encounters an
error while processing a request, it stores the error in $c->error. This
-method should not be used to store non-fatal error messages.
+method should only be used to store fatal error messages.
my @error = @{ $c->error };
$c->model('Foo')->do_stuff;
-If the name is omitted, it will look for a config setting 'default_model',
-or check if there is only one view, and return it if that's the case.
+Any extra arguments are directly passed to ACCEPT_CONTEXT.
+
+If the name is omitted, it will look for
+ - a model object in $c->stash{current_model_instance}, then
+ - a model name in $c->stash->{current_model}, then
+ - a config setting 'default_model', or
+ - check if there is only one model, and return it if that's the case.
=cut
return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
@args )
if $name;
- return $c->component( $c->config->{default_model} )
+ if (ref $c) {
+ return $c->stash->{current_model_instance}
+ if $c->stash->{current_model_instance};
+ return $c->model( $c->stash->{current_model} )
+ if $c->stash->{current_model};
+ }
+ return $c->model( $c->config->{default_model} )
if $c->config->{default_model};
- return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
+ return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
}
$c->view('Foo')->do_stuff;
-If the name is omitted, it will look for a config setting
-'default_view', or check if there is only one view, and forward to it if
-that's the case.
+Any extra arguments are directly passed to ACCEPT_CONTEXT.
+
+If the name is omitted, it will look for
+ - a view object in $c->stash{current_view_instance}, then
+ - a view name in $c->stash->{current_view}, then
+ - a config setting 'default_view', or
+ - check if there is only one view, and return it if that's the case.
=cut
return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
@args )
if $name;
- return $c->component( $c->config->{default_view} )
+ if (ref $c) {
+ return $c->stash->{current_view_instance}
+ if $c->stash->{current_view_instance};
+ return $c->view( $c->stash->{current_view} )
+ if $c->stash->{current_view};
+ }
+ return $c->view( $c->config->{default_view} )
if $c->config->{default_view};
return $c->_filter_component( $c->_comp_singular(qw/View V/) );
}
=head2 $c->component($name)
-Gets a component object by name. This method is no longer recommended,
+Gets a component object by name. This method is not recommended,
unless you want to get a specific component by full
-class. C<$c-E<gt>controller>, C<$c-E<gt>model>, and C<$c-E<gt>view>
+class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
should be used instead.
=cut
__PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
-You can also use a L<YAML> config file like myapp.yml in your
-applications home directory.
+You can also use a C<YAML>, C<XML> or C<Config::General> config file
+like myapp.yml in your applications home directory. See
+L<Catalyst::Plugin::ConfigLoader>.
---
db: dsn:SQLite:foo.db
=head2 $c->path_to(@path)
-Merges C<@path> with C<$c-E<gt>config-E<gt>{home}> and returns a
-L<Path::Class> object.
+Merges C<@path> with C<< $c->config->{home} >> and returns a
+L<Path::Class::Dir> object.
For example:
$class->setup_plugins( delete $flags->{plugins} );
$class->setup_dispatcher( delete $flags->{dispatcher} );
$class->setup_engine( delete $flags->{engine} );
+ $class->setup_stats( delete $flags->{stats} );
for my $flag ( sort keys %{$flags} ) {
or (this will not overwrite existing files):
catalyst.pl -scripts $class
+
EOF
}
if (@plugins) {
my $t = Text::SimpleTable->new(74);
$t->row($_) for @plugins;
- $class->log->debug( "Loaded plugins:\n" . $t->draw );
+ $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
}
my $dispatcher = $class->dispatcher;
my $type = ref $class->components->{$comp} ? 'instance' : 'class';
$t->row( $comp, $type );
}
- $class->log->debug( "Loaded components:\n" . $t->draw )
+ $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
if ( keys %{ $class->components } );
}
contain GET parameter key/value pairs, which will be appended to the URI
in standard fashion.
+Note that uri_for is destructive to the passed hashref. Subsequent calls
+with the same hashref may have unintended results.
+
Instead of C<$path>, you can also optionally pass a C<$action> object
which will be resolved to a path using
C<< $c->dispatcher->uri_for_action >>; if the first element of
sub uri_for {
my ( $c, $path, @args ) = @_;
- my $base = $c->request->base->clone;
- my $basepath = $base->path;
- $basepath =~ s/\/$//;
- $basepath .= '/';
- my $namespace = $c->namespace || '';
if ( Scalar::Util::blessed($path) ) { # action object
my $captures = ( scalar @args && ref $args[0] eq 'ARRAY'
: [] );
$path = $c->dispatcher->uri_for_action($path, $captures);
return undef unless defined($path);
+ $path = '/' if $path eq '';
}
- # massage namespace, empty if absolute path
- $namespace =~ s/^\/// if $namespace;
- $namespace .= '/' if $namespace;
- $path ||= '';
- $namespace = '' if $path =~ /^\//;
- $path =~ s/^\///;
+ undef($path) if (defined $path && $path eq '');
my $params =
( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
- for my $value ( values %$params ) {
- my $isa_ref = ref $value;
- if( $isa_ref and $isa_ref ne 'ARRAY' ) {
- croak( "Non-array reference ($isa_ref) passed to uri_for()" );
+ carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
+ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args;
+
+ unshift(@args, $path);
+
+ unless (defined $path && $path =~ s!^/!!) { # in-place strip
+ my $namespace = $c->namespace;
+ if (defined $path) { # cheesy hack to handle path '../foo'
+ $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
}
- utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
- };
+ unshift(@args, $namespace || '');
+ }
# join args with '/', or a blank string
- my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
- $args =~ s/^\/// unless $path;
- my $res =
- URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
- ->canonical;
- $res->query_form(%$params);
+ my $args = join('/', grep { defined($_) } @args);
+ $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
+ $args =~ s!^/!!;
+ my $base = $c->req->base;
+ my $class = ref($base);
+ $base =~ s{(?<!/)$}{/};
+
+ my $query = '';
+
+ if (my @keys = keys %$params) {
+ # somewhat lifted from URI::_query's query_form
+ $query = '?'.join('&', map {
+ s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
+ s/ /+/g;
+ my $key = $_;
+ my $val = $params->{$_};
+ $val = '' unless defined $val;
+ (map {
+ $_ = "$_";
+ utf8::encode( $_ ) if utf8::is_utf8($_);
+ # using the URI::Escape pattern here so utf8 chars survive
+ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
+ s/ /+/g;
+ "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
+ } @keys);
+ }
+
+ my $res = bless(\"${base}${args}${query}", $class);
$res;
}
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <meta http-equiv="Content-Language" content="en" />
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>$name on Catalyst $VERSION</title>
<style type="text/css">
body {
<p>
<img src="$logo" alt="Catalyst Logo" />
</p>
- <p>Welcome to the wonderful world of Catalyst.
+ <p>Welcome to the world of Catalyst.
This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
framework will make web development something you had
never expected it to be: Fun, rewarding, and quick.</p>
<p>That really depends on what <b>you</b> want to do.
We do, however, provide you with a few starting points.</p>
<p>If you want to jump right into web development with Catalyst
- you might want to check out the documentation.</p>
- <pre><code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
-perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
-perldoc <a href="http://cpansearch.perl.org/dist/Catalyst/lib/Catalyst/Manual.pod">Catalyst::Manual</a></code></pre>
+ you might want want to start with a tutorial.</p>
+<pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
+</pre>
+<p>Afterwards you can go on to check out a more complete look at our features.</p>
+<pre>
+<code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
+<!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
+</code></pre>
<h2>What to do next?</h2>
<p>Next it's time to write an actual application. Use the
helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
return $c->state;
}
- my $stats_info = $c->_stats_start_execute( $code ) if $c->debug;
+ my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
push( @{ $c->stack }, $code );
eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
- $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info;
+ $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
my $last = pop( @{ $c->stack } );
if ( my $error = $@ ) {
- if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
+ if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
else {
unless ( ref $error ) {
no warnings 'uninitialized';
}
}
- my $node = Tree::Simple->new(
- {
- action => $action,
- elapsed => undef, # to be filled in later
- comment => "",
- }
- );
- $node->setUID( "$code" . $c->counter->{"$code"} );
+ my $uid = "$code" . $c->counter->{"$code"};
# is this a root-level call or a forwarded call?
if ( $callsub =~ /forward$/ ) {
# forward, locate the caller
if ( my $parent = $c->stack->[-1] ) {
- my $visitor = Tree::Simple::Visitor::FindByUID->new;
- $visitor->searchForUID(
- "$parent" . $c->counter->{"$parent"} );
- $c->stats->accept($visitor);
- if ( my $result = $visitor->getResult ) {
- $result->addChild($node);
- }
+ $c->stats->profile(
+ begin => $action,
+ parent => "$parent" . $c->counter->{"$parent"},
+ uid => $uid,
+ );
}
else {
# forward with no caller may come from a plugin
- $c->stats->addChild($node);
+ $c->stats->profile(
+ begin => $action,
+ uid => $uid,
+ );
}
}
else {
-
+
# root-level call
- $c->stats->addChild($node);
+ $c->stats->profile(
+ begin => $action,
+ uid => $uid,
+ );
}
+ return $action;
- return {
- start => [gettimeofday],
- node => $node,
- };
}
sub _stats_finish_execute {
my ( $c, $info ) = @_;
- my $elapsed = tv_interval $info->{start};
- my $value = $info->{node}->getNodeValue;
- $value->{elapsed} = sprintf( '%fs', $elapsed );
+ $c->stats->profile( end => $info );
}
=head2 $c->_localize_fields( sub { }, \%keys );
$c->finalize_body;
}
+
+ if ($c->use_stats) {
+ my $elapsed = sprintf '%f', $c->stats->elapsed;
+ my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
+ $c->log->info(
+ "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
+ }
return $c->response->status;
}
if ( my $location = $c->response->redirect ) {
$c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
$c->response->header( Location => $location );
+
+ if ( !$c->response->body ) {
+ # Add a default body if none is already present
+ $c->response->body(
+ qq{<html><body><p>This item has moved <a href="$location">here</a>.</p></body></html>}
+ );
+ }
}
# Content-Length
# get the length from a filehandle
if ( blessed( $c->response->body ) && $c->response->body->can('read') )
{
- if ( my $stat = stat $c->response->body ) {
+ my $stat = stat $c->response->body;
+ if ( $stat && $stat->size > 0 ) {
$c->response->content_length( $stat->size );
}
else {
}
}
else {
+ # everything should be bytes at this point, but just in case
$c->response->content_length( bytes::length( $c->response->body ) );
}
}
my $status = -1;
eval {
if ($class->debug) {
- my $start = [gettimeofday];
- my $c = $class->prepare(@arguments);
- $c->stats(Tree::Simple->new);
- $c->dispatch;
- $status = $c->finalize;
-
- my $elapsed = tv_interval $start;
- $elapsed = sprintf '%f', $elapsed;
- my $av = sprintf '%.3f',
- ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
- my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
-
- $c->stats->traverse(
- sub {
- my $action = shift;
- my $stat = $action->getNodeValue;
- $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
- $stat->{elapsed} || '??' );
- }
- );
-
- $class->log->info(
- "Request took ${elapsed}s ($av/s)\n" . $t->draw );
- }
- else {
- my $c = $class->prepare(@arguments);
- $c->dispatch;
- $status = $c->finalize;
+ my $secs = time - $START || 1;
+ my $av = sprintf '%.3f', $COUNT / $secs;
+ my $time = localtime time;
+ $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
}
+
+ my $c = $class->prepare(@arguments);
+ $c->dispatch;
+ $status = $c->finalize;
};
if ( my $error = $@ ) {
}
);
- # For on-demand data
- $c->request->{_context} = $c;
- $c->response->{_context} = $c;
- weaken( $c->request->{_context} );
- weaken( $c->response->{_context} );
-
+ $c->stats($class->stats_class->new)->enable($c->use_stats);
if ( $c->debug ) {
- my $secs = time - $START || 1;
- my $av = sprintf '%.3f', $COUNT / $secs;
- my $time = localtime time;
- $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
- $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
+ $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
}
+ # For on-demand data
+ $c->request->_context($c);
+ $c->response->_context($c);
+
# Allow engine to direct the prepare flow (for POE)
if ( $c->engine->can('prepare') ) {
$c->engine->prepare( $c, @arguments );
$c->prepare_cookies;
$c->prepare_path;
- # On-demand parsing
- $c->prepare_body unless $c->config->{parse_on_demand};
+ # Prepare the body for reading, either by prepare_body
+ # or the user, if they are using $c->read
+ $c->prepare_read;
+
+ # Parse the body unless the user wants it on-demand
+ unless ( $c->config->{parse_on_demand} ) {
+ $c->prepare_body;
+ }
}
my $method = $c->req->method || '';
be used in a while loop, reading C<$maxlength> bytes on every call.
C<$maxlength> defaults to the size of the request if not specified.
-You have to set C<MyApp-E<gt>config-E<gt>{parse_on_demand}> to use this
+You have to set C<< MyApp->config->{parse_on_demand} >> to use this
directly.
+Warning: If you use read(), Catalyst will not process the body,
+so you will not be able to access POST parameters or file uploads via
+$c->request. You must handle all body parsing yourself.
+
=cut
sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
%$config
);
+
+ my @comps = sort { length $a <=> length $b } $locator->plugins;
+ my %comps = map { $_ => 1 } @comps;
- for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
+ for my $component ( @comps ) {
+
+ # We pass ignore_loaded here so that overlay files for (e.g.)
+ # Model::DBI::Schema sub-classes are loaded - if it's in @comps
+ # we know M::P::O found a file on disk so this is safe
+
Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
my $module = $class->setup_component( $component );
$component => $module,
map {
$_ => $class->setup_component( $_ )
+ } grep {
+ not exists $comps{$_}
} Devel::InnerPackage::list_packages( $component )
);
$dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
}
- if ( $ENV{CATALYST_DISPATCHER} ) {
- $dispatcher = 'Catalyst::Dispatcher::' . $ENV{CATALYST_DISPATCHER};
- }
-
- if ( $ENV{ uc($class) . '_DISPATCHER' } ) {
- $dispatcher =
- 'Catalyst::Dispatcher::' . $ENV{ uc($class) . '_DISPATCHER' };
+ if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
+ $dispatcher = 'Catalyst::Dispatcher::' . $env;
}
unless ($dispatcher) {
$engine = 'Catalyst::Engine::' . $engine;
}
- if ( $ENV{CATALYST_ENGINE} ) {
- $engine = 'Catalyst::Engine::' . $ENV{CATALYST_ENGINE};
- }
-
- if ( $ENV{ uc($class) . '_ENGINE' } ) {
- $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
+ if ( my $env = Catalyst::Utils::env_value( $class, 'ENGINE' ) ) {
+ $engine = 'Catalyst::Engine::' . $env;
}
if ( $ENV{MOD_PERL} ) {
sub setup_home {
my ( $class, $home ) = @_;
- if ( $ENV{CATALYST_HOME} ) {
- $home = $ENV{CATALYST_HOME};
- }
-
- if ( $ENV{ uc($class) . '_HOME' } ) {
- $home = $ENV{ uc($class) . '_HOME' };
+ if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
+ $home = $env;
}
unless ($home) {
$class->log( Catalyst::Log->new );
}
- my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG';
-
- if (
- ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) )
- ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} )
- : $debug
- )
- {
+ my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
+ if ( defined($env_debug) ? $env_debug : $debug ) {
no strict 'refs';
*{"$class\::debug"} = sub { 1 };
$class->log->debug('Debug messages enabled');
=cut
+=head2 $c->setup_stats
+
+Sets up timing statistics class.
+
+=cut
+
+sub setup_stats {
+ my ( $class, $stats ) = @_;
+
+ Catalyst::Utils::ensure_class_loaded($class->stats_class);
+
+ my $env = Catalyst::Utils::env_value( $class, 'STATS' );
+ if ( defined($env) ? $env : ($stats || $class->debug ) ) {
+ no strict 'refs';
+ *{"$class\::use_stats"} = sub { 1 };
+ $class->log->debug('Statistics enabled');
+ }
+}
+
+
=head2 $c->registered_plugins
Returns a sorted list of the plugins which have either been stated in the
my ( $proto, $plugin, $instant ) = @_;
my $class = ref $proto || $proto;
- unless (Class::Inspector->loaded($plugin)) {
- require Class::Inspector->filename($plugin);
- }
+ # no ignore_loaded here, the plugin may already have been
+ # defined in memory and we don't want to error on "no file" if so
+
+ Catalyst::Utils::ensure_class_loaded( $plugin );
$proto->_plugins->{$plugin} = 1;
unless ($instant) {
Returns an arrayref of the internal execution stack (actions that are
currently executing).
+=head2 $c->stats_class
+
+Returns or sets the stats (timing statistics) class.
+
+=head2 $c->use_stats
+
+Returns 1 when stats collection is enabled. Stats collection is enabled
+when the -Stats options is set, debug is on or when the <MYAPP>_STATS
+environment variable is set.
+
+Note that this is a static method, not an accessor and should be overloaded
+by declaring "sub use_stats { 1 }" in your MyApp.pm, not by calling $c->use_stats(1).
+
+=cut
+
+sub use_stats { 0 }
+
+
=head2 $c->write( $data )
Writes $data to the output stream. When using this method directly, you
=head1 ON-DEMAND PARSER
The request body is usually parsed at the beginning of a request,
-but if you want to handle input yourself or speed things up a bit,
-you can enable on-demand parsing with a config parameter.
+but if you want to handle input yourself, you can enable on-demand
+parsing with a config parameter.
MyApp->config->{parse_on_demand} = 1;
Sascha Kiefer
+Sebastian Willert
+
Tatsuhiko Miyagawa
Ulf Edvinsson
projects / catagits/Catalyst-Runtime.git / blobdiff