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/;
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.90004';
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 : Global { # 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 : Path('/bar/of/soap') { ... }
171 # called for all actions, from the top-most controller downwards
173 my ( $self, $c ) = @_;
174 if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication
175 $c->res->redirect( '/login' ); # require login
176 return 0; # abort request and go immediately to end()
178 return 1; # success; carry on to next action
181 # called after all actions are finished
183 my ( $self, $c ) = @_;
184 if ( scalar @{ $c->error } ) { ... } # handle errors
185 return if $c->res->body; # already have a response
186 $c->forward( 'MyApp::View::TT' ); # render template
189 ### in MyApp/Controller/Foo.pm
190 # called for /foo/bar
191 sub bar : Local { ... }
193 # called for /blargle
194 sub blargle : Global { ... }
196 # an index action matches /foo, but not /foo/1, etc.
197 sub index : Private { ... }
199 ### in MyApp/Controller/Foo/Bar.pm
200 # called for /foo/bar/baz
201 sub baz : Local { ... }
203 # first Root auto is called, then Foo auto, then this
204 sub auto : Private { ... }
206 # powerful regular expression paths are also possible
207 sub details : Regex('^product/(\w+)/details$') {
208 my ( $self, $c ) = @_;
209 # extract the (\w+) from the URI
210 my $product = $c->req->captures->[0];
213 See L<Catalyst::Manual::Intro> for additional information.
217 Catalyst is a modern framework for making web applications without the
218 pain usually associated with this process. This document is a reference
219 to the main Catalyst application. If you are a new user, we suggest you
220 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
222 See L<Catalyst::Manual> for more documentation.
224 Catalyst plugins can be loaded by naming them as arguments to the "use
225 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
226 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
229 use Catalyst qw/My::Module/;
231 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
232 fully qualify the name by using a unary plus:
236 +Fully::Qualified::Plugin::Name
239 Special flags like C<-Debug> and C<-Engine> can also be specified as
240 arguments when Catalyst is loaded:
242 use Catalyst qw/-Debug My::Module/;
244 The position of plugins and flags in the chain is important, because
245 they are loaded in the order in which they appear.
247 The following flags are supported:
251 Enables debug output. You can also force this setting from the system
252 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
253 settings override the application, with <MYAPP>_DEBUG having the highest
256 This sets the log level to 'debug' and enables full debug output on the
257 error screen. If you only want the latter, see L<< $c->debug >>.
261 Forces Catalyst to use a specific engine. Omit the
262 C<Catalyst::Engine::> prefix of the engine name, i.e.:
264 use Catalyst qw/-Engine=CGI/;
268 Forces Catalyst to use a specific home directory, e.g.:
270 use Catalyst qw[-Home=/usr/mst];
272 This can also be done in the shell environment by setting either the
273 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
274 is replaced with the uppercased name of your application, any "::" in
275 the name will be replaced with underscores, e.g. MyApp::Web should use
276 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
278 If none of these are set, Catalyst will attempt to automatically detect the
279 home directory. If you are working in a development environment, Catalyst
280 will try and find the directory containing either Makefile.PL, Build.PL or
281 dist.ini. If the application has been installed into the system (i.e.
282 you have done C<make install>), then Catalyst will use the path to your
283 application module, without the .pm extension (e.g., /foo/MyApp if your
284 application was installed at /foo/MyApp.pm)
288 use Catalyst '-Log=warn,fatal,error';
290 Specifies a comma-delimited list of log levels.
294 Enables statistics collection and reporting.
296 use Catalyst qw/-Stats=1/;
298 You can also force this setting from the system environment with CATALYST_STATS
299 or <MYAPP>_STATS. The environment settings override the application, with
300 <MYAPP>_STATS having the highest priority.
302 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
306 =head2 INFORMATION ABOUT THE CURRENT REQUEST
310 Returns a L<Catalyst::Action> object for the current action, which
311 stringifies to the action name. See L<Catalyst::Action>.
315 Returns the namespace of the current action, i.e., the URI prefix
316 corresponding to the controller of the current action. For example:
318 # in Controller::Foo::Bar
319 $c->namespace; # returns 'foo/bar';
325 Returns the current L<Catalyst::Request> object, giving access to
326 information about the current client request (including parameters,
327 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
329 =head2 REQUEST FLOW HANDLING
331 =head2 $c->forward( $action [, \@arguments ] )
333 =head2 $c->forward( $class, $method, [, \@arguments ] )
335 Forwards processing to another action, by its private name. If you give a
336 class name but no method, C<process()> is called. You may also optionally
337 pass arguments in an arrayref. The action will receive the arguments in
338 C<@_> and C<< $c->req->args >>. Upon returning from the function,
339 C<< $c->req->args >> will be restored to the previous values.
341 Any data C<return>ed from the action forwarded to, will be returned by the
344 my $foodata = $c->forward('/foo');
345 $c->forward('index');
346 $c->forward(qw/Model::DBIC::Foo do_stuff/);
347 $c->forward('View::TT');
349 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
350 an C<< eval { } >> around the call (actually
351 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
352 exceptions thrown by the called action non-fatal and pushing them onto
353 $c->error instead. If you want C<die> to propagate you need to do something
357 die join "\n", @{ $c->error } if @{ $c->error };
359 Or make sure to always return true values from your actions and write
362 $c->forward('foo') || return;
364 Another note is that C<< $c->forward >> always returns a scalar because it
365 actually returns $c->state which operates in a scalar context.
366 Thus, something like:
370 in an action that is forwarded to is going to return a scalar,
371 i.e. how many items are in that array, which is probably not what you want.
372 If you need to return an array then return a reference to it,
375 $c->stash->{array} = \@array;
377 and access it from the stash.
379 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.
383 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
385 =head2 $c->detach( $action [, \@arguments ] )
387 =head2 $c->detach( $class, $method, [, \@arguments ] )
391 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
392 doesn't return to the previous action when processing is finished.
394 When called with no arguments it escapes the processing chain entirely.
398 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
400 =head2 $c->visit( $action [, \@captures, \@arguments ] )
402 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
404 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
405 but does a full dispatch, instead of just calling the new C<$action> /
406 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
407 you go to are called, just like a new request.
409 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
410 This means, for example, that C<< $c->action >> methods such as
411 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
412 L<reverse|Catalyst::Action/reverse> return information for the visited action
413 when they are invoked within the visited action. This is different from the
414 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
415 continues to use the $c->action object from the caller action even when
416 invoked from the called action.
418 C<< $c->stash >> is kept unchanged.
420 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
421 allows you to "wrap" another action, just as it would have been called by
422 dispatching from a URL, while the analogous
423 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
424 transfer control to another action as if it had been reached directly from a URL.
428 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
430 =head2 $c->go( $action [, \@captures, \@arguments ] )
432 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
434 The relationship between C<go> and
435 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
436 the relationship between
437 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
438 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
439 C<< $c->go >> will perform a full dispatch on the specified action or method,
440 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
441 C<go> escapes the processing of the current request chain on completion, and
442 does not return to its caller.
444 @arguments are arguments to the final destination of $action. @captures are
445 arguments to the intermediate steps, if any, on the way to the final sub of
450 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
456 Returns the current L<Catalyst::Response> object, see there for details.
460 Returns a hashref to the stash, which may be used to store data and pass
461 it between components during a request. You can also set hash keys by
462 passing arguments. The stash is automatically sent to the view. The
463 stash is cleared at the end of a request; it cannot be used for
464 persistent storage (for this you must use a session; see
465 L<Catalyst::Plugin::Session> for a complete system integrated with
468 $c->stash->{foo} = $bar;
469 $c->stash( { moose => 'majestic', qux => 0 } );
470 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
472 # stash is automatically passed to the view for use in a template
473 $c->forward( 'MyApp::View::TT' );
477 around stash => sub {
480 my $stash = $orig->($c);
482 my $new_stash = @_ > 1 ? {@_} : $_[0];
483 croak('stash takes a hash or hashref') unless ref $new_stash;
484 foreach my $key ( keys %$new_stash ) {
485 $stash->{$key} = $new_stash->{$key};
495 =head2 $c->error($error, ...)
497 =head2 $c->error($arrayref)
499 Returns an arrayref containing error messages. If Catalyst encounters an
500 error while processing a request, it stores the error in $c->error. This
501 method should only be used to store fatal error messages.
503 my @error = @{ $c->error };
507 $c->error('Something bad happened');
514 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
515 croak @$error unless ref $c;
516 push @{ $c->{error} }, @$error;
518 elsif ( defined $_[0] ) { $c->{error} = undef }
519 return $c->{error} || [];
525 Contains the return value of the last executed action.
526 Note that << $c->state >> operates in a scalar context which means that all
527 values it returns are scalar.
529 =head2 $c->clear_errors
531 Clear errors. You probably don't want to clear the errors unless you are
532 implementing a custom error screen.
534 This is equivalent to running
545 sub _comp_search_prefixes {
547 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
550 # search components given a name and some prefixes
551 sub _comp_names_search_prefixes {
552 my ( $c, $name, @prefixes ) = @_;
553 my $appclass = ref $c || $c;
554 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
555 $filter = qr/$filter/; # Compile regex now rather than once per loop
557 # map the original component name to the sub part that we will search against
558 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
559 grep { /$filter/ } keys %{ $c->components };
561 # undef for a name will return all
562 return keys %eligible if !defined $name;
564 my $query = ref $name ? $name : qr/^$name$/i;
565 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
567 return @result if @result;
569 # if we were given a regexp to search against, we're done.
572 # skip regexp fallback if configured
574 if $appclass->config->{disable_component_resolution_regex_fallback};
578 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
580 # no results? try against full names
582 @result = grep { m{$query} } keys %eligible;
585 # don't warn if we didn't find any results, it just might not exist
587 # Disgusting hack to work out correct method name
588 my $warn_for = lc $prefixes[0];
589 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
590 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
591 "component resolution is unreliable and unsafe.";
592 my $short = $result[0];
593 # remove the component namespace prefix
594 $short =~ s/.*?(Model|Controller|View):://;
595 my $shortmess = Carp::shortmess('');
596 if ($shortmess =~ m#Catalyst/Plugin#) {
597 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
599 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
600 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
601 "component's config";
603 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
604 "but if you really wanted to search, pass in a regexp as the argument " .
605 "like so: \$c->${warn_for}(qr/${name}/)";
607 $c->log->warn( "${msg}$shortmess" );
613 # Find possible names for a prefix
615 my ( $c, @prefixes ) = @_;
616 my $appclass = ref $c || $c;
618 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
620 my @names = map { s{$filter}{}; $_; }
621 $c->_comp_names_search_prefixes( undef, @prefixes );
626 # Filter a component before returning by calling ACCEPT_CONTEXT if available
627 sub _filter_component {
628 my ( $c, $comp, @args ) = @_;
630 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
631 return $comp->ACCEPT_CONTEXT( $c, @args );
637 =head2 COMPONENT ACCESSORS
639 =head2 $c->controller($name)
641 Gets a L<Catalyst::Controller> instance by name.
643 $c->controller('Foo')->do_stuff;
645 If the name is omitted, will return the controller for the dispatched
648 If you want to search for controllers, pass in a regexp as the argument.
650 # find all controllers that start with Foo
651 my @foo_controllers = $c->controller(qr{^Foo});
657 my ( $c, $name, @args ) = @_;
659 my $appclass = ref($c) || $c;
661 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
662 my $comps = $c->components;
663 my $check = $appclass."::Controller::".$name;
664 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
666 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
667 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
668 return $c->_filter_component( $result[ 0 ], @args );
671 return $c->component( $c->action->class );
674 =head2 $c->model($name)
676 Gets a L<Catalyst::Model> instance by name.
678 $c->model('Foo')->do_stuff;
680 Any extra arguments are directly passed to ACCEPT_CONTEXT.
682 If the name is omitted, it will look for
683 - a model object in $c->stash->{current_model_instance}, then
684 - a model name in $c->stash->{current_model}, then
685 - a config setting 'default_model', or
686 - check if there is only one model, and return it if that's the case.
688 If you want to search for models, pass in a regexp as the argument.
690 # find all models that start with Foo
691 my @foo_models = $c->model(qr{^Foo});
696 my ( $c, $name, @args ) = @_;
697 my $appclass = ref($c) || $c;
699 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
700 my $comps = $c->components;
701 my $check = $appclass."::Model::".$name;
702 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
704 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
705 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
706 return $c->_filter_component( $result[ 0 ], @args );
710 return $c->stash->{current_model_instance}
711 if $c->stash->{current_model_instance};
712 return $c->model( $c->stash->{current_model} )
713 if $c->stash->{current_model};
715 return $c->model( $appclass->config->{default_model} )
716 if $appclass->config->{default_model};
718 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
721 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
722 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
723 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
724 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
725 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
728 return $c->_filter_component( $comp );
732 =head2 $c->view($name)
734 Gets a L<Catalyst::View> instance by name.
736 $c->view('Foo')->do_stuff;
738 Any extra arguments are directly passed to ACCEPT_CONTEXT.
740 If the name is omitted, it will look for
741 - a view object in $c->stash->{current_view_instance}, then
742 - a view name in $c->stash->{current_view}, then
743 - a config setting 'default_view', or
744 - check if there is only one view, and return it if that's the case.
746 If you want to search for views, pass in a regexp as the argument.
748 # find all views that start with Foo
749 my @foo_views = $c->view(qr{^Foo});
754 my ( $c, $name, @args ) = @_;
756 my $appclass = ref($c) || $c;
758 unless ( ref($name) ) { # Direct component hash lookup to avoid costly regexps
759 my $comps = $c->components;
760 my $check = $appclass."::View::".$name;
761 if( exists $comps->{$check} ) {
762 return $c->_filter_component( $comps->{$check}, @args );
765 $c->log->warn( "Attempted to use view '$check', but does not exist" );
768 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
769 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
770 return $c->_filter_component( $result[ 0 ], @args );
774 return $c->stash->{current_view_instance}
775 if $c->stash->{current_view_instance};
776 return $c->view( $c->stash->{current_view} )
777 if $c->stash->{current_view};
779 return $c->view( $appclass->config->{default_view} )
780 if $appclass->config->{default_view};
782 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
785 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
786 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
787 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
788 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
789 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
792 return $c->_filter_component( $comp );
795 =head2 $c->controllers
797 Returns the available names which can be passed to $c->controller
803 return $c->_comp_names(qw/Controller C/);
808 Returns the available names which can be passed to $c->model
814 return $c->_comp_names(qw/Model M/);
820 Returns the available names which can be passed to $c->view
826 return $c->_comp_names(qw/View V/);
829 =head2 $c->comp($name)
831 =head2 $c->component($name)
833 Gets a component object by name. This method is not recommended,
834 unless you want to get a specific component by full
835 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
836 should be used instead.
838 If C<$name> is a regexp, a list of components matched against the full
839 component name will be returned.
841 If Catalyst can't find a component by name, it will fallback to regex
842 matching by default. To disable this behaviour set
843 disable_component_resolution_regex_fallback to a true value.
845 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
850 my ( $c, $name, @args ) = @_;
853 my $comps = $c->components;
856 # is it the exact name?
857 return $c->_filter_component( $comps->{ $name }, @args )
858 if exists $comps->{ $name };
860 # perhaps we just omitted "MyApp"?
861 my $composed = ( ref $c || $c ) . "::${name}";
862 return $c->_filter_component( $comps->{ $composed }, @args )
863 if exists $comps->{ $composed };
865 # search all of the models, views and controllers
866 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
867 return $c->_filter_component( $comp, @args ) if $comp;
871 if $c->config->{disable_component_resolution_regex_fallback};
873 # This is here so $c->comp( '::M::' ) works
874 my $query = ref $name ? $name : qr{$name}i;
876 my @result = grep { m{$query} } keys %{ $c->components };
877 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
880 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
881 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
882 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
883 return $c->_filter_component( $result[ 0 ], @args );
886 # I would expect to return an empty list here, but that breaks back-compat
890 return sort keys %{ $c->components };
893 =head2 CLASS DATA AND HELPER CLASSES
897 Returns or takes a hashref containing the application's configuration.
899 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
901 You can also use a C<YAML>, C<XML> or L<Config::General> config file
902 like C<myapp.conf> in your applications home directory. See
903 L<Catalyst::Plugin::ConfigLoader>.
905 =head3 Cascading configuration
907 The config method is present on all Catalyst components, and configuration
908 will be merged when an application is started. Configuration loaded with
909 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
910 followed by configuration in your top level C<MyApp> class. These two
911 configurations are merged, and then configuration data whose hash key matches a
912 component name is merged with configuration for that component.
914 The configuration for a component is then passed to the C<new> method when a
915 component is constructed.
919 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
920 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
922 will mean that C<MyApp::Model::Foo> receives the following data when
925 MyApp::Model::Foo->new({
931 It's common practice to use a Moose attribute
932 on the receiving component to access the config value.
934 package MyApp::Model::Foo;
938 # this attr will receive 'baz' at construction time
944 You can then get the value 'baz' by calling $c->model('Foo')->bar
945 (or $self->bar inside code in the model).
947 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
948 as a way of reading config within your code, as this B<will not> give you the
949 correctly merged config back. You B<MUST> take the config values supplied to
950 the constructor and use those instead.
954 around config => sub {
958 croak('Setting config after setup has been run is not allowed.')
959 if ( @_ and $c->setup_finished );
966 Returns the logging object instance. Unless it is already set, Catalyst
967 sets this up with a L<Catalyst::Log> object. To use your own log class,
968 set the logger with the C<< __PACKAGE__->log >> method prior to calling
969 C<< __PACKAGE__->setup >>.
971 __PACKAGE__->log( MyLogger->new );
976 $c->log->info( 'Now logging with my own logger!' );
978 Your log class should implement the methods described in
984 Returns 1 if debug mode is enabled, 0 otherwise.
986 You can enable debug mode in several ways:
990 =item By calling myapp_server.pl with the -d flag
992 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
994 =item The -Debug option in your MyApp.pm
996 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1000 The first three also set the log level to 'debug'.
1002 Calling C<< $c->debug(1) >> has no effect.
1008 =head2 $c->dispatcher
1010 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1014 Returns the engine instance. See L<Catalyst::Engine>.
1017 =head2 UTILITY METHODS
1019 =head2 $c->path_to(@path)
1021 Merges C<@path> with C<< $c->config->{home} >> and returns a
1022 L<Path::Class::Dir> object. Note you can usually use this object as
1023 a filename, but sometimes you will have to explicitly stringify it
1024 yourself by calling the C<< ->stringify >> method.
1028 $c->path_to( 'db', 'sqlite.db' );
1033 my ( $c, @path ) = @_;
1034 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1035 if ( -d $path ) { return $path }
1036 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1039 =head2 $c->plugin( $name, $class, @args )
1041 Helper method for plugins. It creates a class data accessor/mutator and
1042 loads and instantiates the given class.
1044 MyApp->plugin( 'prototype', 'HTML::Prototype' );
1046 $c->prototype->define_javascript_functions;
1048 B<Note:> This method of adding plugins is deprecated. The ability
1049 to add plugins like this B<will be removed> in a Catalyst 5.81.
1050 Please do not use this functionality in new code.
1055 my ( $class, $name, $plugin, @args ) = @_;
1057 # See block comment in t/unit_core_plugin.t
1058 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in Catalyst 5.81/);
1060 $class->_register_plugin( $plugin, 1 );
1062 eval { $plugin->import };
1063 $class->mk_classdata($name);
1065 eval { $obj = $plugin->new(@args) };
1068 Catalyst::Exception->throw( message =>
1069 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1072 $class->$name($obj);
1073 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1079 Initializes the dispatcher and engine, loads any plugins, and loads the
1080 model, view, and controller components. You may also specify an array
1081 of plugins to load here, if you choose to not load them in the C<use
1085 MyApp->setup( qw/-Debug/ );
1090 my ( $class, @arguments ) = @_;
1091 croak('Running setup more than once')
1092 if ( $class->setup_finished );
1094 unless ( $class->isa('Catalyst') ) {
1096 Catalyst::Exception->throw(
1097 message => qq/'$class' does not inherit from Catalyst/ );
1100 if ( $class->arguments ) {
1101 @arguments = ( @arguments, @{ $class->arguments } );
1107 foreach (@arguments) {
1111 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1113 elsif (/^-(\w+)=?(.*)$/) {
1114 $flags->{ lc $1 } = $2;
1117 push @{ $flags->{plugins} }, $_;
1121 $class->setup_home( delete $flags->{home} );
1123 $class->setup_log( delete $flags->{log} );
1124 $class->setup_plugins( delete $flags->{plugins} );
1125 $class->setup_dispatcher( delete $flags->{dispatcher} );
1126 if (my $engine = delete $flags->{engine}) {
1127 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1129 $class->setup_engine();
1130 $class->setup_stats( delete $flags->{stats} );
1132 for my $flag ( sort keys %{$flags} ) {
1134 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1135 &$code( $class, delete $flags->{$flag} );
1138 $class->log->warn(qq/Unknown flag "$flag"/);
1142 eval { require Catalyst::Devel; };
1143 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1144 $class->log->warn(<<"EOF");
1145 You are running an old script!
1147 Please update by running (this will overwrite existing files):
1148 catalyst.pl -force -scripts $class
1150 or (this will not overwrite existing files):
1151 catalyst.pl -scripts $class
1156 if ( $class->debug ) {
1157 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1160 my $column_width = Catalyst::Utils::term_width() - 6;
1161 my $t = Text::SimpleTable->new($column_width);
1162 $t->row($_) for @plugins;
1163 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1166 my $dispatcher = $class->dispatcher;
1167 my $engine = $class->engine;
1168 my $home = $class->config->{home};
1170 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1171 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1175 ? $class->log->debug(qq/Found home "$home"/)
1176 : $class->log->debug(qq/Home "$home" doesn't exist/)
1177 : $class->log->debug(q/Couldn't find home/);
1180 # Call plugins setup, this is stupid and evil.
1181 # Also screws C3 badly on 5.10, hack to avoid.
1183 no warnings qw/redefine/;
1184 local *setup = sub { };
1185 $class->setup unless $Catalyst::__AM_RESTARTING;
1188 # Initialize our data structure
1189 $class->components( {} );
1191 $class->setup_components;
1193 if ( $class->debug ) {
1194 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1195 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1196 for my $comp ( sort keys %{ $class->components } ) {
1197 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1198 $t->row( $comp, $type );
1200 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1201 if ( keys %{ $class->components } );
1204 # Add our self to components, since we are also a component
1205 if( $class->isa('Catalyst::Controller') ){
1206 $class->components->{$class} = $class;
1209 $class->setup_actions;
1211 if ( $class->debug ) {
1212 my $name = $class->config->{name} || 'Application';
1213 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1216 # Make sure that the application class becomes immutable at this point,
1217 B::Hooks::EndOfScope::on_scope_end {
1219 my $meta = Class::MOP::get_metaclass_by_name($class);
1222 && ! { $meta->immutable_options }->{replace_constructor}
1224 $class->isa('Class::Accessor::Fast')
1225 || $class->isa('Class::Accessor')
1228 warn "You made your application class ($class) immutable, "
1229 . "but did not inline the\nconstructor. "
1230 . "This will break catalyst, as your app \@ISA "
1231 . "Class::Accessor(::Fast)?\nPlease pass "
1232 . "(replace_constructor => 1)\nwhen making your class immutable.\n";
1234 $meta->make_immutable(
1235 replace_constructor => 1,
1236 ) unless $meta->is_immutable;
1239 if ($class->config->{case_sensitive}) {
1240 $class->log->warn($class . "->config->{case_sensitive} is set.");
1241 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1244 $class->setup_finalize;
1245 # Should be the last thing we do so that user things hooking
1246 # setup_finalize can log..
1247 $class->log->_flush() if $class->log->can('_flush');
1248 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1251 =head2 $app->setup_finalize
1253 A hook to attach modifiers to. This method does not do anything except set the
1254 C<setup_finished> accessor.
1256 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1260 after setup_finalize => sub {
1268 sub setup_finalize {
1270 $class->setup_finished(1);
1273 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1275 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1277 Constructs an absolute L<URI> object based on the application root, the
1278 provided path, and the additional arguments and query parameters provided.
1279 When used as a string, provides a textual URI. If you need more flexibility
1280 than this (i.e. the option to provide relative URIs etc.) see
1281 L<Catalyst::Plugin::SmartURI>.
1283 If no arguments are provided, the URI for the current action is returned.
1284 To return the current action and also provide @args, use
1285 C<< $c->uri_for( $c->action, @args ) >>.
1287 If the first argument is a string, it is taken as a public URI path relative
1288 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1289 relative to the application root (if it does). It is then merged with
1290 C<< $c->request->base >>; any C<@args> are appended as additional path
1291 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1293 If the first argument is a L<Catalyst::Action> it represents an action which
1294 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1295 optional C<\@captures> argument (an arrayref) allows passing the captured
1296 variables that are needed to fill in the paths of Chained and Regex actions;
1297 once the path is resolved, C<uri_for> continues as though a path was
1298 provided, appending any arguments or parameters and creating an absolute
1301 The captures for the current request can be found in
1302 C<< $c->request->captures >>, and actions can be resolved using
1303 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1304 path, use C<< $c->uri_for_action >> instead.
1306 # Equivalent to $c->req->uri
1307 $c->uri_for($c->action, $c->req->captures,
1308 @{ $c->req->args }, $c->req->params);
1310 # For the Foo action in the Bar controller
1311 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1313 # Path to a static resource
1314 $c->uri_for('/static/images/logo.png');
1319 my ( $c, $path, @args ) = @_;
1321 if (blessed($path) && $path->isa('Catalyst::Controller')) {
1322 $path = $path->path_prefix;
1327 undef($path) if (defined $path && $path eq '');
1330 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1332 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1333 foreach my $arg (@args) {
1334 utf8::encode($arg) if utf8::is_utf8($arg);
1335 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1338 if ( blessed($path) ) { # action object
1339 s|/|%2F|g for @args;
1340 my $captures = [ map { s|/|%2F|g; $_; }
1341 ( scalar @args && ref $args[0] eq 'ARRAY'
1345 foreach my $capture (@$captures) {
1346 utf8::encode($capture) if utf8::is_utf8($capture);
1347 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1351 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1352 if( !@args && $action->number_of_args ) {
1353 my $expanded_action = $c->dispatcher->expand_action( $action );
1355 my $num_captures = $expanded_action->number_of_captures;
1356 unshift @args, splice @$captures, $num_captures;
1359 $path = $c->dispatcher->uri_for_action($action, $captures);
1360 if (not defined $path) {
1361 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1365 $path = '/' if $path eq '';
1368 unshift(@args, $path);
1370 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1371 my $namespace = $c->namespace;
1372 if (defined $path) { # cheesy hack to handle path '../foo'
1373 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1375 unshift(@args, $namespace || '');
1378 # join args with '/', or a blank string
1379 my $args = join('/', grep { defined($_) } @args);
1380 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1382 my $base = $c->req->base;
1383 my $class = ref($base);
1384 $base =~ s{(?<!/)$}{/};
1388 if (my @keys = keys %$params) {
1389 # somewhat lifted from URI::_query's query_form
1390 $query = '?'.join('&', map {
1391 my $val = $params->{$_};
1392 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1395 $val = '' unless defined $val;
1398 utf8::encode( $param ) if utf8::is_utf8($param);
1399 # using the URI::Escape pattern here so utf8 chars survive
1400 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1402 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1406 my $res = bless(\"${base}${args}${query}", $class);
1410 =head2 $c->uri_for_action( $path, \@captures?, @args?, \%query_values? )
1412 =head2 $c->uri_for_action( $action, \@captures?, @args?, \%query_values? )
1418 A private path to the Catalyst action you want to create a URI for.
1420 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1421 >> and passing the resulting C<$action> and the remaining arguments to C<<
1424 You can also pass in a Catalyst::Action object, in which case it is passed to
1427 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.
1429 For example, if the action looks like:
1431 package MyApp::Controller::Users;
1433 sub lst : Path('the-list') {}
1437 $c->uri_for_action('/users/lst')
1439 and it will create the URI /users/the-list.
1445 sub uri_for_action {
1446 my ( $c, $path, @args ) = @_;
1447 my $action = blessed($path)
1449 : $c->dispatcher->get_action_by_path($path);
1450 unless (defined $action) {
1451 croak "Can't find action for path '$path'";
1453 return $c->uri_for( $action, @args );
1456 =head2 $c->welcome_message
1458 Returns the Catalyst welcome HTML page.
1462 sub welcome_message {
1464 my $name = $c->config->{name};
1465 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1466 my $prefix = Catalyst::Utils::appprefix( ref $c );
1467 $c->response->content_type('text/html; charset=utf-8');
1469 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1470 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1471 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1473 <meta http-equiv="Content-Language" content="en" />
1474 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1475 <title>$name on Catalyst $VERSION</title>
1476 <style type="text/css">
1479 background-color: #eee;
1486 margin-bottom: 10px;
1488 background-color: #ccc;
1489 border: 1px solid #aaa;
1494 font-family: verdana, tahoma, sans-serif;
1497 font-family: verdana, tahoma, sans-serif;
1500 text-decoration: none;
1502 border-bottom: 1px dotted #bbb;
1504 :link:hover, :visited:hover {
1517 background-color: #fff;
1518 border: 1px solid #aaa;
1522 font-weight: normal;
1544 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1549 <img src="$logo" alt="Catalyst Logo" />
1551 <p>Welcome to the world of Catalyst.
1552 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1553 framework will make web development something you had
1554 never expected it to be: Fun, rewarding, and quick.</p>
1555 <h2>What to do now?</h2>
1556 <p>That really depends on what <b>you</b> want to do.
1557 We do, however, provide you with a few starting points.</p>
1558 <p>If you want to jump right into web development with Catalyst
1559 you might want to start with a tutorial.</p>
1560 <pre>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Tutorial.pod">Catalyst::Manual::Tutorial</a></code>
1562 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1564 <code>perldoc <a href="http://cpansearch.perl.org/dist/Catalyst-Manual/lib/Catalyst/Manual/Intro.pod">Catalyst::Manual::Intro</a>
1565 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1567 <h2>What to do next?</h2>
1568 <p>Next it's time to write an actual application. Use the
1569 helper scripts to generate <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AController%3A%3A&mode=all">controllers</a>,
1570 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AModel%3A%3A&mode=all">models</a>, and
1571 <a href="http://cpansearch.perl.org/search?query=Catalyst%3A%3AView%3A%3A&mode=all">views</a>;
1572 they can save you a lot of work.</p>
1573 <pre><code>script/${prefix}_create.pl --help</code></pre>
1574 <p>Also, be sure to check out the vast and growing
1575 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1576 you are likely to find what you need there.
1580 <p>Catalyst has a very active community. Here are the main places to
1581 get in touch with us.</p>
1584 <a href="http://dev.catalyst.perl.org">Wiki</a>
1587 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1590 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1593 <h2>In conclusion</h2>
1594 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1595 as we enjoyed making it. Please contact us if you have ideas
1596 for improvement or other feedback.</p>
1604 =head1 INTERNAL METHODS
1606 These methods are not meant to be used by end users.
1608 =head2 $c->components
1610 Returns a hash of components.
1612 =head2 $c->context_class
1614 Returns or sets the context class.
1618 Returns a hashref containing coderefs and execution counts (needed for
1619 deep recursion detection).
1623 Returns the number of actions on the current internal execution stack.
1627 Dispatches a request to actions.
1631 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1633 =head2 $c->dispatcher_class
1635 Returns or sets the dispatcher class.
1637 =head2 $c->dump_these
1639 Returns a list of 2-element array references (name, structure) pairs
1640 that will be dumped on the error page in debug mode.
1646 [ Request => $c->req ],
1647 [ Response => $c->res ],
1648 [ Stash => $c->stash ],
1649 [ Config => $c->config ];
1652 =head2 $c->engine_class
1654 Returns or sets the engine class.
1656 =head2 $c->execute( $class, $coderef )
1658 Execute a coderef in given class and catch exceptions. Errors are available
1664 my ( $c, $class, $code ) = @_;
1665 $class = $c->component($class) || $class;
1668 if ( $c->depth >= $RECURSION ) {
1669 my $action = $code->reverse();
1670 $action = "/$action" unless $action =~ /->/;
1671 my $error = qq/Deep recursion detected calling "${action}"/;
1672 $c->log->error($error);
1678 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1680 push( @{ $c->stack }, $code );
1682 no warnings 'recursion';
1683 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1684 # I have no idea how, ergo $ret (which appears to fix the issue)
1685 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1687 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1689 my $last = pop( @{ $c->stack } );
1691 if ( my $error = $@ ) {
1692 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1693 $error->rethrow if $c->depth > 1;
1695 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1696 $error->rethrow if $c->depth > 0;
1699 unless ( ref $error ) {
1700 no warnings 'uninitialized';
1702 my $class = $last->class;
1703 my $name = $last->name;
1704 $error = qq/Caught exception in $class->$name "$error"/;
1713 sub _stats_start_execute {
1714 my ( $c, $code ) = @_;
1715 my $appclass = ref($c) || $c;
1716 return if ( ( $code->name =~ /^_.*/ )
1717 && ( !$appclass->config->{show_internal_actions} ) );
1719 my $action_name = $code->reverse();
1720 $c->counter->{$action_name}++;
1722 my $action = $action_name;
1723 $action = "/$action" unless $action =~ /->/;
1725 # determine if the call was the result of a forward
1726 # this is done by walking up the call stack and looking for a calling
1727 # sub of Catalyst::forward before the eval
1729 for my $index ( 2 .. 11 ) {
1731 if ( ( caller($index) )[0] eq 'Catalyst'
1732 && ( caller($index) )[3] eq '(eval)' );
1734 if ( ( caller($index) )[3] =~ /forward$/ ) {
1735 $callsub = ( caller($index) )[3];
1736 $action = "-> $action";
1741 my $uid = $action_name . $c->counter->{$action_name};
1743 # is this a root-level call or a forwarded call?
1744 if ( $callsub =~ /forward$/ ) {
1745 my $parent = $c->stack->[-1];
1747 # forward, locate the caller
1748 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1751 parent => "$parent" . $c->counter->{"$parent"},
1757 # forward with no caller may come from a plugin
1776 sub _stats_finish_execute {
1777 my ( $c, $info ) = @_;
1778 $c->stats->profile( end => $info );
1783 Finalizes the request.
1790 for my $error ( @{ $c->error } ) {
1791 $c->log->error($error);
1794 # Allow engine to handle finalize flow (for POE)
1795 my $engine = $c->engine;
1796 if ( my $code = $engine->can('finalize') ) {
1801 $c->finalize_uploads;
1804 if ( $#{ $c->error } >= 0 ) {
1808 $c->finalize_headers;
1811 if ( $c->request->method eq 'HEAD' ) {
1812 $c->response->body('');
1820 if ($c->use_stats) {
1821 my $elapsed = sprintf '%f', $c->stats->elapsed;
1822 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1824 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1827 return $c->response->status;
1830 =head2 $c->finalize_body
1836 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1838 =head2 $c->finalize_cookies
1844 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1846 =head2 $c->finalize_error
1852 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1854 =head2 $c->finalize_headers
1860 sub finalize_headers {
1863 my $response = $c->response; #accessor calls can add up?
1865 # Check if we already finalized headers
1866 return if $response->finalized_headers;
1869 if ( my $location = $response->redirect ) {
1870 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1871 $response->header( Location => $location );
1873 if ( !$response->has_body ) {
1874 # Add a default body if none is already present
1875 $response->body(<<"EOF");
1876 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1877 <html xmlns="http://www.w3.org/1999/xhtml">
1879 <title>Moved</title>
1882 <p>This item has moved <a href="$location">here</a>.</p>
1886 $response->content_type('text/html; charset=utf-8');
1891 if ( defined $response->body && length $response->body && !$response->content_length ) {
1893 # get the length from a filehandle
1894 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1896 my $size = -s $response->body;
1898 $response->content_length( $size );
1901 $c->log->warn('Serving filehandle without a content-length');
1905 # everything should be bytes at this point, but just in case
1906 $response->content_length( length( $response->body ) );
1911 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1912 $response->headers->remove_header("Content-Length");
1913 $response->body('');
1916 $c->finalize_cookies;
1918 $c->engine->finalize_headers( $c, @_ );
1921 $response->finalized_headers(1);
1924 =head2 $c->finalize_output
1926 An alias for finalize_body.
1928 =head2 $c->finalize_read
1930 Finalizes the input after reading is complete.
1934 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1936 =head2 $c->finalize_uploads
1938 Finalizes uploads. Cleans up any temporary files.
1942 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1944 =head2 $c->get_action( $action, $namespace )
1946 Gets an action in a given namespace.
1950 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1952 =head2 $c->get_actions( $action, $namespace )
1954 Gets all actions of a given name in a namespace and all parent
1959 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1961 =head2 $app->handle_request( @arguments )
1963 Called to handle each HTTP request.
1967 sub handle_request {
1968 my ( $class, @arguments ) = @_;
1970 # Always expect worst case!
1973 if ($class->debug) {
1974 my $secs = time - $START || 1;
1975 my $av = sprintf '%.3f', $COUNT / $secs;
1976 my $time = localtime time;
1977 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
1980 my $c = $class->prepare(@arguments);
1982 $status = $c->finalize;
1985 chomp(my $error = $_);
1986 $class->log->error(qq/Caught exception in engine "$error"/);
1991 if(my $coderef = $class->log->can('_flush')){
1992 $class->log->$coderef();
1997 =head2 $class->prepare( @arguments )
1999 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2005 my ( $class, @arguments ) = @_;
2008 # After the app/ctxt split, this should become an attribute based on something passed
2009 # into the application.
2010 $class->context_class( ref $class || $class ) unless $class->context_class;
2012 my $c = $class->context_class->new({});
2014 # For on-demand data
2015 $c->request->_context($c);
2016 $c->response->_context($c);
2018 #surely this is not the most efficient way to do things...
2019 $c->stats($class->stats_class->new)->enable($c->use_stats);
2020 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2021 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2025 # Allow engine to direct the prepare flow (for POE)
2026 if ( my $prepare = $c->engine->can('prepare') ) {
2027 $c->engine->$prepare( $c, @arguments );
2030 $c->prepare_request(@arguments);
2031 $c->prepare_connection;
2032 $c->prepare_query_parameters;
2033 $c->prepare_headers;
2034 $c->prepare_cookies;
2037 # Prepare the body for reading, either by prepare_body
2038 # or the user, if they are using $c->read
2041 # Parse the body unless the user wants it on-demand
2042 unless ( ref($c)->config->{parse_on_demand} ) {
2047 # VERY ugly and probably shouldn't rely on ->finalize actually working
2049 # failed prepare is always due to an invalid request, right?
2050 $c->response->status(400);
2051 $c->response->content_type('text/plain');
2052 $c->response->body('Bad Request');
2057 my $method = $c->req->method || '';
2058 my $path = $c->req->path;
2059 $path = '/' unless length $path;
2060 my $address = $c->req->address || '';
2069 =head2 $c->prepare_action
2071 Prepares action. See L<Catalyst::Dispatcher>.
2075 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2077 =head2 $c->prepare_body
2079 Prepares message body.
2086 return if $c->request->_has_body;
2088 # Initialize on-demand data
2089 $c->engine->prepare_body( $c, @_ );
2090 $c->prepare_parameters;
2091 $c->prepare_uploads;
2094 =head2 $c->prepare_body_chunk( $chunk )
2096 Prepares a chunk of data before sending it to L<HTTP::Body>.
2098 See L<Catalyst::Engine>.
2102 sub prepare_body_chunk {
2104 $c->engine->prepare_body_chunk( $c, @_ );
2107 =head2 $c->prepare_body_parameters
2109 Prepares body parameters.
2113 sub prepare_body_parameters {
2115 $c->engine->prepare_body_parameters( $c, @_ );
2118 =head2 $c->prepare_connection
2120 Prepares connection.
2124 sub prepare_connection {
2126 $c->engine->prepare_connection( $c, @_ );
2129 =head2 $c->prepare_cookies
2135 sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) }
2137 =head2 $c->prepare_headers
2143 sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) }
2145 =head2 $c->prepare_parameters
2147 Prepares parameters.
2151 sub prepare_parameters {
2153 $c->prepare_body_parameters;
2154 $c->engine->prepare_parameters( $c, @_ );
2157 =head2 $c->prepare_path
2159 Prepares path and base.
2163 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2165 =head2 $c->prepare_query_parameters
2167 Prepares query parameters.
2171 sub prepare_query_parameters {
2174 $c->engine->prepare_query_parameters( $c, @_ );
2177 =head2 $c->log_request
2179 Writes information about the request to the debug logs. This includes:
2183 =item * Request method, path, and remote IP address
2185 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2187 =item * Request parameters
2189 =item * File uploads
2198 return unless $c->debug;
2200 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2201 my $request = $dump->[1];
2203 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2205 $path = '/' unless length $path;
2207 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2209 $c->log_request_headers($request->headers);
2211 if ( my $keywords = $request->query_keywords ) {
2212 $c->log->debug("Query keywords are: $keywords");
2215 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2217 $c->log_request_uploads($request);
2220 =head2 $c->log_response
2222 Writes information about the response to the debug logs by calling
2223 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2230 return unless $c->debug;
2232 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2233 my $response = $dump->[1];
2235 $c->log_response_status_line($response);
2236 $c->log_response_headers($response->headers);
2239 =head2 $c->log_response_status_line($response)
2241 Writes one line of information about the response to the debug logs. This includes:
2245 =item * Response status code
2247 =item * Content-Type header (if present)
2249 =item * Content-Length header (if present)
2255 sub log_response_status_line {
2256 my ($c, $response) = @_;
2260 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2261 $response->status || 'unknown',
2262 $response->headers->header('Content-Type') || 'unknown',
2263 $response->headers->header('Content-Length') || 'unknown'
2268 =head2 $c->log_response_headers($headers);
2270 Hook method which can be wrapped by plugins to log the response headers.
2271 No-op in the default implementation.
2275 sub log_response_headers {}
2277 =head2 $c->log_request_parameters( query => {}, body => {} )
2279 Logs request parameters to debug logs
2283 sub log_request_parameters {
2285 my %all_params = @_;
2287 return unless $c->debug;
2289 my $column_width = Catalyst::Utils::term_width() - 44;
2290 foreach my $type (qw(query body)) {
2291 my $params = $all_params{$type};
2292 next if ! keys %$params;
2293 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2294 for my $key ( sort keys %$params ) {
2295 my $param = $params->{$key};
2296 my $value = defined($param) ? $param : '';
2297 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2299 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2303 =head2 $c->log_request_uploads
2305 Logs file uploads included in the request to the debug logs.
2306 The parameter name, filename, file type, and file size are all included in
2311 sub log_request_uploads {
2313 my $request = shift;
2314 return unless $c->debug;
2315 my $uploads = $request->uploads;
2316 if ( keys %$uploads ) {
2317 my $t = Text::SimpleTable->new(
2318 [ 12, 'Parameter' ],
2323 for my $key ( sort keys %$uploads ) {
2324 my $upload = $uploads->{$key};
2325 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2326 $t->row( $key, $u->filename, $u->type, $u->size );
2329 $c->log->debug( "File Uploads are:\n" . $t->draw );
2333 =head2 $c->log_request_headers($headers);
2335 Hook method which can be wrapped by plugins to log the request headers.
2336 No-op in the default implementation.
2340 sub log_request_headers {}
2342 =head2 $c->log_headers($type => $headers)
2344 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2351 my $headers = shift; # an HTTP::Headers instance
2353 return unless $c->debug;
2355 my $column_width = Catalyst::Utils::term_width() - 28;
2356 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2359 my ( $name, $value ) = @_;
2360 $t->row( $name, $value );
2363 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2367 =head2 $c->prepare_read
2369 Prepares the input for reading.
2373 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2375 =head2 $c->prepare_request
2377 Prepares the engine request.
2381 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2383 =head2 $c->prepare_uploads
2389 sub prepare_uploads {
2392 $c->engine->prepare_uploads( $c, @_ );
2395 =head2 $c->prepare_write
2397 Prepares the output for writing.
2401 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2403 =head2 $c->request_class
2405 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2407 =head2 $c->response_class
2409 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2411 =head2 $c->read( [$maxlength] )
2413 Reads a chunk of data from the request body. This method is designed to
2414 be used in a while loop, reading C<$maxlength> bytes on every call.
2415 C<$maxlength> defaults to the size of the request if not specified.
2417 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2420 Warning: If you use read(), Catalyst will not process the body,
2421 so you will not be able to access POST parameters or file uploads via
2422 $c->request. You must handle all body parsing yourself.
2426 sub read { my $c = shift; return $c->engine->read( $c, @_ ) }
2436 $app->engine_loader->needs_psgi_engine_compat_hack ?
2437 $app->engine->run($app, @_) :
2438 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2441 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2443 Sets an action in a given namespace.
2447 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2449 =head2 $c->setup_actions($component)
2451 Sets up actions for a component.
2455 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2457 =head2 $c->setup_components
2459 This method is called internally to set up the application's components.
2461 It finds modules by calling the L<locate_components> method, expands them to
2462 package names with the L<expand_component_module> method, and then installs
2463 each component into the application.
2465 The C<setup_components> config option is passed to both of the above methods.
2467 Installation of each component is performed by the L<setup_component> method,
2472 sub setup_components {
2475 my $config = $class->config->{ setup_components };
2477 my @comps = $class->locate_components($config);
2478 my %comps = map { $_ => 1 } @comps;
2480 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2481 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2482 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2483 ) if $deprecatedcatalyst_component_names;
2485 for my $component ( @comps ) {
2487 # We pass ignore_loaded here so that overlay files for (e.g.)
2488 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2489 # we know M::P::O found a file on disk so this is safe
2491 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2494 for my $component (@comps) {
2495 my $instance = $class->components->{ $component } = $class->setup_component($component);
2496 my @expanded_components = $instance->can('expand_modules')
2497 ? $instance->expand_modules( $component, $config )
2498 : $class->expand_component_module( $component, $config );
2499 for my $component (@expanded_components) {
2500 next if $comps{$component};
2501 $class->components->{ $component } = $class->setup_component($component);
2506 =head2 $c->locate_components( $setup_component_config )
2508 This method is meant to provide a list of component modules that should be
2509 setup for the application. By default, it will use L<Module::Pluggable>.
2511 Specify a C<setup_components> config option to pass additional options directly
2512 to L<Module::Pluggable>. To add additional search paths, specify a key named
2513 C<search_extra> as an array reference. Items in the array beginning with C<::>
2514 will have the application class name prepended to them.
2518 sub locate_components {
2522 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2523 my $extra = delete $config->{ search_extra } || [];
2525 push @paths, @$extra;
2527 my $locator = Module::Pluggable::Object->new(
2528 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2532 # XXX think about ditching this sort entirely
2533 my @comps = sort { length $a <=> length $b } $locator->plugins;
2538 =head2 $c->expand_component_module( $component, $setup_component_config )
2540 Components found by C<locate_components> will be passed to this method, which
2541 is expected to return a list of component (package) names to be set up.
2545 sub expand_component_module {
2546 my ($class, $module) = @_;
2547 return Devel::InnerPackage::list_packages( $module );
2550 =head2 $c->setup_component
2554 sub setup_component {
2555 my( $class, $component ) = @_;
2557 unless ( $component->can( 'COMPONENT' ) ) {
2561 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2562 my $config = $class->config->{ $suffix } || {};
2563 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2564 # methods also pass it. local to avoid pointlessly shitting in config
2565 # for the debug screen, as $component is already the key name.
2566 local $config->{catalyst_component_name} = $component;
2568 my $instance = eval { $component->COMPONENT( $class, $config ); };
2570 if ( my $error = $@ ) {
2572 Catalyst::Exception->throw(
2573 message => qq/Couldn't instantiate component "$component", "$error"/
2577 unless (blessed $instance) {
2578 my $metaclass = Moose::Util::find_meta($component);
2579 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2580 my $component_method_from = $method_meta->associated_metaclass->name;
2581 my $value = defined($instance) ? $instance : 'undef';
2582 Catalyst::Exception->throw(
2584 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2590 =head2 $c->setup_dispatcher
2596 sub setup_dispatcher {
2597 my ( $class, $dispatcher ) = @_;
2600 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2603 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2604 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2607 unless ($dispatcher) {
2608 $dispatcher = $class->dispatcher_class;
2611 Class::MOP::load_class($dispatcher);
2613 # dispatcher instance
2614 $class->dispatcher( $dispatcher->new );
2617 =head2 $c->setup_engine
2624 my ($class, $requested_engine) = @_;
2626 if (!$class->engine_loader || $requested_engine) {
2627 $class->engine_loader(
2628 Catalyst::EngineLoader->new({
2629 application_name => $class,
2630 (defined $requested_engine
2631 ? (catalyst_engine_class => $requested_engine) : ()),
2636 $class->engine_loader->catalyst_engine_class;
2640 my ($class, $requested_engine) = @_;
2643 my $loader = $class->engine_loader;
2645 if (!$loader || $requested_engine) {
2646 $loader = Catalyst::EngineLoader->new({
2647 application_name => $class,
2648 (defined $requested_engine
2649 ? (requested_engine => $requested_engine) : ()),
2652 $class->engine_loader($loader);
2655 $loader->catalyst_engine_class;
2658 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2659 return if $class->loading_psgi_file;
2661 Class::MOP::load_class($engine);
2663 if ($ENV{MOD_PERL}) {
2664 my $apache = $class->engine_loader->auto;
2666 my $meta = find_meta($class);
2667 my $was_immutable = $meta->is_immutable;
2668 my %immutable_options = $meta->immutable_options;
2669 $meta->make_mutable if $was_immutable;
2671 $meta->add_method(handler => sub {
2673 my $psgi_app = $class->psgi_app;
2674 $apache->call_app($r, $psgi_app);
2677 $meta->make_immutable(%immutable_options) if $was_immutable;
2680 $class->engine( $engine->new );
2685 sub _finalized_psgi_app {
2688 unless ($app->_psgi_app) {
2689 my $psgi_app = $app->_setup_psgi_app;
2690 $app->_psgi_app($psgi_app);
2693 return $app->_psgi_app;
2696 sub _setup_psgi_app {
2699 for my $home (Path::Class::Dir->new($app->config->{home})) {
2700 my $psgi_file = $home->file(
2701 Catalyst::Utils::appprefix($app) . '.psgi',
2704 next unless -e $psgi_file;
2706 # If $psgi_file calls ->setup_engine, it's doing so to load
2707 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2708 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2709 # anyway. So set a flag (ick) that tells setup_engine not to populate
2710 # $c->engine or do any other things we might regret.
2712 $app->loading_psgi_file(1);
2713 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2714 $app->loading_psgi_file(0);
2717 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2720 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2722 Its content has been ignored. Please consult the Catalyst::Upgrading
2723 documentation on how to upgrade from Catalyst::Engine::PSGI.
2727 return $app->apply_default_middlewares($app->psgi_app);
2730 =head2 $c->apply_default_middlewares
2732 Adds the following L<Plack> middlewares to your application, since they are
2733 useful and commonly needed:
2735 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2736 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2737 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2738 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2739 applied since this middleware is smart enough to conditionally apply itself).
2741 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2742 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2748 sub apply_default_middlewares {
2749 my ($app, $psgi_app) = @_;
2751 $psgi_app = Plack::Middleware::Conditional->wrap(
2753 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2756 return if $app->config->{ignore_frontend_proxy};
2757 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2758 || $app->config->{using_frontend_proxy};
2762 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2763 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2764 $psgi_app = Plack::Middleware::LighttpdScriptNameFix->wrap($psgi_app);
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
2880 import list or which have been added via C<< MyApp->plugin(@args); >>.
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> - Controlls 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 synthesised 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 => 1);
3180 =head1 THREAD SAFETY
3182 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3183 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3184 believe the Catalyst core to be thread-safe.
3186 If you plan to operate in a threaded environment, remember that all other
3187 modules you are using must also be thread-safe. Some modules, most notably
3188 L<DBD::SQLite>, are not thread-safe.
3194 Join #catalyst on irc.perl.org.
3198 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3199 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3203 http://catalyst.perl.org
3207 http://dev.catalyst.perl.org
3211 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3213 =head2 L<Catalyst::Manual> - The Catalyst Manual
3215 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3217 =head2 L<Catalyst::Engine> - Core engine
3219 =head2 L<Catalyst::Log> - Log class.
3221 =head2 L<Catalyst::Request> - Request object
3223 =head2 L<Catalyst::Response> - Response object
3225 =head2 L<Catalyst::Test> - The test suite.
3229 =head1 PROJECT FOUNDER
3231 sri: Sebastian Riedel <sri@cpan.org>
3237 acme: Leon Brocard <leon@astray.com>
3239 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3243 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3247 andyg: Andy Grundman <andy@hybridized.org>
3249 audreyt: Audrey Tang
3251 bricas: Brian Cassidy <bricas@cpan.org>
3253 Caelum: Rafael Kitover <rkitover@io.com>
3255 chansen: Christian Hansen
3257 chicks: Christopher Hicks
3259 Chisel Wright C<pause@herlpacker.co.uk>
3261 Danijel Milicevic C<me@danijel.de>
3263 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3265 David Naughton, C<naughton@umn.edu>
3269 dhoss: Devin Austin <dhoss@cpan.org>
3271 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3275 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3277 esskar: Sascha Kiefer
3279 fireartist: Carl Franks <cfranks@cpan.org>
3281 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3283 gabb: Danijel Milicevic
3287 Gavin Henry C<ghenry@perl.me.uk>
3291 groditi: Guillermo Roditi <groditi@gmail.com>
3293 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3295 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3297 jcamacho: Juan Camacho
3299 jester: Jesse Sheidlower C<jester@panix.com>
3301 jhannah: Jay Hannah <jay@jays.net>
3307 jon: Jon Schutz <jjschutz@cpan.org>
3309 Jonathan Rockway C<< <jrockway@cpan.org> >>
3311 Kieren Diment C<kd@totaldatasolution.com>
3313 konobi: Scott McWhirter <konobi@cpan.org>
3315 marcus: Marcus Ramberg <mramberg@cpan.org>
3317 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3319 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3323 naughton: David Naughton
3325 ningu: David Kamholz <dkamholz@cpan.org>
3327 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3329 numa: Dan Sully <daniel@cpan.org>
3335 omega: Andreas Marienborg
3337 Oleg Kostyuk <cub.uanic@gmail.com>
3339 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3341 rafl: Florian Ragwitz <rafl@debian.org>
3343 random: Roland Lammel <lammel@cpan.org>
3345 Robert Sedlacek C<< <rs@474.at> >>
3347 SpiceMan: Marcel Montes
3351 szbalint: Balint Szilakszi <szbalint@cpan.org>
3353 t0m: Tomas Doran <bobtfish@bobtfish.net>
3357 Viljo Marrandi C<vilts@yahoo.com>
3359 Will Hawes C<info@whawes.co.uk>
3361 willert: Sebastian Willert <willert@cpan.org>
3363 wreis: Wallace Reis <wallace@reis.org.br>
3365 Yuval Kogman, C<nothingmuch@woobling.org>
3367 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3369 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3375 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3379 This library is free software. You can redistribute it and/or modify it under
3380 the same terms as Perl itself.
3386 __PACKAGE__->meta->make_immutable;