X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=bed35031e2e49ebfa07423e2e90c1928bc1d27ca;hb=ebaf0dded48b6d0e2a98911562280d035e9cb807;hp=781736c25994478e6b2f35a4d86aa823dcaf9275;hpb=261c571ec577304a8a41218a4576675c8099069a;p=catagits%2FCatalyst-Runtime.git
diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 781736c..bed3503 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -1,28 +1,40 @@
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 Devel::InnerPackage ();
+use File::stat;
+use Module::Pluggable::Object;
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 depth request response state action namespace/
+ qw/counter request response state action stack namespace stats/
);
-attributes->import(__PACKAGE__, \&namespace, 'lvalue');
+attributes->import( __PACKAGE__, \&namespace, 'lvalue' );
+
+sub depth { scalar @{ shift->stack || [] }; }
# Laziness++
*comp = \&component;
@@ -38,15 +50,18 @@ our $START = time;
our $RECURSION = 1000;
our $DETACH = "catalyst_detach\n";
-require Module::Pluggable::Fast;
+__PACKAGE__->mk_classdata($_)
+ for qw/components arguments dispatcher engine log dispatcher_class
+ engine_class context_class request_class response_class setup_finished/;
-# Helper script generation
-our $CATALYST_SCRIPT_GEN = 10;
+__PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
+__PACKAGE__->engine_class('Catalyst::Engine::CGI');
+__PACKAGE__->request_class('Catalyst::Request');
+__PACKAGE__->response_class('Catalyst::Response');
-__PACKAGE__->mk_classdata($_)
- for qw/components arguments dispatcher engine log/;
+# Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.49_03';
+our $VERSION = '5.70_03';
sub import {
my ( $class, @arguments ) = @_;
@@ -59,7 +74,7 @@ sub import {
unless ( $caller->isa('Catalyst') ) {
no strict 'refs';
- push @{"$caller\::ISA"}, $class;
+ push @{"$caller\::ISA"}, $class, 'Catalyst::Controller';
}
$caller->arguments( [@arguments] );
@@ -72,447 +87,609 @@ 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
- cd MyApp
# add models, views, controllers
- script/myapp_create.pl model Something
- script/myapp_create.pl view Stuff
- script/myapp_create.pl controller Yada
+ 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
- # built in testserver
+ # built in testserver -- use -r to restart automatically on changes
script/myapp_server.pl
- # command line interface
+ # command line testing interface
script/myapp_test.pl /yada
+ ### in lib/MyApp.pm
+ use Catalyst qw/-Debug/; # include plugins here as well
+
+ ### 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
+ # lookup something from db -- stash vars are passed to TT
+ $c->stash->{data} =
+ $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
+ }
+ }
+
+ # The foo.tt TT template can use the stash data from the database
+ [% WHILE (item = data.next) %]
+ [% item.foo %]
+ [% END %]
+
+ # called for /bar/of/soap, /bar/of/soap/10, etc.
+ sub bar : Path('/bar/of/soap') { ... }
- use Catalyst;
-
- use Catalyst qw/My::Module My::OtherModule/;
-
- use Catalyst '-Debug';
-
- use Catalyst qw/-Debug -Engine=CGI/;
-
- sub default : Private { $_[1]->res->output('Hello') } );
-
- sub index : Path('/index.html') {
+ # called for all actions, from the top-most controller downwards
+ sub auto : Private {
+ my ( $self, $c ) = @_;
+ if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
+ $c->res->redirect( '/login' ); # require login
+ return 0; # abort request and go immediately to end()
+ }
+ return 1; # success; carry on to next action
+ }
+
+ # called after all actions are finished
+ sub end : Private {
my ( $self, $c ) = @_;
- $c->res->output('Hello');
- $c->forward('foo');
+ if ( scalar @{ $c->error } ) { ... } # handle errors
+ return if $c->res->body; # already have a response
+ $c->forward( 'MyApp::View::TT' ); # render template
}
- sub product : Regex('^product[_]*(\d*).html$') {
+ ### in MyApp/Controller/Foo.pm
+ # called for /foo/bar
+ sub bar : Local { ... }
+
+ # called for /blargle
+ sub blargle : Global { ... }
+
+ # an index action matches /foo, but not /foo/1, etc.
+ sub index : Private { ... }
+
+ ### in MyApp/Controller/Foo/Bar.pm
+ # called for /foo/bar/baz
+ sub baz : Local { ... }
+
+ # 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 ) = @_;
- $c->stash->{template} = 'product.tt';
- $c->stash->{product} = $c->req->snippets->[0];
+ # extract the (\w+) from the URI
+ my $product = $c->req->captures->[0];
}
-See also L
+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.
-Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
-Omit the C prefix from the plugin name,
-so C becomes C.
+Catalyst plugins can be loaded by naming them as arguments to the "use
+Catalyst" statement. Omit the C prefix from the
+plugin name, i.e., C becomes
+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 'My::Module';
+ use Catalyst qw/
+ My::Module
+ +Fully::Qualified::Plugin::Name
+ /;
-Special flags like -Debug and -Engine can also be specified as arguments when
-Catalyst is loaded:
+Special flags like C<-Debug> and C<-Engine> can also be specified as
+arguments when Catalyst is loaded:
use Catalyst qw/-Debug My::Module/;
-The position of plugins and flags in the chain is important, because they are
-loaded in exactly the order that they appear.
+The position of plugins and flags in the chain is important, because
+they are loaded in exactly the order in which they appear.
The following flags are supported:
-=over 4
+=head2 -Debug
-=item -Debug
+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.
-enables debug output, i.e.:
+=head2 -Engine
- use Catalyst '-Debug';
+Forces Catalyst to use a specific engine. Omit the
+C prefix of the engine name, i.e.:
-this is equivalent to:
+ use Catalyst qw/-Engine=CGI/;
- use Catalyst;
- sub debug { 1 }
+=head2 -Home
-=item -Dispatcher
+Forces Catalyst to use a specific home directory, e.g.:
-Force Catalyst to use a specific dispatcher.
+ use Catalyst qw[-Home=/usr/sri];
-=item -Engine
+=head2 -Log
-Force Catalyst to use a specific engine.
-Omit the C prefix of the engine name, i.e.:
+Specifies log level.
- use Catalyst '-Engine=CGI';
+=head1 METHODS
-=item -Home
+=head2 INFORMATION ABOUT THE CURRENT REQUEST
-Force Catalyst to use a specific home directory.
+=head2 $c->action
-=item -Log
+Returns a L object for the current action, which
+stringifies to the action name. See L.
-Specify log level.
+=head2 $c->namespace
-=back
+Returns the namespace of the current action, i.e., the uri prefix
+corresponding to the controller of the current action. For example:
-=head1 METHODS
+ # in Controller::Foo::Bar
+ $c->namespace; # returns 'foo/bar';
+
+=head2 $c->request
+
+=head2 $c->req
+
+Returns the current L object. See
+L.
-=over 4
+=head2 REQUEST FLOW HANDLING
-=item $c->action
+=head2 $c->forward( $action [, \@arguments ] )
-Accessor for the current action
+=head2 $c->forward( $class, $method, [, \@arguments ] )
-=item $c->comp($name)
+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.
-=item $c->component($name)
+Any data Ced from the action forwarded to, will be returned by the
+call to forward.
-Get a component object by name.
+ my $foodata = $c->forward('/foo');
+ $c->forward('index');
+ $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->comp('MyApp::Model::MyModel')->do_stuff;
+ $c->forward('foo') || return;
=cut
-sub component {
- my $c = shift;
+sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
- if (@_) {
+=head2 $c->detach( $action [, \@arguments ] )
- my $name = shift;
+=head2 $c->detach( $class, $method, [, \@arguments ] )
- my $appclass = ref $c || $c;
+The same as C, but doesn't return to the previous action when
+processing is finished.
- my @names = (
- $name, "${appclass}::${name}",
- map { "${appclass}::${_}::${name}" } qw/M V C/
- );
+=cut
- foreach my $try (@names) {
+sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
- if ( exists $c->components->{$try} ) {
+=head2 $c->response
- return $c->components->{$try};
- }
- }
+=head2 $c->res
- foreach my $component ( keys %{ $c->components } ) {
+Returns the current L object.
- return $c->components->{$component} if $component =~ /$name/i;
- }
+=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.
- return sort keys %{ $c->components };
+ $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};
}
-=item config
+=head2 $c->error
-Returns a hashref containing your applications settings.
+=head2 $c->error($error, ...)
-=cut
+=head2 $c->error($arrayref)
-=item $c->controller($name)
+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.
-Get a L instance by name.
+ my @error = @{ $c->error };
- $c->controller('Foo')->do_stuff;
+Add a new error.
+
+ $c->error('Something bad happened');
=cut
-sub controller {
- my ( $c, $name ) = @_;
- my $controller = $c->comp("Controller::$name");
- return $controller if $controller;
- return $c->comp("C::$name");
+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} || [];
}
-=item debug
-Overload to enable debug messages.
+=head2 $c->state
-=cut
+Contains the return value of the last executed action.
-sub debug { 0 }
+=head2 $c->clear_errors
-=item $c->detach( $command [, \@arguments ] )
+Clear errors. You probably don't want to clear the errors unless you are
+implementing a custom error screen.
-Like C but doesn't return.
+This is equivalent to running
+
+ $c->error(0);
=cut
-sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
+sub clear_errors {
+ my $c = shift;
+ $c->error(0);
+}
-=item $c->dispatcher
-Contains the dispatcher instance.
-Stringifies to class.
-=item $c->forward( $command [, \@arguments ] )
-Forward processing to a private action or a method from a class.
-If you define a class without method it will default to process().
-also takes an optional arrayref containing arguments to be passed
-to the new function. $c->req->args will be reset upon returning
-from the function.
+# search via regex
+sub _comp_search {
+ my ( $c, @names ) = @_;
- $c->forward('/foo');
- $c->forward('index');
- $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
- $c->forward('MyApp::View::TT');
+ foreach my $name (@names) {
+ foreach my $component ( keys %{ $c->components } ) {
+ return $c->components->{$component} if $component =~ /$name/i;
+ }
+ }
+
+ return undef;
+}
+
+# try explicit component names
+sub _comp_explicit {
+ my ( $c, @names ) = @_;
+
+ foreach my $try (@names) {
+ return $c->components->{$try} if ( exists $c->components->{$try} );
+ }
+
+ 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;
+}
+
+# Find possible names for a prefix
+
+sub _comp_names {
+ my ( $c, @prefixes ) = @_;
+
+ my $appclass = ref $c || $c;
+
+ my @pre = map { "${appclass}::${_}::" } @prefixes;
+
+ my @names;
+
+ COMPONENT: foreach my $comp ($c->component) {
+ foreach my $p (@pre) {
+ if ($comp =~ s/^$p//) {
+ push(@names, $comp);
+ next COMPONENT;
+ }
+ }
+ }
+
+ return @names;
+}
+
+# Return a component if only one matches.
+sub _comp_singular {
+ my ( $c, @prefixes ) = @_;
+
+ my $appclass = ref $c || $c;
+
+ 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 forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) }
+sub controller {
+ my ( $c, $name, @args ) = @_;
+ return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ),
+ @args )
+ if ($name);
+ return $c->component( $c->action->class );
+}
-=item $c->model($name)
+=head2 $c->model($name)
-Get a L instance by name.
+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 );
+
}
-=item $c->namespace
+=head2 $c->controllers
-Accessor to the namespace of the current action
+Returns the available names which can be passed to $c->controller
-=item $c->path_to(@path)
+=cut
-Merges C<@path> with $c->config->{home} and returns a L object.
+sub controllers {
+ my ( $c ) = @_;
+ return $c->_comp_names(qw/Controller C/);
+}
-For example:
- $c->path_to( 'db', 'sqlite.db' );
+=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 path_to {
- my ( $c, @path ) = @_;
- my $path = dir( $c->config->{home}, @path );
- if ( -d $path ) { return $path }
- else { return file( $c->config->{home}, @path ) }
+sub view {
+ 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/) );
}
-=item $c->setup
+=head2 $c->models
-Setup.
-
- $c->setup;
+Returns the available names which can be passed to $c->model
=cut
-sub setup {
- my ( $class, @arguments ) = @_;
-
- unless ( $class->isa('Catalyst') ) {
+sub models {
+ my ( $c ) = @_;
+ return $c->_comp_names(qw/Model M/);
+}
- Catalyst::Exception->throw(
- message => qq/'$class' does not inherit from Catalyst/ );
- }
- if ( $class->arguments ) {
- @arguments = ( @arguments, @{ $class->arguments } );
- }
+=head2 $c->views
- # Process options
- my $flags = {};
+Returns the available names which can be passed to $c->view
- foreach (@arguments) {
+=cut
- if (/^-Debug$/) {
- $flags->{log} =
- ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
- }
- elsif (/^-(\w+)=?(.*)$/) {
- $flags->{ lc $1 } = $2;
- }
- else {
- push @{ $flags->{plugins} }, $_;
- }
- }
+sub views {
+ my ( $c ) = @_;
+ return $c->_comp_names(qw/View V/);
+}
- $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} );
+=head2 $c->comp($name)
- for my $flag ( sort keys %{$flags} ) {
+=head2 $c->component($name)
- if ( my $code = $class->can( 'setup_' . $flag ) ) {
- &$code( $class, delete $flags->{$flag} );
- }
- else {
- $class->log->warn(qq/Unknown flag "$flag"/);
- }
- }
+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.
- $class->log->warn( "You are running an old helper script! "
- . "Please update your scripts by regenerating the "
- . "application and copying over the new scripts." )
- if ( $ENV{CATALYST_SCRIPT_GEN}
- && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) );
+=cut
- if ( $class->debug ) {
+sub component {
+ my $c = shift;
- my @plugins = ();
+ if (@_) {
- {
- no strict 'refs';
- @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"};
- }
+ my $name = shift;
- if (@plugins) {
- my $t = Text::SimpleTable->new(76);
- $t->row($_) for @plugins;
- $class->log->debug( "Loaded plugins:\n" . $t->draw );
- }
+ my $appclass = ref $c || $c;
- my $dispatcher = $class->dispatcher;
- my $engine = $class->engine;
- my $home = $class->config->{home};
+ my @names = (
+ $name, "${appclass}::${name}",
+ map { "${appclass}::${_}::${name}" }
+ qw/Model M Controller C View V/
+ );
- $class->log->debug(qq/Loaded dispatcher "$dispatcher"/);
- $class->log->debug(qq/Loaded engine "$engine"/);
+ my $comp = $c->_comp_explicit(@names);
+ return $c->_filter_component( $comp, @_ ) if defined($comp);
- $home
- ? ( -d $home )
- ? $class->log->debug(qq/Found home "$home"/)
- : $class->log->debug(qq/Home "$home" doesn't exist/)
- : $class->log->debug(q/Couldn't find home/);
+ $comp = $c->_comp_search($name);
+ return $c->_filter_component( $comp, @_ ) if defined($comp);
}
- # Call plugins setup
- {
- no warnings qw/redefine/;
- local *setup = sub { };
- $class->setup;
- }
+ return sort keys %{ $c->components };
+}
- # Initialize our data structure
- $class->components( {} );
- $class->setup_components;
- if ( $class->debug ) {
- my $t = Text::SimpleTable->new(76);
- $t->row($_) for sort keys %{ $class->components };
- $class->log->debug( "Loaded components:\n" . $t->draw )
- if ( keys %{ $class->components } );
- }
+=head2 CLASS DATA AND HELPER CLASSES
- # Add our self to components, since we are also a component
- $class->components->{$class} = $class;
+=head2 $c->config
- $class->setup_actions;
+Returns or takes a hashref containing the application's configuration.
- if ( $class->debug ) {
- my $name = $class->config->{name} || 'Application';
- $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
- }
- $class->log->_flush() if $class->log->can('_flush');
-}
+ __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
-=item $c->uri_for($path,[@args])
+You can also use a L config file like myapp.yml in your
+applications home directory.
+
+ ---
+ db: dsn:SQLite:foo.db
-Merges path with $c->request->base for absolute uri's and with
-$c->request->match for relative uri's, then returns a normalized
-L object. If any args are passed, they are added at the end
-of the path.
=cut
-sub uri_for {
- my ( $c, $path, @args ) = @_;
- my $base = $c->request->base->clone;
- my $basepath = $base->path;
- $basepath =~ s/\/$//;
- $basepath .= '/';
- my $match = $c->request->match;
+sub config {
+ my $c = shift;
- # massage match, empty if absolute path
- $match =~ s/^\///;
- $match .= '/' if $match;
- $path ||= '';
- $match = '' if $path =~ /^\//;
- $path =~ s/^\///;
+ $c->log->warn("Setting config after setup has been run is not a good idea.")
+ if ( @_ and $c->setup_finished );
- # join args with '/', or a blank string
- my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
- return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ),
- $base )->canonical;
+ $c->NEXT::config(@_);
}
-=item $c->error
+=head2 $c->log
-=item $c->error($error, ...)
+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 >>.
-=item $c->error($arrayref)
+ __PACKAGE__->log( MyLogger->new );
+ __PACKAGE__->setup;
-Returns an arrayref containing error messages.
+And later:
- my @error = @{ $c->error };
+ $c->log->info( 'Now logging with my own logger!' );
-Add a new error.
+Your log class should implement the methods described in the
+L man page.
- $c->error('Something bad happened');
-Clean errors.
+=head2 $c->debug
- $c->error(0);
+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 error {
- my $c = shift;
- if ( $_[0] ) {
- my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
- push @{ $c->{error} }, @$error;
- }
- elsif ( defined $_[0] ) { $c->{error} = undef }
- return $c->{error} || [];
-}
+sub debug { 0 }
+
+=head2 $c->dispatcher
+
+Returns the dispatcher instance. Stringifies to class name. See
+L.
+
+=head2 $c->engine
-=item $c->engine
+Returns the engine instance. Stringifies to the class name. See
+L.
-Contains the engine instance.
-Stringifies to the class.
-=item $c->log
+=head2 UTILITY METHODS
-Contains the logging object. Unless it is already set Catalyst sets this up with a
-C object. To use your own log class:
+=head2 $c->path_to(@path)
- $c->log( MyLogger->new );
- $c->log->info("now logging with my own logger!");
+Merges C<@path> with C<$c-Econfig-E{home}> and returns a
+L object.
-Your log class should implement the methods described in the C
-man page.
+For example:
+
+ $c->path_to( 'db', 'sqlite.db' );
+
+=cut
+
+sub path_to {
+ my ( $c, @path ) = @_;
+ my $path = Path::Class::Dir->new( $c->config->{home}, @path );
+ if ( -d $path ) { return $path }
+ else { return Path::Class::File->new( $c->config->{home}, @path ) }
+}
-=item $c->plugin( $name, $class, @args )
+=head2 $c->plugin( $name, $class, @args )
-Instant plugins for Catalyst.
-Classdata accessor/mutator will be created, class loaded and instantiated.
+Helper method for plugins. It creates a classdata accessor/mutator and
+loads and instantiates the given class.
MyApp->plugin( 'prototype', 'HTML::Prototype' );
@@ -522,12 +699,7 @@ Classdata accessor/mutator will be created, class loaded and instantiated.
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);
@@ -539,75 +711,206 @@ sub plugin {
qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
}
- $class->$name($obj);
- $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
- if $class->debug;
-}
-
-=item $c->request
+ $class->$name($obj);
+ $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
+ if $class->debug;
+}
+
+=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
+of plugins to load here, if you choose to not load them in the C
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.
@@ -752,129 +1054,231 @@ perldoc components
-sub benchmark {
- my $c = shift;
- my $code = shift;
- my $time = [gettimeofday];
- my @return = &$code(@_);
- my $elapsed = tv_interval $time;
- return wantarray ? ( $elapsed, @return ) : $elapsed;
-}
+Returns a hash of components.
-=item $c->components
+=head2 $c->context_class
-Contains the components.
+Returns or sets the context class.
-=item $c->counter
+=head2 $c->counter
-Returns a hashref containing coderefs and execution counts.
-(Needed for deep recursion detection)
+Returns a hashref containing coderefs and execution counts (needed for
+deep recursion detection).
-=item $c->depth
+=head2 $c->depth
-Returns the actual forward depth.
+Returns the number of actions on the current internal execution stack.
-=item $c->dispatch
+=head2 $c->dispatch
-Dispatch request to actions.
+Dispatches a request to actions.
=cut
sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
-=item dump_these
+=head2 $c->dispatcher_class
+
+Returns or sets the dispatcher class.
+
+=head2 $c->dump_these
-Returns a list of 2-element array references (name, structure) pairs that will
-be dumped on the error page in debug mode.
+Returns a list of 2-element array references (name, structure) pairs
+that will be dumped on the error page in debug mode.
=cut
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 ];
}
-=item $c->execute($class, $coderef)
+=head2 $c->engine_class
-Execute a coderef in given class and catch exceptions.
-Errors are available via $c->error.
+Returns or sets the engine class.
+
+=head2 $c->execute( $class, $coderef )
+
+Execute a coderef in given class and catch exceptions. Errors are available
+via $c->error.
=cut
sub execute {
my ( $c, $class, $code ) = @_;
- $class = $c->components->{$class} || $class;
+ $class = $c->component($class) || $class;
$c->state(0);
- my $callsub = ( 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;
+ }
+
+ my $stats_info = $c->_stats_start_execute( $code );
+
+ push( @{ $c->stack }, $code );
+
+ eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) };
- if ( $c->counter->{"$code"} > $RECURSION ) {
- my $error = qq/Deep recursion detected in "$action"/;
- $c->log->error($error);
+ $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;
+ my $class = $last->class;
+ my $name = $last->name;
+ $error = qq/Caught exception in $class->$name "$error"/;
+ }
$c->error($error);
$c->state(0);
- return $c->state;
}
+ }
+ return $c->state;
+}
+
+sub _stats_start_execute {
+ my ( $c, $code ) = @_;
+
+ return unless $c->debug;
- $action = "-> $action" if $callsub =~ /forward$/;
+ 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;
+ }
}
- $c->{depth}++;
- eval {
- if ( $c->debug )
+
+ my $node = Tree::Simple->new(
{
- my ( $elapsed, @state ) =
- $c->benchmark( $code, $class, $c, @{ $c->req->args } );
- unless ( ( $code->name =~ /^_.*/ )
- && ( !$c->config->{show_internal_actions} ) )
- {
- push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
+ 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);
}
- $c->state(@state);
}
else {
- $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 );
+
+ # root-level call
+ $c->stats->addChild($node);
}
- };
- $c->{depth}--;
+ }
- if ( my $error = $@ ) {
+ my $start = [gettimeofday];
+ my $elapsed = tv_interval($start);
- if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 }
- else {
- unless ( ref $error ) {
- chomp $error;
- $error = qq/Caught exception "$error"/;
- }
- $c->error($error);
- $c->state(0);
+ 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;
}
- return $c->state;
}
-=item $c->finalize
+=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
-Finalize request.
+Finalizes the request.
=cut
@@ -885,52 +1289,59 @@ 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;
}
-=item $c->finalize_body
+=head2 $c->finalize_body
-Finalize body.
+Finalizes body.
=cut
sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
-=item $c->finalize_cookies
+=head2 $c->finalize_cookies
-Finalize cookies.
+Finalizes cookies.
=cut
sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
-=item $c->finalize_error
+=head2 $c->finalize_error
-Finalize error.
+Finalizes error.
=cut
sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
-=item $c->finalize_headers
+=head2 $c->finalize_headers
-Finalize headers.
+Finalizes headers.
=cut
@@ -948,7 +1359,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
@@ -965,45 +1389,46 @@ 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
-Finalize the input after reading is complete.
+Finalizes the input after reading is complete.
=cut
sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
-=item $c->finalize_uploads
+=head2 $c->finalize_uploads
-Finalize uploads. Cleans up any temporary files.
+Finalizes uploads. Cleans up any temporary files.
=cut
sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
-=item $c->get_action( $action, $namespace )
+=head2 $c->get_action( $action, $namespace )
-Get an action in a given namespace.
+Gets an action in a given namespace.
=cut
-sub get_action { my $c = shift; $c->dispatcher->get_action( @_ ) }
+sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
-=item $c->get_actions( $action, $namespace )
+=head2 $c->get_actions( $action, $namespace )
-Get all actions of a given name in a namespace and all base namespaces.
+Gets all actions of a given name in a namespace and all parent
+namespaces.
=cut
sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
-=item handle_request( $class, @arguments )
+=head2 $c->handle_request( $class, @arguments )
-Handles the request.
+Called to handle each HTTP request.
=cut
@@ -1013,24 +1438,33 @@ 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;
};
if ( $class->debug ) {
- my $elapsed;
- ( $elapsed, $status ) = $class->benchmark($handler);
+ my $start = [gettimeofday];
+ $status = &$handler;
+ my $elapsed = tv_interval $start;
$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 );
}
@@ -1048,43 +1482,46 @@ sub handle_request {
return $status;
}
-=item $c->prepare(@arguments)
+=head2 $c->prepare( @arguments )
-Turns the engine-specific request( Apache, CGI ... )
-into a Catalyst context .
+Creates a Catalyst context from an engine-specific request (Apache, CGI,
+etc.).
=cut
sub prepare {
my ( $class, @arguments ) = @_;
- my $c = bless {
- counter => {},
- depth => 0,
- request => Catalyst::Request->new(
- {
- arguments => [],
- body_parameters => {},
- cookies => {},
- headers => HTTP::Headers->new,
- parameters => {},
- query_parameters => {},
- secure => 0,
- snippets => [],
- uploads => {}
- }
- ),
- response => Catalyst::Response->new(
- {
- body => '',
- cookies => {},
- headers => HTTP::Headers->new(),
- status => 200
- }
- ),
- stash => {},
- state => 0
- }, $class;
+ $class->context_class( ref $class || $class ) unless $class->context_class;
+ my $c = $class->context_class->new(
+ {
+ counter => {},
+ stack => [],
+ request => $class->request_class->new(
+ {
+ arguments => [],
+ body_parameters => {},
+ cookies => {},
+ headers => HTTP::Headers->new,
+ parameters => {},
+ query_parameters => {},
+ secure => 0,
+ captures => [],
+ uploads => {}
+ }
+ ),
+ response => $class->response_class->new(
+ {
+ body => '',
+ cookies => {},
+ headers => HTTP::Headers->new(),
+ status => 200
+ }
+ ),
+ stash => {},
+ state => 0
+ }
+ );
# For on-demand data
$c->request->{_context} = $c;
@@ -1095,44 +1532,50 @@ 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};
+ }
- $c->prepare_action;
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/)
+ $c->log->debug(qq/"$method" request for "$path" from "$address"/)
if $c->debug;
+ $c->prepare_action;
+
return $c;
}
-=item $c->prepare_action
+=head2 $c->prepare_action
-Prepare action.
+Prepares action. See L.
=cut
sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
-=item $c->prepare_body
+=head2 $c->prepare_body
-Prepare message body.
+Prepares message body.
=cut
@@ -1148,7 +1591,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 : '';
@@ -1159,9 +1602,11 @@ 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.
-Prepare a chunk of data before sending it to HTTP::Body.
+See L.
=cut
@@ -1170,9 +1615,9 @@ sub prepare_body_chunk {
$c->engine->prepare_body_chunk( $c, @_ );
}
-=item $c->prepare_body_parameters
+=head2 $c->prepare_body_parameters
-Prepare body parameters.
+Prepares body parameters.
=cut
@@ -1181,9 +1626,9 @@ sub prepare_body_parameters {
$c->engine->prepare_body_parameters( $c, @_ );
}
-=item $c->prepare_connection
+=head2 $c->prepare_connection
-Prepare connection.
+Prepares connection.
=cut
@@ -1192,25 +1637,25 @@ sub prepare_connection {
$c->engine->prepare_connection( $c, @_ );
}
-=item $c->prepare_cookies
+=head2 $c->prepare_cookies
-Prepare cookies.
+Prepares cookies.
=cut
sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
-=item $c->prepare_headers
+=head2 $c->prepare_headers
-Prepare headers.
+Prepares headers.
=cut
sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
-=item $c->prepare_parameters
+=head2 $c->prepare_parameters
-Prepare parameters.
+Prepares parameters.
=cut
@@ -1220,17 +1665,17 @@ sub prepare_parameters {
$c->engine->prepare_parameters( $c, @_ );
}
-=item $c->prepare_path
+=head2 $c->prepare_path
-Prepare path and base.
+Prepares path and base.
=cut
sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
-=item $c->prepare_query_parameters
+=head2 $c->prepare_query_parameters
-Prepare query parameters.
+Prepares query parameters.
=cut
@@ -1240,7 +1685,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 : '';
@@ -1251,25 +1696,25 @@ sub prepare_query_parameters {
}
}
-=item $c->prepare_read
+=head2 $c->prepare_read
-Prepare the input for reading.
+Prepares the input for reading.
=cut
sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
-=item $c->prepare_request
+=head2 $c->prepare_request
-Prepare the engine request.
+Prepares the engine request.
=cut
sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
-=item $c->prepare_uploads
+=head2 $c->prepare_uploads
-Prepare uploads.
+Prepares uploads.
=cut
@@ -1280,8 +1725,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' ]
);
@@ -1295,27 +1740,36 @@ sub prepare_uploads {
}
}
-=item $c->prepare_write
+=head2 $c->prepare_write
-Prepare the output for writing.
+Prepares the output for writing.
=cut
sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
-=item $c->read( [$maxlength] )
+=head2 $c->request_class
+
+Returns or sets the request class.
+
+=head2 $c->response_class
+
+Returns or sets the response class.
+
+=head2 $c->read( [$maxlength] )
-Read a chunk of data from the request body. This method is designed to be
-used in a while loop, reading $maxlength bytes on every call. $maxlength
-defaults to the size of the request if not specified.
+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.
+C<$maxlength> defaults to the size of the request if not specified.
-You have to set MyApp->config->{parse_on_demand} to use this directly.
+You have to set Cconfig-E{parse_on_demand}> to use this
+directly.
=cut
sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
-=item $c->run
+=head2 $c->run
Starts the engine.
@@ -1323,86 +1777,96 @@ 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 )
-Set an action in a given namespace.
+Sets an action in a given namespace.
=cut
sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
-=item $c->setup_actions($component)
+=head2 $c->setup_actions($component)
-Setup actions for a component.
+Sets up actions for a component.
=cut
sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
-=item $c->setup_components
+=head2 $c->setup_components
-Setup components.
+Sets up components. Specify a C config option to pass additional options
+directly to L. To add additional search paths, specify a key named
+C as an array reference. Items in the array beginning with C<::> will have the
+application class name prepended to them.
=cut
sub setup_components {
my $class = shift;
- my $callback = sub {
- my ( $component, $context ) = @_;
-
- unless ( $component->isa('Catalyst::Component') ) {
- return $component;
+ my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
+ my $config = $class->config->{ setup_components };
+ my $extra = delete $config->{ search_extra } || [];
+
+ push @paths, @$extra;
+
+ my $locator = Module::Pluggable::Object->new(
+ search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
+ %$config
+ );
+
+ for my $component ( sort { length $a <=> length $b } $locator->plugins ) {
+ Catalyst::Utils::ensure_class_loaded( $component );
+
+ my $module = $class->setup_component( $component );
+ my %modules = (
+ $component => $module,
+ map {
+ $_ => $class->setup_component( $_ )
+ } Devel::InnerPackage::list_packages( $component )
+ );
+
+ for my $key ( keys %modules ) {
+ $class->components->{ $key } = $modules{ $key };
}
+ }
+}
- my $suffix = Catalyst::Utils::class2classsuffix($class);
- my $config = $class->config->{$suffix} || {};
-
- my $instance;
-
- eval { $instance = $component->new( $context, $config ); };
+=head2 $c->setup_component
- if ( my $error = $@ ) {
+=cut
- chomp $error;
+sub setup_component {
+ my( $class, $component ) = @_;
- Catalyst::Exception->throw( message =>
- qq/Couldn't instantiate component "$component", "$error"/ );
- }
+ unless ( $component->can( 'COMPONENT' ) ) {
+ return $component;
+ }
- Catalyst::Exception->throw( message =>
-qq/Couldn't instantiate component "$component", "new() didn't return a object"/
- )
- unless ref $instance;
- return $instance;
- };
+ my $suffix = Catalyst::Utils::class2classsuffix( $component );
+ my $config = $class->config->{ $suffix } || {};
- eval {
- Module::Pluggable::Fast->import(
- name => '_catalyst_components',
- search => [
- "$class\::Controller", "$class\::C",
- "$class\::Model", "$class\::M",
- "$class\::View", "$class\::V"
- ],
- callback => $callback
- );
- };
+ my $instance = eval { $component->COMPONENT( $class, $config ); };
if ( my $error = $@ ) {
-
chomp $error;
-
Catalyst::Exception->throw(
- message => qq/Couldn't load components "$error"/ );
+ message => qq/Couldn't instantiate component "$component", "$error"/
+ );
}
- for my $component ( $class->_catalyst_components($class) ) {
- $class->components->{ ref $component || $component } = $component;
- }
+ Catalyst::Exception->throw(
+ message =>
+ qq/Couldn't instantiate component "$component", "COMPONENT() didn't return an object-like value"/
+ ) unless eval { $instance->can( 'can' ) };
+
+ return $instance;
}
-=item $c->setup_dispatcher
+=head2 $c->setup_dispatcher
+
+Sets up dispatcher.
=cut
@@ -1423,21 +1887,20 @@ sub setup_dispatcher {
}
unless ($dispatcher) {
- $dispatcher = 'Catalyst::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
$class->dispatcher( $dispatcher->new );
}
-=item $c->setup_engine
+=head2 $c->setup_engine
+
+Sets up engine.
=cut
@@ -1456,7 +1919,7 @@ sub setup_engine {
$engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' };
}
- if ( !$engine && $ENV{MOD_PERL} ) {
+ if ( $ENV{MOD_PERL} ) {
# create the apache method
{
@@ -1472,21 +1935,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
@@ -1512,15 +1979,11 @@ sub setup_engine {
}
unless ($engine) {
- $engine = 'Catalyst::Engine::CGI';
+ $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
@@ -1559,7 +2022,9 @@ 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.
=cut
@@ -1580,11 +2045,13 @@ 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');
}
}
-=item $c->setup_log
+=head2 $c->setup_log
+
+Sets up log.
=cut
@@ -1609,37 +2076,79 @@ 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
- $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);
+ }
}
}
-=item $c->write( $data )
+=head2 $c->stack
+
+Returns an arrayref of the internal execution stack (actions that are currently
+executing).
+
+=head2 $c->write( $data )
-Writes $data to the output stream. When using this method directly, you will
-need to manually set the Content-Length header to the length of your output
-data, if known.
+Writes $data to the output stream. When using this method directly, you
+will need to manually set the C header to the length of
+your output data, if known.
=cut
@@ -1652,70 +2161,66 @@ 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.
+Returns the Catalyst version number. Mostly useful for "powered by"
+messages in template systems.
=cut
sub version { return $Catalyst::VERSION }
-=back
-
=head1 INTERNAL ACTIONS
-Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>
-C<_ACTION> and C<_END>, these are by default not shown in the private
-action table.
-
-But you can deactivate this with a config parameter.
+Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
+C<_ACTION>, and C<_END>. These are by default not shown in the private
+action table, but you can make them visible with a config parameter.
MyApp->config->{show_internal_actions} = 1;
=head1 CASE SENSITIVITY
-By default Catalyst is not case sensitive, so C becomes
-C.
-
-But you can activate case sensitivity with a config parameter.
+By default Catalyst is not case sensitive, so C is
+mapped to C. You can activate case sensitivity with a config
+parameter.
MyApp->config->{case_sensitive} = 1;
-So C becomes C.
+This causes C to map to C.
=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
+but if you want to handle input yourself or speed things up a bit,
you can enable on-demand parsing with a config parameter.
MyApp->config->{parse_on_demand} = 1;
=head1 PROXY SUPPORT
-Many production servers operate using the common double-server approach, with
-a lightweight frontend web server passing requests to a larger backend
-server. An application running on the backend server must deal with two
-problems: the remote user always appears to be '127.0.0.1' and the server's
-hostname will appear to be 'localhost' regardless of the virtual host the
-user connected through.
+Many production servers operate using the common double-server approach,
+with a lightweight frontend web server passing requests to a larger
+backend server. An application running on the backend server must deal
+with two problems: the remote user always appears to be C<127.0.0.1> and
+the server's hostname will appear to be C regardless of the
+virtual host that the user connected through.
-Catalyst will automatically detect this situation when you are running both
-the frontend and backend servers on the same machine. The following changes
-are made to the request.
+Catalyst will automatically detect this situation when you are running
+the frontend and backend servers on the same machine. The following
+changes are made to the request.
- $c->req->address is set to the user's real IP address, as read from the
- HTTP_X_FORWARDED_FOR header.
+ $c->req->address is set to the user's real IP address, as read from
+ the HTTP X-Forwarded-For header.
- The host value for $c->req->base and $c->req->uri is set to the real host,
- as read from the HTTP_X_FORWARDED_HOST header.
+ The host value for $c->req->base and $c->req->uri is set to the real
+ host, as read from the HTTP X-Forwarded-Host header.
-Obviously, your web server must support these 2 headers for this to work.
+Obviously, your web server must support these headers for this to work.
-In a more complex server farm environment where you may have your frontend
-proxy server(s) on different machines, you will need to set a configuration
-option to tell Catalyst to read the proxied data from the headers.
+In a more complex server farm environment where you may have your
+frontend proxy server(s) on different machines, you will need to set a
+configuration option to tell Catalyst to read the proxied data from the
+headers.
MyApp->config->{using_frontend_proxy} = 1;
@@ -1726,12 +2231,12 @@ If you do not wish to use the proxy support at all, you may set:
=head1 THREAD SAFETY
Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
-and the standalone forking HTTP server on Windows. We believe the Catalyst
+and the standalone forking HTTP server on Windows. We believe the Catalyst
core to be thread-safe.
If you plan to operate in a threaded environment, remember that all other
-modules you are using must also be thread-safe. Some modules, most notably
-DBD::SQLite, are not thread-safe.
+modules you are using must also be thread-safe. Some modules, most notably
+L, are not thread-safe.
=head1 SUPPORT
@@ -1739,7 +2244,7 @@ IRC:
Join #catalyst on irc.perl.org.
-Mailing-Lists:
+Mailing Lists:
http://lists.rawmode.org/mailman/listinfo/catalyst
http://lists.rawmode.org/mailman/listinfo/catalyst-dev
@@ -1748,23 +2253,27 @@ Web:
http://catalyst.perl.org
+Wiki:
+
+ http://dev.catalyst.perl.org
+
=head1 SEE ALSO
-=over 4
+=head2 L - All you need to start with Catalyst
-=item L - The Catalyst Manual
+=head2 L - The Catalyst Manual
-=item L - Core Engine
+=head2 L, L - Base classes for components
-=item L - The Log Class.
+=head2 L - Core engine
-=item L - The Request Object
+=head2 L - Log class.
-=item L - The Response Object
+=head2 L - Request object
-=item L - The test suite.
+=head2 L - Response object
-=back
+=head2 L - The test suite.
=head1 CREDITS
@@ -1786,6 +2295,8 @@ Autrijus Tang
Brian Cassidy
+Carl Franks
+
Christian Hansen
Christopher Hicks
@@ -1794,8 +2305,12 @@ Dan Sully
Danijel Milicevic
+David Kamholz
+
David Naughton
+Drew Taylor
+
Gary Ashton Jones
Geoff Richards