4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
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 ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Moose::Util 'find_meta';
39 use Plack::Middleware::Conditional;
40 use Plack::Middleware::ReverseProxy;
41 use Plack::Middleware::IIS6ScriptNameFix;
42 use Plack::Middleware::IIS7KeepAliveFix;
43 use Plack::Middleware::LighttpdScriptNameFix;
44 use Class::Load 'load_class';
46 BEGIN { require 5.008003; }
48 has stack => (is => 'ro', default => sub { [] });
49 has stash => (is => 'rw', default => sub { {} });
50 has state => (is => 'rw', default => 0);
51 has stats => (is => 'rw');
52 has action => (is => 'rw');
53 has counter => (is => 'rw', default => sub { {} });
58 $self->request_class->new($self->_build_request_constructor_args);
62 sub _build_request_constructor_args {
64 my %p = ( _log => $self->log );
65 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
73 $self->response_class->new($self->_build_response_constructor_args);
77 sub _build_response_constructor_args {
79 { _log => $self->log };
82 has namespace => (is => 'rw');
84 sub depth { scalar @{ shift->stack || [] }; }
85 sub comp { shift->component(@_) }
88 my $self = shift; return $self->request(@_);
91 my $self = shift; return $self->response(@_);
94 # For backwards compatibility
95 sub finalize_output { shift->finalize_body(@_) };
100 our $RECURSION = 1000;
101 our $DETACH = Catalyst::Exception::Detach->new;
102 our $GO = Catalyst::Exception::Go->new;
104 #I imagine that very few of these really need to be class variables. if any.
105 #maybe we should just make them attributes with a default?
106 __PACKAGE__->mk_classdata($_)
107 for qw/components arguments dispatcher engine log dispatcher_class
108 engine_loader context_class request_class response_class stats_class
109 setup_finished _psgi_app loading_psgi_file run_options/;
111 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
112 __PACKAGE__->request_class('Catalyst::Request');
113 __PACKAGE__->response_class('Catalyst::Response');
114 __PACKAGE__->stats_class('Catalyst::Stats');
116 # Remember to update this in Catalyst::Runtime as well!
118 our $VERSION = '5.90042';
121 my ( $class, @arguments ) = @_;
123 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
125 return unless $class eq 'Catalyst';
127 my $caller = caller();
128 return if $caller eq 'main';
130 my $meta = Moose::Meta::Class->initialize($caller);
131 unless ( $caller->isa('Catalyst') ) {
132 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
133 $meta->superclasses(@superclasses);
135 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
136 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
138 unless( $meta->has_method('meta') ){
139 if ($Moose::VERSION >= 1.15) {
140 $meta->_add_meta_method('meta');
143 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
147 $caller->arguments( [@arguments] );
151 sub _application { $_[0] }
157 Catalyst - The Elegant MVC Web Application Framework
161 See the L<Catalyst::Manual> distribution for comprehensive
162 documentation and tutorials.
164 # Install Catalyst::Devel for helpers and other development tools
165 # use the helper to create a new application
168 # add models, views, controllers
169 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
170 script/myapp_create.pl view MyTemplate TT
171 script/myapp_create.pl controller Search
173 # built in testserver -- use -r to restart automatically on changes
174 # --help to see all available options
175 script/myapp_server.pl
177 # command line testing interface
178 script/myapp_test.pl /yada
181 use Catalyst qw/-Debug/; # include plugins here as well
183 ### In lib/MyApp/Controller/Root.pm (autocreated)
184 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
185 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
186 $c->stash->{template} = 'foo.tt'; # set the template
187 # lookup something from db -- stash vars are passed to TT
189 $c->model('Database::Foo')->search( { country => $args[0] } );
190 if ( $c->req->params->{bar} ) { # access GET or POST parameters
191 $c->forward( 'bar' ); # process another action
192 # do something else after forward returns
196 # The foo.tt TT template can use the stash data from the database
197 [% WHILE (item = data.next) %]
201 # called for /bar/of/soap, /bar/of/soap/10, etc.
202 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
204 # called after all actions are finished
206 my ( $self, $c ) = @_;
207 if ( scalar @{ $c->error } ) { ... } # handle errors
208 return if $c->res->body; # already have a response
209 $c->forward( 'MyApp::View::TT' ); # render template
212 See L<Catalyst::Manual::Intro> for additional information.
216 Catalyst is a modern framework for making web applications without the
217 pain usually associated with this process. This document is a reference
218 to the main Catalyst application. If you are a new user, we suggest you
219 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
221 See L<Catalyst::Manual> for more documentation.
223 Catalyst plugins can be loaded by naming them as arguments to the "use
224 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
225 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
228 use Catalyst qw/My::Module/;
230 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
231 fully qualify the name by using a unary plus:
235 +Fully::Qualified::Plugin::Name
238 Special flags like C<-Debug> can also be specified as
239 arguments when Catalyst is loaded:
241 use Catalyst qw/-Debug My::Module/;
243 The position of plugins and flags in the chain is important, because
244 they are loaded in the order in which they appear.
246 The following flags are supported:
250 Enables debug output. You can also force this setting from the system
251 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
252 settings override the application, with <MYAPP>_DEBUG having the highest
255 This sets the log level to 'debug' and enables full debug output on the
256 error screen. If you only want the latter, see L<< $c->debug >>.
260 Forces Catalyst to use a specific home directory, e.g.:
262 use Catalyst qw[-Home=/usr/mst];
264 This can also be done in the shell environment by setting either the
265 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
266 is replaced with the uppercased name of your application, any "::" in
267 the name will be replaced with underscores, e.g. MyApp::Web should use
268 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
270 If none of these are set, Catalyst will attempt to automatically detect the
271 home directory. If you are working in a development environment, Catalyst
272 will try and find the directory containing either Makefile.PL, Build.PL,
273 dist.ini, or cpanfile. If the application has been installed into the system
274 (i.e. you have done C<make install>), then Catalyst will use the path to your
275 application module, without the .pm extension (e.g., /foo/MyApp if your
276 application was installed at /foo/MyApp.pm)
280 use Catalyst '-Log=warn,fatal,error';
282 Specifies a comma-delimited list of log levels.
286 Enables statistics collection and reporting.
288 use Catalyst qw/-Stats=1/;
290 You can also force this setting from the system environment with CATALYST_STATS
291 or <MYAPP>_STATS. The environment settings override the application, with
292 <MYAPP>_STATS having the highest priority.
294 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
298 =head2 INFORMATION ABOUT THE CURRENT REQUEST
302 Returns a L<Catalyst::Action> object for the current action, which
303 stringifies to the action name. See L<Catalyst::Action>.
307 Returns the namespace of the current action, i.e., the URI prefix
308 corresponding to the controller of the current action. For example:
310 # in Controller::Foo::Bar
311 $c->namespace; # returns 'foo/bar';
317 Returns the current L<Catalyst::Request> object, giving access to
318 information about the current client request (including parameters,
319 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
321 =head2 REQUEST FLOW HANDLING
323 =head2 $c->forward( $action [, \@arguments ] )
325 =head2 $c->forward( $class, $method, [, \@arguments ] )
327 This is one way of calling another action (method) in the same or
328 a different controller. You can also use C<< $self->my_method($c, @args) >>
329 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
330 in a different controller.
331 The main difference is that 'forward' uses some of the Catalyst request
332 cycle overhead, including debugging, which may be useful to you. On the
333 other hand, there are some complications to using 'forward', restrictions
334 on values returned from 'forward', and it may not handle errors as you prefer.
335 Whether you use 'forward' or not is up to you; it is not considered superior to
336 the other ways to call a method.
338 'forward' calls another action, by its private name. If you give a
339 class name but no method, C<process()> is called. You may also optionally
340 pass arguments in an arrayref. The action will receive the arguments in
341 C<@_> and C<< $c->req->args >>. Upon returning from the function,
342 C<< $c->req->args >> will be restored to the previous values.
344 Any data C<return>ed from the action forwarded to, will be returned by the
347 my $foodata = $c->forward('/foo');
348 $c->forward('index');
349 $c->forward(qw/Model::DBIC::Foo do_stuff/);
350 $c->forward('View::TT');
352 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
353 an C<< eval { } >> around the call (actually
354 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
355 exceptions thrown by the called action non-fatal and pushing them onto
356 $c->error instead. If you want C<die> to propagate you need to do something
360 die join "\n", @{ $c->error } if @{ $c->error };
362 Or make sure to always return true values from your actions and write
365 $c->forward('foo') || return;
367 Another note is that C<< $c->forward >> always returns a scalar because it
368 actually returns $c->state which operates in a scalar context.
369 Thus, something like:
373 in an action that is forwarded to is going to return a scalar,
374 i.e. how many items are in that array, which is probably not what you want.
375 If you need to return an array then return a reference to it,
378 $c->stash->{array} = \@array;
380 and access it from the stash.
382 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.
386 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
388 =head2 $c->detach( $action [, \@arguments ] )
390 =head2 $c->detach( $class, $method, [, \@arguments ] )
394 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
395 doesn't return to the previous action when processing is finished.
397 When called with no arguments it escapes the processing chain entirely.
401 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
403 =head2 $c->visit( $action [, \@arguments ] )
405 =head2 $c->visit( $action [, \@captures, \@arguments ] )
407 =head2 $c->visit( $class, $method, [, \@arguments ] )
409 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
411 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
412 but does a full dispatch, instead of just calling the new C<$action> /
413 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
414 you go to are called, just like a new request.
416 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
417 This means, for example, that C<< $c->action >> methods such as
418 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
419 L<reverse|Catalyst::Action/reverse> return information for the visited action
420 when they are invoked within the visited action. This is different from the
421 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
422 continues to use the $c->action object from the caller action even when
423 invoked from the called action.
425 C<< $c->stash >> is kept unchanged.
427 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
428 allows you to "wrap" another action, just as it would have been called by
429 dispatching from a URL, while the analogous
430 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
431 transfer control to another action as if it had been reached directly from a URL.
435 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
437 =head2 $c->go( $action [, \@arguments ] )
439 =head2 $c->go( $action [, \@captures, \@arguments ] )
441 =head2 $c->go( $class, $method, [, \@arguments ] )
443 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
445 The relationship between C<go> and
446 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
447 the relationship between
448 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
449 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
450 C<< $c->go >> will perform a full dispatch on the specified action or method,
451 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
452 C<go> escapes the processing of the current request chain on completion, and
453 does not return to its caller.
455 @arguments are arguments to the final destination of $action. @captures are
456 arguments to the intermediate steps, if any, on the way to the final sub of
461 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
467 Returns the current L<Catalyst::Response> object, see there for details.
471 Returns a hashref to the stash, which may be used to store data and pass
472 it between components during a request. You can also set hash keys by
473 passing arguments. The stash is automatically sent to the view. The
474 stash is cleared at the end of a request; it cannot be used for
475 persistent storage (for this you must use a session; see
476 L<Catalyst::Plugin::Session> for a complete system integrated with
479 $c->stash->{foo} = $bar;
480 $c->stash( { moose => 'majestic', qux => 0 } );
481 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
483 # stash is automatically passed to the view for use in a template
484 $c->forward( 'MyApp::View::TT' );
488 around stash => sub {
491 my $stash = $orig->($c);
493 my $new_stash = @_ > 1 ? {@_} : $_[0];
494 croak('stash takes a hash or hashref') unless ref $new_stash;
495 foreach my $key ( keys %$new_stash ) {
496 $stash->{$key} = $new_stash->{$key};
506 =head2 $c->error($error, ...)
508 =head2 $c->error($arrayref)
510 Returns an arrayref containing error messages. If Catalyst encounters an
511 error while processing a request, it stores the error in $c->error. This
512 method should only be used to store fatal error messages.
514 my @error = @{ $c->error };
518 $c->error('Something bad happened');
525 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
526 croak @$error unless ref $c;
527 push @{ $c->{error} }, @$error;
529 elsif ( defined $_[0] ) { $c->{error} = undef }
530 return $c->{error} || [];
536 Contains the return value of the last executed action.
537 Note that << $c->state >> operates in a scalar context which means that all
538 values it returns are scalar.
540 =head2 $c->clear_errors
542 Clear errors. You probably don't want to clear the errors unless you are
543 implementing a custom error screen.
545 This is equivalent to running
556 sub _comp_search_prefixes {
558 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
561 # search components given a name and some prefixes
562 sub _comp_names_search_prefixes {
563 my ( $c, $name, @prefixes ) = @_;
564 my $appclass = ref $c || $c;
565 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
566 $filter = qr/$filter/; # Compile regex now rather than once per loop
568 # map the original component name to the sub part that we will search against
569 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
570 grep { /$filter/ } keys %{ $c->components };
572 # undef for a name will return all
573 return keys %eligible if !defined $name;
575 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
576 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
578 return @result if @result;
580 # if we were given a regexp to search against, we're done.
581 return if $name->$_isa('Regexp');
583 # skip regexp fallback if configured
585 if $appclass->config->{disable_component_resolution_regex_fallback};
589 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
591 # no results? try against full names
593 @result = grep { m{$query} } keys %eligible;
596 # don't warn if we didn't find any results, it just might not exist
598 # Disgusting hack to work out correct method name
599 my $warn_for = lc $prefixes[0];
600 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
601 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
602 "component resolution is unreliable and unsafe.";
603 my $short = $result[0];
604 # remove the component namespace prefix
605 $short =~ s/.*?(Model|Controller|View):://;
606 my $shortmess = Carp::shortmess('');
607 if ($shortmess =~ m#Catalyst/Plugin#) {
608 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
610 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
611 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
612 "component's config";
614 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
615 "but if you really wanted to search, pass in a regexp as the argument " .
616 "like so: \$c->${warn_for}(qr/${name}/)";
618 $c->log->warn( "${msg}$shortmess" );
624 # Find possible names for a prefix
626 my ( $c, @prefixes ) = @_;
627 my $appclass = ref $c || $c;
629 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
631 my @names = map { s{$filter}{}; $_; }
632 $c->_comp_names_search_prefixes( undef, @prefixes );
637 # Filter a component before returning by calling ACCEPT_CONTEXT if available
638 sub _filter_component {
639 my ( $c, $comp, @args ) = @_;
641 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
642 return $comp->ACCEPT_CONTEXT( $c, @args );
648 =head2 COMPONENT ACCESSORS
650 =head2 $c->controller($name)
652 Gets a L<Catalyst::Controller> instance by name.
654 $c->controller('Foo')->do_stuff;
656 If the name is omitted, will return the controller for the dispatched
659 If you want to search for controllers, pass in a regexp as the argument.
661 # find all controllers that start with Foo
662 my @foo_controllers = $c->controller(qr{^Foo});
668 my ( $c, $name, @args ) = @_;
670 my $appclass = ref($c) || $c;
672 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
673 my $comps = $c->components;
674 my $check = $appclass."::Controller::".$name;
675 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
677 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
678 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
679 return $c->_filter_component( $result[ 0 ], @args );
682 return $c->component( $c->action->class );
685 =head2 $c->model($name)
687 Gets a L<Catalyst::Model> instance by name.
689 $c->model('Foo')->do_stuff;
691 Any extra arguments are directly passed to ACCEPT_CONTEXT.
693 If the name is omitted, it will look for
694 - a model object in $c->stash->{current_model_instance}, then
695 - a model name in $c->stash->{current_model}, then
696 - a config setting 'default_model', or
697 - check if there is only one model, and return it if that's the case.
699 If you want to search for models, pass in a regexp as the argument.
701 # find all models that start with Foo
702 my @foo_models = $c->model(qr{^Foo});
707 my ( $c, $name, @args ) = @_;
708 my $appclass = ref($c) || $c;
710 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
711 my $comps = $c->components;
712 my $check = $appclass."::Model::".$name;
713 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
715 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
716 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
717 return $c->_filter_component( $result[ 0 ], @args );
721 return $c->stash->{current_model_instance}
722 if $c->stash->{current_model_instance};
723 return $c->model( $c->stash->{current_model} )
724 if $c->stash->{current_model};
726 return $c->model( $appclass->config->{default_model} )
727 if $appclass->config->{default_model};
729 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
732 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
733 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
734 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
735 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
736 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
739 return $c->_filter_component( $comp );
743 =head2 $c->view($name)
745 Gets a L<Catalyst::View> instance by name.
747 $c->view('Foo')->do_stuff;
749 Any extra arguments are directly passed to ACCEPT_CONTEXT.
751 If the name is omitted, it will look for
752 - a view object in $c->stash->{current_view_instance}, then
753 - a view name in $c->stash->{current_view}, then
754 - a config setting 'default_view', or
755 - check if there is only one view, and return it if that's the case.
757 If you want to search for views, pass in a regexp as the argument.
759 # find all views that start with Foo
760 my @foo_views = $c->view(qr{^Foo});
765 my ( $c, $name, @args ) = @_;
767 my $appclass = ref($c) || $c;
769 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
770 my $comps = $c->components;
771 my $check = $appclass."::View::".$name;
772 if( exists $comps->{$check} ) {
773 return $c->_filter_component( $comps->{$check}, @args );
776 $c->log->warn( "Attempted to use view '$check', but does not exist" );
779 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
780 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
781 return $c->_filter_component( $result[ 0 ], @args );
785 return $c->stash->{current_view_instance}
786 if $c->stash->{current_view_instance};
787 return $c->view( $c->stash->{current_view} )
788 if $c->stash->{current_view};
790 return $c->view( $appclass->config->{default_view} )
791 if $appclass->config->{default_view};
793 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
796 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
797 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
798 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
799 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
800 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
803 return $c->_filter_component( $comp );
806 =head2 $c->controllers
808 Returns the available names which can be passed to $c->controller
814 return $c->_comp_names(qw/Controller C/);
819 Returns the available names which can be passed to $c->model
825 return $c->_comp_names(qw/Model M/);
831 Returns the available names which can be passed to $c->view
837 return $c->_comp_names(qw/View V/);
840 =head2 $c->comp($name)
842 =head2 $c->component($name)
844 Gets a component object by name. This method is not recommended,
845 unless you want to get a specific component by full
846 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
847 should be used instead.
849 If C<$name> is a regexp, a list of components matched against the full
850 component name will be returned.
852 If Catalyst can't find a component by name, it will fallback to regex
853 matching by default. To disable this behaviour set
854 disable_component_resolution_regex_fallback to a true value.
856 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
861 my ( $c, $name, @args ) = @_;
864 my $comps = $c->components;
867 # is it the exact name?
868 return $c->_filter_component( $comps->{ $name }, @args )
869 if exists $comps->{ $name };
871 # perhaps we just omitted "MyApp"?
872 my $composed = ( ref $c || $c ) . "::${name}";
873 return $c->_filter_component( $comps->{ $composed }, @args )
874 if exists $comps->{ $composed };
876 # search all of the models, views and controllers
877 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
878 return $c->_filter_component( $comp, @args ) if $comp;
882 if $c->config->{disable_component_resolution_regex_fallback};
884 # This is here so $c->comp( '::M::' ) works
885 my $query = ref $name ? $name : qr{$name}i;
887 my @result = grep { m{$query} } keys %{ $c->components };
888 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
891 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
892 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
893 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
894 return $c->_filter_component( $result[ 0 ], @args );
897 # I would expect to return an empty list here, but that breaks back-compat
901 return sort keys %{ $c->components };
904 =head2 CLASS DATA AND HELPER CLASSES
908 Returns or takes a hashref containing the application's configuration.
910 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
912 You can also use a C<YAML>, C<XML> or L<Config::General> config file
913 like C<myapp.conf> in your applications home directory. See
914 L<Catalyst::Plugin::ConfigLoader>.
916 =head3 Cascading configuration
918 The config method is present on all Catalyst components, and configuration
919 will be merged when an application is started. Configuration loaded with
920 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
921 followed by configuration in your top level C<MyApp> class. These two
922 configurations are merged, and then configuration data whose hash key matches a
923 component name is merged with configuration for that component.
925 The configuration for a component is then passed to the C<new> method when a
926 component is constructed.
930 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
931 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
933 will mean that C<MyApp::Model::Foo> receives the following data when
936 MyApp::Model::Foo->new({
942 It's common practice to use a Moose attribute
943 on the receiving component to access the config value.
945 package MyApp::Model::Foo;
949 # this attr will receive 'baz' at construction time
955 You can then get the value 'baz' by calling $c->model('Foo')->bar
956 (or $self->bar inside code in the model).
958 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
959 as a way of reading config within your code, as this B<will not> give you the
960 correctly merged config back. You B<MUST> take the config values supplied to
961 the constructor and use those instead.
965 around config => sub {
969 croak('Setting config after setup has been run is not allowed.')
970 if ( @_ and $c->setup_finished );
977 Returns the logging object instance. Unless it is already set, Catalyst
978 sets this up with a L<Catalyst::Log> object. To use your own log class,
979 set the logger with the C<< __PACKAGE__->log >> method prior to calling
980 C<< __PACKAGE__->setup >>.
982 __PACKAGE__->log( MyLogger->new );
987 $c->log->info( 'Now logging with my own logger!' );
989 Your log class should implement the methods described in
995 Returns 1 if debug mode is enabled, 0 otherwise.
997 You can enable debug mode in several ways:
1001 =item By calling myapp_server.pl with the -d flag
1003 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1005 =item The -Debug option in your MyApp.pm
1007 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1011 The first three also set the log level to 'debug'.
1013 Calling C<< $c->debug(1) >> has no effect.
1019 =head2 $c->dispatcher
1021 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1025 Returns the engine instance. See L<Catalyst::Engine>.
1028 =head2 UTILITY METHODS
1030 =head2 $c->path_to(@path)
1032 Merges C<@path> with C<< $c->config->{home} >> and returns a
1033 L<Path::Class::Dir> object. Note you can usually use this object as
1034 a filename, but sometimes you will have to explicitly stringify it
1035 yourself by calling the C<< ->stringify >> method.
1039 $c->path_to( 'db', 'sqlite.db' );
1044 my ( $c, @path ) = @_;
1045 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1046 if ( -d $path ) { return $path }
1047 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1051 my ( $class, $name, $plugin, @args ) = @_;
1053 # See block comment in t/unit_core_plugin.t
1054 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1056 $class->_register_plugin( $plugin, 1 );
1058 eval { $plugin->import };
1059 $class->mk_classdata($name);
1061 eval { $obj = $plugin->new(@args) };
1064 Catalyst::Exception->throw( message =>
1065 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1068 $class->$name($obj);
1069 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1075 Initializes the dispatcher and engine, loads any plugins, and loads the
1076 model, view, and controller components. You may also specify an array
1077 of plugins to load here, if you choose to not load them in the C<use
1081 MyApp->setup( qw/-Debug/ );
1083 B<Note:> You B<should not> wrap this method with method modifiers
1084 or bad things will happen - wrap the C<setup_finalize> method instead.
1089 my ( $class, @arguments ) = @_;
1090 croak('Running setup more than once')
1091 if ( $class->setup_finished );
1093 unless ( $class->isa('Catalyst') ) {
1095 Catalyst::Exception->throw(
1096 message => qq/'$class' does not inherit from Catalyst/ );
1099 if ( $class->arguments ) {
1100 @arguments = ( @arguments, @{ $class->arguments } );
1106 foreach (@arguments) {
1110 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1112 elsif (/^-(\w+)=?(.*)$/) {
1113 $flags->{ lc $1 } = $2;
1116 push @{ $flags->{plugins} }, $_;
1120 $class->setup_home( delete $flags->{home} );
1122 $class->setup_log( delete $flags->{log} );
1123 $class->setup_plugins( delete $flags->{plugins} );
1124 $class->setup_dispatcher( delete $flags->{dispatcher} );
1125 if (my $engine = delete $flags->{engine}) {
1126 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1128 $class->setup_engine();
1129 $class->setup_stats( delete $flags->{stats} );
1131 for my $flag ( sort keys %{$flags} ) {
1133 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1134 &$code( $class, delete $flags->{$flag} );
1137 $class->log->warn(qq/Unknown flag "$flag"/);
1141 eval { require Catalyst::Devel; };
1142 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1143 $class->log->warn(<<"EOF");
1144 You are running an old script!
1146 Please update by running (this will overwrite existing files):
1147 catalyst.pl -force -scripts $class
1149 or (this will not overwrite existing files):
1150 catalyst.pl -scripts $class
1155 if ( $class->debug ) {
1156 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1159 my $column_width = Catalyst::Utils::term_width() - 6;
1160 my $t = Text::SimpleTable->new($column_width);
1161 $t->row($_) for @plugins;
1162 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1165 my $dispatcher = $class->dispatcher;
1166 my $engine = $class->engine;
1167 my $home = $class->config->{home};
1169 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1170 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1174 ? $class->log->debug(qq/Found home "$home"/)
1175 : $class->log->debug(qq/Home "$home" doesn't exist/)
1176 : $class->log->debug(q/Couldn't find home/);
1179 # Call plugins setup, this is stupid and evil.
1180 # Also screws C3 badly on 5.10, hack to avoid.
1182 no warnings qw/redefine/;
1183 local *setup = sub { };
1184 $class->setup unless $Catalyst::__AM_RESTARTING;
1187 # Initialize our data structure
1188 $class->components( {} );
1190 $class->setup_components;
1192 if ( $class->debug ) {
1193 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1194 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1195 for my $comp ( sort keys %{ $class->components } ) {
1196 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1197 $t->row( $comp, $type );
1199 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1200 if ( keys %{ $class->components } );
1203 # Add our self to components, since we are also a component
1204 if( $class->isa('Catalyst::Controller') ){
1205 $class->components->{$class} = $class;
1208 $class->setup_actions;
1210 if ( $class->debug ) {
1211 my $name = $class->config->{name} || 'Application';
1212 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1215 if ($class->config->{case_sensitive}) {
1216 $class->log->warn($class . "->config->{case_sensitive} is set.");
1217 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1220 $class->setup_finalize;
1221 # Should be the last thing we do so that user things hooking
1222 # setup_finalize can log..
1223 $class->log->_flush() if $class->log->can('_flush');
1224 return 1; # Explicit return true as people have __PACKAGE__->setup as the last thing in their class. HATE.
1227 =head2 $app->setup_finalize
1229 A hook to attach modifiers to. This method does not do anything except set the
1230 C<setup_finished> accessor.
1232 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1236 after setup_finalize => sub {
1244 sub setup_finalize {
1246 $class->setup_finished(1);
1249 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1251 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1253 Constructs an absolute L<URI> object based on the application root, the
1254 provided path, and the additional arguments and query parameters provided.
1255 When used as a string, provides a textual URI. If you need more flexibility
1256 than this (i.e. the option to provide relative URIs etc.) see
1257 L<Catalyst::Plugin::SmartURI>.
1259 If no arguments are provided, the URI for the current action is returned.
1260 To return the current action and also provide @args, use
1261 C<< $c->uri_for( $c->action, @args ) >>.
1263 If the first argument is a string, it is taken as a public URI path relative
1264 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1265 relative to the application root (if it does). It is then merged with
1266 C<< $c->request->base >>; any C<@args> are appended as additional path
1267 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1269 If the first argument is a L<Catalyst::Action> it represents an action which
1270 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1271 optional C<\@captures> argument (an arrayref) allows passing the captured
1272 variables that are needed to fill in the paths of Chained and Regex actions;
1273 once the path is resolved, C<uri_for> continues as though a path was
1274 provided, appending any arguments or parameters and creating an absolute
1277 The captures for the current request can be found in
1278 C<< $c->request->captures >>, and actions can be resolved using
1279 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1280 path, use C<< $c->uri_for_action >> instead.
1282 # Equivalent to $c->req->uri
1283 $c->uri_for($c->action, $c->req->captures,
1284 @{ $c->req->args }, $c->req->params);
1286 # For the Foo action in the Bar controller
1287 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1289 # Path to a static resource
1290 $c->uri_for('/static/images/logo.png');
1295 my ( $c, $path, @args ) = @_;
1297 if ( $path->$_isa('Catalyst::Controller') ) {
1298 $path = $path->path_prefix;
1303 undef($path) if (defined $path && $path eq '');
1306 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1308 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1309 foreach my $arg (@args) {
1310 utf8::encode($arg) if utf8::is_utf8($arg);
1311 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1314 if ( $path->$_isa('Catalyst::Action') ) { # action object
1315 s|/|%2F|g for @args;
1316 my $captures = [ map { s|/|%2F|g; $_; }
1317 ( scalar @args && ref $args[0] eq 'ARRAY'
1321 foreach my $capture (@$captures) {
1322 utf8::encode($capture) if utf8::is_utf8($capture);
1323 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1327 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1328 if( !@args && $action->number_of_args ) {
1329 my $expanded_action = $c->dispatcher->expand_action( $action );
1331 my $num_captures = $expanded_action->number_of_captures;
1332 unshift @args, splice @$captures, $num_captures;
1335 $path = $c->dispatcher->uri_for_action($action, $captures);
1336 if (not defined $path) {
1337 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1341 $path = '/' if $path eq '';
1344 unshift(@args, $path);
1346 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1347 my $namespace = $c->namespace;
1348 if (defined $path) { # cheesy hack to handle path '../foo'
1349 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1351 unshift(@args, $namespace || '');
1354 # join args with '/', or a blank string
1355 my $args = join('/', grep { defined($_) } @args);
1356 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1359 my ($base, $class) = ('/', 'URI::_generic');
1361 $base = $c->req->base;
1362 $class = ref($base);
1363 $base =~ s{(?<!/)$}{/};
1368 if (my @keys = keys %$params) {
1369 # somewhat lifted from URI::_query's query_form
1370 $query = '?'.join('&', map {
1371 my $val = $params->{$_};
1372 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1375 $val = '' unless defined $val;
1378 utf8::encode( $param ) if utf8::is_utf8($param);
1379 # using the URI::Escape pattern here so utf8 chars survive
1380 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1382 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1386 my $res = bless(\"${base}${args}${query}", $class);
1390 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1392 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1398 A private path to the Catalyst action you want to create a URI for.
1400 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1401 >> and passing the resulting C<$action> and the remaining arguments to C<<
1404 You can also pass in a Catalyst::Action object, in which case it is passed to
1407 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.
1409 For example, if the action looks like:
1411 package MyApp::Controller::Users;
1413 sub lst : Path('the-list') {}
1417 $c->uri_for_action('/users/lst')
1419 and it will create the URI /users/the-list.
1421 =item \@captures_and_args?
1423 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1424 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1425 to interpolate all the parameters in the URI.
1429 Optional list of extra arguments - can be supplied in the
1430 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1433 Your action can have zero, a fixed or a variable number of args (e.g.
1434 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1436 =item \%query_values?
1438 Optional array reference of query parameters to append. E.g.
1444 /rest/of/your/uri?foo=bar
1450 sub uri_for_action {
1451 my ( $c, $path, @args ) = @_;
1452 my $action = blessed($path)
1454 : $c->dispatcher->get_action_by_path($path);
1455 unless (defined $action) {
1456 croak "Can't find action for path '$path'";
1458 return $c->uri_for( $action, @args );
1461 =head2 $c->welcome_message
1463 Returns the Catalyst welcome HTML page.
1467 sub welcome_message {
1469 my $name = $c->config->{name};
1470 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1471 my $prefix = Catalyst::Utils::appprefix( ref $c );
1472 $c->response->content_type('text/html; charset=utf-8');
1474 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1475 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1476 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1478 <meta http-equiv="Content-Language" content="en" />
1479 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1480 <title>$name on Catalyst $VERSION</title>
1481 <style type="text/css">
1484 background-color: #eee;
1491 margin-bottom: 10px;
1493 background-color: #ccc;
1494 border: 1px solid #aaa;
1499 font-family: verdana, tahoma, sans-serif;
1502 font-family: verdana, tahoma, sans-serif;
1505 text-decoration: none;
1507 border-bottom: 1px dotted #bbb;
1509 :link:hover, :visited:hover {
1522 background-color: #fff;
1523 border: 1px solid #aaa;
1527 font-weight: normal;
1549 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1554 <img src="$logo" alt="Catalyst Logo" />
1556 <p>Welcome to the world of Catalyst.
1557 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1558 framework will make web development something you had
1559 never expected it to be: Fun, rewarding, and quick.</p>
1560 <h2>What to do now?</h2>
1561 <p>That really depends on what <b>you</b> want to do.
1562 We do, however, provide you with a few starting points.</p>
1563 <p>If you want to jump right into web development with Catalyst
1564 you might want to start with a tutorial.</p>
1565 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1567 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1569 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1570 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1572 <h2>What to do next?</h2>
1573 <p>Next it's time to write an actual application. Use the
1574 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1575 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1576 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1577 they can save you a lot of work.</p>
1578 <pre><code>script/${prefix}_create.pl --help</code></pre>
1579 <p>Also, be sure to check out the vast and growing
1580 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1581 you are likely to find what you need there.
1585 <p>Catalyst has a very active community. Here are the main places to
1586 get in touch with us.</p>
1589 <a href="http://dev.catalyst.perl.org">Wiki</a>
1592 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1595 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1598 <h2>In conclusion</h2>
1599 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1600 as we enjoyed making it. Please contact us if you have ideas
1601 for improvement or other feedback.</p>
1611 Contains a hash of options passed from the application script, including
1612 the original ARGV the script received, the processed values from that
1613 ARGV and any extra arguments to the script which were not processed.
1615 This can be used to add custom options to your application's scripts
1616 and setup your application differently depending on the values of these
1619 =head1 INTERNAL METHODS
1621 These methods are not meant to be used by end users.
1623 =head2 $c->components
1625 Returns a hash of components.
1627 =head2 $c->context_class
1629 Returns or sets the context class.
1633 Returns a hashref containing coderefs and execution counts (needed for
1634 deep recursion detection).
1638 Returns the number of actions on the current internal execution stack.
1642 Dispatches a request to actions.
1646 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1648 =head2 $c->dispatcher_class
1650 Returns or sets the dispatcher class.
1652 =head2 $c->dump_these
1654 Returns a list of 2-element array references (name, structure) pairs
1655 that will be dumped on the error page in debug mode.
1661 [ Request => $c->req ],
1662 [ Response => $c->res ],
1663 [ Stash => $c->stash ],
1664 [ Config => $c->config ];
1667 =head2 $c->engine_class
1669 Returns or sets the engine class.
1671 =head2 $c->execute( $class, $coderef )
1673 Execute a coderef in given class and catch exceptions. Errors are available
1679 my ( $c, $class, $code ) = @_;
1680 $class = $c->component($class) || $class;
1683 if ( $c->depth >= $RECURSION ) {
1684 my $action = $code->reverse();
1685 $action = "/$action" unless $action =~ /->/;
1686 my $error = qq/Deep recursion detected calling "${action}"/;
1687 $c->log->error($error);
1693 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1695 push( @{ $c->stack }, $code );
1697 no warnings 'recursion';
1698 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1699 # I have no idea how, ergo $ret (which appears to fix the issue)
1700 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1702 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1704 my $last = pop( @{ $c->stack } );
1706 if ( my $error = $@ ) {
1707 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1708 $error->rethrow if $c->depth > 1;
1710 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1711 $error->rethrow if $c->depth > 0;
1714 unless ( ref $error ) {
1715 no warnings 'uninitialized';
1717 my $class = $last->class;
1718 my $name = $last->name;
1719 $error = qq/Caught exception in $class->$name "$error"/;
1728 sub _stats_start_execute {
1729 my ( $c, $code ) = @_;
1730 my $appclass = ref($c) || $c;
1731 return if ( ( $code->name =~ /^_.*/ )
1732 && ( !$appclass->config->{show_internal_actions} ) );
1734 my $action_name = $code->reverse();
1735 $c->counter->{$action_name}++;
1737 my $action = $action_name;
1738 $action = "/$action" unless $action =~ /->/;
1740 # determine if the call was the result of a forward
1741 # this is done by walking up the call stack and looking for a calling
1742 # sub of Catalyst::forward before the eval
1744 for my $index ( 2 .. 11 ) {
1746 if ( ( caller($index) )[0] eq 'Catalyst'
1747 && ( caller($index) )[3] eq '(eval)' );
1749 if ( ( caller($index) )[3] =~ /forward$/ ) {
1750 $callsub = ( caller($index) )[3];
1751 $action = "-> $action";
1756 my $uid = $action_name . $c->counter->{$action_name};
1758 # is this a root-level call or a forwarded call?
1759 if ( $callsub =~ /forward$/ ) {
1760 my $parent = $c->stack->[-1];
1762 # forward, locate the caller
1763 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1766 parent => "$parent" . $c->counter->{"$parent"},
1772 # forward with no caller may come from a plugin
1791 sub _stats_finish_execute {
1792 my ( $c, $info ) = @_;
1793 $c->stats->profile( end => $info );
1798 Finalizes the request.
1805 for my $error ( @{ $c->error } ) {
1806 $c->log->error($error);
1809 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1810 # stuff like cometd and websockets
1812 if($c->request->has_io_fh) {
1817 # Allow engine to handle finalize flow (for POE)
1818 my $engine = $c->engine;
1819 if ( my $code = $engine->can('finalize') ) {
1824 $c->finalize_uploads;
1827 if ( $#{ $c->error } >= 0 ) {
1831 $c->finalize_headers unless $c->response->finalized_headers;
1834 if ( $c->request->method eq 'HEAD' ) {
1835 $c->response->body('');
1843 if ($c->use_stats) {
1844 my $elapsed = $c->stats->elapsed;
1845 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1847 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1850 return $c->response->status;
1853 =head2 $c->finalize_body
1859 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1861 =head2 $c->finalize_cookies
1867 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1869 =head2 $c->finalize_error
1875 sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) }
1877 =head2 $c->finalize_headers
1883 sub finalize_headers {
1886 my $response = $c->response; #accessor calls can add up?
1888 # Check if we already finalized headers
1889 return if $response->finalized_headers;
1892 if ( my $location = $response->redirect ) {
1893 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1894 $response->header( Location => $location );
1896 if ( !$response->has_body ) {
1897 # Add a default body if none is already present
1898 my $encoded_location = encode_entities($location);
1899 $response->body(<<"EOF");
1900 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1901 <html xmlns="http://www.w3.org/1999/xhtml">
1903 <title>Moved</title>
1906 <p>This item has moved <a href="$encoded_location">here</a>.</p>
1910 $response->content_type('text/html; charset=utf-8');
1915 if ( defined $response->body && length $response->body && !$response->content_length ) {
1917 # get the length from a filehandle
1918 if ( blessed( $response->body ) && $response->body->can('read') || ref( $response->body ) eq 'GLOB' )
1920 my $size = -s $response->body;
1922 $response->content_length( $size );
1925 $c->log->warn('Serving filehandle without a content-length');
1929 # everything should be bytes at this point, but just in case
1930 $response->content_length( length( $response->body ) );
1935 if ( $response->status =~ /^(1\d\d|[23]04)$/ ) {
1936 $response->headers->remove_header("Content-Length");
1937 $response->body('');
1940 $c->finalize_cookies;
1942 $c->response->finalize_headers();
1945 $response->finalized_headers(1);
1948 =head2 $c->finalize_output
1950 An alias for finalize_body.
1952 =head2 $c->finalize_read
1954 Finalizes the input after reading is complete.
1958 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1960 =head2 $c->finalize_uploads
1962 Finalizes uploads. Cleans up any temporary files.
1966 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1968 =head2 $c->get_action( $action, $namespace )
1970 Gets an action in a given namespace.
1974 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1976 =head2 $c->get_actions( $action, $namespace )
1978 Gets all actions of a given name in a namespace and all parent
1983 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1985 =head2 $app->handle_request( @arguments )
1987 Called to handle each HTTP request.
1991 sub handle_request {
1992 my ( $class, @arguments ) = @_;
1994 # Always expect worst case!
1997 if ($class->debug) {
1998 my $secs = time - $START || 1;
1999 my $av = sprintf '%.3f', $COUNT / $secs;
2000 my $time = localtime time;
2001 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2004 my $c = $class->prepare(@arguments);
2006 $status = $c->finalize;
2009 chomp(my $error = $_);
2010 $class->log->error(qq/Caught exception in engine "$error"/);
2015 if(my $coderef = $class->log->can('_flush')){
2016 $class->log->$coderef();
2021 =head2 $class->prepare( @arguments )
2023 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2030 predicate => '_has_uploadtmp',
2034 my ( $class, @arguments ) = @_;
2037 # After the app/ctxt split, this should become an attribute based on something passed
2038 # into the application.
2039 $class->context_class( ref $class || $class ) unless $class->context_class;
2041 my $uploadtmp = $class->config->{uploadtmp};
2042 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2044 $c->response->_context($c);
2046 #surely this is not the most efficient way to do things...
2047 $c->stats($class->stats_class->new)->enable($c->use_stats);
2048 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2049 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2053 # Allow engine to direct the prepare flow (for POE)
2054 if ( my $prepare = $c->engine->can('prepare') ) {
2055 $c->engine->$prepare( $c, @arguments );
2058 $c->prepare_request(@arguments);
2059 $c->prepare_connection;
2060 $c->prepare_query_parameters;
2061 $c->prepare_headers; # Just hooks, no longer needed - they just
2062 $c->prepare_cookies; # cause the lazy attribute on req to build
2065 # Prepare the body for reading, either by prepare_body
2066 # or the user, if they are using $c->read
2069 # Parse the body unless the user wants it on-demand
2070 unless ( ref($c)->config->{parse_on_demand} ) {
2076 # VERY ugly and probably shouldn't rely on ->finalize actually working
2078 # failed prepare is always due to an invalid request, right?
2079 $c->response->status(400);
2080 $c->response->content_type('text/plain');
2081 $c->response->body('Bad Request');
2082 # Note we call finalize and then die here, which escapes
2083 # finalize being called in the enclosing block..
2084 # It in fact couldn't be called, as we don't return $c..
2085 # This is a mess - but I'm unsure you can fix this without
2086 # breaking compat for people doing crazy things (we should set
2087 # the 400 and just return the ctx here IMO, letting finalize get called
2098 =head2 $c->prepare_action
2100 Prepares action. See L<Catalyst::Dispatcher>.
2104 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2106 =head2 $c->prepare_body
2108 Prepares message body.
2115 return if $c->request->_has_body;
2117 # Initialize on-demand data
2118 $c->engine->prepare_body( $c, @_ );
2119 $c->prepare_parameters;
2120 $c->prepare_uploads;
2123 =head2 $c->prepare_body_chunk( $chunk )
2125 Prepares a chunk of data before sending it to L<HTTP::Body>.
2127 See L<Catalyst::Engine>.
2131 sub prepare_body_chunk {
2133 $c->engine->prepare_body_chunk( $c, @_ );
2136 =head2 $c->prepare_body_parameters
2138 Prepares body parameters.
2142 sub prepare_body_parameters {
2144 $c->engine->prepare_body_parameters( $c, @_ );
2147 =head2 $c->prepare_connection
2149 Prepares connection.
2153 sub prepare_connection {
2155 # XXX - This is called on the engine (not the request) to maintain
2156 # Engine::PSGI back compat.
2157 $c->engine->prepare_connection($c);
2160 =head2 $c->prepare_cookies
2162 Prepares cookies by ensuring that the attribute on the request
2163 object has been built.
2167 sub prepare_cookies { my $c = shift; $c->request->cookies }
2169 =head2 $c->prepare_headers
2171 Prepares request headers by ensuring that the attribute on the request
2172 object has been built.
2176 sub prepare_headers { my $c = shift; $c->request->headers }
2178 =head2 $c->prepare_parameters
2180 Prepares parameters.
2184 sub prepare_parameters {
2186 $c->prepare_body_parameters;
2187 $c->engine->prepare_parameters( $c, @_ );
2190 =head2 $c->prepare_path
2192 Prepares path and base.
2196 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2198 =head2 $c->prepare_query_parameters
2200 Prepares query parameters.
2204 sub prepare_query_parameters {
2207 $c->engine->prepare_query_parameters( $c, @_ );
2210 =head2 $c->log_request
2212 Writes information about the request to the debug logs. This includes:
2216 =item * Request method, path, and remote IP address
2218 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2220 =item * Request parameters
2222 =item * File uploads
2231 return unless $c->debug;
2233 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2234 my $request = $dump->[1];
2236 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2238 $path = '/' unless length $path;
2240 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2242 $c->log_request_headers($request->headers);
2244 if ( my $keywords = $request->query_keywords ) {
2245 $c->log->debug("Query keywords are: $keywords");
2248 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2250 $c->log_request_uploads($request);
2253 =head2 $c->log_response
2255 Writes information about the response to the debug logs by calling
2256 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2263 return unless $c->debug;
2265 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2266 my $response = $dump->[1];
2268 $c->log_response_status_line($response);
2269 $c->log_response_headers($response->headers);
2272 =head2 $c->log_response_status_line($response)
2274 Writes one line of information about the response to the debug logs. This includes:
2278 =item * Response status code
2280 =item * Content-Type header (if present)
2282 =item * Content-Length header (if present)
2288 sub log_response_status_line {
2289 my ($c, $response) = @_;
2293 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2294 $response->status || 'unknown',
2295 $response->headers->header('Content-Type') || 'unknown',
2296 $response->headers->header('Content-Length') || 'unknown'
2301 =head2 $c->log_response_headers($headers);
2303 Hook method which can be wrapped by plugins to log the response headers.
2304 No-op in the default implementation.
2308 sub log_response_headers {}
2310 =head2 $c->log_request_parameters( query => {}, body => {} )
2312 Logs request parameters to debug logs
2316 sub log_request_parameters {
2318 my %all_params = @_;
2320 return unless $c->debug;
2322 my $column_width = Catalyst::Utils::term_width() - 44;
2323 foreach my $type (qw(query body)) {
2324 my $params = $all_params{$type};
2325 next if ! keys %$params;
2326 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2327 for my $key ( sort keys %$params ) {
2328 my $param = $params->{$key};
2329 my $value = defined($param) ? $param : '';
2330 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2332 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2336 =head2 $c->log_request_uploads
2338 Logs file uploads included in the request to the debug logs.
2339 The parameter name, filename, file type, and file size are all included in
2344 sub log_request_uploads {
2346 my $request = shift;
2347 return unless $c->debug;
2348 my $uploads = $request->uploads;
2349 if ( keys %$uploads ) {
2350 my $t = Text::SimpleTable->new(
2351 [ 12, 'Parameter' ],
2356 for my $key ( sort keys %$uploads ) {
2357 my $upload = $uploads->{$key};
2358 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2359 $t->row( $key, $u->filename, $u->type, $u->size );
2362 $c->log->debug( "File Uploads are:\n" . $t->draw );
2366 =head2 $c->log_request_headers($headers);
2368 Hook method which can be wrapped by plugins to log the request headers.
2369 No-op in the default implementation.
2373 sub log_request_headers {}
2375 =head2 $c->log_headers($type => $headers)
2377 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2384 my $headers = shift; # an HTTP::Headers instance
2386 return unless $c->debug;
2388 my $column_width = Catalyst::Utils::term_width() - 28;
2389 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2392 my ( $name, $value ) = @_;
2393 $t->row( $name, $value );
2396 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2400 =head2 $c->prepare_read
2402 Prepares the input for reading.
2406 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2408 =head2 $c->prepare_request
2410 Prepares the engine request.
2414 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2416 =head2 $c->prepare_uploads
2422 sub prepare_uploads {
2425 $c->engine->prepare_uploads( $c, @_ );
2428 =head2 $c->prepare_write
2430 Prepares the output for writing.
2434 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2436 =head2 $c->request_class
2438 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2440 =head2 $c->response_class
2442 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2444 =head2 $c->read( [$maxlength] )
2446 Reads a chunk of data from the request body. This method is designed to
2447 be used in a while loop, reading C<$maxlength> bytes on every call.
2448 C<$maxlength> defaults to the size of the request if not specified.
2450 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2453 Warning: If you use read(), Catalyst will not process the body,
2454 so you will not be able to access POST parameters or file uploads via
2455 $c->request. You must handle all body parsing yourself.
2459 sub read { my $c = shift; return $c->request->read( @_ ) }
2469 $app->_make_immutable_if_needed;
2470 $app->engine_loader->needs_psgi_engine_compat_hack ?
2471 $app->engine->run($app, @_) :
2472 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2475 sub _make_immutable_if_needed {
2477 my $meta = find_meta($class);
2478 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2481 && ! { $meta->immutable_options }->{replace_constructor}
2484 warn("You made your application class ($class) immutable, "
2485 . "but did not inline the\nconstructor. "
2486 . "This will break catalyst, as your app \@ISA "
2487 . "Class::Accessor(::Fast)?\nPlease pass "
2488 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2490 unless ($meta->is_immutable) {
2491 # XXX - FIXME warning here as you should make your app immutable yourself.
2492 $meta->make_immutable(
2493 replace_constructor => 1,
2498 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2500 Sets an action in a given namespace.
2504 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2506 =head2 $c->setup_actions($component)
2508 Sets up actions for a component.
2512 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2514 =head2 $c->setup_components
2516 This method is called internally to set up the application's components.
2518 It finds modules by calling the L<locate_components> method, expands them to
2519 package names with the L<expand_component_module> method, and then installs
2520 each component into the application.
2522 The C<setup_components> config option is passed to both of the above methods.
2524 Installation of each component is performed by the L<setup_component> method,
2529 sub setup_components {
2532 my $config = $class->config->{ setup_components };
2534 my @comps = $class->locate_components($config);
2535 my %comps = map { $_ => 1 } @comps;
2537 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2538 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2539 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2540 ) if $deprecatedcatalyst_component_names;
2542 for my $component ( @comps ) {
2544 # We pass ignore_loaded here so that overlay files for (e.g.)
2545 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2546 # we know M::P::O found a file on disk so this is safe
2548 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2551 for my $component (@comps) {
2552 my $instance = $class->components->{ $component } = $class->setup_component($component);
2553 my @expanded_components = $instance->can('expand_modules')
2554 ? $instance->expand_modules( $component, $config )
2555 : $class->expand_component_module( $component, $config );
2556 for my $component (@expanded_components) {
2557 next if $comps{$component};
2558 $class->components->{ $component } = $class->setup_component($component);
2563 =head2 $c->locate_components( $setup_component_config )
2565 This method is meant to provide a list of component modules that should be
2566 setup for the application. By default, it will use L<Module::Pluggable>.
2568 Specify a C<setup_components> config option to pass additional options directly
2569 to L<Module::Pluggable>. To add additional search paths, specify a key named
2570 C<search_extra> as an array reference. Items in the array beginning with C<::>
2571 will have the application class name prepended to them.
2575 sub locate_components {
2579 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2580 my $extra = delete $config->{ search_extra } || [];
2582 push @paths, @$extra;
2584 my $locator = Module::Pluggable::Object->new(
2585 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2589 # XXX think about ditching this sort entirely
2590 my @comps = sort { length $a <=> length $b } $locator->plugins;
2595 =head2 $c->expand_component_module( $component, $setup_component_config )
2597 Components found by C<locate_components> will be passed to this method, which
2598 is expected to return a list of component (package) names to be set up.
2602 sub expand_component_module {
2603 my ($class, $module) = @_;
2604 return Devel::InnerPackage::list_packages( $module );
2607 =head2 $c->setup_component
2611 sub setup_component {
2612 my( $class, $component ) = @_;
2614 unless ( $component->can( 'COMPONENT' ) ) {
2618 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2619 my $config = $class->config->{ $suffix } || {};
2620 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2621 # methods also pass it. local to avoid pointlessly shitting in config
2622 # for the debug screen, as $component is already the key name.
2623 local $config->{catalyst_component_name} = $component;
2625 my $instance = eval { $component->COMPONENT( $class, $config ); };
2627 if ( my $error = $@ ) {
2629 Catalyst::Exception->throw(
2630 message => qq/Couldn't instantiate component "$component", "$error"/
2634 unless (blessed $instance) {
2635 my $metaclass = Moose::Util::find_meta($component);
2636 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2637 my $component_method_from = $method_meta->associated_metaclass->name;
2638 my $value = defined($instance) ? $instance : 'undef';
2639 Catalyst::Exception->throw(
2641 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2647 =head2 $c->setup_dispatcher
2653 sub setup_dispatcher {
2654 my ( $class, $dispatcher ) = @_;
2657 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2660 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2661 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2664 unless ($dispatcher) {
2665 $dispatcher = $class->dispatcher_class;
2668 load_class($dispatcher);
2670 # dispatcher instance
2671 $class->dispatcher( $dispatcher->new );
2674 =head2 $c->setup_engine
2681 my ($class, $requested_engine) = @_;
2683 if (!$class->engine_loader || $requested_engine) {
2684 $class->engine_loader(
2685 Catalyst::EngineLoader->new({
2686 application_name => $class,
2687 (defined $requested_engine
2688 ? (catalyst_engine_class => $requested_engine) : ()),
2693 $class->engine_loader->catalyst_engine_class;
2697 my ($class, $requested_engine) = @_;
2700 my $loader = $class->engine_loader;
2702 if (!$loader || $requested_engine) {
2703 $loader = Catalyst::EngineLoader->new({
2704 application_name => $class,
2705 (defined $requested_engine
2706 ? (requested_engine => $requested_engine) : ()),
2709 $class->engine_loader($loader);
2712 $loader->catalyst_engine_class;
2715 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2716 return if $class->loading_psgi_file;
2718 load_class($engine);
2720 if ($ENV{MOD_PERL}) {
2721 my $apache = $class->engine_loader->auto;
2723 my $meta = find_meta($class);
2724 my $was_immutable = $meta->is_immutable;
2725 my %immutable_options = $meta->immutable_options;
2726 $meta->make_mutable if $was_immutable;
2728 $meta->add_method(handler => sub {
2730 my $psgi_app = $class->_finalized_psgi_app;
2731 $apache->call_app($r, $psgi_app);
2734 $meta->make_immutable(%immutable_options) if $was_immutable;
2737 $class->engine( $engine->new );
2742 sub _finalized_psgi_app {
2745 unless ($app->_psgi_app) {
2746 my $psgi_app = $app->_setup_psgi_app;
2747 $app->_psgi_app($psgi_app);
2750 return $app->_psgi_app;
2753 sub _setup_psgi_app {
2756 for my $home (Path::Class::Dir->new($app->config->{home})) {
2757 my $psgi_file = $home->file(
2758 Catalyst::Utils::appprefix($app) . '.psgi',
2761 next unless -e $psgi_file;
2763 # If $psgi_file calls ->setup_engine, it's doing so to load
2764 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2765 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2766 # anyway. So set a flag (ick) that tells setup_engine not to populate
2767 # $c->engine or do any other things we might regret.
2769 $app->loading_psgi_file(1);
2770 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2771 $app->loading_psgi_file(0);
2774 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2777 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2779 Its content has been ignored. Please consult the Catalyst::Upgrading
2780 documentation on how to upgrade from Catalyst::Engine::PSGI.
2784 return $app->apply_default_middlewares($app->psgi_app);
2787 =head2 $c->apply_default_middlewares
2789 Adds the following L<Plack> middlewares to your application, since they are
2790 useful and commonly needed:
2792 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2793 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2794 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2795 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2796 applied since this middleware is smart enough to conditionally apply itself).
2798 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2799 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2805 sub apply_default_middlewares {
2806 my ($app, $psgi_app) = @_;
2808 $psgi_app = Plack::Middleware::Conditional->wrap(
2810 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2813 return if $app->config->{ignore_frontend_proxy};
2814 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2815 || $app->config->{using_frontend_proxy};
2819 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2820 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2821 $psgi_app = Plack::Middleware::Conditional->wrap(
2823 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2826 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2827 return unless $1 < 4.23;
2832 # we're applying this unconditionally as the middleware itself already makes
2833 # sure it doesn't fuck things up if it's not running under one of the right
2835 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2837 # And another IIS issue, this time with IIS7.
2838 $psgi_app = Plack::Middleware::Conditional->wrap(
2840 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2843 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2852 Returns a PSGI application code reference for the catalyst application
2853 C<$c>. This is the bare application without any middlewares
2854 applied. C<${myapp}.psgi> is not taken into account.
2856 This is what you want to be using to retrieve the PSGI application code
2857 reference of your Catalyst application for use in F<.psgi> files.
2863 return $app->engine->build_psgi_app($app);
2866 =head2 $c->setup_home
2868 Sets up the home directory.
2873 my ( $class, $home ) = @_;
2875 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2879 $home ||= Catalyst::Utils::home($class);
2882 #I remember recently being scolded for assigning config values like this
2883 $class->config->{home} ||= $home;
2884 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2888 =head2 $c->setup_log
2890 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2891 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2894 This method also installs a C<debug> method that returns a true value into the
2895 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2896 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2898 Note that if the log has already been setup, by either a previous call to
2899 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2900 that this method won't actually set up the log object.
2905 my ( $class, $levels ) = @_;
2908 $levels =~ s/^\s+//;
2909 $levels =~ s/\s+$//;
2910 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2912 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2913 if ( defined $env_debug ) {
2914 $levels{debug} = 1 if $env_debug; # Ugly!
2915 delete($levels{debug}) unless $env_debug;
2918 unless ( $class->log ) {
2919 $class->log( Catalyst::Log->new(keys %levels) );
2922 if ( $levels{debug} ) {
2923 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2924 $class->log->debug('Debug messages enabled');
2928 =head2 $c->setup_plugins
2934 =head2 $c->setup_stats
2936 Sets up timing statistics class.
2941 my ( $class, $stats ) = @_;
2943 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2945 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2946 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2947 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2948 $class->log->debug('Statistics enabled');
2953 =head2 $c->registered_plugins
2955 Returns a sorted list of the plugins which have either been stated in the
2958 If passed a given plugin name, it will report a boolean value indicating
2959 whether or not that plugin is loaded. A fully qualified name is required if
2960 the plugin name does not begin with C<Catalyst::Plugin::>.
2962 if ($c->registered_plugins('Some::Plugin')) {
2970 sub registered_plugins {
2972 return sort keys %{ $proto->_plugins } unless @_;
2974 return 1 if exists $proto->_plugins->{$plugin};
2975 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
2978 sub _register_plugin {
2979 my ( $proto, $plugin, $instant ) = @_;
2980 my $class = ref $proto || $proto;
2982 load_class( $plugin );
2983 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
2984 if $plugin->isa( 'Catalyst::Component' );
2985 my $plugin_meta = Moose::Meta::Class->create($plugin);
2986 if (!$plugin_meta->has_method('new')
2987 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
2988 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
2990 if (!$instant && !$proto->_plugins->{$plugin}) {
2991 my $meta = Class::MOP::get_metaclass_by_name($class);
2992 $meta->superclasses($plugin, $meta->superclasses);
2994 $proto->_plugins->{$plugin} = 1;
2998 sub _default_plugins { return qw(Unicode::Encoding) }
3001 my ( $class, $plugins ) = @_;
3003 $class->_plugins( {} ) unless $class->_plugins;
3005 m/Unicode::Encoding/ ? do {
3007 'Unicode::Encoding plugin is auto-applied,'
3008 . ' please remove this from your appclass'
3009 . ' and make sure to define "encoding" config'
3011 unless (exists $class->config->{'encoding'}) {
3012 $class->config->{'encoding'} = 'UTF-8';
3017 push @$plugins, $class->_default_plugins;
3018 $plugins = Data::OptList::mkopt($plugins || []);
3021 [ Catalyst::Utils::resolve_namespace(
3022 $class . '::Plugin',
3023 'Catalyst::Plugin', $_->[0]
3029 for my $plugin ( reverse @plugins ) {
3030 load_class($plugin->[0], $plugin->[1]);
3031 my $meta = find_meta($plugin->[0]);
3032 next if $meta && $meta->isa('Moose::Meta::Role');
3034 $class->_register_plugin($plugin->[0]);
3038 map { $_->[0]->name, $_->[1] }
3039 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3040 map { [find_meta($_->[0]), $_->[1]] }
3043 Moose::Util::apply_all_roles(
3051 Returns an arrayref of the internal execution stack (actions that are
3052 currently executing).
3056 Returns the current timing statistics object. By default Catalyst uses
3057 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3058 L<< stats_class|/"$c->stats_class" >>.
3060 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3061 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3062 profile explicitly, although MyApp.pm still won't profile nor output anything
3065 =head2 $c->stats_class
3067 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3069 =head2 $c->use_stats
3071 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3073 Note that this is a static method, not an accessor and should be overridden
3074 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3081 =head2 $c->write( $data )
3083 Writes $data to the output stream. When using this method directly, you
3084 will need to manually set the C<Content-Length> header to the length of
3085 your output data, if known.
3092 # Finalize headers if someone manually writes output (for compat)
3093 $c->finalize_headers;
3095 return $c->response->write( @_ );
3100 Returns the Catalyst version number. Mostly useful for "powered by"
3101 messages in template systems.
3105 sub version { return $Catalyst::VERSION }
3107 =head1 CONFIGURATION
3109 There are a number of 'base' config variables which can be set:
3115 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3119 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3123 C<disable_component_resolution_regex_fallback> - Turns
3124 off the deprecated component resolution functionality so
3125 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3126 are called then regex search will not be attempted on string values and
3127 instead C<undef> will be returned.
3131 C<home> - The application home directory. In an uninstalled application,
3132 this is the top level application directory. In an installed application,
3133 this will be the directory containing C<< MyApp.pm >>.
3137 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3141 C<name> - The name of the application in debug messages and the debug and
3146 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3147 until it is accessed. This allows you to (for example) check authentication (and reject
3148 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3152 C<root> - The root directory for templates. Usually this is just a
3153 subdirectory of the home directory, but you can set it to change the
3154 templates to a different directory.
3158 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3159 namespaces from which components will be loaded (and constructed and stored in
3160 C<< $c->components >>).
3164 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3165 to be shown in hit debug tables in the test server.
3169 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3170 variable should be used for determining the request path.
3172 Most web server environments pass the requested path to the application using environment variables,
3173 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3174 exposed as C<< $c->request->base >>) and the request path below that base.
3176 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3177 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3181 =item use_request_uri_for_path => 0
3183 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3184 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3185 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3186 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3188 However this method has the major disadvantage that it is impossible to correctly decode some elements
3189 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3190 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3191 can't distinguish / vs %2F in paths (in addition to other encoded values).
3193 =item use_request_uri_for_path => 1
3195 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3196 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3197 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3199 Given that this method of path resolution is provably more correct, it is recommended that you use
3200 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3201 aware of the implications of not being able to handle encoded URI paths correctly.
3203 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3204 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3205 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3206 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3207 C<< $c->request->base >> will be incorrect.
3213 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3217 C<encoding> - See L</ENCODING>
3221 C<abort_chain_on_error_fix>
3223 When there is an error in an action chain, the default behavior is to continue
3224 processing the remaining actions and then catch the error upon chain end. This
3225 can lead to running actions when the application is in an unexpected state. If
3226 you have this issue, setting this config value to true will promptly exit a
3227 chain when there is an error raised in any action (thus terminating the chain
3232 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3234 In the future this might become the default behavior.
3238 =head1 INTERNAL ACTIONS
3240 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3241 C<_ACTION>, and C<_END>. These are by default not shown in the private
3242 action table, but you can make them visible with a config parameter.
3244 MyApp->config(show_internal_actions => 1);
3246 =head1 ON-DEMAND PARSER
3248 The request body is usually parsed at the beginning of a request,
3249 but if you want to handle input yourself, you can enable on-demand
3250 parsing with a config parameter.
3252 MyApp->config(parse_on_demand => 1);
3254 =head1 PROXY SUPPORT
3256 Many production servers operate using the common double-server approach,
3257 with a lightweight frontend web server passing requests to a larger
3258 backend server. An application running on the backend server must deal
3259 with two problems: the remote user always appears to be C<127.0.0.1> and
3260 the server's hostname will appear to be C<localhost> regardless of the
3261 virtual host that the user connected through.
3263 Catalyst will automatically detect this situation when you are running
3264 the frontend and backend servers on the same machine. The following
3265 changes are made to the request.
3267 $c->req->address is set to the user's real IP address, as read from
3268 the HTTP X-Forwarded-For header.
3270 The host value for $c->req->base and $c->req->uri is set to the real
3271 host, as read from the HTTP X-Forwarded-Host header.
3273 Additionally, you may be running your backend application on an insecure
3274 connection (port 80) while your frontend proxy is running under SSL. If there
3275 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3276 tell Catalyst what port the frontend listens on. This will allow all URIs to
3277 be created properly.
3279 In the case of passing in:
3281 X-Forwarded-Port: 443
3283 All calls to C<uri_for> will result in an https link, as is expected.
3285 Obviously, your web server must support these headers for this to work.
3287 In a more complex server farm environment where you may have your
3288 frontend proxy server(s) on different machines, you will need to set a
3289 configuration option to tell Catalyst to read the proxied data from the
3292 MyApp->config(using_frontend_proxy => 1);
3294 If you do not wish to use the proxy support at all, you may set:
3296 MyApp->config(ignore_frontend_proxy => 0);
3298 =head2 Note about psgi files
3300 Note that if you supply your own .psgi file, calling
3301 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3303 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3304 in your psgi, for example:
3307 enable "Plack::Middleware::ReverseProxy";
3311 This will unconditionally add the ReverseProxy support, or you need to call
3312 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3313 apply the support depending upon your config).
3315 See L<Catalyst::PSGI> for more information.
3317 =head1 THREAD SAFETY
3319 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3320 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3321 believe the Catalyst core to be thread-safe.
3323 If you plan to operate in a threaded environment, remember that all other
3324 modules you are using must also be thread-safe. Some modules, most notably
3325 L<DBD::SQLite>, are not thread-safe.
3329 On request, decodes all params from encoding into a sequence of
3330 logical characters. On response, encodes body into encoding.
3338 Returns an instance of an C<Encode> encoding
3340 print $c->encoding->name
3342 =item handle_unicode_encoding_exception ($exception_context)
3344 Method called when decoding process for a request fails.
3346 An C<$exception_context> hashref is provided to allow you to override the
3347 behaviour of your application when given data with incorrect encodings.
3349 The default method throws exceptions in the case of invalid request parameters
3350 (resulting in a 500 error), but ignores errors in upload filenames.
3352 The keys passed in the C<$exception_context> hash are:
3358 The value which was not able to be decoded.
3362 The exception received from L<Encode>.
3366 What type of data was being decoded. Valid values are (currently)
3367 C<params> - for request parameters / arguments / captures
3368 and C<uploads> - for request upload filenames.
3378 Join #catalyst on irc.perl.org.
3382 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3383 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3387 http://catalyst.perl.org
3391 http://dev.catalyst.perl.org
3395 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3397 =head2 L<Catalyst::Manual> - The Catalyst Manual
3399 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3401 =head2 L<Catalyst::Engine> - Core engine
3403 =head2 L<Catalyst::Log> - Log class.
3405 =head2 L<Catalyst::Request> - Request object
3407 =head2 L<Catalyst::Response> - Response object
3409 =head2 L<Catalyst::Test> - The test suite.
3411 =head1 PROJECT FOUNDER
3413 sri: Sebastian Riedel <sri@cpan.org>
3419 acme: Leon Brocard <leon@astray.com>
3421 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3425 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3429 andyg: Andy Grundman <andy@hybridized.org>
3431 audreyt: Audrey Tang
3433 bricas: Brian Cassidy <bricas@cpan.org>
3435 Caelum: Rafael Kitover <rkitover@io.com>
3437 chansen: Christian Hansen
3439 chicks: Christopher Hicks
3441 Chisel Wright C<pause@herlpacker.co.uk>
3443 Danijel Milicevic C<me@danijel.de>
3445 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3447 David Naughton, C<naughton@umn.edu>
3451 dhoss: Devin Austin <dhoss@cpan.org>
3453 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3457 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3459 esskar: Sascha Kiefer
3461 fireartist: Carl Franks <cfranks@cpan.org>
3463 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3465 gabb: Danijel Milicevic
3469 Gavin Henry C<ghenry@perl.me.uk>
3473 groditi: Guillermo Roditi <groditi@gmail.com>
3475 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3477 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3479 jcamacho: Juan Camacho
3481 jester: Jesse Sheidlower C<jester@panix.com>
3483 jhannah: Jay Hannah <jay@jays.net>
3489 jon: Jon Schutz <jjschutz@cpan.org>
3491 Jonathan Rockway C<< <jrockway@cpan.org> >>
3493 Kieren Diment C<kd@totaldatasolution.com>
3495 konobi: Scott McWhirter <konobi@cpan.org>
3497 marcus: Marcus Ramberg <mramberg@cpan.org>
3499 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3501 mgrimes: Mark Grimes <mgrimes@cpan.org>
3503 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3507 naughton: David Naughton
3509 ningu: David Kamholz <dkamholz@cpan.org>
3511 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3513 numa: Dan Sully <daniel@cpan.org>
3519 omega: Andreas Marienborg
3521 Oleg Kostyuk <cub.uanic@gmail.com>
3523 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3525 rafl: Florian Ragwitz <rafl@debian.org>
3527 random: Roland Lammel <lammel@cpan.org>
3529 Robert Sedlacek C<< <rs@474.at> >>
3531 SpiceMan: Marcel Montes
3535 szbalint: Balint Szilakszi <szbalint@cpan.org>
3537 t0m: Tomas Doran <bobtfish@bobtfish.net>
3541 Viljo Marrandi C<vilts@yahoo.com>
3543 Will Hawes C<info@whawes.co.uk>
3545 willert: Sebastian Willert <willert@cpan.org>
3547 wreis: Wallace Reis <wreis@cpan.org>
3549 Yuval Kogman, C<nothingmuch@woobling.org>
3551 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3553 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3557 Copyright (c) 2005, the above named PROJECT FOUNDER and CONTRIBUTORS.
3561 This library is free software. You can redistribute it and/or modify it under
3562 the same terms as Perl itself.
3568 __PACKAGE__->meta->make_immutable;