X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=4cf485d0e99a0685744f7dab227f139c86aef751;hp=1adf5576a326670f32394729986e12a5c4a64471;hb=cc95842fedcac58b2dc12c6ce547e22d3170351c;hpb=8767c5a3e3e357113d0092cef50d81f358be8b92 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 1adf557..4cf485d 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,25 +1,35 @@ 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 Text::SimpleTable (); +use Path::Class::Dir (); +use Path::Class::File (); use Time::HiRes qw/gettimeofday tv_interval/; -use URI; -use Scalar::Util qw/weaken/; +use URI (); +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' ); @@ -40,21 +50,18 @@ our $START = time; our $RECURSION = 1000; our $DETACH = "catalyst_detach\n"; -require Module::Pluggable::Fast; - -# Helper script generation -our $CATALYST_SCRIPT_GEN = 10; - __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.49_03'; +# Remember to update this in Catalyst::Runtime as well! + +our $VERSION = '5.7006'; sub import { my ( $class, @arguments ) = @_; @@ -67,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] ); @@ -80,545 +87,871 @@ Catalyst - The Elegant MVC Web Application Framework =head1 SYNOPSIS - # use the helper to start a new application + # Install Catalyst::Devel for helpers and other development tools + # 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 MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db + script/myapp_create.pl view MyTemplate TT + script/myapp_create.pl controller Search - # built in testserver + # built in testserver -- use -r to restart automatically on changes + # --help to see all available options 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/; - use Catalyst 'My::Module'; +If your plugin starts with a name other than C, you can +fully qualify the name by using a unary plus: -Special flags like -Debug and -Engine can also be specified as arguments when -Catalyst is loaded: + 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: 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 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 application, with _DEBUG having the 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/mst]; -=item -Engine +This can also be done in the shell environment by setting either the +C environment variable or C; where C +is replaced with the uppercased name of your application, any "::" in +the name will be replaced with underscores, e.g. MyApp::Web should use +MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used. -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +=head2 -Log - use Catalyst '-Engine=CGI'; +Specifies log level. -=item -Home +=head1 METHODS -Force Catalyst to use a specific home directory. +=head2 INFORMATION ABOUT THE CURRENT REQUEST -=item -Log +=head2 $c->action -Specify log level. +Returns a L object for the current action, which +stringifies to the action name. See L. -=back +=head2 $c->namespace -=head1 METHODS +Returns the namespace of the current action, i.e., the URI prefix +corresponding to the controller of the current action. For example: -=over 4 + # in Controller::Foo::Bar + $c->namespace; # returns 'foo/bar'; -=item $c->action +=head2 $c->request -Accessor for the current action +=head2 $c->req -=item $c->comp($name) +Returns the current L object, giving access to +information about the current client request (including parameters, +cookies, HTTP headers, etc.). See L. -=item $c->component($name) +=head2 REQUEST FLOW HANDLING -Get a component object by name. +=head2 $c->forward( $action [, \@arguments ] ) - $c->comp('MyApp::Model::MyModel')->do_stuff; +=head2 $c->forward( $class, $method, [, \@arguments ] ) + +Forwards processing to another action, by its 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->req->args >>. Upon returning from the function, +C<< $c->req->args >> will be restored to the previous values. + +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::DBIC::Foo do_stuff/); + $c->forward('MyApp::View::TT'); + +Note that forward implies an C<> around the call (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 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; +=head2 $c->detach() - my @names = ( - $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } qw/M V C/ - ); +The same as C, but doesn't return to the previous action when +processing is finished. - foreach my $try (@names) { +When called with no arguments it escapes the processing chain entirely. - if ( exists $c->components->{$try} ) { +=cut - return $c->components->{$try}; - } +sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } + +=head2 $c->response + +=head2 $c->res + +Returns the current L object, see there for details. + +=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 (for this you must use a session; see +L for a complete system integrated with +Catalyst). + + $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::View::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}; +} - foreach my $component ( keys %{ $c->components } ) { +=head2 $c->error + +=head2 $c->error($error, ...) + +=head2 $c->error($arrayref) + +Returns an arrayref containing error messages. If Catalyst encounters an +error while processing a request, it stores the error in $c->error. This +method should not be used to store non-fatal error messages. + + my @error = @{ $c->error }; + +Add a new error. + + $c->error('Something bad happened'); + +=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->state + +Contains the return value of the last executed action. + +=head2 $c->clear_errors + +Clear errors. You probably don't want to clear the errors unless you are +implementing a custom error screen. + +This is equivalent to running + + $c->error(0); + +=cut + +sub clear_errors { + my $c = shift; + $c->error(0); +} + + +# search via regex +sub _comp_search { + my ( $c, @names ) = @_; + 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 sort keys %{ $c->components }; + return undef; } -=item config +# 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 ) = @_; -Returns a hashref containing your applications settings. + my $appclass = ref $c || $c; -=cut + my @names = map { "${appclass}::${_}::${name}" } @prefixes; -=item $c->controller($name) + my $comp = $c->_comp_explicit(@names); + return $comp if defined($comp); + $comp = $c->_comp_search($name); + return $comp; +} -Get a L instance by name. +# Find possible names for a prefix - $c->controller('Foo')->do_stuff; +sub _comp_names { + my ( $c, @prefixes ) = @_; -=cut + my $appclass = ref $c || $c; -sub controller { - my ( $c, $name ) = @_; - my $controller = $c->comp("Controller::$name"); - return $controller if $controller; - return $c->comp("C::$name"); + 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; } -=item debug +# Return a component if only one matches. +sub _comp_singular { + my ( $c, @prefixes ) = @_; -Overload to enable debug messages. + my $appclass = ref $c || $c; -=cut + my ( $comp, $rest ) = + map { $c->_comp_search("^${appclass}::${_}::") } @prefixes; + return $comp unless $rest; +} -sub debug { 0 } +# 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) -=item $c->detach( $command [, \@arguments ] ) +Gets a L instance by name. -Like C but doesn't return. + $c->controller('Foo')->do_stuff; + +If the name is omitted, will return the controller for the dispatched +action. =cut -sub detach { my $c = shift; $c->dispatcher->detach( $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->dispatcher +=head2 $c->model($name) -Contains the dispatcher instance. -Stringifies to class. +Gets a L instance by name. -=item $c->forward( $command [, \@arguments ] ) + $c->model('Foo')->do_stuff; -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. +If the name is omitted, it will look for + - a model object in $c->stash{current_model_instance}, then + - a model name in $c->stash->{current_model}, then + - a config setting 'default_model', or + - check if there is only one model, and return it if that's the case. - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +=cut + +sub model { + my ( $c, $name, @args ) = @_; + return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ), + @args ) + if $name; + if (ref $c) { + return $c->stash->{current_model_instance} + if $c->stash->{current_model_instance}; + return $c->model( $c->stash->{current_model} ) + if $c->stash->{current_model}; + return $c->model( $c->config->{default_model} ) + if $c->config->{default_model}; + } + return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args ); + +} + +=head2 $c->controllers + +Returns the available names which can be passed to $c->controller =cut -sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } +sub controllers { + my ( $c ) = @_; + return $c->_comp_names(qw/Controller C/); +} -=item $c->model($name) -Get a L instance by name. +=head2 $c->view($name) - $c->model('Foo')->do_stuff; +Gets a L instance by name. + + $c->view('Foo')->do_stuff; + +If the name is omitted, it will look for + - a view object in $c->stash{current_view_instance}, then + - a view name in $c->stash->{current_view}, then + - a config setting 'default_view', or + - check if there is only one view, and return it if that's the case. =cut -sub model { - my ( $c, $name ) = @_; - my $model = $c->comp("Model::$name"); - return $model if $model; - return $c->comp("M::$name"); +sub view { + my ( $c, $name, @args ) = @_; + return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ), + @args ) + if $name; + if (ref $c) { + return $c->stash->{current_view_instance} + if $c->stash->{current_view_instance}; + return $c->view( $c->stash->{current_view} ) + if $c->stash->{current_view}; + return $c->view( $c->config->{default_view} ) + if $c->config->{default_view}; + } + return $c->_filter_component( $c->_comp_singular(qw/View V/) ); } -=item $c->namespace +=head2 $c->models -Accessor to the namespace of the current action +Returns the available names which can be passed to $c->model -=item $c->path_to(@path) +=cut -Merges C<@path> with $c->config->{home} and returns a L object. +sub models { + my ( $c ) = @_; + return $c->_comp_names(qw/Model M/); +} -For example: - $c->path_to( 'db', 'sqlite.db' ); +=head2 $c->views + +Returns the available names which can be passed to $c->view =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 views { + my ( $c ) = @_; + return $c->_comp_names(qw/View V/); } -=item $c->setup +=head2 $c->comp($name) -Setup. +=head2 $c->component($name) - $c->setup; +Gets a component object by name. This method is not recommended, +unless you want to get a specific component by full +class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >> +should be used instead. =cut -sub setup { - my ( $class, @arguments ) = @_; +sub component { + my $c = shift; - unless ( $class->isa('Catalyst') ) { + if (@_) { - Catalyst::Exception->throw( - message => qq/'$class' does not inherit from Catalyst/ ); - } + my $name = shift; - if ( $class->arguments ) { - @arguments = ( @arguments, @{ $class->arguments } ); - } + my $appclass = ref $c || $c; - # Process options - my $flags = {}; + my @names = ( + $name, "${appclass}::${name}", + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ + ); - foreach (@arguments) { + my $comp = $c->_comp_explicit(@names); + return $c->_filter_component( $comp, @_ ) if defined($comp); - if (/^-Debug$/) { - $flags->{log} = - ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; - } - elsif (/^-(\w+)=?(.*)$/) { - $flags->{ lc $1 } = $2; - } - else { - push @{ $flags->{plugins} }, $_; - } + $comp = $c->_comp_search($name); + return $c->_filter_component( $comp, @_ ) if defined($comp); } - $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} ); + return sort keys %{ $c->components }; +} - for my $flag ( sort keys %{$flags} ) { - if ( my $code = $class->can( 'setup_' . $flag ) ) { - &$code( $class, delete $flags->{$flag} ); - } - else { - $class->log->warn(qq/Unknown flag "$flag"/); - } - } - $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 ) ); +=head2 CLASS DATA AND HELPER CLASSES - if ( $class->debug ) { +=head2 $c->config - my @plugins = (); +Returns or takes a hashref containing the application's configuration. - { - no strict 'refs'; - @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; - } + __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } ); - if (@plugins) { - my $t = Text::SimpleTable->new(76); - $t->row($_) for @plugins; - $class->log->debug( "Loaded plugins:\n" . $t->draw ); - } +You can also use a C, C or C config file +like myapp.yml in your applications home directory. See +L. - my $dispatcher = $class->dispatcher; - my $engine = $class->engine; - my $home = $class->config->{home}; + --- + db: dsn:SQLite:foo.db - $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); - $class->log->debug(qq/Loaded engine "$engine"/); - $home - ? ( -d $home ) - ? $class->log->debug(qq/Found home "$home"/) - : $class->log->debug(qq/Home "$home" doesn't exist/) - : $class->log->debug(q/Couldn't find home/); - } +=cut - # Call plugins setup - { - no warnings qw/redefine/; - local *setup = sub { }; - $class->setup; - } +sub config { + my $c = shift; - # Initialize our data structure - $class->components( {} ); + $c->log->warn("Setting config after setup has been run is not a good idea.") + if ( @_ and $c->setup_finished ); - $class->setup_components; + $c->NEXT::config(@_); +} - if ( $class->debug ) { - my $t = Text::SimpleTable->new( [ 65, 'Class' ], [ 8, 'Type' ] ); - for my $comp ( sort keys %{ $class->components } ) { - my $type = ref $class->components->{$comp} ? 'instance' : 'class'; - $t->row( $comp, $type ); - } - $class->log->debug( "Loaded components:\n" . $t->draw ) - if ( keys %{ $class->components } ); - } +=head2 $c->log - # Add our self to components, since we are also a component - $class->components->{$class} = $class; +Returns the logging object instance. Unless it is already set, Catalyst +sets this up with a L object. To use your own log class, +set the logger with the C<< __PACKAGE__->log >> method prior to calling +C<< __PACKAGE__->setup >>. - $class->setup_actions; + __PACKAGE__->log( MyLogger->new ); + __PACKAGE__->setup; - 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'); -} +And later: + + $c->log->info( 'Now logging with my own logger!' ); + +Your log class should implement the methods described in +L. -=item $c->uri_for($path,[@args]) -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. +=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 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 debug { 0 } - # massage match, empty if absolute path - $match =~ s/^\///; - $match .= '/' if $match; - $path ||= ''; - $match = '' if $path =~ /^\//; - $path =~ s/^\///; +=head2 $c->dispatcher - # 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; -} +Returns the dispatcher instance. Stringifies to class name. See +L. -=item $c->error +=head2 $c->engine -=item $c->error($error, ...) +Returns the engine instance. Stringifies to the class name. See +L. -=item $c->error($arrayref) -Returns an arrayref containing error messages. +=head2 UTILITY METHODS - my @error = @{ $c->error }; +=head2 $c->path_to(@path) -Add a new error. +Merges C<@path> with C<< $c->config->{home} >> and returns a +L object. - $c->error('Something bad happened'); +For example: + + $c->path_to( 'db', 'sqlite.db' ); -Clean errors. +=cut - $c->error(0); +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 ) } +} + +=head2 $c->plugin( $name, $class, @args ) + +Helper method for plugins. It creates a classdata accessor/mutator and +loads and instantiates the given class. + + MyApp->plugin( 'prototype', 'HTML::Prototype' ); + + $c->prototype->define_javascript_functions; =cut -sub error { - my $c = shift; - if ( $_[0] ) { - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; +sub plugin { + my ( $class, $name, $plugin, @args ) = @_; + $class->_register_plugin( $plugin, 1 ); + + eval { $plugin->import }; + $class->mk_classdata($name); + my $obj; + eval { $obj = $plugin->new(@args) }; + + if ($@) { + Catalyst::Exception->throw( message => + qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); } - elsif ( defined $_[0] ) { $c->{error} = undef } - return $c->{error} || []; + + $class->$name($obj); + $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) + if $class->debug; } -=item $c->engine +=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 line. + + MyApp->setup; + MyApp->setup( qw/-Debug/ ); -Contains the engine instance. -Stringifies to the class. +=cut -=item $c->log +sub setup { + my ( $class, @arguments ) = @_; -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: + $class->log->warn("Running setup twice is not a good idea.") + if ( $class->setup_finished ); + + unless ( $class->isa('Catalyst') ) { - $c->log( MyLogger->new ); - $c->log->info("now logging with my own logger!"); + Catalyst::Exception->throw( + message => qq/'$class' does not inherit from Catalyst/ ); + } -Your log class should implement the methods described in the C -man page. + if ( $class->arguments ) { + @arguments = ( @arguments, @{ $class->arguments } ); + } -=item $c->plugin( $name, $class, @args ) + # Process options + my $flags = {}; -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. + foreach (@arguments) { - MyApp->plugin( 'prototype', 'HTML::Prototype' ); + if (/^-Debug$/) { + $flags->{log} = + ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; + } + elsif (/^-(\w+)=?(.*)$/) { + $flags->{ lc $1 } = $2; + } + else { + push @{ $flags->{plugins} }, $_; + } + } - $c->prototype->define_javascript_functions; + $class->setup_home( delete $flags->{home} ); -=cut + $class->setup_log( delete $flags->{log} ); + $class->setup_plugins( delete $flags->{plugins} ); + $class->setup_dispatcher( delete $flags->{dispatcher} ); + $class->setup_engine( delete $flags->{engine} ); -sub plugin { - my ( $class, $name, $plugin, @args ) = @_; - $plugin->require; + for my $flag ( sort keys %{$flags} ) { - if ( my $error = $UNIVERSAL::require::ERROR ) { - Catalyst::Exception->throw( - message => qq/Couldn't load instant plugin "$plugin", "$error"/ ); + if ( my $code = $class->can( 'setup_' . $flag ) ) { + &$code( $class, delete $flags->{$flag} ); + } + else { + $class->log->warn(qq/Unknown flag "$flag"/); + } } - eval { $plugin->import }; - $class->mk_classdata($name); - my $obj; - eval { $obj = $plugin->new(@args) }; + eval { require Catalyst::Devel; }; + if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) { + $class->log->warn(<<"EOF"); +You are running an old script! - if ($@) { - Catalyst::Exception->throw( message => - qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); - } + Please update by running (this will overwrite existing files): + catalyst.pl -force -scripts $class - $class->$name($obj); - $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) - if $class->debug; -} + or (this will not overwrite existing files): + catalyst.pl -scripts $class -=item $c->request +EOF + } + + if ( $class->debug ) { + my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins; -=item $c->req + if (@plugins) { + my $t = Text::SimpleTable->new(74); + $t->row($_) for @plugins; + $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" ); + } -Returns a C object. + my $dispatcher = $class->dispatcher; + my $engine = $class->engine; + my $home = $class->config->{home}; - my $req = $c->req; + $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); + $class->log->debug(qq/Loaded engine "$engine"/); -=item $c->response + $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/); + } -=item $c->res + # Call plugins setup + { + no warnings qw/redefine/; + local *setup = sub { }; + $class->setup; + } -Returns a C object. + # Initialize our data structure + $class->components( {} ); - my $res = $c->res; + $class->setup_components; -=item $c->state + if ( $class->debug ) { + 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 ); + } + $class->log->debug( "Loaded components:\n" . $t->draw . "\n" ) + if ( keys %{ $class->components } ); + } -Contains the return value of the last executed action. + # Add our self to components, since we are also a component + $class->components->{$class} = $class; -=item $c->stash + $class->setup_actions; -Returns a hashref containing all your data. + 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'); - print $c->stash->{foo}; + $class->setup_finished(1); +} -Keys may be set in the stash by assigning to the hash reference, or by passing -either a single hash reference or a list of key/value pairs as arguments. +=head2 $c->uri_for( $path, @args?, \%query_values? ) -For example: +Merges path with C<< $c->request->base >> for absolute URIs and with +C<< $c->namespace >> for relative URIs, then returns a normalized L +object. If any args are passed, they are added at the end of the path. +If the last argument to C is a hash reference, it is assumed to +contain GET parameter key/value pairs, which will be appended to the URI +in standard fashion. - $c->stash->{foo} ||= 'yada'; - $c->stash( { moose => 'majestic', qux => 0 } ); - $c->stash( bar => 1, gorch => 2 ); +Instead of C<$path>, you can also optionally pass a C<$action> object +which will be resolved to a path using +C<< $c->dispatcher->uri_for_action >>; if the first element of +C<@args> is an arrayref it is treated as a list of captures to be passed +to C. =cut -sub stash { - my $c = shift; - if (@_) { - my $stash = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $c->{stash}->{$key} = $val; - } +sub uri_for { + my ( $c, $path, @args ) = @_; + my $base = $c->request->base->clone; + my $basepath = $base->path; + $basepath =~ s/\/$//; + $basepath .= '/'; + my $namespace = $c->namespace || ''; + + if ( Scalar::Util::blessed($path) ) { # action object + my $captures = ( scalar @args && ref $args[0] eq 'ARRAY' + ? shift(@args) + : [] ); + $path = $c->dispatcher->uri_for_action($path, $captures); + return undef unless defined($path); + $path = '/' if $path eq ''; } - return $c->{stash}; -} -=item $c->view($name) - -Get a L instance by name. - - $c->view('Foo')->do_stuff; + # massage namespace, empty if absolute path + $namespace =~ s/^\/// if $namespace; + $namespace .= '/' if $namespace; + $path ||= ''; + $namespace = '' if $path =~ /^\//; + $path =~ s/^\///; + $path =~ s/\?/%3F/g; -=cut + my $params = + ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} ); -sub view { - my ( $c, $name ) = @_; - my $view = $c->comp("View::$name"); - return $view if $view; - return $c->comp("V::$name"); + for my $value ( values %$params ) { + next unless defined $value; + for ( ref $value eq 'ARRAY' ? @$value : $value ) { + $_ = "$_"; + utf8::encode( $_ ); + } + }; + + # join args with '/', or a blank string + my $args = ( scalar @args ? '/' . join( '/', map {s/\?/%3F/g; $_} @args ) : '' ); + $args =~ s/^\/// unless $path; + my $res = + URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base ) + ->canonical; + $res->query_form(%$params); + $res; } -=item $c->welcome_message +=head2 $c->welcome_message Returns the Catalyst welcome HTML page. @@ -652,7 +985,6 @@ sub welcome_message { text-align: left; background-color: #ccc; border: 1px solid #aaa; - -moz-border-radius: 10px; } p, h1, h2 { margin-left: 20px; @@ -682,7 +1014,6 @@ sub welcome_message { margin: 10px; background-color: #fff; border: 1px solid #aaa; - -moz-border-radius: 10px; } h1 { font-size: 0.9em; @@ -715,26 +1046,31 @@ sub welcome_message {

