X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=203f1c44a8053cb198e4062603fd82363f3748de;hp=d2235de8c3440bc7c55a5415d40b271b55fdc7c2;hb=1627551a60fe1e220d390a565f793dea27cd36a6;hpb=94a6e0e40e4507a79c747bd41cbf9bfecdd58914
diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index d2235de..203f1c4 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -1,7 +1,7 @@
package Catalyst;
use strict;
-use base 'Catalyst::Base';
+use base 'Catalyst::Component';
use bytes;
use UNIVERSAL::require;
use Catalyst::Exception;
@@ -10,12 +10,16 @@ use Catalyst::Request;
use Catalyst::Request::Upload;
use Catalyst::Response;
use Catalyst::Utils;
+use Catalyst::Controller;
+use File::stat;
use NEXT;
use Text::SimpleTable;
use Path::Class;
use Time::HiRes qw/gettimeofday tv_interval/;
use URI;
-use Scalar::Util qw/weaken/;
+use Scalar::Util qw/weaken blessed/;
+use Tree::Simple qw/use_weak_refs/;
+use Tree::Simple::Visitor::FindByUID;
use attributes;
__PACKAGE__->mk_accessors(
@@ -43,18 +47,18 @@ our $DETACH = "catalyst_detach\n";
require Module::Pluggable::Fast;
# Helper script generation
-our $CATALYST_SCRIPT_GEN = 14;
+our $CATALYST_SCRIPT_GEN = 27;
__PACKAGE__->mk_classdata($_)
for qw/components arguments dispatcher engine log dispatcher_class
- engine_class context_class request_class response_class/;
+ engine_class context_class request_class response_class setup_finished/;
__PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
__PACKAGE__->engine_class('Catalyst::Engine::CGI');
__PACKAGE__->request_class('Catalyst::Request');
__PACKAGE__->response_class('Catalyst::Response');
-our $VERSION = '5.57';
+our $VERSION = '5.66';
sub import {
my ( $class, @arguments ) = @_;
@@ -67,7 +71,7 @@ sub import {
unless ( $caller->isa('Catalyst') ) {
no strict 'refs';
- push @{"$caller\::ISA"}, $class;
+ push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
}
$caller->arguments( [@arguments] );
@@ -174,6 +178,14 @@ C.
use Catalyst qw/My::Module/;
+If your plugin starts with a name other than C, you can
+fully qualify the name by using a unary plus:
+
+ use Catalyst qw/
+ My::Module
+ +Fully::Qualified::Plugin::Name
+ /;
+
Special flags like C<-Debug> and C<-Engine> can also be specified as
arguments when Catalyst is loaded:
@@ -184,43 +196,37 @@ they are loaded in exactly the order in which they appear.
The following flags are supported:
-=over 4
-
-=item -Debug
+=head2 -Debug
Enables debug output.
-=item -Engine
+=head2 -Engine
Forces Catalyst to use a specific engine. Omit the
C prefix of the engine name, i.e.:
use Catalyst qw/-Engine=CGI/;
-=item -Home
+=head2 -Home
Forces Catalyst to use a specific home directory, e.g.:
use Catalyst qw[-Home=/usr/sri];
-=item -Log
+=head2 -Log
Specifies log level.
-=back
-
=head1 METHODS
=head2 Information about the current request
-=over 4
-
-=item $c->action
+=head2 $c->action
Returns a L object for the current action, which
stringifies to the action name. See L.
-=item $c->namespace
+=head2 $c->namespace
Returns the namespace of the current action, i.e., the uri prefix
corresponding to the controller of the current action. For example:
@@ -228,22 +234,18 @@ corresponding to the controller of the current action. For example:
# in Controller::Foo::Bar
$c->namespace; # returns 'foo/bar';
-=item $c->request
+=head2 $c->request
-=item $c->req
+=head2 $c->req
Returns the current L object. See
L.
-=back
-
=head2 Processing and response to the current request
-=over 4
-
-=item $c->forward( $action [, \@arguments ] )
+=head2 $c->forward( $action [, \@arguments ] )
-=item $c->forward( $class, $method, [, \@arguments ] )
+=head2 $c->forward( $class, $method, [, \@arguments ] )
Forwards processing to a private action. If you give a class name but no
method, C is called. You may also optionally pass arguments
@@ -251,7 +253,10 @@ in an arrayref. The action will receive the arguments in C<@_> and
C<$c-Ereq-Eargs>. Upon returning from the function,
C<$c-Ereq-Eargs> will be restored to the previous values.
- $c->forward('/foo');
+Any data Ced from the action forwarded to, will be returned by the
+call to forward.
+
+ my $foodata = $c->forward('/foo');
$c->forward('index');
$c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
$c->forward('MyApp::View::TT');
@@ -260,9 +265,9 @@ C<$c-Ereq-Eargs> will be restored to the previous values.
sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
-=item $c->detach( $action [, \@arguments ] )
+=head2 $c->detach( $action [, \@arguments ] )
-=item $c->detach( $class, $method, [, \@arguments ] )
+=head2 $c->detach( $class, $method, [, \@arguments ] )
The same as C, but doesn't return.
@@ -270,13 +275,15 @@ The same as C, but doesn't return.
sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
-=item $c->error
+=head2 $c->error
-=item $c->error($error, ...)
+=head2 $c->error($error, ...)
-=item $c->error($arrayref)
+=head2 $c->error($arrayref)
-Returns an arrayref containing error messages.
+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.
my @error = @{ $c->error };
@@ -284,7 +291,8 @@ Add a new error.
$c->error('Something bad happened');
-Clear errors.
+Clear errors. You probably don't want to clear the errors unless you are
+implementing a custom error screen.
$c->error(0);
@@ -300,13 +308,13 @@ sub error {
return $c->{error} || [];
}
-=item $c->response
+=head2 $c->response
-=item $c->res
+=head2 $c->res
Returns the current L object.
-=item $c->stash
+=head2 $c->stash
Returns a hashref to the stash, which may be used to store data and pass
it between components during a request. You can also set hash keys by
@@ -334,19 +342,68 @@ sub stash {
return $c->{stash};
}
-=item $c->state
+=head2 $c->state
Contains the return value of the last executed action.
-=back
+=cut
-=head2 Component Accessors
+# search via regex
+sub _comp_search {
+ my ($c, @names) = @_;
-=over 4
+ foreach my $name (@names) {
+ foreach my $component ( keys %{ $c->components } ) {
+ my $comp = $c->components->{$component} if $component =~ /$name/i;
+ if ($comp) {
+ if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
+ return $comp->ACCEPT_CONTEXT($c);
+ }
+ else { return $comp }
+ }
+ }
+ }
-=item $c->comp($name)
+ return undef;
+}
-=item $c->component($name)
+# try explicit component names
+sub _comp_explicit {
+ my ($c, @names) = @_;
+
+ foreach my $try (@names) {
+ if ( exists $c->components->{$try} ) {
+ my $comp = $c->components->{$try};
+ if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
+ return $comp->ACCEPT_CONTEXT($c);
+ }
+ else { return $comp }
+ }
+ }
+
+ return undef;
+}
+
+# like component, but try just these prefixes before regex searching,
+# and do not try to return "sort keys %{ $c->components }"
+sub _comp_prefixes {
+ my ($c, $name, @prefixes) = @_;
+
+ my $appclass = ref $c || $c;
+
+ my @names = map { "${appclass}::${_}::${name}" } @prefixes;
+
+ my $comp = $c->_comp_explicit(@names);
+ return $comp if defined($comp);
+ $comp = $c->_comp_search($name);
+ return $comp;
+}
+
+=head2 Component Accessors
+
+=head2 $c->comp($name)
+
+=head2 $c->component($name)
Gets a component object by name. This method is no longer recommended,
unless you want to get a specific component by full
@@ -370,25 +427,17 @@ sub component {
qw/Model M Controller C View V/
);
- foreach my $try (@names) {
-
- if ( exists $c->components->{$try} ) {
-
- return $c->components->{$try};
- }
- }
-
- foreach my $component ( keys %{ $c->components } ) {
-
- return $c->components->{$component} if $component =~ /$name/i;
- }
+ my $comp = $c->_comp_explicit(@names);
+ return $comp if defined($comp);
+ $comp = $c->_comp_search($name);
+ return $comp if defined($comp);
}
return sort keys %{ $c->components };
}
-=item $c->controller($name)
+=head2 $c->controller($name)
Gets a L instance by name.
@@ -398,12 +447,10 @@ Gets a L instance by name.
sub controller {
my ( $c, $name ) = @_;
- my $controller = $c->comp("Controller::$name");
- return $controller if $controller;
- return $c->comp("C::$name");
+ return $c->_comp_prefixes($name, qw/Controller C/);
}
-=item $c->model($name)
+=head2 $c->model($name)
Gets a L instance by name.
@@ -413,12 +460,10 @@ Gets a L instance by name.
sub model {
my ( $c, $name ) = @_;
- my $model = $c->comp("Model::$name");
- return $model if $model;
- return $c->comp("M::$name");
+ return $c->_comp_prefixes($name, qw/Model M/);
}
-=item $c->view($name)
+=head2 $c->view($name)
Gets a L instance by name.
@@ -428,24 +473,35 @@ Gets a L instance by name.
sub view {
my ( $c, $name ) = @_;
- my $view = $c->comp("View::$name");
- return $view if $view;
- return $c->comp("V::$name");
+ return $c->_comp_prefixes($name, qw/View V/);
}
-=back
-
=head2 Class data and helper classes
-=over 4
-
-=item $c->config
+=head2 $c->config
Returns or takes a hashref containing the application's configuration.
- __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' });
+ __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
+
+You can also use a L config file like myapp.yml in your
+applications home directory.
+
+ ---
+ db: dsn:SQLite:foo.db
+
+=cut
+
+sub config {
+ my $c = shift;
+
+ $c->log->warn("Setting config after setup has been run is not a good idea.")
+ if ( @_ and $c->setup_finished );
+
+ $c->NEXT::config(@_);
+}
-=item $c->debug
+=head2 $c->debug
Overload to enable debug messages (same as -Debug option).
@@ -453,22 +509,28 @@ Overload to enable debug messages (same as -Debug option).
sub debug { 0 }
-=item $c->dispatcher
+=head2 $c->dispatcher
Returns the dispatcher instance. Stringifies to class name. See
L.
-=item $c->engine
+=head2 $c->engine
Returns the engine instance. Stringifies to the class name. See
L.
-=item $c->log
+=head2 $c->log
-Returns the logging object instance. Unless it is already set, Catalyst
-sets this up with a L object. To use your own log class:
+Returns the logging object instance. Unless it is already set, Catalyst sets
+this up with a L object. To use your own log class, set the
+logger with the C<< __PACKAGE__->log >> method prior to calling
+C<< __PACKAGE__->setup >>.
+
+ __PACKAGE__->log( MyLogger->new );
+ __PACKAGE__->setup;
+
+And later:
- $c->log( MyLogger->new );
$c->log->info( 'Now logging with my own logger!' );
Your log class should implement the methods described in the
@@ -476,13 +538,9 @@ L man page.
=cut
-=back
-
=head2 Utility methods
-=over 4
-
-=item $c->path_to(@path)
+=head2 $c->path_to(@path)
Merges C<@path> with C<$c-Econfig-E{home}> and returns a
L object.
@@ -500,7 +558,7 @@ sub path_to {
else { return file( $c->config->{home}, @path ) }
}
-=item $c->plugin( $name, $class, @args )
+=head2 $c->plugin( $name, $class, @args )
Helper method for plugins. It creates a classdata accessor/mutator and
loads and instantiates the given class.
@@ -513,12 +571,7 @@ loads and instantiates the given class.
sub plugin {
my ( $class, $name, $plugin, @args ) = @_;
- $plugin->require;
-
- if ( my $error = $UNIVERSAL::require::ERROR ) {
- Catalyst::Exception->throw(
- message => qq/Couldn't load instant plugin "$plugin", "$error"/ );
- }
+ $class->_register_plugin( $plugin, 1 );
eval { $plugin->import };
$class->mk_classdata($name);
@@ -535,7 +588,7 @@ sub plugin {
if $class->debug;
}
-=item MyApp->setup
+=head2 MyApp->setup
Initializes the dispatcher and engine, loads any plugins, and loads the
model, view, and controller components. You may also specify an array
@@ -577,11 +630,12 @@ sub setup {
}
}
+ $class->setup_home( delete $flags->{home} );
+
$class->setup_log( delete $flags->{log} );
$class->setup_plugins( delete $flags->{plugins} );
$class->setup_dispatcher( delete $flags->{dispatcher} );
$class->setup_engine( delete $flags->{engine} );
- $class->setup_home( delete $flags->{home} );
for my $flag ( sort keys %{$flags} ) {
@@ -597,8 +651,11 @@ sub setup {
<<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
You are running an old script!
- Please update by running:
- catalyst.pl -nonew -scripts $class
+ Please update by running (this will overwrite existing files):
+ catalyst.pl -force -scripts $class
+
+ or (this will not overwrite existing files):
+ catalyst.pl -scripts $class
EOF
if ( $class->debug ) {
@@ -607,7 +664,9 @@ EOF
{
no strict 'refs';
- @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
+ @plugins =
+ map { $_ . ' ' . ( $_->VERSION || '' ) }
+ grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
}
if (@plugins) {
@@ -662,14 +721,18 @@ EOF
$class->log->info("$name powered by Catalyst $Catalyst::VERSION");
}
$class->log->_flush() if $class->log->can('_flush');
+
+ $class->setup_finished(1);
}
-=item $c->uri_for( $path, [ @args ] )
+=head2 $c->uri_for( $path, [ @args ] )
Merges path with C<$c-Erequest-Ebase> for absolute uri's and
with C<$c-Enamespace> for relative uri's, then returns a
normalized L object. If any args are passed, they are added at the
-end of the path.
+end of the path. If the last argument to uri_for is a hash reference,
+it is assumed to contain GET parameter key/value pairs, which will be
+appended to the URI in standard fashion.
=cut
@@ -688,13 +751,20 @@ sub uri_for {
$namespace = '' if $path =~ /^\//;
$path =~ s/^\///;
+ my $params =
+ ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
+
# join args with '/', or a blank string
my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
- return URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ),
- $base )->canonical;
+ $args =~ s/^\/// unless $path;
+ my $res =
+ URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
+ ->canonical;
+ $res->query_form(%$params);
+ $res;
}
-=item $c->welcome_message
+=head2 $c->welcome_message
Returns the Catalyst welcome HTML page.
@@ -794,23 +864,24 @@ sub welcome_message {
Welcome to the wonderful world of Catalyst.
This MVC
framework will make web development something you had
- never expected it to be: Fun, rewarding and quick.
+ never expected it to be: Fun, rewarding, and quick.
What to do now?
That really depends on what you want to do.
We do, however, provide you with a few starting points.
If you want to jump right into web development with Catalyst
you might want to check out the documentation.
perldoc Catalyst::Manual::Intro
+perldoc Catalyst::Manual::Tutorial
perldoc Catalyst::Manual
What to do next?
Next it's time to write an actual application. Use the
helper scripts to generate controllers,
- models and
- views,
+ models, and
+ views;
they can save you a lot of work.
script/${prefix}_create.pl -help
Also, be sure to check out the vast and growing
- collection of plugins for Catalyst on CPAN,
+ collection of plugins for Catalyst on CPAN;
you are likely to find what you need there.
@@ -839,32 +910,28 @@ perldoc /;
+ my $error = qq/Deep recursion detected calling "$action"/;
+ $c->log->error($error);
+ $c->error($error);
+ $c->state(0);
+ return $c->state;
+ }
+
- my $action = '';
if ( $c->debug ) {
- $action = "$code";
+ my $action = "$code";
$action = "/$action" unless $action =~ /\-\>/;
$c->counter->{"$code"}++;
- if ( $c->counter->{"$code"} > $RECURSION ) {
- my $error = qq/Deep recursion detected in "$action"/;
- $c->log->error($error);
- $c->error($error);
- $c->state(0);
- return $c->state;
+ # determine if the call was the result of a forward
+ # this is done by walking up the call stack and looking for a calling
+ # sub of Catalyst::forward before the eval
+ my $callsub = q{};
+ for my $index ( 1 .. 10 ) {
+ last
+ if ( ( caller($index) )[0] eq 'Catalyst'
+ && ( caller($index) )[3] eq '(eval)' );
+
+ if ( ( caller($index) )[3] =~ /forward$/ ) {
+ $callsub = ( caller($index) )[3];
+ $action = "-> $action";
+ last;
+ }
}
- $action = "-> $action" if $callsub =~ /forward$/;
+ my $node = Tree::Simple->new(
+ {
+ action => $action,
+ elapsed => undef, # to be filled in later
+ }
+ );
+ $node->setUID( "$code" . $c->counter->{"$code"} );
+
+ unless ( ( $code->name =~ /^_.*/ )
+ && ( !$c->config->{show_internal_actions} ) )
+ {
+
+ # 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);
+ }
+ }
+ else {
+
+ # forward with no caller may come from a plugin
+ $c->{stats}->addChild($node);
+ }
+ }
+ else {
+
+ # root-level call
+ $c->{stats}->addChild($node);
+ }
+ }
}
+
push( @{ $c->stack }, $code );
my $elapsed = 0;
my $start = 0;
@@ -936,18 +1053,35 @@ sub execute {
unless ( ( $code->name =~ /^_.*/ )
&& ( !$c->config->{show_internal_actions} ) )
{
- push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
+
+ # FindByUID uses an internal die, so we save the existing error
+ my $error = $@;
+
+ # locate the node in the tree and update the elapsed time
+ my $visitor = Tree::Simple::Visitor::FindByUID->new;
+ $visitor->searchForUID( "$code" . $c->counter->{"$code"} );
+ $c->{stats}->accept($visitor);
+ if ( my $result = $visitor->getResult ) {
+ my $value = $result->getNodeValue;
+ $value->{elapsed} = sprintf( '%fs', $elapsed );
+ $result->setNodeValue($value);
+ }
+
+ # restore error
+ $@ = $error || undef;
}
}
+ my $last = ${ $c->stack }[-1];
pop( @{ $c->stack } );
if ( my $error = $@ ) {
-
if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 }
else {
unless ( ref $error ) {
chomp $error;
- $error = qq/Caught exception "$error"/;
+ my $class = $last->class;
+ my $name = $last->name;
+ $error = qq/Caught exception in $class->$name "$error"/;
}
$c->error($error);
$c->state(0);
@@ -956,7 +1090,7 @@ sub execute {
return $c->state;
}
-=item $c->finalize
+=head2 $c->finalize
Finalizes the request.
@@ -988,7 +1122,7 @@ sub finalize {
return $c->response->status;
}
-=item $c->finalize_body
+=head2 $c->finalize_body
Finalizes body.
@@ -996,7 +1130,7 @@ Finalizes body.
sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
-=item $c->finalize_cookies
+=head2 $c->finalize_cookies
Finalizes cookies.
@@ -1004,7 +1138,7 @@ Finalizes cookies.
sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
-=item $c->finalize_error
+=head2 $c->finalize_error
Finalizes error.
@@ -1012,7 +1146,7 @@ Finalizes error.
sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
-=item $c->finalize_headers
+=head2 $c->finalize_headers
Finalizes headers.
@@ -1032,7 +1166,19 @@ sub finalize_headers {
# Content-Length
if ( $c->response->body && !$c->response->content_length ) {
- $c->response->content_length( bytes::length( $c->response->body ) );
+
+ # get the length from a filehandle
+ if ( blessed($c->response->body) && $c->response->body->can('read') ) {
+ if ( my $stat = stat $c->response->body ) {
+ $c->response->content_length( $stat->size );
+ }
+ else {
+ $c->log->warn('Serving filehandle without a content-length');
+ }
+ }
+ else {
+ $c->response->content_length( bytes::length( $c->response->body ) );
+ }
}
# Errors
@@ -1049,11 +1195,11 @@ sub finalize_headers {
$c->response->{_finalized_headers} = 1;
}
-=item $c->finalize_output
+=head2 $c->finalize_output
An alias for finalize_body.
-=item $c->finalize_read
+=head2 $c->finalize_read
Finalizes the input after reading is complete.
@@ -1061,7 +1207,7 @@ Finalizes the input after reading is complete.
sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
-=item $c->finalize_uploads
+=head2 $c->finalize_uploads
Finalizes uploads. Cleans up any temporary files.
@@ -1069,7 +1215,7 @@ Finalizes uploads. Cleans up any temporary files.
sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
-=item $c->get_action( $action, $namespace )
+=head2 $c->get_action( $action, $namespace )
Gets an action in a given namespace.
@@ -1077,7 +1223,7 @@ Gets an action in a given namespace.
sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
-=item $c->get_actions( $action, $namespace )
+=head2 $c->get_actions( $action, $namespace )
Gets all actions of a given name in a namespace and all parent
namespaces.
@@ -1086,7 +1232,7 @@ namespaces.
sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
-=item handle_request( $class, @arguments )
+=head2 handle_request( $class, @arguments )
Called to handle each HTTP request.
@@ -1098,11 +1244,11 @@ sub handle_request {
# Always expect worst case!
my $status = -1;
eval {
- my @stats = ();
+ my $stats = ( $class->debug ) ? Tree::Simple->new: q{};
my $handler = sub {
my $c = $class->prepare(@arguments);
- $c->{stats} = \@stats;
+ $c->{stats} = $stats;
$c->dispatch;
return $c->finalize;
};
@@ -1116,7 +1262,15 @@ sub handle_request {
( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
- for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
+ $stats->traverse(
+ sub {
+ my $action = shift;
+ my $stat = $action->getNodeValue;
+ $t->row( ( q{ } x $action->getDepth ) . $stat->{action},
+ $stat->{elapsed} || '??' );
+ }
+ );
+
$class->log->info(
"Request took ${elapsed}s ($av/s)\n" . $t->draw );
}
@@ -1134,7 +1288,7 @@ sub handle_request {
return $status;
}
-=item $c->prepare( @arguments )
+=head2 $c->prepare( @arguments )
Creates a Catalyst context from an engine-specific request (Apache, CGI,
etc.).
@@ -1212,7 +1366,7 @@ sub prepare {
return $c;
}
-=item $c->prepare_action
+=head2 $c->prepare_action
Prepares action.
@@ -1220,7 +1374,7 @@ Prepares action.
sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
-=item $c->prepare_body
+=head2 $c->prepare_body
Prepares message body.
@@ -1249,7 +1403,7 @@ sub prepare_body {
}
}
-=item $c->prepare_body_chunk( $chunk )
+=head2 $c->prepare_body_chunk( $chunk )
Prepares a chunk of data before sending it to L.
@@ -1260,7 +1414,7 @@ sub prepare_body_chunk {
$c->engine->prepare_body_chunk( $c, @_ );
}
-=item $c->prepare_body_parameters
+=head2 $c->prepare_body_parameters
Prepares body parameters.
@@ -1271,7 +1425,7 @@ sub prepare_body_parameters {
$c->engine->prepare_body_parameters( $c, @_ );
}
-=item $c->prepare_connection
+=head2 $c->prepare_connection
Prepares connection.
@@ -1282,7 +1436,7 @@ sub prepare_connection {
$c->engine->prepare_connection( $c, @_ );
}
-=item $c->prepare_cookies
+=head2 $c->prepare_cookies
Prepares cookies.
@@ -1290,7 +1444,7 @@ Prepares cookies.
sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
-=item $c->prepare_headers
+=head2 $c->prepare_headers
Prepares headers.
@@ -1298,7 +1452,7 @@ Prepares headers.
sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
-=item $c->prepare_parameters
+=head2 $c->prepare_parameters
Prepares parameters.
@@ -1310,7 +1464,7 @@ sub prepare_parameters {
$c->engine->prepare_parameters( $c, @_ );
}
-=item $c->prepare_path
+=head2 $c->prepare_path
Prepares path and base.
@@ -1318,7 +1472,7 @@ Prepares path and base.
sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
-=item $c->prepare_query_parameters
+=head2 $c->prepare_query_parameters
Prepares query parameters.
@@ -1341,7 +1495,7 @@ sub prepare_query_parameters {
}
}
-=item $c->prepare_read
+=head2 $c->prepare_read
Prepares the input for reading.
@@ -1349,7 +1503,7 @@ Prepares the input for reading.
sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
-=item $c->prepare_request
+=head2 $c->prepare_request
Prepares the engine request.
@@ -1357,7 +1511,7 @@ Prepares the engine request.
sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
-=item $c->prepare_uploads
+=head2 $c->prepare_uploads
Prepares uploads.
@@ -1385,7 +1539,7 @@ sub prepare_uploads {
}
}
-=item $c->prepare_write
+=head2 $c->prepare_write
Prepares the output for writing.
@@ -1393,15 +1547,15 @@ Prepares the output for writing.
sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
-=item $c->request_class
+=head2 $c->request_class
Returns or sets the request class.
-=item $c->response_class
+=head2 $c->response_class
Returns or sets the response class.
-=item $c->read( [$maxlength] )
+=head2 $c->read( [$maxlength] )
Reads a chunk of data from the request body. This method is designed to
be used in a while loop, reading C<$maxlength> bytes on every call.
@@ -1414,7 +1568,7 @@ directly.
sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
-=item $c->run
+=head2 $c->run
Starts the engine.
@@ -1422,7 +1576,7 @@ Starts the engine.
sub run { my $c = shift; return $c->engine->run( $c, @_ ) }
-=item $c->set_action( $action, $code, $namespace, $attrs )
+=head2 $c->set_action( $action, $code, $namespace, $attrs )
Sets an action in a given namespace.
@@ -1430,7 +1584,7 @@ Sets an action in a given namespace.
sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
-=item $c->setup_actions($component)
+=head2 $c->setup_actions($component)
Sets up actions for a component.
@@ -1438,7 +1592,7 @@ Sets up actions for a component.
sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
-=item $c->setup_components
+=head2 $c->setup_components
Sets up components.
@@ -1450,7 +1604,7 @@ sub setup_components {
my $callback = sub {
my ( $component, $context ) = @_;
- unless ( $component->isa('Catalyst::Component') ) {
+ unless ( $component->can('COMPONENT') ) {
return $component;
}
@@ -1459,7 +1613,7 @@ sub setup_components {
my $instance;
- eval { $instance = $component->new( $context, $config ); };
+ eval { $instance = $component->COMPONENT( $context, $config ); };
if ( my $error = $@ ) {
@@ -1470,7 +1624,7 @@ sub setup_components {
}
Catalyst::Exception->throw( message =>
-qq/Couldn't instantiate component "$component", "new() didn't return a object"/
+qq/Couldn't instantiate component "$component", "COMPONENT() didn't return a object"/
)
unless ref $instance;
return $instance;
@@ -1500,7 +1654,7 @@ qq/Couldn't instantiate component "$component", "new() didn't return a object"/
}
}
-=item $c->setup_dispatcher
+=head2 $c->setup_dispatcher
Sets up dispatcher.
@@ -1537,7 +1691,7 @@ sub setup_dispatcher {
$class->dispatcher( $dispatcher->new );
}
-=item $c->setup_engine
+=head2 $c->setup_engine
Sets up engine.
@@ -1558,7 +1712,7 @@ sub setup_engine {
$engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
}
- if ( !$engine && $ENV{MOD_PERL} ) {
+ if ( $ENV{MOD_PERL} ) {
# create the apache method
{
@@ -1574,21 +1728,25 @@ sub setup_engine {
if ( $software eq 'mod_perl' ) {
- if ( $version >= 1.99922 ) {
- $engine = 'Catalyst::Engine::Apache2::MP20';
- }
+ if ( !$engine ) {
- elsif ( $version >= 1.9901 ) {
- $engine = 'Catalyst::Engine::Apache2::MP19';
- }
+ if ( $version >= 1.99922 ) {
+ $engine = 'Catalyst::Engine::Apache2::MP20';
+ }
- elsif ( $version >= 1.24 ) {
- $engine = 'Catalyst::Engine::Apache::MP13';
- }
+ elsif ( $version >= 1.9901 ) {
+ $engine = 'Catalyst::Engine::Apache2::MP19';
+ }
+
+ elsif ( $version >= 1.24 ) {
+ $engine = 'Catalyst::Engine::Apache::MP13';
+ }
+
+ else {
+ Catalyst::Exception->throw( message =>
+ qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
+ }
- else {
- Catalyst::Exception->throw( message =>
- qq/Unsupported mod_perl version: $ENV{MOD_PERL}/ );
}
# install the correct mod_perl handler
@@ -1661,7 +1819,7 @@ qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
$class->engine( $engine->new );
}
-=item $c->setup_home
+=head2 $c->setup_home
Sets up the home directory.
@@ -1688,7 +1846,7 @@ sub setup_home {
}
}
-=item $c->setup_log
+=head2 $c->setup_log
Sets up log.
@@ -1715,39 +1873,78 @@ sub setup_log {
}
}
-=item $c->setup_plugins
+=head2 $c->setup_plugins
Sets up plugins.
=cut
-sub setup_plugins {
- my ( $class, $plugins ) = @_;
+=head2 $c->registered_plugins
+
+Returns a sorted list of the plugins which have either been stated in the
+import list or which have been added via C<< MyApp->plugin(@args); >>.
+
+If passed a given plugin name, it will report a boolean value indicating
+whether or not that plugin is loaded. A fully qualified name is required if
+the plugin name does not begin with C.
+
+ if ($c->registered_plugins('Some::Plugin')) {
+ ...
+ }
+
+=cut
+
+{
- $plugins ||= [];
- for my $plugin ( reverse @$plugins ) {
+ sub registered_plugins {
+ my $proto = shift;
+ return sort keys %{$proto->_plugins} unless @_;
+ my $plugin = shift;
+ return 1 if exists $proto->_plugins->{$plugin};
+ return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
+ }
- $plugin = "Catalyst::Plugin::$plugin";
+ sub _register_plugin {
+ my ( $proto, $plugin, $instant ) = @_;
+ my $class = ref $proto || $proto;
$plugin->require;
- if ($@) {
+ if ( my $error = $@ ) {
+ my $type = $instant ? "instant " : '';
Catalyst::Exception->throw(
- message => qq/Couldn't load plugin "$plugin", "$@"/ );
+ message => qq/Couldn't load ${type}plugin "$plugin", $error/ );
}
- {
+ $proto->_plugins->{$plugin} = 1;
+ unless ($instant) {
no strict 'refs';
unshift @{"$class\::ISA"}, $plugin;
}
+ return $class;
+ }
+
+ sub setup_plugins {
+ my ( $class, $plugins ) = @_;
+
+ $class->_plugins( {} ) unless $class->_plugins;
+ $plugins ||= [];
+ for my $plugin ( reverse @$plugins ) {
+
+ unless ( $plugin =~ s/\A\+// ) {
+ $plugin = "Catalyst::Plugin::$plugin";
+ }
+
+ $class->_register_plugin($plugin);
+ }
}
}
-=item $c->stack
+=head2 $c->stack
Returns the stack.
-=item $c->write( $data )
+=head2 $c->write( $data )
Writes $data to the output stream. When using this method directly, you
will need to manually set the C header to the length of
@@ -1764,7 +1961,7 @@ sub write {
return $c->engine->write( $c, @_ );
}
-=item version
+=head2 version
Returns the Catalyst version number. Mostly useful for "powered by"
messages in template systems.
@@ -1773,8 +1970,6 @@ messages in template systems.
sub version { return $Catalyst::VERSION }
-=back
-
=head1 INTERNAL ACTIONS
Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
@@ -1864,23 +2059,21 @@ Wiki:
=head1 SEE ALSO
-=over 4
-
-=item L - The Catalyst Manual
+=head2 L - All you need to start with Catalyst
-=item L, L - Base classes for components
+=head2 L - The Catalyst Manual
-=item L - Core engine
+=head2 L, L - Base classes for components
-=item L - Log class.
+=head2 L - Core engine
-=item L - Request object
+=head2 L - Log class.
-=item L - Response object
+=head2 L - Request object
-=item L - The test suite.
+=head2 L - Response object
-=back
+=head2 L - The test suite.
=head1 CREDITS
@@ -1902,6 +2095,8 @@ Autrijus Tang
Brian Cassidy
+Carl Franks
+
Christian Hansen
Christopher Hicks
@@ -1914,6 +2109,8 @@ David Kamholz
David Naughton
+Drew Taylor
+
Gary Ashton Jones
Geoff Richards