X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=4fe18e78bead702b460a4624e3fc21e01c917613;hp=904693bb829a541514169c21cfb37ba2832aa28c;hb=e80e8542290e1c62b3c6dbee4265691d7ad634c3;hpb=f991f6a0dd3b2fc63223bf206c402fce8213807f
diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 904693b..4fe18e7 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -1,25 +1,33 @@
package Catalyst;
use strict;
-use base 'Catalyst::Base';
+use base 'Catalyst::Component';
use bytes;
-use UNIVERSAL::require;
use Catalyst::Exception;
use Catalyst::Log;
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 Path::Class::Dir;
+use Path::Class::File;
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;
+use utf8;
+use Carp qw/croak/;
+
+BEGIN { require 5.008001; }
__PACKAGE__->mk_accessors(
- qw/counter request response state action stack namespace/
+ qw/counter request response state action stack namespace stats/
);
attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
@@ -43,18 +51,18 @@ our $DETACH = "catalyst_detach\n";
require Module::Pluggable::Fast;
# Helper script generation
-our $CATALYST_SCRIPT_GEN = 19;
+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.6902';
sub import {
my ( $class, @arguments ) = @_;
@@ -67,7 +75,7 @@ sub import {
unless ( $caller->isa('Catalyst') ) {
no strict 'refs';
- push @{"$caller\::ISA"}, $class;
+ push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
}
$caller->arguments( [@arguments] );
@@ -80,11 +88,11 @@ Catalyst - The Elegant MVC Web Application Framework
=head1 SYNOPSIS
- # use the helper to start a new application
+ # use the helper to create a new application
catalyst.pl MyApp
# add models, views, controllers
- script/myapp_create.pl model Database DBIC dbi:SQLite:/path/to/db
+ script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
script/myapp_create.pl view TT TT
script/myapp_create.pl controller Search
@@ -94,15 +102,16 @@ Catalyst - The Elegant MVC Web Application Framework
# command line testing interface
script/myapp_test.pl /yada
- ### in MyApp.pm
+ ### in lib/MyApp.pm
use Catalyst qw/-Debug/; # include plugins here as well
+ ### In libMyApp/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
# lookup something from db -- stash vars are passed to TT
$c->stash->{data} =
- MyApp::Model::Database::Foo->search( { country => $args[0] } );
+ $c->model('Database::Foo')->search( { country => $args[0] } );
if ( $c->req->params->{bar} ) { # access GET or POST parameters
$c->forward( 'bar' ); # process another action
# do something else after forward returns
@@ -120,7 +129,7 @@ Catalyst - The Elegant MVC Web Application Framework
# called for all actions, from the top-most controller downwards
sub auto : Private {
my ( $self, $c ) = @_;
- if ( !$c->user ) {
+ if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
$c->res->redirect( '/login' ); # require login
return 0; # abort request and go immediately to end()
}
@@ -149,21 +158,21 @@ Catalyst - The Elegant MVC Web Application Framework
# called for /foo/bar/baz
sub baz : Local { ... }
- # first MyApp auto is called, then Foo auto, then this
+ # first Root auto is called, then Foo auto, then this
sub auto : Private { ... }
# powerful regular expression paths are also possible
sub details : Regex('^product/(\w+)/details$') {
my ( $self, $c ) = @_;
# extract the (\w+) from the URI
- my $product = $c->req->snippets->[0];
+ my $product = $c->req->captures->[0];
}
See L for additional information.
=head1 DESCRIPTION
-The key concept of Catalyst is DRY (Don't Repeat Yourself).
+Catalyst is a modern framework for making web applications without the pain usually associated with this process. This document is a reference to the main Catalyst application. If you are a new user, we suggest you start with L or L
See L for more documentation.
@@ -174,6 +183,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:
@@ -186,7 +203,9 @@ The following flags are supported:
=head2 -Debug
-Enables debug output.
+Enables debug output. You can also force this setting from the system
+environment with CATALYST_DEBUG or _DEBUG. The environment settings
+override the app, with _DEBUG having highest priority.
=head2 -Engine
@@ -207,7 +226,7 @@ Specifies log level.
=head1 METHODS
-=head2 Information about the current request
+=head2 INFORMATION ABOUT THE CURRENT REQUEST
=head2 $c->action
@@ -229,23 +248,38 @@ corresponding to the controller of the current action. For example:
Returns the current L object. See
L.
-=head2 Processing and response to the current request
+=head2 REQUEST FLOW HANDLING
=head2 $c->forward( $action [, \@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
-in an arrayref. The action will receive the arguments in C<@_> and
-C<$c-Ereq-Eargs>. Upon returning from the function,
+Forwards processing to another action, by it's private name. If you give a
+class name but no method, C is called. You may also optionally
+pass arguments 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(qw/MyApp::Model::DBIC::Foo do_stuff/);
$c->forward('MyApp::View::TT');
+Note that forward implies an C<> around the call (well, actually
+C does), thus de-fatalizing all 'dies' within the called action. If
+you want C to propagate you need to do something like:
+
+ $c->forward('foo');
+ die $c->error if $c->error;
+
+Or make sure to always return true values from your actions and write your code
+like this:
+
+ $c->forward('foo') || return;
+
=cut
sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
@@ -254,12 +288,48 @@ sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
=head2 $c->detach( $class, $method, [, \@arguments ] )
-The same as C, but doesn't return.
+The same as C, but doesn't return to the previous action when
+processing is finished.
=cut
sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
+=head2 $c->response
+
+=head2 $c->res
+
+Returns the current L object.
+
+=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
+passing arguments. The stash is automatically sent to the view. The
+stash is cleared at the end of a request; it cannot be used for
+persistent storage.
+
+ $c->stash->{foo} = $bar;
+ $c->stash( { moose => 'majestic', qux => 0 } );
+ $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' );
+
+=cut
+
+sub stash {
+ my $c = shift;
+ if (@_) {
+ my $stash = @_ > 1 ? {@_} : $_[0];
+ croak('stash takes a hash or hashref') unless ref $stash;
+ foreach my $key ( keys %$stash ) {
+ $c->{stash}->{$key} = $stash->{$key};
+ }
+ }
+ return $c->{stash};
+}
+
=head2 $c->error
=head2 $c->error($error, ...)
@@ -276,120 +346,143 @@ Add a new error.
$c->error('Something bad happened');
-Clear errors. You probably don't want to clear the errors unless you are
-implementing a custom error screen.
-
- $c->error(0);
-
=cut
sub error {
my $c = shift;
if ( $_[0] ) {
my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
+ croak @$error unless ref $c;
push @{ $c->{error} }, @$error;
}
elsif ( defined $_[0] ) { $c->{error} = undef }
return $c->{error} || [];
}
-=head2 $c->response
-=head2 $c->res
+=head2 $c->state
-Returns the current L object.
+Contains the return value of the last executed action.
-=head2 $c->stash
+=head2 $c->clear_errors
-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
-passing arguments. The stash is automatically sent to the view. The
-stash is cleared at the end of a request; it cannot be used for
-persistent storage.
+Clear errors. You probably don't want to clear the errors unless you are
+implementing a custom error screen.
- $c->stash->{foo} = $bar;
- $c->stash( { moose => 'majestic', qux => 0 } );
- $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' );
+This is equivalent to running
+
+ $c->error(0);
=cut
-sub stash {
+sub clear_errors {
my $c = shift;
- if (@_) {
- my $stash = @_ > 1 ? {@_} : $_[0];
- while ( my ( $key, $val ) = each %$stash ) {
- $c->{stash}->{$key} = $val;
- }
- }
- return $c->{stash};
+ $c->error(0);
}
-=head2 $c->state
-Contains the return value of the last executed action.
-=head2 Component Accessors
-=head2 $c->comp($name)
+# search via regex
+sub _comp_search {
+ my ( $c, @names ) = @_;
-=head2 $c->component($name)
+ foreach my $name (@names) {
+ foreach my $component ( keys %{ $c->components } ) {
+ return $c->components->{$component} if $component =~ /$name/i;
+ }
+ }
-Gets a component object by name. This method is no longer recommended,
-unless you want to get a specific component by full
-class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview>
-should be used instead.
+ return undef;
+}
-=cut
+# try explicit component names
+sub _comp_explicit {
+ my ( $c, @names ) = @_;
-sub component {
- my $c = shift;
+ foreach my $try (@names) {
+ return $c->components->{$try} if ( exists $c->components->{$try} );
+ }
- if (@_) {
+ return undef;
+}
- my $name = shift;
+# 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 $appclass = ref $c || $c;
- my @names = (
- $name, "${appclass}::${name}",
- map { "${appclass}::${_}::${name}" }
- qw/Model M Controller C View V/
- );
+ my @names = map { "${appclass}::${_}::${name}" } @prefixes;
+
+ my $comp = $c->_comp_explicit(@names);
+ return $comp if defined($comp);
+ $comp = $c->_comp_search($name);
+ return $comp;
+}
+
+# Find possible names for a prefix
+
+sub _comp_names {
+ my ( $c, @prefixes ) = @_;
+
+ my $appclass = ref $c || $c;
- foreach my $try (@names) {
+ my @pre = map { "${appclass}::${_}::" } @prefixes;
- if ( exists $c->components->{$try} ) {
+ my @names;
- return $c->components->{$try};
+ COMPONENT: foreach my $comp ($c->component) {
+ foreach my $p (@pre) {
+ if ($comp =~ s/^$p//) {
+ push(@names, $comp);
+ next COMPONENT;
}
}
+ }
- foreach my $component ( keys %{ $c->components } ) {
+ return @names;
+}
- return $c->components->{$component} if $component =~ /$name/i;
- }
+# Return a component if only one matches.
+sub _comp_singular {
+ my ( $c, @prefixes ) = @_;
- }
+ my $appclass = ref $c || $c;
- return sort keys %{ $c->components };
+ my ( $comp, $rest ) =
+ map { $c->_comp_search("^${appclass}::${_}::") } @prefixes;
+ return $comp unless $rest;
}
+# Filter a component before returning by calling ACCEPT_CONTEXT if available
+sub _filter_component {
+ my ( $c, $comp, @args ) = @_;
+ if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
+ return $comp->ACCEPT_CONTEXT( $c, @args );
+ }
+ else { return $comp }
+}
+
+=head2 COMPONENT ACCESSORS
+
=head2 $c->controller($name)
Gets a L instance by name.
$c->controller('Foo')->do_stuff;
+If name is omitted, will return the controller for the dispatched action.
+
=cut
sub controller {
- my ( $c, $name ) = @_;
- my $controller = $c->comp("Controller::$name");
- return $controller if $controller;
- return $c->comp("C::$name");
+ my ( $c, $name, @args ) = @_;
+ return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
+ @args )
+ if ($name);
+ return $c->component( $c->action->class );
}
=head2 $c->model($name)
@@ -398,42 +491,167 @@ Gets a L instance by name.
$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.
+
=cut
sub model {
- my ( $c, $name ) = @_;
- my $model = $c->comp("Model::$name");
- return $model if $model;
- return $c->comp("M::$name");
+ my ( $c, $name, @args ) = @_;
+ return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ),
+ @args )
+ if $name;
+ return $c->component( $c->config->{default_model} )
+ if $c->config->{default_model};
+ return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
+
+}
+
+=head2 $c->controllers
+
+Returns the available names which can be passed to $c->controller
+
+=cut
+
+sub controllers {
+ my ( $c ) = @_;
+ return $c->_comp_names(qw/Controller C/);
}
+
=head2 $c->view($name)
Gets a L instance by name.
$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.
+
=cut
sub view {
- my ( $c, $name ) = @_;
- my $view = $c->comp("View::$name");
- return $view if $view;
- return $c->comp("V::$name");
+ my ( $c, $name, @args ) = @_;
+ return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ),
+ @args )
+ if $name;
+ return $c->component( $c->config->{default_view} )
+ if $c->config->{default_view};
+ return $c->_filter_component( $c->_comp_singular(qw/View V/) );
}
-=head2 Class data and helper classes
+=head2 $c->models
+
+Returns the available names which can be passed to $c->model
+
+=cut
+
+sub models {
+ my ( $c ) = @_;
+ return $c->_comp_names(qw/Model M/);
+}
+
+
+=head2 $c->views
+
+Returns the available names which can be passed to $c->view
+
+=cut
+
+sub views {
+ my ( $c ) = @_;
+ return $c->_comp_names(qw/View V/);
+}
+
+=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
+class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview>
+should be used instead.
+
+=cut
+
+sub component {
+ my $c = shift;
+
+ if (@_) {
+
+ my $name = shift;
+
+ my $appclass = ref $c || $c;
+
+ my @names = (
+ $name, "${appclass}::${name}",
+ map { "${appclass}::${_}::${name}" }
+ qw/Model M Controller C View V/
+ );
+
+ my $comp = $c->_comp_explicit(@names);
+ return $c->_filter_component( $comp, @_ ) if defined($comp);
+
+ $comp = $c->_comp_search($name);
+ return $c->_filter_component( $comp, @_ ) if defined($comp);
+ }
+
+ return sort keys %{ $c->components };
+}
+
+
+
+=head2 CLASS DATA AND HELPER CLASSES
=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(@_);
+}
+
+=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, 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->info( 'Now logging with my own logger!' );
+
+Your log class should implement the methods described in the
+L man page.
+
=head2 $c->debug
Overload to enable debug messages (same as -Debug option).
+Note that this is a static method, not an accessor and should be overloaded
+by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1).
+
=cut
sub debug { 0 }
@@ -448,20 +666,8 @@ L.
Returns the engine instance. Stringifies to the class name. See
L.
-=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:
-
- $c->log( MyLogger->new );
- $c->log->info( 'Now logging with my own logger!' );
-
-Your log class should implement the methods described in the
-L man page.
-
-=cut
-
-=head2 Utility methods
+=head2 UTILITY METHODS
=head2 $c->path_to(@path)
@@ -476,9 +682,9 @@ For example:
sub path_to {
my ( $c, @path ) = @_;
- my $path = dir( $c->config->{home}, @path );
+ my $path = Path::Class::Dir->new( $c->config->{home}, @path );
if ( -d $path ) { return $path }
- else { return file( $c->config->{home}, @path ) }
+ else { return Path::Class::File->new( $c->config->{home}, @path ) }
}
=head2 $c->plugin( $name, $class, @args )
@@ -494,12 +700,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);
@@ -531,6 +732,9 @@ Catalyst> line.
sub setup {
my ( $class, @arguments ) = @_;
+ $class->log->warn("Running setup twice is not a good idea.")
+ if ( $class->setup_finished );
+
unless ( $class->isa('Catalyst') ) {
Catalyst::Exception->throw(
@@ -558,11 +762,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} ) {
@@ -591,11 +796,13 @@ EOF
{
no strict 'refs';
- @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
+ @plugins =
+ map { $_ . ' ' . ( $_->VERSION || '' ) }
+ grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
}
if (@plugins) {
- my $t = Text::SimpleTable->new(76);
+ my $t = Text::SimpleTable->new(74);
$t->row($_) for @plugins;
$class->log->debug( "Loaded plugins:\n" . $t->draw );
}
@@ -627,7 +834,7 @@ EOF
$class->setup_components;
if ( $class->debug ) {
- my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] );
+ my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] );
for my $comp ( sort keys %{ $class->components } ) {
my $type = ref $class->components->{$comp} ? 'instance' : 'class';
$t->row( $comp, $type );
@@ -646,14 +853,18 @@ EOF
$class->log->info("$name powered by Catalyst $Catalyst::VERSION");
}
$class->log->_flush() if $class->log->can('_flush');
+
+ $class->setup_finished(1);
}
-=head2 $c->uri_for( $path, [ @args ] )
+=head2 $c->uri_for( $path, @args?, \%query_values? )
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
@@ -663,19 +874,34 @@ sub uri_for {
my $basepath = $base->path;
$basepath =~ s/\/$//;
$basepath .= '/';
- my $namespace = $c->namespace;
+ my $namespace = $c->namespace || '';
# massage namespace, empty if absolute path
- $namespace =~ s/^\///;
+ $namespace =~ s/^\/// if $namespace;
$namespace .= '/' if $namespace;
$path ||= '';
$namespace = '' if $path =~ /^\//;
$path =~ s/^\///;
+ 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()" );
+ }
+ utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value;
+ };
+
# 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;
}
=head2 $c->welcome_message
@@ -712,7 +938,6 @@ sub welcome_message {
text-align: left;
background-color: #ccc;
border: 1px solid #aaa;
- -moz-border-radius: 10px;
}
p, h1, h2 {
margin-left: 20px;
@@ -742,7 +967,6 @@ sub welcome_message {
margin: 10px;
background-color: #fff;
border: 1px solid #aaa;
- -moz-border-radius: 10px;
}
h1 {
font-size: 0.9em;
@@ -778,23 +1002,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.
@@ -865,7 +1090,10 @@ that will be dumped on the error page in debug mode.
sub dump_these {
my $c = shift;
- [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],;
+ [ Request => $c->req ],
+ [ Response => $c->res ],
+ [ Stash => $c->stash ],
+ [ Config => $c->config ];
}
=head2 $c->engine_class
@@ -881,53 +1109,38 @@ via $c->error.
sub execute {
my ( $c, $class, $code ) = @_;
- $class = $c->components->{$class} || $class;
+ $class = $c->component($class) || $class;
$c->state(0);
- my $callsub =
- ( caller(0) )[0]->isa('Catalyst::Action')
- ? ( caller(2) )[3]
- : ( caller(1) )[3];
-
- my $action = '';
- if ( $c->debug ) {
- $action = "$code";
+ if ( $c->depth >= $RECURSION ) {
+ my $action = "$code";
$action = "/$action" unless $action =~ /\-\>/;
- $c->counter->{"$code"}++;
+ my $error = qq/Deep recursion detected calling "$action"/;
+ $c->log->error($error);
+ $c->error($error);
+ $c->state(0);
+ return $c->state;
+ }
- 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;
- }
+ my $stats_info = $c->_stats_start_execute( $code );
- $action = "-> $action" if $callsub =~ /forward$/;
- }
push( @{ $c->stack }, $code );
- my $elapsed = 0;
- my $start = 0;
- $start = [gettimeofday] if $c->debug;
+
eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
- $elapsed = tv_interval($start) if $c->debug;
- if ( $c->debug ) {
- unless ( ( $code->name =~ /^_.*/ )
- && ( !$c->config->{show_internal_actions} ) )
- {
- push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
- }
- }
+ $c->_stats_finish_execute( $stats_info );
+
+ 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);
@@ -936,6 +1149,127 @@ sub execute {
return $c->state;
}
+sub _stats_start_execute {
+ my ( $c, $code ) = @_;
+
+ return unless $c->debug;
+
+ my $action = "$code";
+
+ $action = "/$action" unless $action =~ /\-\>/;
+ $c->counter->{"$code"}++;
+
+ # 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 ( 2 .. 11 ) {
+ last
+ if ( ( caller($index) )[0] eq 'Catalyst'
+ && ( caller($index) )[3] eq '(eval)' );
+
+ if ( ( caller($index) )[3] =~ /forward$/ ) {
+ $callsub = ( caller($index) )[3];
+ $action = "-> $action";
+ last;
+ }
+ }
+
+ my $node = Tree::Simple->new(
+ {
+ action => $action,
+ elapsed => undef, # to be filled in later
+ comment => "",
+ }
+ );
+ $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);
+ }
+ }
+
+ my $start = [gettimeofday];
+ my $elapsed = tv_interval($start);
+
+ return {
+ code => $code,
+ elapsed => $elapsed,
+ start => $start,
+ node => $node,
+ }
+}
+
+sub _stats_finish_execute {
+ my ( $c, $info ) = @_;
+
+ return unless $c->debug;
+
+ my ( $code, $start, $elapsed ) = @{ $info }{qw/code start elapsed/};
+
+ unless ( ( $code->name =~ /^_.*/ )
+ && ( !$c->config->{show_internal_actions} ) )
+ {
+
+ # 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;
+ }
+}
+
+=head2 $c->_localize_fields( sub { }, \%keys );
+
+=cut
+
+sub _localize_fields {
+ my ( $c, $localized, $code ) = ( @_ );
+
+ my $request = delete $localized->{request} || {};
+ my $response = delete $localized->{response} || {};
+
+ local @{ $c }{ keys %$localized } = values %$localized;
+ local @{ $c->request }{ keys %$request } = values %$request;
+ local @{ $c->response }{ keys %$response } = values %$response;
+
+ $code->();
+}
+
=head2 $c->finalize
Finalizes the request.
@@ -949,21 +1283,28 @@ sub finalize {
$c->log->error($error);
}
- $c->finalize_uploads;
-
- # Error
- if ( $#{ $c->error } >= 0 ) {
- $c->finalize_error;
+ # Allow engine to handle finalize flow (for POE)
+ if ( $c->engine->can('finalize') ) {
+ $c->engine->finalize($c);
}
+ else {
- $c->finalize_headers;
+ $c->finalize_uploads;
- # HEAD request
- if ( $c->request->method eq 'HEAD' ) {
- $c->response->body('');
- }
+ # Error
+ if ( $#{ $c->error } >= 0 ) {
+ $c->finalize_error;
+ }
- $c->finalize_body;
+ $c->finalize_headers;
+
+ # HEAD request
+ if ( $c->request->method eq 'HEAD' ) {
+ $c->response->body('');
+ }
+
+ $c->finalize_body;
+ }
return $c->response->status;
}
@@ -1012,7 +1353,20 @@ 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
@@ -1066,7 +1420,7 @@ namespaces.
sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
-=head2 handle_request( $class, @arguments )
+=head2 $c->handle_request( $class, @arguments )
Called to handle each HTTP request.
@@ -1078,11 +1432,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;
};
@@ -1094,9 +1448,17 @@ sub handle_request {
$elapsed = sprintf '%f', $elapsed;
my $av = sprintf '%.3f',
( $elapsed == 0 ? '??' : ( 1 / $elapsed ) );
- my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] );
+ my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] );
+
+ $stats->traverse(
+ sub {
+ my $action = shift;
+ my $stat = $action->getNodeValue;
+ $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment},
+ $stat->{elapsed} || '??' );
+ }
+ );
- for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) }
$class->log->info(
"Request took ${elapsed}s ($av/s)\n" . $t->draw );
}
@@ -1138,7 +1500,7 @@ sub prepare {
parameters => {},
query_parameters => {},
secure => 0,
- snippets => [],
+ captures => [],
uploads => {}
}
),
@@ -1164,24 +1526,29 @@ sub prepare {
if ( $c->debug ) {
my $secs = time - $START || 1;
my $av = sprintf '%.3f', $COUNT / $secs;
- $c->log->debug('**********************************');
- $c->log->debug("* Request $COUNT ($av/s) [$$]");
- $c->log->debug('**********************************');
+ my $time = localtime time;
+ $c->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
$c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
}
- $c->prepare_request(@arguments);
- $c->prepare_connection;
- $c->prepare_query_parameters;
- $c->prepare_headers;
- $c->prepare_cookies;
- $c->prepare_path;
-
- # On-demand parsing
- $c->prepare_body unless $c->config->{parse_on_demand};
+ # Allow engine to direct the prepare flow (for POE)
+ if ( $c->engine->can('prepare') ) {
+ $c->engine->prepare( $c, @arguments );
+ }
+ else {
+ $c->prepare_request(@arguments);
+ $c->prepare_connection;
+ $c->prepare_query_parameters;
+ $c->prepare_headers;
+ $c->prepare_cookies;
+ $c->prepare_path;
+
+ # On-demand parsing
+ $c->prepare_body unless $c->config->{parse_on_demand};
+ }
my $method = $c->req->method || '';
- my $path = $c->req->path || '';
+ my $path = $c->req->path || '/';
my $address = $c->req->address || '';
$c->log->debug(qq/"$method" request for "$path" from "$address"/)
@@ -1194,7 +1561,7 @@ sub prepare {
=head2 $c->prepare_action
-Prepares action.
+Prepares action. See L.
=cut
@@ -1218,7 +1585,7 @@ sub prepare_body {
$c->prepare_uploads;
if ( $c->debug && keys %{ $c->req->body_parameters } ) {
- my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
+ my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
for my $key ( sort keys %{ $c->req->body_parameters } ) {
my $param = $c->req->body_parameters->{$key};
my $value = defined($param) ? $param : '';
@@ -1233,6 +1600,8 @@ sub prepare_body {
Prepares a chunk of data before sending it to L.
+See L.
+
=cut
sub prepare_body_chunk {
@@ -1310,7 +1679,7 @@ sub prepare_query_parameters {
$c->engine->prepare_query_parameters( $c, @_ );
if ( $c->debug && keys %{ $c->request->query_parameters } ) {
- my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] );
+ my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ 36, 'Value' ] );
for my $key ( sort keys %{ $c->req->query_parameters } ) {
my $param = $c->req->query_parameters->{$key};
my $value = defined($param) ? $param : '';
@@ -1350,8 +1719,8 @@ sub prepare_uploads {
if ( $c->debug && keys %{ $c->request->uploads } ) {
my $t = Text::SimpleTable->new(
- [ 12, 'Key' ],
- [ 28, 'Filename' ],
+ [ 12, 'Parameter' ],
+ [ 26, 'Filename' ],
[ 18, 'Type' ],
[ 9, 'Size' ]
);
@@ -1430,7 +1799,7 @@ sub setup_components {
my $callback = sub {
my ( $component, $context ) = @_;
- unless ( $component->isa('Catalyst::Component') ) {
+ unless ( $component->can('COMPONENT') ) {
return $component;
}
@@ -1439,7 +1808,7 @@ sub setup_components {
my $instance;
- eval { $instance = $component->new( $context, $config ); };
+ eval { $instance = $component->COMPONENT( $context, $config ); };
if ( my $error = $@ ) {
@@ -1450,7 +1819,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;
@@ -1506,11 +1875,8 @@ sub setup_dispatcher {
$dispatcher = $class->dispatcher_class;
}
- $dispatcher->require;
-
- if ($@) {
- Catalyst::Exception->throw(
- message => qq/Couldn't load dispatcher "$dispatcher", "$@"/ );
+ unless (Class::Inspector->loaded($dispatcher)) {
+ require Class::Inspector->filename($dispatcher);
}
# dispatcher instance
@@ -1538,7 +1904,7 @@ sub setup_engine {
$engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
}
- if ( !$engine && $ENV{MOD_PERL} ) {
+ if ( $ENV{MOD_PERL} ) {
# create the apache method
{
@@ -1554,21 +1920,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
@@ -1597,12 +1967,8 @@ sub setup_engine {
$engine = $class->engine_class;
}
- $engine->require;
-
- if ($@) {
- Catalyst::Exception->throw( message =>
-qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/
- );
+ unless (Class::Inspector->loaded($engine)) {
+ require Class::Inspector->filename($engine);
}
# check for old engines that are no longer compatible
@@ -1664,7 +2030,7 @@ sub setup_home {
if ($home) {
$class->config->{home} ||= $home;
- $class->config->{root} ||= dir($home)->subdir('root');
+ $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
}
}
@@ -1701,31 +2067,67 @@ Sets up plugins.
=cut
-sub setup_plugins {
- my ( $class, $plugins ) = @_;
+=head2 $c->registered_plugins
- $plugins ||= [];
- for my $plugin ( reverse @$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); >>.
- $plugin = "Catalyst::Plugin::$plugin";
+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.
- $plugin->require;
+ if ($c->registered_plugins('Some::Plugin')) {
+ ...
+ }
- if ($@) {
- Catalyst::Exception->throw(
- message => qq/Couldn't load plugin "$plugin", "$@"/ );
+=cut
+
+{
+
+ 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"};
+ }
+
+ sub _register_plugin {
+ my ( $proto, $plugin, $instant ) = @_;
+ my $class = ref $proto || $proto;
+
+ unless (Class::Inspector->loaded($plugin)) {
+ require Class::Inspector->filename($plugin);
}
- {
+ $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);
+ }
}
}
=head2 $c->stack
-Returns the stack.
+Returns an arrayref of the internal execution stack (actions that are currently
+executing).
=head2 $c->write( $data )
@@ -1842,6 +2244,8 @@ Wiki:
=head1 SEE ALSO
+=head2 L - All you need to start with Catalyst
+
=head2 L - The Catalyst Manual
=head2 L, L - Base classes for components
@@ -1876,6 +2280,8 @@ Autrijus Tang
Brian Cassidy
+Carl Franks
+
Christian Hansen
Christopher Hicks