Catalyst Logo

-

Welcome to the wonderful world of Catalyst. +

Welcome to the 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
+ you might want want to start with a tutorial.

+
perldoc Catalyst::Manual::Tutorial
+
+

Afterwards you can go on to check out a more complete look at our features.

+
+perldoc Catalyst::Manual::Intro
+
+

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.

@@ -763,130 +1099,99 @@ perldoc components +=head2 $c->components -Contains the components. +Returns a hash of components. -=item $c->context_class($class) +=head2 $c->context_class -Contains the context class. +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 $c->dispatcher_class($class) +=head2 $c->dispatcher_class -Contains the dispatcher class. +Returns or sets the dispatcher class. -=item dump_these +=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->engine_class($class) +=head2 $c->engine_class -Contains the engine class. +Returns or sets the engine class. -=item $c->execute($class, $coderef) +=head2 $c->execute( $class, $coderef ) -Execute a coderef in given class and catch exceptions. -Errors are available via $c->error. +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"; - $action = "/$action" unless $action =~ /\-\>/; - $c->counter->{"$code"}++; + if ( $c->depth >= $RECURSION ) { + my $action = "$code"; + $action = "/$action" unless $action =~ /->/; + 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 ) if $c->debug; - $action = "-> $action" if $callsub =~ /forward$/; - } push( @{ $c->stack }, $code ); - eval { - if ( $c->debug ) - { - 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 ) ]; - } - $c->state(@state); - } - else { - $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ); - } - }; - pop( @{ $c->stack } ); + + eval { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) }; - if ( my $error = $@ ) { + $c->_stats_finish_execute( $stats_info ) if $c->debug and $stats_info; + + my $last = pop( @{ $c->stack } ); - if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 } + if ( my $error = $@ ) { + if ( !ref($error) and $error eq $DETACH ) { die $DETACH if $c->depth > 1 } else { unless ( ref $error ) { + no warnings 'uninitialized'; 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); @@ -895,9 +1200,100 @@ sub execute { return $c->state; } -=item $c->finalize +sub _stats_start_execute { + my ( $c, $code ) = @_; + + return if ( ( $code->name =~ /^_.*/ ) + && ( !$c->config->{show_internal_actions} ) ); + + $c->counter->{"$code"}++; + + my $action = "$code"; + $action = "/$action" unless $action =~ /->/; + + # 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"} ); + + # 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); + } + + return { + start => [gettimeofday], + node => $node, + }; +} + +sub _stats_finish_execute { + my ( $c, $info ) = @_; + my $elapsed = tv_interval $info->{start}; + my $value = $info->{node}->getNodeValue; + $value->{elapsed} = sprintf( '%fs', $elapsed ); +} + +=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 @@ -908,52 +1304,77 @@ 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_headers; + + # HEAD request + if ( $c->request->method eq 'HEAD' ) { + $c->response->body(''); + } + + $c->finalize_body; } + + if ($c->debug) { + my $elapsed = sprintf '%f', tv_interval($c->stats->getNodeValue); + my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) ); + + my $t = Text::SimpleTable->new( [ 62, 'Action' ], [ 9, 'Time' ] ); + $c->stats->traverse( + sub { + my $action = shift; + my $stat = $action->getNodeValue; + $t->row( ( q{ } x $action->getDepth ) . $stat->{action} . $stat->{comment}, + $stat->{elapsed} || '??' ); + } + ); - $c->finalize_body; + $c->log->info( + "Request took ${elapsed}s ($av/s)\n" . $t->draw . "\n" ); + } 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 @@ -971,7 +1392,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 @@ -988,45 +1422,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(@_) } -=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 @@ -1036,29 +1471,16 @@ sub handle_request { # Always expect worst case! my $status = -1; eval { - my @stats = (); - - my $handler = sub { - my $c = $class->prepare(@arguments); - $c->{stats} = \@stats; - $c->dispatch; - return $c->finalize; - }; - - if ( $class->debug ) { - my $elapsed; - ( $elapsed, $status ) = $class->benchmark($handler); - $elapsed = sprintf '%f', $elapsed; - my $av = sprintf '%.3f', - ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) ); - my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] ); - - for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) } - $class->log->info( - "Request took ${elapsed}s ($av/s)\n" . $t->draw ); + if ($class->debug) { + my $secs = time - $START || 1; + my $av = sprintf '%.3f', $COUNT / $secs; + my $time = localtime time; + $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***"); } - else { $status = &$handler } + my $c = $class->prepare(@arguments); + $c->dispatch; + $status = $c->finalize; }; if ( my $error = $@ ) { @@ -1071,10 +1493,10 @@ 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 @@ -1095,7 +1517,7 @@ sub prepare { parameters => {}, query_parameters => {}, secure => 0, - snippets => [], + captures => [], uploads => {} } ), @@ -1112,53 +1534,56 @@ sub prepare { } ); + if ( $c->debug ) { + $c->stats(Tree::Simple->new([gettimeofday])); + $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); + } + # For on-demand data $c->request->{_context} = $c; $c->response->{_context} = $c; weaken( $c->request->{_context} ); weaken( $c->response->{_context} ); - 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('**********************************'); - $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); + # 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_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 @@ -1174,7 +1599,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 : ''; @@ -1185,9 +1610,11 @@ sub prepare_body { } } -=item $c->prepare_body_chunk( $chunk ) +=head2 $c->prepare_body_chunk( $chunk ) -Prepare a chunk of data before sending it to HTTP::Body. +Prepares a chunk of data before sending it to L. + +See L. =cut @@ -1196,9 +1623,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 @@ -1207,9 +1634,9 @@ sub prepare_body_parameters { $c->engine->prepare_body_parameters( $c, @_ ); } -=item $c->prepare_connection +=head2 $c->prepare_connection -Prepare connection. +Prepares connection. =cut @@ -1218,25 +1645,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 @@ -1246,17 +1673,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 @@ -1266,7 +1693,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 : ''; @@ -1277,25 +1704,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 @@ -1306,8 +1733,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' ] ); @@ -1321,35 +1748,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->request_class($class) +=head2 $c->request_class -Contains the request class. +Returns or sets the request class. -=item $c->response_class($class) +=head2 $c->response_class -Contains the response class. +Returns or sets the response class. -=item $c->read( [$maxlength] ) +=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 C<< MyApp->config->{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. @@ -1357,86 +1785,97 @@ 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, { ignore_loaded => 1 } ); + + 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 @@ -1460,18 +1899,17 @@ 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 $class->dispatcher( $dispatcher->new ); } -=item $c->setup_engine +=head2 $c->setup_engine + +Sets up engine. =cut @@ -1490,7 +1928,7 @@ sub setup_engine { $engine = 'Catalyst::Engine::' . $ENV{ uc($class) . '_ENGINE' }; } - if ( !$engine && $ENV{MOD_PERL} ) { + if ( $ENV{MOD_PERL} ) { # create the apache method { @@ -1506,21 +1944,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 @@ -1549,12 +1991,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 @@ -1593,7 +2031,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 @@ -1605,6 +2045,7 @@ sub setup_home { } if ( $ENV{ uc($class) . '_HOME' } ) { + $class =~ s/::/_/g; $home = $ENV{ uc($class) . '_HOME' }; } @@ -1614,11 +2055,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 @@ -1643,41 +2086,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->stack +=head2 $c->stack -Contains the stack. +Returns an arrayref of the internal execution stack (actions that are +currently executing). -=item $c->write( $data ) +=head2 $c->write( $data ) -Writes $data to the output stream. When using this method directly, you will -need to manually set the 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 @@ -1690,70 +2171,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; @@ -1763,13 +2240,13 @@ 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 -core to be thread-safe. +Catalyst has been tested under Apache 2's threading C, +C, 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 @@ -1777,7 +2254,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 @@ -1786,23 +2263,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 @@ -1824,6 +2305,8 @@ Autrijus Tang Brian Cassidy +Carl Franks + Christian Hansen Christopher Hicks @@ -1832,8 +2315,12 @@ Dan Sully Danijel Milicevic +David Kamholz + David Naughton +Drew Taylor + Gary Ashton Jones Geoff Richards