4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use B::Hooks::EndOfScope ();
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
26 use Tree::Simple qw/use_weak_refs/;
27 use Tree::Simple::Visitor::FindByUID;
28 use Class::C3::Adopt::NEXT;
29 use List::MoreUtils qw/uniq/;
31 use String::RewritePrefix;
32 use Catalyst::EngineLoader;
34 use Carp qw/croak carp shortmess/;
36 use Plack::Middleware::Conditional;
37 use Plack::Middleware::ReverseProxy;
38 use Plack::Middleware::IIS6ScriptNameFix;
39 use Plack::Middleware::LighttpdScriptNameFix;
41 BEGIN { require 5.008004; }
43 has stack => (is => 'ro', default => sub { [] });
44 has stash => (is => 'rw', default => sub { {} });
45 has state => (is => 'rw', default => 0);
46 has stats => (is => 'rw');
47 has action => (is => 'rw');
48 has counter => (is => 'rw', default => sub { {} });
49 has request => (is => 'rw', default => sub { $_[0]->request_class->new({}) }, required => 1, lazy => 1);
50 has response => (is => 'rw', default => sub { $_[0]->response_class->new({}) }, required => 1, lazy => 1);
51 has namespace => (is => 'rw');
53 sub depth { scalar @{ shift->stack || [] }; }
54 sub comp { shift->component(@_) }
57 my $self = shift; return $self->request(@_);
60 my $self = shift; return $self->response(@_);
63 # For backwards compatibility
64 sub finalize_output { shift->finalize_body(@_) };
69 our $RECURSION = 1000;
70 our $DETACH = Catalyst::Exception::Detach->new;
71 our $GO = Catalyst::Exception::Go->new;
73 #I imagine that very few of these really need to be class variables. if any.
74 #maybe we should just make them attributes with a default?
75 __PACKAGE__->mk_classdata($_)
76 for qw/components arguments dispatcher engine log dispatcher_class
77 engine_loader context_class request_class response_class stats_class
78 setup_finished _psgi_app loading_psgi_file run_options/;
80 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
81 __PACKAGE__->request_class('Catalyst::Request');
82 __PACKAGE__->response_class('Catalyst::Response');
83 __PACKAGE__->stats_class('Catalyst::Stats');
85 # Remember to update this in Catalyst::Runtime as well!
87 our $VERSION = '5.90007';
90 my ( $class, @arguments ) = @_;
92 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
94 return unless $class eq 'Catalyst';
96 my $caller = caller();
97 return if $caller eq 'main';
99 my $meta = Moose::Meta::Class->initialize($caller);
100 unless ( $caller->isa('Catalyst') ) {
101 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
102 $meta->superclasses(@superclasses);
104 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
105 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
107 unless( $meta->has_method('meta') ){
108 if ($Moose::VERSION >= 1.15) {
109 $meta->_add_meta_method('meta');
112 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
116 $caller->arguments( [@arguments] );
120 sub _application { $_[0] }
124 Catalyst - The Elegant MVC Web Application Framework
128 See the L<Catalyst::Manual> distribution for comprehensive
129 documentation and tutorials.
131 # Install Catalyst::Devel for helpers and other development tools
132 # use the helper to create a new application
135 # add models, views, controllers
136 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
137 script/myapp_create.pl view MyTemplate TT
138 script/myapp_create.pl controller Search
140 # built in testserver -- use -r to restart automatically on changes
141 # --help to see all available options
142 script/myapp_server.pl
144 # command line testing interface
145 script/myapp_test.pl /yada
148 use Catalyst qw/-Debug/; # include plugins here as well
150 ### In lib/MyApp/Controller/Root.pm (autocreated)
151 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
152 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
153 $c->stash->{template} = 'foo.tt'; # set the template
154 # lookup something from db -- stash vars are passed to TT
156 $c->model('Database::Foo')->search( { country => $args[0] } );
157 if ( $c->req->params->{bar} ) { # access GET or POST parameters
158 $c->forward( 'bar' ); # process another action
159 # do something else after forward returns
163 # The foo.tt TT template can use the stash data from the database
164 [% WHILE (item = data.next) %]
168 # called for /bar/of/soap, /bar/of/soap/10, etc.
169 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
171 # called after all actions are finished
173 my ( $self, $c ) = @_;
174 if ( scalar @{ $c->error } ) { ... } # handle errors
175 return if $c->res->body; # already have a response
176 $c->forward( 'MyApp::View::TT' ); # render template
179 See L<Catalyst::Manual::Intro> for additional information.
183 Catalyst is a modern framework for making web applications without the
184 pain usually associated with this process. This document is a reference
185 to the main Catalyst application. If you are a new user, we suggest you
186 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
188 See L<Catalyst::Manual> for more documentation.
190 Catalyst plugins can be loaded by naming them as arguments to the "use
191 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
192 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
195 use Catalyst qw/My::Module/;
197 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
198 fully qualify the name by using a unary plus:
202 +Fully::Qualified::Plugin::Name
205 Special flags like C<-Debug> can also be specified as
206 arguments when Catalyst is loaded:
208 use Catalyst qw/-Debug My::Module/;
210 The position of plugins and flags in the chain is important, because
211 they are loaded in the order in which they appear.
213 The following flags are supported:
217 Enables debug output. You can also force this setting from the system
218 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
219 settings override the application, with <MYAPP>_DEBUG having the highest
222 This sets the log level to 'debug' and enables full debug output on the
223 error screen. If you only want the latter, see L<< $c->debug >>.
227 Forces Catalyst to use a specific home directory, e.g.:
229 use Catalyst qw[-Home=/usr/mst];
231 This can also be done in the shell environment by setting either the
232 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
233 is replaced with the uppercased name of your application, any "::" in
234 the name will be replaced with underscores, e.g. MyApp::Web should use
235 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
237 If none of these are set, Catalyst will attempt to automatically detect the
238 home directory. If you are working in a development environment, Catalyst
239 will try and find the directory containing either Makefile.PL, Build.PL or
240 dist.ini. If the application has been installed into the system (i.e.
241 you have done C<make install>), then Catalyst will use the path to your
242 application module, without the .pm extension (e.g., /foo/MyApp if your
243 application was installed at /foo/MyApp.pm)
247 use Catalyst '-Log=warn,fatal,error';
249 Specifies a comma-delimited list of log levels.
253 Enables statistics collection and reporting.
255 use Catalyst qw/-Stats=1/;
257 You can also force this setting from the system environment with CATALYST_STATS
258 or <MYAPP>_STATS. The environment settings override the application, with
259 <MYAPP>_STATS having the highest priority.
261 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
265 =head2 INFORMATION ABOUT THE CURRENT REQUEST
269 Returns a L<Catalyst::Action> object for the current action, which
270 stringifies to the action name. See L<Catalyst::Action>.
274 Returns the namespace of the current action, i.e., the URI prefix
275 corresponding to the controller of the current action. For example:
277 # in Controller::Foo::Bar
278 $c->namespace; # returns 'foo/bar';
284 Returns the current L<Catalyst::Request> object, giving access to
285 information about the current client request (including parameters,
286 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
288 =head2 REQUEST FLOW HANDLING
290 =head2 $c->forward( $action [, \@arguments ] )
292 =head2 $c->forward( $class, $method, [, \@arguments ] )
294 Forwards processing to another action, by its private name. If you give a
295 class name but no method, C<process()> is called. You may also optionally
296 pass arguments in an arrayref. The action will receive the arguments in
297 C<@_> and C<< $c->req->args >>. Upon returning from the function,
298 C<< $c->req->args >> will be restored to the previous values.
300 Any data C<return>ed from the action forwarded to, will be returned by the
303 my $foodata = $c->forward('/foo');
304 $c->forward('index');
305 $c->forward(qw/Model::DBIC::Foo do_stuff/);
306 $c->forward('View::TT');
308 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
309 an C<< eval { } >> around the call (actually
310 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
311 exceptions thrown by the called action non-fatal and pushing them onto
312 $c->error instead. If you want C<die> to propagate you need to do something
316 die join "\n", @{ $c->error } if @{ $c->error };
318 Or make sure to always return true values from your actions and write
321 $c->forward('foo') || return;
323 Another note is that C<< $c->forward >> always returns a scalar because it
324 actually returns $c->state which operates in a scalar context.
325 Thus, something like:
329 in an action that is forwarded to is going to return a scalar,
330 i.e. how many items are in that array, which is probably not what you want.
331 If you need to return an array then return a reference to it,
334 $c->stash->{array} = \@array;
336 and access it from the stash.
338 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
342 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
344 =head2 $c->detach( $action [, \@arguments ] )
346 =head2 $c->detach( $class, $method, [, \@arguments ] )
350 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
351 doesn't return to the previous action when processing is finished.
353 When called with no arguments it escapes the processing chain entirely.
357 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
359 =head2 $c->visit( $action [, \@arguments ] )
361 =head2 $c->visit( $action [, \@captures, \@arguments ] )
363 =head2 $c->visit( $class, $method, [, \@arguments ] )
365 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
367 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
368 but does a full dispatch, instead of just calling the new C<$action> /
369 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
370 you go to are called, just like a new request.
372 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
373 This means, for example, that C<< $c->action >> methods such as
374 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
375 L<reverse|Catalyst::Action/reverse> return information for the visited action
376 when they are invoked within the visited action. This is different from the
377 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
378 continues to use the $c->action object from the caller action even when
379 invoked from the called action.
381 C<< $c->stash >> is kept unchanged.
383 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
384 allows you to "wrap" another action, just as it would have been called by
385 dispatching from a URL, while the analogous
386 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
387 transfer control to another action as if it had been reached directly from a URL.
391 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
393 =head2 $c->go( $action [, \@arguments ] )
395 =head2 $c->go( $action [, \@captures, \@arguments ] )
397 =head2 $c->go( $class, $method, [, \@arguments ] )
399 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
401 The relationship between C<go> and
402 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
403 the relationship between
404 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
405 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
406 C<< $c->go >> will perform a full dispatch on the specified action or method,
407 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
408 C<go> escapes the processing of the current request chain on completion, and
409 does not return to its caller.
411 @arguments are arguments to the final destination of $action. @captures are
412 arguments to the intermediate steps, if any, on the way to the final sub of
417 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
423 Returns the current L<Catalyst::Response> object, see there for details.
427 Returns a hashref to the stash, which may be used to store data and pass
428 it between components during a request. You can also set hash keys by
429 passing arguments. The stash is automatically sent to the view. The
430 stash is cleared at the end of a request; it cannot be used for
431 persistent storage (for this you must use a session; see
432 L<Catalyst::Plugin::Session> for a complete system integrated with
435 $c->stash->{foo} = $bar;
436 $c->stash( { moose => 'majestic', qux => 0 } );
437 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
439 # stash is automatically passed to the view for use in a template
440 $c->forward( 'MyApp::View::TT' );
444 around stash => sub {
447 my $stash = $orig->($c);
449 my $new_stash = @_ > 1 ? {@_} : $_[0];
450 croak('stash takes a hash or hashref') unless ref $new_stash;
451 foreach my $key ( keys %$new_stash ) {
452 $stash->{$key} = $new_stash->{$key};
462 =head2 $c->error($error, ...)
464 =head2 $c->error($arrayref)
466 Returns an arrayref containing error messages. If Catalyst encounters an
467 error while processing a request, it stores the error in $c->error. This
468 method should only be used to store fatal error messages.
470 my @error = @{ $c->error };
474 $c->error('Something bad happened');
481 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
482 croak @$error unless ref $c;
483 push @{ $c->{error} }, @$error;
485 elsif ( defined $_[0] ) { $c->{error} = undef }
486 return $c->{error} || [];
492 Contains the return value of the last executed action.
493 Note that << $c->state >> operates in a scalar context which means that all
494 values it returns are scalar.
496 =head2 $c->clear_errors
498 Clear errors. You probably don't want to clear the errors unless you are
499 implementing a custom error screen.
501 This is equivalent to running
512 sub _comp_search_prefixes {
514 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
517 # search components given a name and some prefixes
518 sub _comp_names_search_prefixes {
519 my ( $c, $name, @prefixes ) = @_;
520 my $appclass = ref $c || $c;
521 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
522 $filter = qr/$filter/; # Compile regex now rather than once per loop
524 # map the original component name to the sub part that we will search against
525 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
526 grep { /$filter/ } keys %{ $c->components };
528 # undef for a name will return all
529 return keys %eligible if !defined $name;
531 my $query = ref $name ? $name : qr/^$name$/i;
532 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
534 return @result if @result;
536 # if we were given a regexp to search against, we're done.
539 # skip regexp fallback if configured
541 if $appclass->config->{disable_component_resolution_regex_fallback};
545 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
547 # no results? try against full names
549 @result = grep { m{$query} } keys %eligible;
552 # don't warn if we didn't find any results, it just might not exist
554 # Disgusting hack to work out correct method name
555 my $warn_for = lc $prefixes[0];
556 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
557 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
558 "component resolution is unreliable and unsafe.";
559 my $short = $result[0];
560 # remove the component namespace prefix
561 $short =~ s/.*?(Model|Controller|View):://;
562 my $shortmess = Carp::shortmess('');
563 if ($shortmess =~ m#Catalyst/Plugin#) {
564 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
566 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
567 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
568 "component's config";
570 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
571 "but if you really wanted to search, pass in a regexp as the argument " .
572 "like so: \$c->${warn_for}(qr/${name}/)";
574 $c->log->warn( "${msg}$shortmess" );
580 # Find possible names for a prefix
582 my ( $c, @prefixes ) = @_;
583 my $appclass = ref $c || $c;
585 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
587 my @names = map { s{$filter}{}; $_; }
588 $c->_comp_names_search_prefixes( undef, @prefixes );
593 # Filter a component before returning by calling ACCEPT_CONTEXT if available
594 sub _filter_component {
595 my ( $c, $comp, @args ) = @_;
597 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
598 return $comp->ACCEPT_CONTEXT( $c, @args );
604 =head2 COMPONENT ACCESSORS
606 =head2 $c->controller($name)
608 Gets a L<Catalyst::Controller> instance by name.
610 $c->controller('Foo')->do_stuff;
612 If the name is omitted, will return the controller for the dispatched
615 If you want to search for controllers, pass in a regexp as the argument.
617 # find all controllers that start with Foo
618 my @foo_controllers = $c->controller(qr{^Foo});
624 my ( $c, $name, @args ) = @_;
626 my $appclass = ref($c) || $c;
628 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
629 my $comps = $c->components;
630 my $check = $appclass."::Controller::".$name;
631 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
633 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
634 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
635 return $c->_filter_component( $result[ 0 ], @args );
638 return $c->component( $c->action->class );
641 =head2 $c->model($name)
643 Gets a L<Catalyst::Model> instance by name.
645 $c->model('Foo')->do_stuff;
647 Any extra arguments are directly passed to ACCEPT_CONTEXT.
649 If the name is omitted, it will look for
650 - a model object in $c->stash->{current_model_instance}, then
651 - a model name in $c->stash->{current_model}, then
652 - a config setting 'default_model', or
653 - check if there is only one model, and return it if that's the case.
655 If you want to search for models, pass in a regexp as the argument.
657 # find all models that start with Foo
658 my @foo_models = $c->model(qr{^Foo});
663 my ( $c, $name, @args ) = @_;
664 my $appclass = ref($c) || $c;
666 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
667 my $comps = $c->components;
668 my $check = $appclass."::Model::".$name;
669 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
671 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
672 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
673 return $c->_filter_component( $result[ 0 ], @args );
677 return $c->stash->{current_model_instance}
678 if $c->stash->{current_model_instance};
679 return $c->model( $c->stash->{current_model} )
680 if $c->stash->{current_model};
682 return $c->model( $appclass->config->{default_model} )
683 if $appclass->config->{default_model};
685 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
688 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
689 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
690 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
691 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
692 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
695 return $c->_filter_component( $comp );
699 =head2 $c->view($name)
701 Gets a L<Catalyst::View> instance by name.
703 $c->view('Foo')->do_stuff;
705 Any extra arguments are directly passed to ACCEPT_CONTEXT.
707 If the name is omitted, it will look for
708 - a view object in $c->stash->{current_view_instance}, then
709 - a view name in $c->stash->{current_view}, then
710 - a config setting 'default_view', or
711 - check if there is only one view, and return it if that's the case.
713 If you want to search for views, pass in a regexp as the argument.
715 # find all views that start with Foo
716 my @foo_views = $c->view(qr{^Foo});
721 my ( $c, $name, @args ) = @_;
723 my $appclass = ref($c) || $c;
725 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
726 my $comps = $c->components;
727 my $check = $appclass."::View::".$name;
728 if( exists $comps->{$check} ) {
729 return $c->_filter_component( $comps->{$check}, @args );
732 $c->log->warn( "Attempted to use view '$check', but does not exist" );
735 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
736 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
737 return $c->_filter_component( $result[ 0 ], @args );
741 return $c->stash->{current_view_instance}
742 if $c->stash->{current_view_instance};
743 return $c->view( $c->stash->{current_view} )
744 if $c->stash->{current_view};
746 return $c->view( $appclass->config->{default_view} )
747 if $appclass->config->{default_view};
749 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
752 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
753 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
754 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
755 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
756 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
759 return $c->_filter_component( $comp );
762 =head2 $c->controllers
764 Returns the available names which can be passed to $c->controller
770 return $c->_comp_names(qw/Controller C/);
775 Returns the available names which can be passed to $c->model
781 return $c->_comp_names(qw/Model M/);
787 Returns the available names which can be passed to $c->view
793 return $c->_comp_names(qw/View V/);
796 =head2 $c->comp($name)
798 =head2 $c->component($name)
800 Gets a component object by name. This method is not recommended,
801 unless you want to get a specific component by full
802 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
803 should be used instead.
805 If C<$name> is a regexp, a list of components matched against the full
806 component name will be returned.
808 If Catalyst can't find a component by name, it will fallback to regex
809 matching by default. To disable this behaviour set
810 disable_component_resolution_regex_fallback to a true value.
812 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
817 my ( $c, $name, @args ) = @_;
820 my $comps = $c->components;
823 # is it the exact name?
824 return $c->_filter_component( $comps->{ $name }, @args )
825 if exists $comps->{ $name };
827 # perhaps we just omitted "MyApp"?
828 my $composed = ( ref $c || $c ) . "::${name}";
829 return $c->_filter_component( $comps->{ $composed }, @args )
830 if exists $comps->{ $composed };
832 # search all of the models, views and controllers
833 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
834 return $c->_filter_component( $comp, @args ) if $comp;
838 if $c->config->{disable_component_resolution_regex_fallback};
840 # This is here so $c->comp( '::M::' ) works
841 my $query = ref $name ? $name : qr{$name}i;
843 my @result = grep { m{$query} } keys %{ $c->components };
844 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
847 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
848 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
849 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
850 return $c->_filter_component( $result[ 0 ], @args );
853 # I would expect to return an empty list here, but that breaks back-compat
857 return sort keys %{ $c->components };
860 =head2 CLASS DATA AND HELPER CLASSES
864 Returns or takes a hashref containing the application's configuration.
866 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
868 You can also use a C<YAML>, C<XML> or L<Config::General> config file
869 like C<myapp.conf> in your applications home directory. See
870 L<Catalyst::Plugin::ConfigLoader>.
872 =head3 Cascading configuration
874 The config method is present on all Catalyst components, and configuration
875 will be merged when an application is started. Configuration loaded with
876 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
877 followed by configuration in your top level C<MyApp> class. These two
878 configurations are merged, and then configuration data whose hash key matches a
879 component name is merged with configuration for that component.
881 The configuration for a component is then passed to the C<new> method when a
882 component is constructed.
886 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
887 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
889 will mean that C<MyApp::Model::Foo> receives the following data when
892 MyApp::Model::Foo->new({
898 It's common practice to use a Moose attribute
899 on the receiving component to access the config value.
901 package MyApp::Model::Foo;
905 # this attr will receive 'baz' at construction time
911 You can then get the value 'baz' by calling $c->model('Foo')->bar
912 (or $self->bar inside code in the model).
914 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
915 as a way of reading config within your code, as this B<will not> give you the
916 correctly merged config back. You B<MUST> take the config values supplied to
917 the constructor and use those instead.
921 around config => sub {
925 croak('Setting config after setup has been run is not allowed.')
926 if ( @_ and $c->setup_finished );
933 Returns the logging object instance. Unless it is already set, Catalyst
934 sets this up with a L<Catalyst::Log> object. To use your own log class,
935 set the logger with the C<< __PACKAGE__->log >> method prior to calling
936 C<< __PACKAGE__->setup >>.
938 __PACKAGE__->log( MyLogger->new );
943 $c->log->info( 'Now logging with my own logger!' );
945 Your log class should implement the methods described in
951 Returns 1 if debug mode is enabled, 0 otherwise.
953 You can enable debug mode in several ways:
957 =item By calling myapp_server.pl with the -d flag
959 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
961 =item The -Debug option in your MyApp.pm
963 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
967 The first three also set the log level to 'debug'.
969 Calling C<< $c->debug(1) >> has no effect.
975 =head2 $c->dispatcher
977 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
981 Returns the engine instance. See L<Catalyst::Engine>.
984 =head2 UTILITY METHODS
986 =head2 $c->path_to(@path)
988 Merges C<@path> with C<< $c->config->{home} >> and returns a
989 L<Path::Class::Dir> object. Note you can usually use this object as
990 a filename, but sometimes you will have to explicitly stringify it
991 yourself by calling the C<< ->stringify >> method.
995 $c->path_to( 'db', 'sqlite.db' );
1000 my ( $c, @path ) = @_;
1001 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1002 if ( -d $path ) { return $path }
1003 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1007 my ( $class, $name, $plugin, @args ) = @_;
1009 # See block comment in t/unit_core_plugin.t
1010 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1012 $class->_register_plugin( $plugin, 1 );
1014 eval { $plugin->import };
1015 $class->mk_classdata($name);
1017 eval { $obj = $plugin->new(@args) };
1020 Catalyst::Exception->throw( message =>
1021 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1024 $class->$name($obj);
1025 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1031 Initializes the dispatcher and engine, loads any plugins, and loads the
1032 model, view, and controller components. You may also specify an array
1033 of plugins to load here, if you choose to not load them in the C<use
1037 MyApp->setup( qw/-Debug/ );
1039 B<Note:> You B<should not> wrap this method with method modifiers
1040 or bad things will happen - wrap the C<setup_finalize> method instead.
1045 my ( $class, @arguments ) = @_;
1046 croak('Running setup more than once')
1047 if ( $class->setup_finished );
1049 unless ( $class->isa('Catalyst') ) {
1051 Catalyst::Exception->throw(
1052 message => qq/'$class' does not inherit from Catalyst/ );
1055 if ( $class->arguments ) {
1056 @arguments = ( @arguments, @{ $class->arguments } );
1062 foreach (@arguments) {
1066 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1068 elsif (/^-(\w+)=?(.*)$/) {
1069 $flags->{ lc $1 } = $2;
1072 push @{ $flags->{plugins} }, $_;
1076 $class->setup_home( delete $flags->{home} );
1078 $class->setup_log( delete $flags->{log} );
1079 $class->setup_plugins( delete $flags->{plugins} );
1080 $class->setup_dispatcher( delete $flags->{dispatcher} );
1081 if (my $engine = delete $flags->{engine}) {
1082 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1084 $class->setup_engine();
1085 $class->setup_stats( delete $flags->{stats} );
1087 for my $flag ( sort keys %{$flags} ) {
1089 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1090 &$code( $class, delete $flags->{$flag} );
1093 $class->log->warn(qq/Unknown flag "$flag"/);
1097 eval { require Catalyst::Devel; };
1098 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1099 $class->log->warn(<<"EOF");
1100 You are running an old script!
1102 Please update by running (this will overwrite existing files):
1103 catalyst.pl -force -scripts $class
1105 or (this will not overwrite existing files):
1106 catalyst.pl -scripts $class
1111 if ( $class->debug ) {
1112 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1115 my $column_width = Catalyst::Utils::term_width() - 6;
1116 my $t = Text::SimpleTable->new($column_width);
1117 $t->row($_) for @plugins;
1118 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1121 my $dispatcher = $class->dispatcher;
1122 my $engine = $class->engine;
1123 my $home = $class->config->{home};
1125 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1126 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1130 ? $class->log->debug(qq/Found home "$home"/)
1131 : $class->log->debug(qq/Home "$home" doesn't exist/)
1132 : $class->log->debug(q/Couldn't find home/);
1135 # Call plugins setup, this is stupid and evil.
1136 # Also screws C3 badly on 5.10, hack to avoid.
1138 no warnings qw/redefine/;
1139 local *setup = sub { };
1140 $class->setup unless $Catalyst::__AM_RESTARTING;
1143 # Initialize our data structure
1144 $class->components( {} );
1146 $class->setup_components;
1148 if ( $class->debug ) {
1149 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1150 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1151 for my $comp ( sort keys %{ $class->components } ) {
1152 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1153 $t->row( $comp, $type );
1155 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1156 if ( keys %{ $class->components } );
1159 # Add our self to components, since we are also a component
1160 if( $class->isa('Catalyst::Controller') ){
1161 $class->components->{$class} = $class;
1164 $class->setup_actions;
1166 if ( $class->debug ) {
1167 my $name = $class->config->{name} || 'Application';
1168 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1171 # Make sure that the application class becomes immutable at this point,
1172 B::Hooks::EndOfScope::on_scope_end {
1174 my $meta = Class::MOP::get_metaclass_by_name($class);
1177 && ! { $meta->immutable_options }->{replace_constructor}
1179 $class->isa('Class::Accessor::Fast')
1180 || $class->isa('Class::Accessor')
1183 warn "You made your application class ($class) immutable, "
1184 . "but did not inline the\nconstructor. "
1185 . "This will break catalyst, as your app \@ISA "
1186 . "Class::Accessor(::Fast)?\nPlease pass "
1187 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1189 $meta->make_immutable(
1190 replace_constructor => 1,
1191 ) unless $meta->is_immutable;
1194 if ($class->config->{case_sensitive}) {
1195 $class->log->warn($class . "->config->{case_sensitive} is set.");
1196 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1199 $class->setup_finalize;
1200 # Should be the last thing we do so that user things hooking
1201 # setup_finalize can log..
1202 $class->log->_flush() if $class->log->can('_flush');
1203 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1206 =head2 $app->setup_finalize
1208 A hook to attach modifiers to. This method does not do anything except set the
1209 C<setup_finished> accessor.
1211 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1215 after setup_finalize => sub {
1223 sub setup_finalize {
1225 $class->setup_finished(1);
1228 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1230 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1232 Constructs an absolute L<URI> object based on the application root, the
1233 provided path, and the additional arguments and query parameters provided.
1234 When used as a string, provides a textual URI. If you need more flexibility
1235 than this (i.e. the option to provide relative URIs etc.) see
1236 L<Catalyst::Plugin::SmartURI>.
1238 If no arguments are provided, the URI for the current action is returned.
1239 To return the current action and also provide @args, use
1240 C<< $c->uri_for( $c->action, @args ) >>.
1242 If the first argument is a string, it is taken as a public URI path relative
1243 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1244 relative to the application root (if it does). It is then merged with
1245 C<< $c->request->base >>; any C<@args> are appended as additional path
1246 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1248 If the first argument is a L<Catalyst::Action> it represents an action which
1249 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1250 optional C<\@captures> argument (an arrayref) allows passing the captured
1251 variables that are needed to fill in the paths of Chained and Regex actions;
1252 once the path is resolved, C<uri_for> continues as though a path was
1253 provided, appending any arguments or parameters and creating an absolute
1256 The captures for the current request can be found in
1257 C<< $c->request->captures >>, and actions can be resolved using
1258 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1259 path, use C<< $c->uri_for_action >> instead.
1261 # Equivalent to $c->req->uri
1262 $c->uri_for($c->action, $c->req->captures,
1263 @{ $c->req->args }, $c->req->params);
1265 # For the Foo action in the Bar controller
1266 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1268 # Path to a static resource
1269 $c->uri_for('/static/images/logo.png');
1274 my ( $c, $path, @args ) = @_;
1276 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1277 $path = $path->path_prefix;
1282 undef($path) if (defined $path && $path eq '');
1285 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1287 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1288 foreach my $arg (@args) {
1289 utf8::encode($arg) if utf8::is_utf8($arg);
1290 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1293 if ( blessed($path) ) { # action object
1294 s|/|%2F|g for @args;
1295 my $captures = [ map { s|/|%2F|g; $_; }
1296 ( scalar @args && ref $args[0] eq 'ARRAY'
1300 foreach my $capture (@$captures) {
1301 utf8::encode($capture) if utf8::is_utf8($capture);
1302 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1306 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1307 if( !@args && $action->number_of_args ) {
1308 my $expanded_action = $c->dispatcher->expand_action( $action );
1310 my $num_captures = $expanded_action->number_of_captures;
1311 unshift @args, splice @$captures, $num_captures;
1314 $path = $c->dispatcher->uri_for_action($action, $captures);
1315 if (not defined $path) {
1316 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1320 $path = '/' if $path eq '';
1323 unshift(@args, $path);
1325 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1326 my $namespace = $c->namespace;
1327 if (defined $path) { # cheesy hack to handle path '../foo'
1328 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1330 unshift(@args, $namespace || '');
1333 # join args with '/', or a blank string
1334 my $args = join('/', grep { defined($_) } @args);
1335 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1337 my $base = $c->req->base;
1338 my $class = ref($base);
1339 $base =~ s{(?<!/)$}{/};
1343 if (my @keys = keys %$params) {
1344 # somewhat lifted from URI::_query's query_form
1345 $query = '?'.join('&', map {
1346 my $val = $params->{$_};
1347 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1350 $val = '' unless defined $val;
1353 utf8::encode( $param ) if utf8::is_utf8($param);
1354 # using the URI::Escape pattern here so utf8 chars survive
1355 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1357 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1361 my $res = bless(\"${base}${args}${query}", $class);
1365 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1367 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1373 A private path to the Catalyst action you want to create a URI for.
1375 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1376 >> and passing the resulting C<$action> and the remaining arguments to C<<
1379 You can also pass in a Catalyst::Action object, in which case it is passed to
1382 Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.
1384 For example, if the action looks like:
1386 package MyApp::Controller::Users;
1388 sub lst : Path('the-list') {}
1392 $c->uri_for_action('/users/lst')
1394 and it will create the URI /users/the-list.
1396 =item \@captures_and_args?
1398 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1399 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1400 to interpolate all the parameters in the URI.
1404 Optional list of extra arguments - can be supplied in the
1405 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1408 Your action can have zero, a fixed or a variable number of args (e.g.
1409 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1411 =item \%query_values?
1413 Optional array reference of query parameters to append. E.g.
1419 /rest/of/your/uri?foo=bar
1425 sub uri_for_action {
1426 my ( $c, $path, @args ) = @_;
1427 my $action = blessed($path)
1429 : $c->dispatcher->get_action_by_path($path);
1430 unless (defined $action) {
1431 croak "Can't find action for path '$path'";
1433 return $c->uri_for( $action, @args );
1436 =head2 $c->welcome_message
1438 Returns the Catalyst welcome HTML page.
1442 sub welcome_message {
1444 my $name = $c->config->{name};
1445 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1446 my $prefix = Catalyst::Utils::appprefix( ref $c );
1447 $c->response->content_type('text/html; charset=utf-8');
1449 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1450 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1451 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1453 <meta http-equiv="Content-Language" content="en" />
1454 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1455 <title>$name on Catalyst $VERSION</title>
1456 <style type="text/css">
1459 background-color: #eee;
1466 margin-bottom: 10px;
1468 background-color: #ccc;
1469 border: 1px solid #aaa;
1474 font-family: verdana, tahoma, sans-serif;
1477 font-family: verdana, tahoma, sans-serif;
1480 text-decoration: none;
1482 border-bottom: 1px dotted #bbb;
1484 :link:hover, :visited:hover {
1497 background-color: #fff;
1498 border: 1px solid #aaa;
1502 font-weight: normal;
1524 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1529 <img src="$logo" alt="Catalyst Logo" />
1531 <p>Welcome to the world of Catalyst.
1532 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1533 framework will make web development something you had
1534 never expected it to be: Fun, rewarding, and quick.</p>
1535 <h2>What to do now?</h2>
1536 <p>That really depends on what <b>you</b> want to do.
1537 We do, however, provide you with a few starting points.</p>
1538 <p>If you want to jump right into web development with Catalyst
1539 you might want to start with a tutorial.</p>
1540 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1542 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1544 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1545 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1547 <h2>What to do next?</h2>
1548 <p>Next it's time to write an actual application. Use the
1549 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1550 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1551 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1552 they can save you a lot of work.</p>
1553 <pre><code>script/${prefix}_create.pl --help</code></pre>
1554 <p>Also, be sure to check out the vast and growing
1555 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1556 you are likely to find what you need there.
1560 <p>Catalyst has a very active community. Here are the main places to
1561 get in touch with us.</p>
1564 <a href="http://dev.catalyst.perl.org">Wiki</a>
1567 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1570 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1573 <h2>In conclusion</h2>
1574 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1575 as we enjoyed making it. Please contact us if you have ideas
1576 for improvement or other feedback.</p>
1586 Contains a hash of options passed from the application script, including
1587 the original ARGV the script received, the processed values from that
1588 ARGV and any extra arguments to the script which were not processed.
1590 This can be used to add custom options to your application's scripts
1591 and setup your application differently depending on the values of these
1594 =head1 INTERNAL METHODS
1596 These methods are not meant to be used by end users.
1598 =head2 $c->components
1600 Returns a hash of components.
1602 =head2 $c->context_class
1604 Returns or sets the context class.
1608 Returns a hashref containing coderefs and execution counts (needed for
1609 deep recursion detection).
1613 Returns the number of actions on the current internal execution stack.
1617 Dispatches a request to actions.
1621 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1623 =head2 $c->dispatcher_class
1625 Returns or sets the dispatcher class.
1627 =head2 $c->dump_these
1629 Returns a list of 2-element array references (name, structure) pairs
1630 that will be dumped on the error page in debug mode.
1636 [ Request => $c->req ],
1637 [ Response => $c->res ],
1638 [ Stash => $c->stash ],
1639 [ Config => $c->config ];
1642 =head2 $c->engine_class
1644 Returns or sets the engine class.
1646 =head2 $c->execute( $class, $coderef )
1648 Execute a coderef in given class and catch exceptions. Errors are available
1654 my ( $c, $class, $code ) = @_;
1655 $class = $c->component($class) || $class;
1658 if ( $c->depth >= $RECURSION ) {
1659 my $action = $code->reverse();
1660 $action = "/$action" unless $action =~ /->/;
1661 my $error = qq/Deep recursion detected calling "${action}"/;
1662 $c->log->error($error);
1668 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1670 push( @{ $c->stack }, $code );
1672 no warnings 'recursion';
1673 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1674 # I have no idea how, ergo $ret (which appears to fix the issue)
1675 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1677 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1679 my $last = pop( @{ $c->stack } );
1681 if ( my $error = $@ ) {
1682 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1683 $error->rethrow if $c->depth > 1;
1685 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1686 $error->rethrow if $c->depth > 0;
1689 unless ( ref $error ) {
1690 no warnings 'uninitialized';
1692 my $class = $last->class;
1693 my $name = $last->name;
1694 $error = qq/Caught exception in $class->$name "$error"/;
1703 sub _stats_start_execute {
1704 my ( $c, $code ) = @_;
1705 my $appclass = ref($c) || $c;
1706 return if ( ( $code->name =~ /^_.*/ )
1707 && ( !$appclass->config->{show_internal_actions} ) );
1709 my $action_name = $code->reverse();
1710 $c->counter->{$action_name}++;
1712 my $action = $action_name;
1713 $action = "/$action" unless $action =~ /->/;
1715 # determine if the call was the result of a forward
1716 # this is done by walking up the call stack and looking for a calling
1717 # sub of Catalyst::forward before the eval
1719 for my $index ( 2 .. 11 ) {
1721 if ( ( caller($index) )[0] eq 'Catalyst'
1722 && ( caller($index) )[3] eq '(eval)' );
1724 if ( ( caller($index) )[3] =~ /forward$/ ) {
1725 $callsub = ( caller($index) )[3];
1726 $action = "-> $action";
1731 my $uid = $action_name . $c->counter->{$action_name};
1733 # is this a root-level call or a forwarded call?
1734 if ( $callsub =~ /forward$/ ) {
1735 my $parent = $c->stack->[-1];
1737 # forward, locate the caller
1738 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1741 parent => "$parent" . $c->counter->{"$parent"},
1747 # forward with no caller may come from a plugin
1766 sub _stats_finish_execute {
1767 my ( $c, $info ) = @_;
1768 $c->stats->profile( end => $info );
1773 Finalizes the request.
1780 for my $error ( @{ $c->error } ) {
1781 $c->log->error($error);
1784 # Allow engine to handle finalize flow (for POE)
1785 my $engine = $c->engine;
1786 if ( my $code = $engine->can('finalize') ) {
1791 $c->finalize_uploads;
1794 if ( $#{ $c->error } >= 0 ) {
1798 $c->finalize_headers;
1801 if ( $c->request->method eq 'HEAD' ) {
1802 $c->response->body('');
1810 if ($c->use_stats) {
1811 my $elapsed = sprintf '%f', $c->stats->elapsed;
1812 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1814 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1817 return $c->response->status;
1820 =head2 $c->finalize_body
1826 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1828 =head2 $c->finalize_cookies
1834 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1836 =head2 $c->finalize_error
1842 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1844 =head2 $c->finalize_headers
1850 sub finalize_headers {
1853 my $response = $c->response; #accessor calls can add up?
1855 # Check if we already finalized headers
1856 return if $response->finalized_headers;
1859 if ( my $location = $response->redirect ) {
1860 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1861 $response->header( Location => $location );
1863 if ( !$response->has_body ) {
1864 # Add a default body if none is already present
1865 $response->body(<<"EOF");
1866 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1867 <html xmlns="http://www.w3.org/1999/xhtml">
1869 <title>Moved</title>
1872 <p>This item has moved <a href="$location">here</a>.</p>
1876 $response->content_type('text/html; charset=utf-8');
1881 if ( defined $response->body && length $response->body && !$response->content_length ) {
1883 # get the length from a filehandle
1884 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1886 my $size = -s $response->body;
1888 $response->content_length( $size );
1891 $c->log->warn('Serving filehandle without a content-length');
1895 # everything should be bytes at this point, but just in case
1896 $response->content_length( length( $response->body ) );
1901 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1902 $response->headers->remove_header("Content-Length");
1903 $response->body('');
1906 $c->finalize_cookies;
1908 $c->engine->finalize_headers( $c, @_ );
1911 $response->finalized_headers(1);
1914 =head2 $c->finalize_output
1916 An alias for finalize_body.
1918 =head2 $c->finalize_read
1920 Finalizes the input after reading is complete.
1924 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1926 =head2 $c->finalize_uploads
1928 Finalizes uploads. Cleans up any temporary files.
1932 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1934 =head2 $c->get_action( $action, $namespace )
1936 Gets an action in a given namespace.
1940 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1942 =head2 $c->get_actions( $action, $namespace )
1944 Gets all actions of a given name in a namespace and all parent
1949 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1951 =head2 $app->handle_request( @arguments )
1953 Called to handle each HTTP request.
1957 sub handle_request {
1958 my ( $class, @arguments ) = @_;
1960 # Always expect worst case!
1963 if ($class->debug) {
1964 my $secs = time - $START || 1;
1965 my $av = sprintf '%.3f', $COUNT / $secs;
1966 my $time = localtime time;
1967 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1970 my $c = $class->prepare(@arguments);
1972 $status = $c->finalize;
1975 chomp(my $error = $_);
1976 $class->log->error(qq/Caught exception in engine "$error"/);
1981 if(my $coderef = $class->log->can('_flush')){
1982 $class->log->$coderef();
1987 =head2 $class->prepare( @arguments )
1989 Creates a Catalyst context from an engine-specific request (Apache, CGI,
1995 my ( $class, @arguments ) = @_;
1998 # After the app/ctxt split, this should become an attribute based on something passed
1999 # into the application.
2000 $class->context_class( ref $class || $class ) unless $class->context_class;
2002 my $c = $class->context_class->new({});
2004 # For on-demand data
2005 $c->request->_context($c);
2006 $c->response->_context($c);
2008 #surely this is not the most efficient way to do things...
2009 $c->stats($class->stats_class->new)->enable($c->use_stats);
2010 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2011 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2015 # Allow engine to direct the prepare flow (for POE)
2016 if ( my $prepare = $c->engine->can('prepare') ) {
2017 $c->engine->$prepare( $c, @arguments );
2020 $c->prepare_request(@arguments);
2021 $c->prepare_connection;
2022 $c->prepare_query_parameters;
2023 $c->prepare_headers;
2024 $c->prepare_cookies;
2027 # Prepare the body for reading, either by prepare_body
2028 # or the user, if they are using $c->read
2031 # Parse the body unless the user wants it on-demand
2032 unless ( ref($c)->config->{parse_on_demand} ) {
2038 # VERY ugly and probably shouldn't rely on ->finalize actually working
2040 # failed prepare is always due to an invalid request, right?
2041 $c->response->status(400);
2042 $c->response->content_type('text/plain');
2043 $c->response->body('Bad Request');
2044 # Note we call finalize and then die here, which escapes
2045 # finalize being called in the enclosing block..
2046 # It in fact couldn't be called, as we don't return $c..
2047 # This is a mess - but I'm unsure you can fix this without
2048 # breaking compat for people doing crazy things (we should set
2049 # the 400 and just return the ctx here IMO, letting finalize get called
2060 =head2 $c->prepare_action
2062 Prepares action. See L<Catalyst::Dispatcher>.
2066 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2068 =head2 $c->prepare_body
2070 Prepares message body.
2077 return if $c->request->_has_body;
2079 # Initialize on-demand data
2080 $c->engine->prepare_body( $c, @_ );
2081 $c->prepare_parameters;
2082 $c->prepare_uploads;
2085 =head2 $c->prepare_body_chunk( $chunk )
2087 Prepares a chunk of data before sending it to L<HTTP::Body>.
2089 See L<Catalyst::Engine>.
2093 sub prepare_body_chunk {
2095 $c->engine->prepare_body_chunk( $c, @_ );
2098 =head2 $c->prepare_body_parameters
2100 Prepares body parameters.
2104 sub prepare_body_parameters {
2106 $c->engine->prepare_body_parameters( $c, @_ );
2109 =head2 $c->prepare_connection
2111 Prepares connection.
2115 sub prepare_connection {
2117 $c->engine->prepare_connection( $c, @_ );
2120 =head2 $c->prepare_cookies
2126 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2128 =head2 $c->prepare_headers
2134 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2136 =head2 $c->prepare_parameters
2138 Prepares parameters.
2142 sub prepare_parameters {
2144 $c->prepare_body_parameters;
2145 $c->engine->prepare_parameters( $c, @_ );
2148 =head2 $c->prepare_path
2150 Prepares path and base.
2154 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2156 =head2 $c->prepare_query_parameters
2158 Prepares query parameters.
2162 sub prepare_query_parameters {
2165 $c->engine->prepare_query_parameters( $c, @_ );
2168 =head2 $c->log_request
2170 Writes information about the request to the debug logs. This includes:
2174 =item * Request method, path, and remote IP address
2176 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2178 =item * Request parameters
2180 =item * File uploads
2189 return unless $c->debug;
2191 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2192 my $request = $dump->[1];
2194 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2196 $path = '/' unless length $path;
2198 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2200 $c->log_request_headers($request->headers);
2202 if ( my $keywords = $request->query_keywords ) {
2203 $c->log->debug("Query keywords are: $keywords");
2206 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2208 $c->log_request_uploads($request);
2211 =head2 $c->log_response
2213 Writes information about the response to the debug logs by calling
2214 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2221 return unless $c->debug;
2223 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2224 my $response = $dump->[1];
2226 $c->log_response_status_line($response);
2227 $c->log_response_headers($response->headers);
2230 =head2 $c->log_response_status_line($response)
2232 Writes one line of information about the response to the debug logs. This includes:
2236 =item * Response status code
2238 =item * Content-Type header (if present)
2240 =item * Content-Length header (if present)
2246 sub log_response_status_line {
2247 my ($c, $response) = @_;
2251 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2252 $response->status || 'unknown',
2253 $response->headers->header('Content-Type') || 'unknown',
2254 $response->headers->header('Content-Length') || 'unknown'
2259 =head2 $c->log_response_headers($headers);
2261 Hook method which can be wrapped by plugins to log the response headers.
2262 No-op in the default implementation.
2266 sub log_response_headers {}
2268 =head2 $c->log_request_parameters( query => {}, body => {} )
2270 Logs request parameters to debug logs
2274 sub log_request_parameters {
2276 my %all_params = @_;
2278 return unless $c->debug;
2280 my $column_width = Catalyst::Utils::term_width() - 44;
2281 foreach my $type (qw(query body)) {
2282 my $params = $all_params{$type};
2283 next if ! keys %$params;
2284 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2285 for my $key ( sort keys %$params ) {
2286 my $param = $params->{$key};
2287 my $value = defined($param) ? $param : '';
2288 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2290 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2294 =head2 $c->log_request_uploads
2296 Logs file uploads included in the request to the debug logs.
2297 The parameter name, filename, file type, and file size are all included in
2302 sub log_request_uploads {
2304 my $request = shift;
2305 return unless $c->debug;
2306 my $uploads = $request->uploads;
2307 if ( keys %$uploads ) {
2308 my $t = Text::SimpleTable->new(
2309 [ 12, 'Parameter' ],
2314 for my $key ( sort keys %$uploads ) {
2315 my $upload = $uploads->{$key};
2316 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2317 $t->row( $key, $u->filename, $u->type, $u->size );
2320 $c->log->debug( "File Uploads are:\n" . $t->draw );
2324 =head2 $c->log_request_headers($headers);
2326 Hook method which can be wrapped by plugins to log the request headers.
2327 No-op in the default implementation.
2331 sub log_request_headers {}
2333 =head2 $c->log_headers($type => $headers)
2335 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2342 my $headers = shift; # an HTTP::Headers instance
2344 return unless $c->debug;
2346 my $column_width = Catalyst::Utils::term_width() - 28;
2347 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2350 my ( $name, $value ) = @_;
2351 $t->row( $name, $value );
2354 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2358 =head2 $c->prepare_read
2360 Prepares the input for reading.
2364 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2366 =head2 $c->prepare_request
2368 Prepares the engine request.
2372 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2374 =head2 $c->prepare_uploads
2380 sub prepare_uploads {
2383 $c->engine->prepare_uploads( $c, @_ );
2386 =head2 $c->prepare_write
2388 Prepares the output for writing.
2392 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2394 =head2 $c->request_class
2396 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2398 =head2 $c->response_class
2400 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2402 =head2 $c->read( [$maxlength] )
2404 Reads a chunk of data from the request body. This method is designed to
2405 be used in a while loop, reading C<$maxlength> bytes on every call.
2406 C<$maxlength> defaults to the size of the request if not specified.
2408 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2411 Warning: If you use read(), Catalyst will not process the body,
2412 so you will not be able to access POST parameters or file uploads via
2413 $c->request. You must handle all body parsing yourself.
2417 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2427 $app->engine_loader->needs_psgi_engine_compat_hack ?
2428 $app->engine->run($app, @_) :
2429 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2432 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2434 Sets an action in a given namespace.
2438 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2440 =head2 $c->setup_actions($component)
2442 Sets up actions for a component.
2446 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2448 =head2 $c->setup_components
2450 This method is called internally to set up the application's components.
2452 It finds modules by calling the L<locate_components> method, expands them to
2453 package names with the L<expand_component_module> method, and then installs
2454 each component into the application.
2456 The C<setup_components> config option is passed to both of the above methods.
2458 Installation of each component is performed by the L<setup_component> method,
2463 sub setup_components {
2466 my $config = $class->config->{ setup_components };
2468 my @comps = $class->locate_components($config);
2469 my %comps = map { $_ => 1 } @comps;
2471 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2472 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2473 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2474 ) if $deprecatedcatalyst_component_names;
2476 for my $component ( @comps ) {
2478 # We pass ignore_loaded here so that overlay files for (e.g.)
2479 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2480 # we know M::P::O found a file on disk so this is safe
2482 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2485 for my $component (@comps) {
2486 my $instance = $class->components->{ $component } = $class->setup_component($component);
2487 my @expanded_components = $instance->can('expand_modules')
2488 ? $instance->expand_modules( $component, $config )
2489 : $class->expand_component_module( $component, $config );
2490 for my $component (@expanded_components) {
2491 next if $comps{$component};
2492 $class->components->{ $component } = $class->setup_component($component);
2497 =head2 $c->locate_components( $setup_component_config )
2499 This method is meant to provide a list of component modules that should be
2500 setup for the application. By default, it will use L<Module::Pluggable>.
2502 Specify a C<setup_components> config option to pass additional options directly
2503 to L<Module::Pluggable>. To add additional search paths, specify a key named
2504 C<search_extra> as an array reference. Items in the array beginning with C<::>
2505 will have the application class name prepended to them.
2509 sub locate_components {
2513 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2514 my $extra = delete $config->{ search_extra } || [];
2516 push @paths, @$extra;
2518 my $locator = Module::Pluggable::Object->new(
2519 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2523 # XXX think about ditching this sort entirely
2524 my @comps = sort { length $a <=> length $b } $locator->plugins;
2529 =head2 $c->expand_component_module( $component, $setup_component_config )
2531 Components found by C<locate_components> will be passed to this method, which
2532 is expected to return a list of component (package) names to be set up.
2536 sub expand_component_module {
2537 my ($class, $module) = @_;
2538 return Devel::InnerPackage::list_packages( $module );
2541 =head2 $c->setup_component
2545 sub setup_component {
2546 my( $class, $component ) = @_;
2548 unless ( $component->can( 'COMPONENT' ) ) {
2552 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2553 my $config = $class->config->{ $suffix } || {};
2554 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2555 # methods also pass it. local to avoid pointlessly shitting in config
2556 # for the debug screen, as $component is already the key name.
2557 local $config->{catalyst_component_name} = $component;
2559 my $instance = eval { $component->COMPONENT( $class, $config ); };
2561 if ( my $error = $@ ) {
2563 Catalyst::Exception->throw(
2564 message => qq/Couldn't instantiate component "$component", "$error"/
2568 unless (blessed $instance) {
2569 my $metaclass = Moose::Util::find_meta($component);
2570 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2571 my $component_method_from = $method_meta->associated_metaclass->name;
2572 my $value = defined($instance) ? $instance : 'undef';
2573 Catalyst::Exception->throw(
2575 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2581 =head2 $c->setup_dispatcher
2587 sub setup_dispatcher {
2588 my ( $class, $dispatcher ) = @_;
2591 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2594 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2595 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2598 unless ($dispatcher) {
2599 $dispatcher = $class->dispatcher_class;
2602 Class::MOP::load_class($dispatcher);
2604 # dispatcher instance
2605 $class->dispatcher( $dispatcher->new );
2608 =head2 $c->setup_engine
2615 my ($class, $requested_engine) = @_;
2617 if (!$class->engine_loader || $requested_engine) {
2618 $class->engine_loader(
2619 Catalyst::EngineLoader->new({
2620 application_name => $class,
2621 (defined $requested_engine
2622 ? (catalyst_engine_class => $requested_engine) : ()),
2627 $class->engine_loader->catalyst_engine_class;
2631 my ($class, $requested_engine) = @_;
2634 my $loader = $class->engine_loader;
2636 if (!$loader || $requested_engine) {
2637 $loader = Catalyst::EngineLoader->new({
2638 application_name => $class,
2639 (defined $requested_engine
2640 ? (requested_engine => $requested_engine) : ()),
2643 $class->engine_loader($loader);
2646 $loader->catalyst_engine_class;
2649 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2650 return if $class->loading_psgi_file;
2652 Class::MOP::load_class($engine);
2654 if ($ENV{MOD_PERL}) {
2655 my $apache = $class->engine_loader->auto;
2657 my $meta = find_meta($class);
2658 my $was_immutable = $meta->is_immutable;
2659 my %immutable_options = $meta->immutable_options;
2660 $meta->make_mutable if $was_immutable;
2662 $meta->add_method(handler => sub {
2664 my $psgi_app = $class->_finalized_psgi_app;
2665 $apache->call_app($r, $psgi_app);
2668 $meta->make_immutable(%immutable_options) if $was_immutable;
2671 $class->engine( $engine->new );
2676 sub _finalized_psgi_app {
2679 unless ($app->_psgi_app) {
2680 my $psgi_app = $app->_setup_psgi_app;
2681 $app->_psgi_app($psgi_app);
2684 return $app->_psgi_app;
2687 sub _setup_psgi_app {
2690 for my $home (Path::Class::Dir->new($app->config->{home})) {
2691 my $psgi_file = $home->file(
2692 Catalyst::Utils::appprefix($app) . '.psgi',
2695 next unless -e $psgi_file;
2697 # If $psgi_file calls ->setup_engine, it's doing so to load
2698 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2699 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2700 # anyway. So set a flag (ick) that tells setup_engine not to populate
2701 # $c->engine or do any other things we might regret.
2703 $app->loading_psgi_file(1);
2704 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2705 $app->loading_psgi_file(0);
2708 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2711 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2713 Its content has been ignored. Please consult the Catalyst::Upgrading
2714 documentation on how to upgrade from Catalyst::Engine::PSGI.
2718 return $app->apply_default_middlewares($app->psgi_app);
2721 =head2 $c->apply_default_middlewares
2723 Adds the following L<Plack> middlewares to your application, since they are
2724 useful and commonly needed:
2726 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2727 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2728 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2729 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2730 applied since this middleware is smart enough to conditionally apply itself).
2732 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2733 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2739 sub apply_default_middlewares {
2740 my ($app, $psgi_app) = @_;
2742 $psgi_app = Plack::Middleware::Conditional->wrap(
2744 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2747 return if $app->config->{ignore_frontend_proxy};
2748 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2749 || $app->config->{using_frontend_proxy};
2753 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2754 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2755 $psgi_app = Plack::Middleware::Conditional->wrap(
2757 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2760 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2761 return unless $1 < 4.23;
2766 # we're applying this unconditionally as the middleware itself already makes
2767 # sure it doesn't fuck things up if it's not running under one of the right
2769 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2776 Returns a PSGI application code reference for the catalyst application
2777 C<$c>. This is the bare application without any middlewares
2778 applied. C<${myapp}.psgi> is not taken into account.
2780 This is what you want to be using to retrieve the PSGI application code
2781 reference of your Catalyst application for use in F<.psgi> files.
2787 return $app->engine->build_psgi_app($app);
2790 =head2 $c->setup_home
2792 Sets up the home directory.
2797 my ( $class, $home ) = @_;
2799 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2803 $home ||= Catalyst::Utils::home($class);
2806 #I remember recently being scolded for assigning config values like this
2807 $class->config->{home} ||= $home;
2808 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2812 =head2 $c->setup_log
2814 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2815 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2818 This method also installs a C<debug> method that returns a true value into the
2819 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2820 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2822 Note that if the log has already been setup, by either a previous call to
2823 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2824 that this method won't actually set up the log object.
2829 my ( $class, $levels ) = @_;
2832 $levels =~ s/^\s+//;
2833 $levels =~ s/\s+$//;
2834 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2836 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2837 if ( defined $env_debug ) {
2838 $levels{debug} = 1 if $env_debug; # Ugly!
2839 delete($levels{debug}) unless $env_debug;
2842 unless ( $class->log ) {
2843 $class->log( Catalyst::Log->new(keys %levels) );
2846 if ( $levels{debug} ) {
2847 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2848 $class->log->debug('Debug messages enabled');
2852 =head2 $c->setup_plugins
2858 =head2 $c->setup_stats
2860 Sets up timing statistics class.
2865 my ( $class, $stats ) = @_;
2867 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2869 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2870 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2871 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2872 $class->log->debug('Statistics enabled');
2877 =head2 $c->registered_plugins
2879 Returns a sorted list of the plugins which have either been stated in the
2882 If passed a given plugin name, it will report a boolean value indicating
2883 whether or not that plugin is loaded. A fully qualified name is required if
2884 the plugin name does not begin with C<Catalyst::Plugin::>.
2886 if ($c->registered_plugins('Some::Plugin')) {
2894 sub registered_plugins {
2896 return sort keys %{ $proto->_plugins } unless @_;
2898 return 1 if exists $proto->_plugins->{$plugin};
2899 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2902 sub _register_plugin {
2903 my ( $proto, $plugin, $instant ) = @_;
2904 my $class = ref $proto || $proto;
2906 Class::MOP::load_class( $plugin );
2907 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2908 if $plugin->isa( 'Catalyst::Component' );
2909 $proto->_plugins->{$plugin} = 1;
2911 my $meta = Class::MOP::get_metaclass_by_name($class);
2912 $meta->superclasses($plugin, $meta->superclasses);
2918 my ( $class, $plugins ) = @_;
2920 $class->_plugins( {} ) unless $class->_plugins;
2921 $plugins = Data::OptList::mkopt($plugins || []);
2924 [ Catalyst::Utils::resolve_namespace(
2925 $class . '::Plugin',
2926 'Catalyst::Plugin', $_->[0]
2932 for my $plugin ( reverse @plugins ) {
2933 Class::MOP::load_class($plugin->[0], $plugin->[1]);
2934 my $meta = find_meta($plugin->[0]);
2935 next if $meta && $meta->isa('Moose::Meta::Role');
2937 $class->_register_plugin($plugin->[0]);
2941 map { $_->[0]->name, $_->[1] }
2942 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
2943 map { [find_meta($_->[0]), $_->[1]] }
2946 Moose::Util::apply_all_roles(
2954 Returns an arrayref of the internal execution stack (actions that are
2955 currently executing).
2959 Returns the current timing statistics object. By default Catalyst uses
2960 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
2961 L<< stats_class|/"$c->stats_class" >>.
2963 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
2964 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
2965 profile explicitly, although MyApp.pm still won't profile nor output anything
2968 =head2 $c->stats_class
2970 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
2972 =head2 $c->use_stats
2974 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
2976 Note that this is a static method, not an accessor and should be overridden
2977 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
2984 =head2 $c->write( $data )
2986 Writes $data to the output stream. When using this method directly, you
2987 will need to manually set the C<Content-Length> header to the length of
2988 your output data, if known.
2995 # Finalize headers if someone manually writes output
2996 $c->finalize_headers;
2998 return $c->engine->write( $c, @_ );
3003 Returns the Catalyst version number. Mostly useful for "powered by"
3004 messages in template systems.
3008 sub version { return $Catalyst::VERSION }
3010 =head1 CONFIGURATION
3012 There are a number of 'base' config variables which can be set:
3018 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3022 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3026 C<disable_component_resolution_regex_fallback> - Turns
3027 off the deprecated component resolution functionality so
3028 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3029 are called then regex search will not be attempted on string values and
3030 instead C<undef> will be returned.
3034 C<home> - The application home directory. In an uninstalled application,
3035 this is the top level application directory. In an installed application,
3036 this will be the directory containing C<< MyApp.pm >>.
3040 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3044 C<name> - The name of the application in debug messages and the debug and
3049 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3050 until it is accessed. This allows you to (for example) check authentication (and reject
3051 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3055 C<root> - The root directory for templates. Usually this is just a
3056 subdirectory of the home directory, but you can set it to change the
3057 templates to a different directory.
3061 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3062 namespaces from which components will be loaded (and constructed and stored in
3063 C<< $c->components >>).
3067 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3068 to be shown in hit debug tables in the test server.
3072 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3073 variable should be used for determining the request path.
3075 Most web server environments pass the requested path to the application using environment variables,
3076 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3077 exposed as C<< $c->request->base >>) and the request path below that base.
3079 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3080 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3084 =item use_request_uri_for_path => 0
3086 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3087 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3088 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3089 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3091 However this method has the major disadvantage that it is impossible to correctly decode some elements
3092 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3093 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3094 can't distinguish / vs %2F in paths (in addition to other encoded values).
3096 =item use_request_uri_for_path => 1
3098 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3099 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3100 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3102 Given that this method of path resolution is provably more correct, it is recommended that you use
3103 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3104 aware of the implications of not being able to handle encoded URI paths correctly.
3106 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3107 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3108 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3109 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3110 C<< $c->request->base >> will be incorrect.
3116 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3120 =head1 INTERNAL ACTIONS
3122 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3123 C<_ACTION>, and C<_END>. These are by default not shown in the private
3124 action table, but you can make them visible with a config parameter.
3126 MyApp->config(show_internal_actions => 1);
3128 =head1 ON-DEMAND PARSER
3130 The request body is usually parsed at the beginning of a request,
3131 but if you want to handle input yourself, you can enable on-demand
3132 parsing with a config parameter.
3134 MyApp->config(parse_on_demand => 1);
3136 =head1 PROXY SUPPORT
3138 Many production servers operate using the common double-server approach,
3139 with a lightweight frontend web server passing requests to a larger
3140 backend server. An application running on the backend server must deal
3141 with two problems: the remote user always appears to be C<127.0.0.1> and
3142 the server's hostname will appear to be C<localhost> regardless of the
3143 virtual host that the user connected through.
3145 Catalyst will automatically detect this situation when you are running
3146 the frontend and backend servers on the same machine. The following
3147 changes are made to the request.
3149 $c->req->address is set to the user's real IP address, as read from
3150 the HTTP X-Forwarded-For header.
3152 The host value for $c->req->base and $c->req->uri is set to the real
3153 host, as read from the HTTP X-Forwarded-Host header.
3155 Additionally, you may be running your backend application on an insecure
3156 connection (port 80) while your frontend proxy is running under SSL. If there
3157 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3158 tell Catalyst what port the frontend listens on. This will allow all URIs to
3159 be created properly.
3161 In the case of passing in:
3163 X-Forwarded-Port: 443
3165 All calls to C<uri_for> will result in an https link, as is expected.
3167 Obviously, your web server must support these headers for this to work.
3169 In a more complex server farm environment where you may have your
3170 frontend proxy server(s) on different machines, you will need to set a
3171 configuration option to tell Catalyst to read the proxied data from the
3174 MyApp->config(using_frontend_proxy => 1);
3176 If you do not wish to use the proxy support at all, you may set:
3178 MyApp->config(ignore_frontend_proxy => 0);
3180 =head2 Note about psgi files
3182 Note that if you supply your own .psgi file, calling
3183 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3185 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3186 in your psgi, for example:
3189 enable "Plack::Middleware::ReverseProxy";
3193 This will unconditionally add the ReverseProxy support, or you need to call
3194 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3195 apply the support depending upon your config).
3197 See L<Catalyst::PSGI> for more information.
3199 =head1 THREAD SAFETY
3201 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3202 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3203 believe the Catalyst core to be thread-safe.
3205 If you plan to operate in a threaded environment, remember that all other
3206 modules you are using must also be thread-safe. Some modules, most notably
3207 L<DBD::SQLite>, are not thread-safe.
3213 Join #catalyst on irc.perl.org.
3217 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3218 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3222 http://catalyst.perl.org
3226 http://dev.catalyst.perl.org
3230 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3232 =head2 L<Catalyst::Manual> - The Catalyst Manual
3234 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3236 =head2 L<Catalyst::Engine> - Core engine
3238 =head2 L<Catalyst::Log> - Log class.
3240 =head2 L<Catalyst::Request> - Request object
3242 =head2 L<Catalyst::Response> - Response object
3244 =head2 L<Catalyst::Test> - The test suite.
3248 =head1 PROJECT FOUNDER
3250 sri: Sebastian Riedel <sri@cpan.org>
3256 acme: Leon Brocard <leon@astray.com>
3258 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3262 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3266 andyg: Andy Grundman <andy@hybridized.org>
3268 audreyt: Audrey Tang
3270 bricas: Brian Cassidy <bricas@cpan.org>
3272 Caelum: Rafael Kitover <rkitover@io.com>
3274 chansen: Christian Hansen
3276 chicks: Christopher Hicks
3278 Chisel Wright C<pause@herlpacker.co.uk>
3280 Danijel Milicevic C<me@danijel.de>
3282 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3284 David Naughton, C<naughton@umn.edu>
3288 dhoss: Devin Austin <dhoss@cpan.org>
3290 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3294 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3296 esskar: Sascha Kiefer
3298 fireartist: Carl Franks <cfranks@cpan.org>
3300 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3302 gabb: Danijel Milicevic
3306 Gavin Henry C<ghenry@perl.me.uk>
3310 groditi: Guillermo Roditi <groditi@gmail.com>
3312 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3314 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3316 jcamacho: Juan Camacho
3318 jester: Jesse Sheidlower C<jester@panix.com>
3320 jhannah: Jay Hannah <jay@jays.net>
3326 jon: Jon Schutz <jjschutz@cpan.org>
3328 Jonathan Rockway C<< <jrockway@cpan.org> >>
3330 Kieren Diment C<kd@totaldatasolution.com>
3332 konobi: Scott McWhirter <konobi@cpan.org>
3334 marcus: Marcus Ramberg <mramberg@cpan.org>
3336 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3338 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3342 naughton: David Naughton
3344 ningu: David Kamholz <dkamholz@cpan.org>
3346 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3348 numa: Dan Sully <daniel@cpan.org>
3354 omega: Andreas Marienborg
3356 Oleg Kostyuk <cub.uanic@gmail.com>
3358 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3360 rafl: Florian Ragwitz <rafl@debian.org>
3362 random: Roland Lammel <lammel@cpan.org>
3364 Robert Sedlacek C<< <rs@474.at> >>
3366 SpiceMan: Marcel Montes
3370 szbalint: Balint Szilakszi <szbalint@cpan.org>
3372 t0m: Tomas Doran <bobtfish@bobtfish.net>
3376 Viljo Marrandi C<vilts@yahoo.com>
3378 Will Hawes C<info@whawes.co.uk>
3380 willert: Sebastian Willert <willert@cpan.org>
3382 wreis: Wallace Reis <wallace@reis.org.br>
3384 Yuval Kogman, C<nothingmuch@woobling.org>
3386 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3388 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3394 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3398 This library is free software. You can redistribute it and/or modify it under
3399 the same terms as Perl itself.
3405 __PACKAGE__->meta->make_immutable;