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 Plack::Middleware::ContentLength;
45 use Plack::Middleware::Head;
46 use Plack::Middleware::HTTPExceptions;
47 use Plack::Middleware::FixMissingBodyInRedirect;
48 use Plack::Middleware::MethodOverride;
49 use Plack::Middleware::RemoveRedundantBody;
50 use Catalyst::Middleware::Stash;
52 use Class::Load 'load_class';
54 BEGIN { require 5.008003; }
56 has stack => (is => 'ro', default => sub { [] });
57 has state => (is => 'rw', default => 0);
58 has stats => (is => 'rw');
59 has action => (is => 'rw');
60 has counter => (is => 'rw', default => sub { {} });
65 $self->request_class->new($self->_build_request_constructor_args);
69 sub _build_request_constructor_args {
71 my %p = ( _log => $self->log );
72 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
73 $p{data_handlers} = {$self->registered_data_handlers};
74 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
75 if $self->config->{use_hash_multivalue_in_request};
83 $self->response_class->new($self->_build_response_constructor_args);
87 sub _build_response_constructor_args {
89 { _log => $self->log };
92 has namespace => (is => 'rw');
94 sub depth { scalar @{ shift->stack || [] }; }
95 sub comp { shift->component(@_) }
98 my $self = shift; return $self->request(@_);
101 my $self = shift; return $self->response(@_);
104 # For backwards compatibility
105 sub finalize_output { shift->finalize_body(@_) };
110 our $RECURSION = 1000;
111 our $DETACH = Catalyst::Exception::Detach->new;
112 our $GO = Catalyst::Exception::Go->new;
114 #I imagine that very few of these really need to be class variables. if any.
115 #maybe we should just make them attributes with a default?
116 __PACKAGE__->mk_classdata($_)
117 for qw/components arguments dispatcher engine log dispatcher_class
118 engine_loader context_class request_class response_class stats_class
119 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
122 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
123 __PACKAGE__->request_class('Catalyst::Request');
124 __PACKAGE__->response_class('Catalyst::Response');
125 __PACKAGE__->stats_class('Catalyst::Stats');
127 # Remember to update this in Catalyst::Runtime as well!
129 our $VERSION = '5.90069_002';
132 my ( $class, @arguments ) = @_;
134 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
136 return unless $class eq 'Catalyst';
138 my $caller = caller();
139 return if $caller eq 'main';
141 my $meta = Moose::Meta::Class->initialize($caller);
142 unless ( $caller->isa('Catalyst') ) {
143 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
144 $meta->superclasses(@superclasses);
146 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
147 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
149 unless( $meta->has_method('meta') ){
150 if ($Moose::VERSION >= 1.15) {
151 $meta->_add_meta_method('meta');
154 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
158 $caller->arguments( [@arguments] );
162 sub _application { $_[0] }
168 Catalyst - The Elegant MVC Web Application Framework
172 See the L<Catalyst::Manual> distribution for comprehensive
173 documentation and tutorials.
175 # Install Catalyst::Devel for helpers and other development tools
176 # use the helper to create a new application
179 # add models, views, controllers
180 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
181 script/myapp_create.pl view MyTemplate TT
182 script/myapp_create.pl controller Search
184 # built in testserver -- use -r to restart automatically on changes
185 # --help to see all available options
186 script/myapp_server.pl
188 # command line testing interface
189 script/myapp_test.pl /yada
192 use Catalyst qw/-Debug/; # include plugins here as well
194 ### In lib/MyApp/Controller/Root.pm (autocreated)
195 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
196 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
197 $c->stash->{template} = 'foo.tt'; # set the template
198 # lookup something from db -- stash vars are passed to TT
200 $c->model('Database::Foo')->search( { country => $args[0] } );
201 if ( $c->req->params->{bar} ) { # access GET or POST parameters
202 $c->forward( 'bar' ); # process another action
203 # do something else after forward returns
207 # The foo.tt TT template can use the stash data from the database
208 [% WHILE (item = data.next) %]
212 # called for /bar/of/soap, /bar/of/soap/10, etc.
213 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
215 # called after all actions are finished
217 my ( $self, $c ) = @_;
218 if ( scalar @{ $c->error } ) { ... } # handle errors
219 return if $c->res->body; # already have a response
220 $c->forward( 'MyApp::View::TT' ); # render template
223 See L<Catalyst::Manual::Intro> for additional information.
227 Catalyst is a modern framework for making web applications without the
228 pain usually associated with this process. This document is a reference
229 to the main Catalyst application. If you are a new user, we suggest you
230 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
232 See L<Catalyst::Manual> for more documentation.
234 Catalyst plugins can be loaded by naming them as arguments to the "use
235 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
236 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
239 use Catalyst qw/My::Module/;
241 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
242 fully qualify the name by using a unary plus:
246 +Fully::Qualified::Plugin::Name
249 Special flags like C<-Debug> can also be specified as
250 arguments when Catalyst is loaded:
252 use Catalyst qw/-Debug My::Module/;
254 The position of plugins and flags in the chain is important, because
255 they are loaded in the order in which they appear.
257 The following flags are supported:
261 Enables debug output. You can also force this setting from the system
262 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
263 settings override the application, with <MYAPP>_DEBUG having the highest
266 This sets the log level to 'debug' and enables full debug output on the
267 error screen. If you only want the latter, see L<< $c->debug >>.
271 Forces Catalyst to use a specific home directory, e.g.:
273 use Catalyst qw[-Home=/usr/mst];
275 This can also be done in the shell environment by setting either the
276 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
277 is replaced with the uppercased name of your application, any "::" in
278 the name will be replaced with underscores, e.g. MyApp::Web should use
279 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
281 If none of these are set, Catalyst will attempt to automatically detect the
282 home directory. If you are working in a development environment, Catalyst
283 will try and find the directory containing either Makefile.PL, Build.PL,
284 dist.ini, or cpanfile. If the application has been installed into the system
285 (i.e. you have done C<make install>), then Catalyst will use the path to your
286 application module, without the .pm extension (e.g., /foo/MyApp if your
287 application was installed at /foo/MyApp.pm)
291 use Catalyst '-Log=warn,fatal,error';
293 Specifies a comma-delimited list of log levels.
297 Enables statistics collection and reporting.
299 use Catalyst qw/-Stats=1/;
301 You can also force this setting from the system environment with CATALYST_STATS
302 or <MYAPP>_STATS. The environment settings override the application, with
303 <MYAPP>_STATS having the highest priority.
305 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
309 =head2 INFORMATION ABOUT THE CURRENT REQUEST
313 Returns a L<Catalyst::Action> object for the current action, which
314 stringifies to the action name. See L<Catalyst::Action>.
318 Returns the namespace of the current action, i.e., the URI prefix
319 corresponding to the controller of the current action. For example:
321 # in Controller::Foo::Bar
322 $c->namespace; # returns 'foo/bar';
328 Returns the current L<Catalyst::Request> object, giving access to
329 information about the current client request (including parameters,
330 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
332 =head2 REQUEST FLOW HANDLING
334 =head2 $c->forward( $action [, \@arguments ] )
336 =head2 $c->forward( $class, $method, [, \@arguments ] )
338 This is one way of calling another action (method) in the same or
339 a different controller. You can also use C<< $self->my_method($c, @args) >>
340 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
341 in a different controller.
342 The main difference is that 'forward' uses some of the Catalyst request
343 cycle overhead, including debugging, which may be useful to you. On the
344 other hand, there are some complications to using 'forward', restrictions
345 on values returned from 'forward', and it may not handle errors as you prefer.
346 Whether you use 'forward' or not is up to you; it is not considered superior to
347 the other ways to call a method.
349 'forward' calls another action, by its private name. If you give a
350 class name but no method, C<process()> is called. You may also optionally
351 pass arguments in an arrayref. The action will receive the arguments in
352 C<@_> and C<< $c->req->args >>. Upon returning from the function,
353 C<< $c->req->args >> will be restored to the previous values.
355 Any data C<return>ed from the action forwarded to, will be returned by the
358 my $foodata = $c->forward('/foo');
359 $c->forward('index');
360 $c->forward(qw/Model::DBIC::Foo do_stuff/);
361 $c->forward('View::TT');
363 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
364 an C<< eval { } >> around the call (actually
365 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
366 exceptions thrown by the called action non-fatal and pushing them onto
367 $c->error instead. If you want C<die> to propagate you need to do something
371 die join "\n", @{ $c->error } if @{ $c->error };
373 Or make sure to always return true values from your actions and write
376 $c->forward('foo') || return;
378 Another note is that C<< $c->forward >> always returns a scalar because it
379 actually returns $c->state which operates in a scalar context.
380 Thus, something like:
384 in an action that is forwarded to is going to return a scalar,
385 i.e. how many items are in that array, which is probably not what you want.
386 If you need to return an array then return a reference to it,
389 $c->stash->{array} = \@array;
391 and access it from the stash.
393 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.
397 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
399 =head2 $c->detach( $action [, \@arguments ] )
401 =head2 $c->detach( $class, $method, [, \@arguments ] )
405 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
406 doesn't return to the previous action when processing is finished.
408 When called with no arguments it escapes the processing chain entirely.
412 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
414 =head2 $c->visit( $action [, \@arguments ] )
416 =head2 $c->visit( $action [, \@captures, \@arguments ] )
418 =head2 $c->visit( $class, $method, [, \@arguments ] )
420 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
422 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
423 but does a full dispatch, instead of just calling the new C<$action> /
424 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
425 you go to are called, just like a new request.
427 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
428 This means, for example, that C<< $c->action >> methods such as
429 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
430 L<reverse|Catalyst::Action/reverse> return information for the visited action
431 when they are invoked within the visited action. This is different from the
432 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
433 continues to use the $c->action object from the caller action even when
434 invoked from the called action.
436 C<< $c->stash >> is kept unchanged.
438 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
439 allows you to "wrap" another action, just as it would have been called by
440 dispatching from a URL, while the analogous
441 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
442 transfer control to another action as if it had been reached directly from a URL.
446 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
448 =head2 $c->go( $action [, \@arguments ] )
450 =head2 $c->go( $action [, \@captures, \@arguments ] )
452 =head2 $c->go( $class, $method, [, \@arguments ] )
454 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
456 The relationship between C<go> and
457 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
458 the relationship between
459 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
460 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
461 C<< $c->go >> will perform a full dispatch on the specified action or method,
462 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
463 C<go> escapes the processing of the current request chain on completion, and
464 does not return to its caller.
466 @arguments are arguments to the final destination of $action. @captures are
467 arguments to the intermediate steps, if any, on the way to the final sub of
472 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
478 Returns the current L<Catalyst::Response> object, see there for details.
482 Returns a hashref to the stash, which may be used to store data and pass
483 it between components during a request. You can also set hash keys by
484 passing arguments. The stash is automatically sent to the view. The
485 stash is cleared at the end of a request; it cannot be used for
486 persistent storage (for this you must use a session; see
487 L<Catalyst::Plugin::Session> for a complete system integrated with
490 $c->stash->{foo} = $bar;
491 $c->stash( { moose => 'majestic', qux => 0 } );
492 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
494 # stash is automatically passed to the view for use in a template
495 $c->forward( 'MyApp::View::TT' );
501 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
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 =head2 $c->has_errors
558 Returns true if you have errors
562 sub has_errors { scalar(@{shift->error}) ? 1:0 }
564 sub _comp_search_prefixes {
566 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
569 # search components given a name and some prefixes
570 sub _comp_names_search_prefixes {
571 my ( $c, $name, @prefixes ) = @_;
572 my $appclass = ref $c || $c;
573 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
574 $filter = qr/$filter/; # Compile regex now rather than once per loop
576 # map the original component name to the sub part that we will search against
577 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
578 grep { /$filter/ } keys %{ $c->components };
580 # undef for a name will return all
581 return keys %eligible if !defined $name;
583 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
584 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
586 return @result if @result;
588 # if we were given a regexp to search against, we're done.
589 return if $name->$_isa('Regexp');
591 # skip regexp fallback if configured
593 if $appclass->config->{disable_component_resolution_regex_fallback};
597 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
599 # no results? try against full names
601 @result = grep { m{$query} } keys %eligible;
604 # don't warn if we didn't find any results, it just might not exist
606 # Disgusting hack to work out correct method name
607 my $warn_for = lc $prefixes[0];
608 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
609 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
610 "component resolution is unreliable and unsafe.";
611 my $short = $result[0];
612 # remove the component namespace prefix
613 $short =~ s/.*?(Model|Controller|View):://;
614 my $shortmess = Carp::shortmess('');
615 if ($shortmess =~ m#Catalyst/Plugin#) {
616 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
618 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
619 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
620 "component's config";
622 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
623 "but if you really wanted to search, pass in a regexp as the argument " .
624 "like so: \$c->${warn_for}(qr/${name}/)";
626 $c->log->warn( "${msg}$shortmess" );
632 # Find possible names for a prefix
634 my ( $c, @prefixes ) = @_;
635 my $appclass = ref $c || $c;
637 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
639 my @names = map { s{$filter}{}; $_; }
640 $c->_comp_names_search_prefixes( undef, @prefixes );
645 # Filter a component before returning by calling ACCEPT_CONTEXT if available
646 sub _filter_component {
647 my ( $c, $comp, @args ) = @_;
649 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
650 return $comp->ACCEPT_CONTEXT( $c, @args );
656 =head2 COMPONENT ACCESSORS
658 =head2 $c->controller($name)
660 Gets a L<Catalyst::Controller> instance by name.
662 $c->controller('Foo')->do_stuff;
664 If the name is omitted, will return the controller for the dispatched
667 If you want to search for controllers, pass in a regexp as the argument.
669 # find all controllers that start with Foo
670 my @foo_controllers = $c->controller(qr{^Foo});
676 my ( $c, $name, @args ) = @_;
678 my $appclass = ref($c) || $c;
680 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
681 my $comps = $c->components;
682 my $check = $appclass."::Controller::".$name;
683 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
685 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
686 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
687 return $c->_filter_component( $result[ 0 ], @args );
690 return $c->component( $c->action->class );
693 =head2 $c->model($name)
695 Gets a L<Catalyst::Model> instance by name.
697 $c->model('Foo')->do_stuff;
699 Any extra arguments are directly passed to ACCEPT_CONTEXT.
701 If the name is omitted, it will look for
702 - a model object in $c->stash->{current_model_instance}, then
703 - a model name in $c->stash->{current_model}, then
704 - a config setting 'default_model', or
705 - check if there is only one model, and return it if that's the case.
707 If you want to search for models, pass in a regexp as the argument.
709 # find all models that start with Foo
710 my @foo_models = $c->model(qr{^Foo});
715 my ( $c, $name, @args ) = @_;
716 my $appclass = ref($c) || $c;
718 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
719 my $comps = $c->components;
720 my $check = $appclass."::Model::".$name;
721 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
723 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
724 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
725 return $c->_filter_component( $result[ 0 ], @args );
729 return $c->stash->{current_model_instance}
730 if $c->stash->{current_model_instance};
731 return $c->model( $c->stash->{current_model} )
732 if $c->stash->{current_model};
734 return $c->model( $appclass->config->{default_model} )
735 if $appclass->config->{default_model};
737 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
740 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
741 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
742 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
743 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
744 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
747 return $c->_filter_component( $comp );
751 =head2 $c->view($name)
753 Gets a L<Catalyst::View> instance by name.
755 $c->view('Foo')->do_stuff;
757 Any extra arguments are directly passed to ACCEPT_CONTEXT.
759 If the name is omitted, it will look for
760 - a view object in $c->stash->{current_view_instance}, then
761 - a view name in $c->stash->{current_view}, then
762 - a config setting 'default_view', or
763 - check if there is only one view, and return it if that's the case.
765 If you want to search for views, pass in a regexp as the argument.
767 # find all views that start with Foo
768 my @foo_views = $c->view(qr{^Foo});
773 my ( $c, $name, @args ) = @_;
775 my $appclass = ref($c) || $c;
777 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
778 my $comps = $c->components;
779 my $check = $appclass."::View::".$name;
780 if( exists $comps->{$check} ) {
781 return $c->_filter_component( $comps->{$check}, @args );
784 $c->log->warn( "Attempted to use view '$check', but does not exist" );
787 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
788 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
789 return $c->_filter_component( $result[ 0 ], @args );
793 return $c->stash->{current_view_instance}
794 if $c->stash->{current_view_instance};
795 return $c->view( $c->stash->{current_view} )
796 if $c->stash->{current_view};
798 return $c->view( $appclass->config->{default_view} )
799 if $appclass->config->{default_view};
801 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
804 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
805 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
806 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
807 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
808 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
811 return $c->_filter_component( $comp );
814 =head2 $c->controllers
816 Returns the available names which can be passed to $c->controller
822 return $c->_comp_names(qw/Controller C/);
827 Returns the available names which can be passed to $c->model
833 return $c->_comp_names(qw/Model M/);
839 Returns the available names which can be passed to $c->view
845 return $c->_comp_names(qw/View V/);
848 =head2 $c->comp($name)
850 =head2 $c->component($name)
852 Gets a component object by name. This method is not recommended,
853 unless you want to get a specific component by full
854 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
855 should be used instead.
857 If C<$name> is a regexp, a list of components matched against the full
858 component name will be returned.
860 If Catalyst can't find a component by name, it will fallback to regex
861 matching by default. To disable this behaviour set
862 disable_component_resolution_regex_fallback to a true value.
864 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
869 my ( $c, $name, @args ) = @_;
872 my $comps = $c->components;
875 # is it the exact name?
876 return $c->_filter_component( $comps->{ $name }, @args )
877 if exists $comps->{ $name };
879 # perhaps we just omitted "MyApp"?
880 my $composed = ( ref $c || $c ) . "::${name}";
881 return $c->_filter_component( $comps->{ $composed }, @args )
882 if exists $comps->{ $composed };
884 # search all of the models, views and controllers
885 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
886 return $c->_filter_component( $comp, @args ) if $comp;
890 if $c->config->{disable_component_resolution_regex_fallback};
892 # This is here so $c->comp( '::M::' ) works
893 my $query = ref $name ? $name : qr{$name}i;
895 my @result = grep { m{$query} } keys %{ $c->components };
896 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
899 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
900 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
901 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
902 return $c->_filter_component( $result[ 0 ], @args );
905 # I would expect to return an empty list here, but that breaks back-compat
909 return sort keys %{ $c->components };
912 =head2 CLASS DATA AND HELPER CLASSES
916 Returns or takes a hashref containing the application's configuration.
918 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
920 You can also use a C<YAML>, C<XML> or L<Config::General> config file
921 like C<myapp.conf> in your applications home directory. See
922 L<Catalyst::Plugin::ConfigLoader>.
924 =head3 Cascading configuration
926 The config method is present on all Catalyst components, and configuration
927 will be merged when an application is started. Configuration loaded with
928 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
929 followed by configuration in your top level C<MyApp> class. These two
930 configurations are merged, and then configuration data whose hash key matches a
931 component name is merged with configuration for that component.
933 The configuration for a component is then passed to the C<new> method when a
934 component is constructed.
938 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
939 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
941 will mean that C<MyApp::Model::Foo> receives the following data when
944 MyApp::Model::Foo->new({
950 It's common practice to use a Moose attribute
951 on the receiving component to access the config value.
953 package MyApp::Model::Foo;
957 # this attr will receive 'baz' at construction time
963 You can then get the value 'baz' by calling $c->model('Foo')->bar
964 (or $self->bar inside code in the model).
966 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
967 as a way of reading config within your code, as this B<will not> give you the
968 correctly merged config back. You B<MUST> take the config values supplied to
969 the constructor and use those instead.
973 around config => sub {
977 croak('Setting config after setup has been run is not allowed.')
978 if ( @_ and $c->setup_finished );
985 Returns the logging object instance. Unless it is already set, Catalyst
986 sets this up with a L<Catalyst::Log> object. To use your own log class,
987 set the logger with the C<< __PACKAGE__->log >> method prior to calling
988 C<< __PACKAGE__->setup >>.
990 __PACKAGE__->log( MyLogger->new );
995 $c->log->info( 'Now logging with my own logger!' );
997 Your log class should implement the methods described in
1003 Returns 1 if debug mode is enabled, 0 otherwise.
1005 You can enable debug mode in several ways:
1009 =item By calling myapp_server.pl with the -d flag
1011 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1013 =item The -Debug option in your MyApp.pm
1015 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1019 The first three also set the log level to 'debug'.
1021 Calling C<< $c->debug(1) >> has no effect.
1027 =head2 $c->dispatcher
1029 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1033 Returns the engine instance. See L<Catalyst::Engine>.
1036 =head2 UTILITY METHODS
1038 =head2 $c->path_to(@path)
1040 Merges C<@path> with C<< $c->config->{home} >> and returns a
1041 L<Path::Class::Dir> object. Note you can usually use this object as
1042 a filename, but sometimes you will have to explicitly stringify it
1043 yourself by calling the C<< ->stringify >> method.
1047 $c->path_to( 'db', 'sqlite.db' );
1052 my ( $c, @path ) = @_;
1053 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1054 if ( -d $path ) { return $path }
1055 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1059 my ( $class, $name, $plugin, @args ) = @_;
1061 # See block comment in t/unit_core_plugin.t
1062 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1064 $class->_register_plugin( $plugin, 1 );
1066 eval { $plugin->import };
1067 $class->mk_classdata($name);
1069 eval { $obj = $plugin->new(@args) };
1072 Catalyst::Exception->throw( message =>
1073 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1076 $class->$name($obj);
1077 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1083 Initializes the dispatcher and engine, loads any plugins, and loads the
1084 model, view, and controller components. You may also specify an array
1085 of plugins to load here, if you choose to not load them in the C<use
1089 MyApp->setup( qw/-Debug/ );
1091 B<Note:> You B<should not> wrap this method with method modifiers
1092 or bad things will happen - wrap the C<setup_finalize> method instead.
1097 my ( $class, @arguments ) = @_;
1098 croak('Running setup more than once')
1099 if ( $class->setup_finished );
1101 unless ( $class->isa('Catalyst') ) {
1103 Catalyst::Exception->throw(
1104 message => qq/'$class' does not inherit from Catalyst/ );
1107 if ( $class->arguments ) {
1108 @arguments = ( @arguments, @{ $class->arguments } );
1114 foreach (@arguments) {
1118 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1120 elsif (/^-(\w+)=?(.*)$/) {
1121 $flags->{ lc $1 } = $2;
1124 push @{ $flags->{plugins} }, $_;
1128 $class->setup_home( delete $flags->{home} );
1130 $class->setup_log( delete $flags->{log} );
1131 $class->setup_plugins( delete $flags->{plugins} );
1133 $class->setup_data_handlers();
1134 $class->setup_dispatcher( delete $flags->{dispatcher} );
1135 if (my $engine = delete $flags->{engine}) {
1136 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1138 $class->setup_engine();
1139 $class->setup_stats( delete $flags->{stats} );
1141 for my $flag ( sort keys %{$flags} ) {
1143 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1144 &$code( $class, delete $flags->{$flag} );
1147 $class->log->warn(qq/Unknown flag "$flag"/);
1151 eval { require Catalyst::Devel; };
1152 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1153 $class->log->warn(<<"EOF");
1154 You are running an old script!
1156 Please update by running (this will overwrite existing files):
1157 catalyst.pl -force -scripts $class
1159 or (this will not overwrite existing files):
1160 catalyst.pl -scripts $class
1165 # Call plugins setup, this is stupid and evil.
1166 # Also screws C3 badly on 5.10, hack to avoid.
1168 no warnings qw/redefine/;
1169 local *setup = sub { };
1170 $class->setup unless $Catalyst::__AM_RESTARTING;
1173 $class->setup_middleware();
1175 # Initialize our data structure
1176 $class->components( {} );
1178 $class->setup_components;
1180 if ( $class->debug ) {
1181 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1184 my $column_width = Catalyst::Utils::term_width() - 6;
1185 my $t = Text::SimpleTable->new($column_width);
1186 $t->row($_) for @plugins;
1187 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1190 my @middleware = map {
1193 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1194 || '') } $class->registered_middlewares;
1197 my $column_width = Catalyst::Utils::term_width() - 6;
1198 my $t = Text::SimpleTable->new($column_width);
1199 $t->row($_) for @middleware;
1200 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1203 my %dh = $class->registered_data_handlers;
1204 if (my @data_handlers = keys %dh) {
1205 my $column_width = Catalyst::Utils::term_width() - 6;
1206 my $t = Text::SimpleTable->new($column_width);
1207 $t->row($_) for @data_handlers;
1208 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1211 my $dispatcher = $class->dispatcher;
1212 my $engine = $class->engine;
1213 my $home = $class->config->{home};
1215 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1216 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1220 ? $class->log->debug(qq/Found home "$home"/)
1221 : $class->log->debug(qq/Home "$home" doesn't exist/)
1222 : $class->log->debug(q/Couldn't find home/);
1224 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1225 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1226 for my $comp ( sort keys %{ $class->components } ) {
1227 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1228 $t->row( $comp, $type );
1230 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1231 if ( keys %{ $class->components } );
1234 # Add our self to components, since we are also a component
1235 if( $class->isa('Catalyst::Controller') ){
1236 $class->components->{$class} = $class;
1239 $class->setup_actions;
1241 if ( $class->debug ) {
1242 my $name = $class->config->{name} || 'Application';
1243 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1246 if ($class->config->{case_sensitive}) {
1247 $class->log->warn($class . "->config->{case_sensitive} is set.");
1248 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1251 $class->setup_finalize;
1253 # Flush the log for good measure (in case something turned off 'autoflush' early)
1254 $class->log->_flush() if $class->log->can('_flush');
1256 return $class || 1; # Just in case someone named their Application 0...
1259 =head2 $app->setup_finalize
1261 A hook to attach modifiers to. This method does not do anything except set the
1262 C<setup_finished> accessor.
1264 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1268 after setup_finalize => sub {
1276 sub setup_finalize {
1278 $class->setup_finished(1);
1281 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1283 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1285 Constructs an absolute L<URI> object based on the application root, the
1286 provided path, and the additional arguments and query parameters provided.
1287 When used as a string, provides a textual URI. If you need more flexibility
1288 than this (i.e. the option to provide relative URIs etc.) see
1289 L<Catalyst::Plugin::SmartURI>.
1291 If no arguments are provided, the URI for the current action is returned.
1292 To return the current action and also provide @args, use
1293 C<< $c->uri_for( $c->action, @args ) >>.
1295 If the first argument is a string, it is taken as a public URI path relative
1296 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1297 relative to the application root (if it does). It is then merged with
1298 C<< $c->request->base >>; any C<@args> are appended as additional path
1299 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1301 If the first argument is a L<Catalyst::Action> it represents an action which
1302 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1303 optional C<\@captures> argument (an arrayref) allows passing the captured
1304 variables that are needed to fill in the paths of Chained and Regex actions;
1305 once the path is resolved, C<uri_for> continues as though a path was
1306 provided, appending any arguments or parameters and creating an absolute
1309 The captures for the current request can be found in
1310 C<< $c->request->captures >>, and actions can be resolved using
1311 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1312 path, use C<< $c->uri_for_action >> instead.
1314 # Equivalent to $c->req->uri
1315 $c->uri_for($c->action, $c->req->captures,
1316 @{ $c->req->args }, $c->req->params);
1318 # For the Foo action in the Bar controller
1319 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1321 # Path to a static resource
1322 $c->uri_for('/static/images/logo.png');
1327 my ( $c, $path, @args ) = @_;
1329 if ( $path->$_isa('Catalyst::Controller') ) {
1330 $path = $path->path_prefix;
1335 undef($path) if (defined $path && $path eq '');
1338 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1340 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1341 foreach my $arg (@args) {
1342 utf8::encode($arg) if utf8::is_utf8($arg);
1343 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1346 if ( $path->$_isa('Catalyst::Action') ) { # action object
1347 s|/|%2F|g for @args;
1348 my $captures = [ map { s|/|%2F|g; $_; }
1349 ( scalar @args && ref $args[0] eq 'ARRAY'
1353 foreach my $capture (@$captures) {
1354 utf8::encode($capture) if utf8::is_utf8($capture);
1355 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1359 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1360 if( !@args && $action->number_of_args ) {
1361 my $expanded_action = $c->dispatcher->expand_action( $action );
1363 my $num_captures = $expanded_action->number_of_captures;
1364 unshift @args, splice @$captures, $num_captures;
1367 $path = $c->dispatcher->uri_for_action($action, $captures);
1368 if (not defined $path) {
1369 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1373 $path = '/' if $path eq '';
1376 unshift(@args, $path);
1378 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1379 my $namespace = $c->namespace;
1380 if (defined $path) { # cheesy hack to handle path '../foo'
1381 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1383 unshift(@args, $namespace || '');
1386 # join args with '/', or a blank string
1387 my $args = join('/', grep { defined($_) } @args);
1388 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1391 my ($base, $class) = ('/', 'URI::_generic');
1393 $base = $c->req->base;
1394 $class = ref($base);
1395 $base =~ s{(?<!/)$}{/};
1400 if (my @keys = keys %$params) {
1401 # somewhat lifted from URI::_query's query_form
1402 $query = '?'.join('&', map {
1403 my $val = $params->{$_};
1404 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1407 $val = '' unless defined $val;
1410 utf8::encode( $param ) if utf8::is_utf8($param);
1411 # using the URI::Escape pattern here so utf8 chars survive
1412 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1414 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1418 my $res = bless(\"${base}${args}${query}", $class);
1422 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1424 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1430 A private path to the Catalyst action you want to create a URI for.
1432 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1433 >> and passing the resulting C<$action> and the remaining arguments to C<<
1436 You can also pass in a Catalyst::Action object, in which case it is passed to
1439 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.
1441 For example, if the action looks like:
1443 package MyApp::Controller::Users;
1445 sub lst : Path('the-list') {}
1449 $c->uri_for_action('/users/lst')
1451 and it will create the URI /users/the-list.
1453 =item \@captures_and_args?
1455 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1456 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1457 to interpolate all the parameters in the URI.
1461 Optional list of extra arguments - can be supplied in the
1462 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1465 Your action can have zero, a fixed or a variable number of args (e.g.
1466 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1468 =item \%query_values?
1470 Optional array reference of query parameters to append. E.g.
1476 /rest/of/your/uri?foo=bar
1482 sub uri_for_action {
1483 my ( $c, $path, @args ) = @_;
1484 my $action = blessed($path)
1486 : $c->dispatcher->get_action_by_path($path);
1487 unless (defined $action) {
1488 croak "Can't find action for path '$path'";
1490 return $c->uri_for( $action, @args );
1493 =head2 $c->welcome_message
1495 Returns the Catalyst welcome HTML page.
1499 sub welcome_message {
1501 my $name = $c->config->{name};
1502 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1503 my $prefix = Catalyst::Utils::appprefix( ref $c );
1504 $c->response->content_type('text/html; charset=utf-8');
1506 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1507 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1508 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1510 <meta http-equiv="Content-Language" content="en" />
1511 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1512 <title>$name on Catalyst $VERSION</title>
1513 <style type="text/css">
1516 background-color: #eee;
1523 margin-bottom: 10px;
1525 background-color: #ccc;
1526 border: 1px solid #aaa;
1531 font-family: verdana, tahoma, sans-serif;
1534 font-family: verdana, tahoma, sans-serif;
1537 text-decoration: none;
1539 border-bottom: 1px dotted #bbb;
1541 :link:hover, :visited:hover {
1554 background-color: #fff;
1555 border: 1px solid #aaa;
1559 font-weight: normal;
1581 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1586 <img src="$logo" alt="Catalyst Logo" />
1588 <p>Welcome to the world of Catalyst.
1589 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1590 framework will make web development something you had
1591 never expected it to be: Fun, rewarding, and quick.</p>
1592 <h2>What to do now?</h2>
1593 <p>That really depends on what <b>you</b> want to do.
1594 We do, however, provide you with a few starting points.</p>
1595 <p>If you want to jump right into web development with Catalyst
1596 you might want to start with a tutorial.</p>
1597 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1599 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1601 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1602 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1604 <h2>What to do next?</h2>
1605 <p>Next it's time to write an actual application. Use the
1606 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1607 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1608 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1609 they can save you a lot of work.</p>
1610 <pre><code>script/${prefix}_create.pl --help</code></pre>
1611 <p>Also, be sure to check out the vast and growing
1612 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1613 you are likely to find what you need there.
1617 <p>Catalyst has a very active community. Here are the main places to
1618 get in touch with us.</p>
1621 <a href="http://dev.catalyst.perl.org">Wiki</a>
1624 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1627 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1630 <h2>In conclusion</h2>
1631 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1632 as we enjoyed making it. Please contact us if you have ideas
1633 for improvement or other feedback.</p>
1643 Contains a hash of options passed from the application script, including
1644 the original ARGV the script received, the processed values from that
1645 ARGV and any extra arguments to the script which were not processed.
1647 This can be used to add custom options to your application's scripts
1648 and setup your application differently depending on the values of these
1651 =head1 INTERNAL METHODS
1653 These methods are not meant to be used by end users.
1655 =head2 $c->components
1657 Returns a hash of components.
1659 =head2 $c->context_class
1661 Returns or sets the context class.
1665 Returns a hashref containing coderefs and execution counts (needed for
1666 deep recursion detection).
1670 Returns the number of actions on the current internal execution stack.
1674 Dispatches a request to actions.
1678 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1680 =head2 $c->dispatcher_class
1682 Returns or sets the dispatcher class.
1684 =head2 $c->dump_these
1686 Returns a list of 2-element array references (name, structure) pairs
1687 that will be dumped on the error page in debug mode.
1693 [ Request => $c->req ],
1694 [ Response => $c->res ],
1695 [ Stash => $c->stash ],
1696 [ Config => $c->config ];
1699 =head2 $c->engine_class
1701 Returns or sets the engine class.
1703 =head2 $c->execute( $class, $coderef )
1705 Execute a coderef in given class and catch exceptions. Errors are available
1711 my ( $c, $class, $code ) = @_;
1712 $class = $c->component($class) || $class;
1715 if ( $c->depth >= $RECURSION ) {
1716 my $action = $code->reverse();
1717 $action = "/$action" unless $action =~ /->/;
1718 my $error = qq/Deep recursion detected calling "${action}"/;
1719 $c->log->error($error);
1725 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1727 push( @{ $c->stack }, $code );
1729 no warnings 'recursion';
1730 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1731 # I have no idea how, ergo $ret (which appears to fix the issue)
1732 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1734 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1736 my $last = pop( @{ $c->stack } );
1738 if ( my $error = $@ ) {
1739 #rethow if this can be handled by middleware
1740 if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) {
1741 foreach my $err (@{$c->error}) {
1742 $c->log->error($err);
1745 $c->log->_flush if $c->log->can('_flush');
1747 $error->can('rethrow') ? $error->rethrow : croak $error;
1749 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1750 $error->rethrow if $c->depth > 1;
1752 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1753 $error->rethrow if $c->depth > 0;
1756 unless ( ref $error ) {
1757 no warnings 'uninitialized';
1759 my $class = $last->class;
1760 my $name = $last->name;
1761 $error = qq/Caught exception in $class->$name "$error"/;
1770 sub _stats_start_execute {
1771 my ( $c, $code ) = @_;
1772 my $appclass = ref($c) || $c;
1773 return if ( ( $code->name =~ /^_.*/ )
1774 && ( !$appclass->config->{show_internal_actions} ) );
1776 my $action_name = $code->reverse();
1777 $c->counter->{$action_name}++;
1779 my $action = $action_name;
1780 $action = "/$action" unless $action =~ /->/;
1782 # determine if the call was the result of a forward
1783 # this is done by walking up the call stack and looking for a calling
1784 # sub of Catalyst::forward before the eval
1786 for my $index ( 2 .. 11 ) {
1788 if ( ( caller($index) )[0] eq 'Catalyst'
1789 && ( caller($index) )[3] eq '(eval)' );
1791 if ( ( caller($index) )[3] =~ /forward$/ ) {
1792 $callsub = ( caller($index) )[3];
1793 $action = "-> $action";
1798 my $uid = $action_name . $c->counter->{$action_name};
1800 # is this a root-level call or a forwarded call?
1801 if ( $callsub =~ /forward$/ ) {
1802 my $parent = $c->stack->[-1];
1804 # forward, locate the caller
1805 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1808 parent => "$parent" . $c->counter->{"$parent"},
1814 # forward with no caller may come from a plugin
1833 sub _stats_finish_execute {
1834 my ( $c, $info ) = @_;
1835 $c->stats->profile( end => $info );
1840 Finalizes the request.
1847 for my $error ( @{ $c->error } ) {
1848 $c->log->error($error);
1851 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1852 # stuff like cometd and websockets
1854 if($c->request->_has_io_fh) {
1859 # Allow engine to handle finalize flow (for POE)
1860 my $engine = $c->engine;
1861 if ( my $code = $engine->can('finalize') ) {
1866 $c->finalize_uploads;
1869 if ( $#{ $c->error } >= 0 ) {
1873 $c->finalize_headers unless $c->response->finalized_headers;
1880 if ($c->use_stats) {
1881 my $elapsed = $c->stats->elapsed;
1882 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1884 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1887 return $c->response->status;
1890 =head2 $c->finalize_body
1896 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1898 =head2 $c->finalize_cookies
1904 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1906 =head2 $c->finalize_error
1908 Finalizes error. If there is only one error in L</error> and it is an object that
1909 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
1910 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
1911 return the default error page (production mode).
1915 sub finalize_error {
1917 if($#{$c->error} > 0) {
1918 $c->engine->finalize_error( $c, @_ );
1920 my ($error) = @{$c->error};
1923 ($error->can('as_psgi') || $error->can('code'))
1925 # In the case where the error 'knows what it wants', becauses its PSGI
1926 # aware, just rethow and let middleware catch it
1927 $error->can('rethrow') ? $error->rethrow : croak $error;
1929 $c->engine->finalize_error( $c, @_ )
1934 =head2 $c->finalize_headers
1940 sub finalize_headers {
1943 my $response = $c->response; #accessor calls can add up?
1945 # Check if we already finalized headers
1946 return if $response->finalized_headers;
1949 if ( my $location = $response->redirect ) {
1950 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1951 $response->header( Location => $location );
1954 # Remove incorrectly added body and content related meta data when returning
1955 # an information response, or a response the is required to not include a body
1957 $c->finalize_cookies;
1959 $c->response->finalize_headers();
1962 $response->finalized_headers(1);
1965 =head2 $c->finalize_output
1967 An alias for finalize_body.
1969 =head2 $c->finalize_read
1971 Finalizes the input after reading is complete.
1975 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1977 =head2 $c->finalize_uploads
1979 Finalizes uploads. Cleans up any temporary files.
1983 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1985 =head2 $c->get_action( $action, $namespace )
1987 Gets an action in a given namespace.
1991 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1993 =head2 $c->get_actions( $action, $namespace )
1995 Gets all actions of a given name in a namespace and all parent
2000 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2002 =head2 $app->handle_request( @arguments )
2004 Called to handle each HTTP request.
2008 sub handle_request {
2009 my ( $class, @arguments ) = @_;
2011 # Always expect worst case!
2014 if ($class->debug) {
2015 my $secs = time - $START || 1;
2016 my $av = sprintf '%.3f', $COUNT / $secs;
2017 my $time = localtime time;
2018 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2021 my $c = $class->prepare(@arguments);
2023 $status = $c->finalize;
2025 #rethow if this can be handled by middleware
2026 if(blessed $_ && ($_->can('as_psgi') || $_->can('code'))) {
2027 $_->can('rethrow') ? $_->rethrow : croak $_;
2029 chomp(my $error = $_);
2030 $class->log->error(qq/Caught exception in engine "$error"/);
2035 if(my $coderef = $class->log->can('_flush')){
2036 $class->log->$coderef();
2041 =head2 $class->prepare( @arguments )
2043 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2050 predicate => '_has_uploadtmp',
2054 my ( $class, @arguments ) = @_;
2057 # After the app/ctxt split, this should become an attribute based on something passed
2058 # into the application.
2059 $class->context_class( ref $class || $class ) unless $class->context_class;
2061 my $uploadtmp = $class->config->{uploadtmp};
2062 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2064 $c->response->_context($c);
2066 #surely this is not the most efficient way to do things...
2067 $c->stats($class->stats_class->new)->enable($c->use_stats);
2068 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2069 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2073 # Allow engine to direct the prepare flow (for POE)
2074 if ( my $prepare = $c->engine->can('prepare') ) {
2075 $c->engine->$prepare( $c, @arguments );
2078 $c->prepare_request(@arguments);
2079 $c->prepare_connection;
2080 $c->prepare_query_parameters;
2081 $c->prepare_headers; # Just hooks, no longer needed - they just
2082 $c->prepare_cookies; # cause the lazy attribute on req to build
2085 # Prepare the body for reading, either by prepare_body
2086 # or the user, if they are using $c->read
2089 # Parse the body unless the user wants it on-demand
2090 unless ( ref($c)->config->{parse_on_demand} ) {
2096 # VERY ugly and probably shouldn't rely on ->finalize actually working
2098 # failed prepare is always due to an invalid request, right?
2099 $c->response->status(400);
2100 $c->response->content_type('text/plain');
2101 $c->response->body('Bad Request');
2102 # Note we call finalize and then die here, which escapes
2103 # finalize being called in the enclosing block..
2104 # It in fact couldn't be called, as we don't return $c..
2105 # This is a mess - but I'm unsure you can fix this without
2106 # breaking compat for people doing crazy things (we should set
2107 # the 400 and just return the ctx here IMO, letting finalize get called
2118 =head2 $c->prepare_action
2120 Prepares action. See L<Catalyst::Dispatcher>.
2124 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2126 =head2 $c->prepare_body
2128 Prepares message body.
2135 return if $c->request->_has_body;
2137 # Initialize on-demand data
2138 $c->engine->prepare_body( $c, @_ );
2139 $c->prepare_parameters;
2140 $c->prepare_uploads;
2143 =head2 $c->prepare_body_chunk( $chunk )
2145 Prepares a chunk of data before sending it to L<HTTP::Body>.
2147 See L<Catalyst::Engine>.
2151 sub prepare_body_chunk {
2153 $c->engine->prepare_body_chunk( $c, @_ );
2156 =head2 $c->prepare_body_parameters
2158 Prepares body parameters.
2162 sub prepare_body_parameters {
2164 $c->engine->prepare_body_parameters( $c, @_ );
2167 =head2 $c->prepare_connection
2169 Prepares connection.
2173 sub prepare_connection {
2175 $c->request->prepare_connection($c);
2178 =head2 $c->prepare_cookies
2180 Prepares cookies by ensuring that the attribute on the request
2181 object has been built.
2185 sub prepare_cookies { my $c = shift; $c->request->cookies }
2187 =head2 $c->prepare_headers
2189 Prepares request headers by ensuring that the attribute on the request
2190 object has been built.
2194 sub prepare_headers { my $c = shift; $c->request->headers }
2196 =head2 $c->prepare_parameters
2198 Prepares parameters.
2202 sub prepare_parameters {
2204 $c->prepare_body_parameters;
2205 $c->engine->prepare_parameters( $c, @_ );
2208 =head2 $c->prepare_path
2210 Prepares path and base.
2214 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2216 =head2 $c->prepare_query_parameters
2218 Prepares query parameters.
2222 sub prepare_query_parameters {
2225 $c->engine->prepare_query_parameters( $c, @_ );
2228 =head2 $c->log_request
2230 Writes information about the request to the debug logs. This includes:
2234 =item * Request method, path, and remote IP address
2236 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2238 =item * Request parameters
2240 =item * File uploads
2249 return unless $c->debug;
2251 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2252 my $request = $dump->[1];
2254 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2256 $path = '/' unless length $path;
2258 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2260 $c->log_request_headers($request->headers);
2262 if ( my $keywords = $request->query_keywords ) {
2263 $c->log->debug("Query keywords are: $keywords");
2266 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2268 $c->log_request_uploads($request);
2271 =head2 $c->log_response
2273 Writes information about the response to the debug logs by calling
2274 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2281 return unless $c->debug;
2283 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2284 my $response = $dump->[1];
2286 $c->log_response_status_line($response);
2287 $c->log_response_headers($response->headers);
2290 =head2 $c->log_response_status_line($response)
2292 Writes one line of information about the response to the debug logs. This includes:
2296 =item * Response status code
2298 =item * Content-Type header (if present)
2300 =item * Content-Length header (if present)
2306 sub log_response_status_line {
2307 my ($c, $response) = @_;
2311 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2312 $response->status || 'unknown',
2313 $response->headers->header('Content-Type') || 'unknown',
2314 $response->headers->header('Content-Length') || 'unknown'
2319 =head2 $c->log_response_headers($headers);
2321 Hook method which can be wrapped by plugins to log the response headers.
2322 No-op in the default implementation.
2326 sub log_response_headers {}
2328 =head2 $c->log_request_parameters( query => {}, body => {} )
2330 Logs request parameters to debug logs
2334 sub log_request_parameters {
2336 my %all_params = @_;
2338 return unless $c->debug;
2340 my $column_width = Catalyst::Utils::term_width() - 44;
2341 foreach my $type (qw(query body)) {
2342 my $params = $all_params{$type};
2343 next if ! keys %$params;
2344 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2345 for my $key ( sort keys %$params ) {
2346 my $param = $params->{$key};
2347 my $value = defined($param) ? $param : '';
2348 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2350 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2354 =head2 $c->log_request_uploads
2356 Logs file uploads included in the request to the debug logs.
2357 The parameter name, filename, file type, and file size are all included in
2362 sub log_request_uploads {
2364 my $request = shift;
2365 return unless $c->debug;
2366 my $uploads = $request->uploads;
2367 if ( keys %$uploads ) {
2368 my $t = Text::SimpleTable->new(
2369 [ 12, 'Parameter' ],
2374 for my $key ( sort keys %$uploads ) {
2375 my $upload = $uploads->{$key};
2376 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2377 $t->row( $key, $u->filename, $u->type, $u->size );
2380 $c->log->debug( "File Uploads are:\n" . $t->draw );
2384 =head2 $c->log_request_headers($headers);
2386 Hook method which can be wrapped by plugins to log the request headers.
2387 No-op in the default implementation.
2391 sub log_request_headers {}
2393 =head2 $c->log_headers($type => $headers)
2395 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2402 my $headers = shift; # an HTTP::Headers instance
2404 return unless $c->debug;
2406 my $column_width = Catalyst::Utils::term_width() - 28;
2407 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2410 my ( $name, $value ) = @_;
2411 $t->row( $name, $value );
2414 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2418 =head2 $c->prepare_read
2420 Prepares the input for reading.
2424 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2426 =head2 $c->prepare_request
2428 Prepares the engine request.
2432 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2434 =head2 $c->prepare_uploads
2440 sub prepare_uploads {
2443 $c->engine->prepare_uploads( $c, @_ );
2446 =head2 $c->prepare_write
2448 Prepares the output for writing.
2452 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2454 =head2 $c->request_class
2456 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2458 =head2 $c->response_class
2460 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2462 =head2 $c->read( [$maxlength] )
2464 Reads a chunk of data from the request body. This method is designed to
2465 be used in a while loop, reading C<$maxlength> bytes on every call.
2466 C<$maxlength> defaults to the size of the request if not specified.
2468 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2471 Warning: If you use read(), Catalyst will not process the body,
2472 so you will not be able to access POST parameters or file uploads via
2473 $c->request. You must handle all body parsing yourself.
2477 sub read { my $c = shift; return $c->request->read( @_ ) }
2487 $app->_make_immutable_if_needed;
2488 $app->engine_loader->needs_psgi_engine_compat_hack ?
2489 $app->engine->run($app, @_) :
2490 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2493 sub _make_immutable_if_needed {
2495 my $meta = find_meta($class);
2496 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2499 && ! { $meta->immutable_options }->{replace_constructor}
2502 warn("You made your application class ($class) immutable, "
2503 . "but did not inline the\nconstructor. "
2504 . "This will break catalyst, as your app \@ISA "
2505 . "Class::Accessor(::Fast)?\nPlease pass "
2506 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2508 unless ($meta->is_immutable) {
2509 # XXX - FIXME warning here as you should make your app immutable yourself.
2510 $meta->make_immutable(
2511 replace_constructor => 1,
2516 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2518 Sets an action in a given namespace.
2522 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2524 =head2 $c->setup_actions($component)
2526 Sets up actions for a component.
2530 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2532 =head2 $c->setup_components
2534 This method is called internally to set up the application's components.
2536 It finds modules by calling the L<locate_components> method, expands them to
2537 package names with the L<expand_component_module> method, and then installs
2538 each component into the application.
2540 The C<setup_components> config option is passed to both of the above methods.
2542 Installation of each component is performed by the L<setup_component> method,
2547 sub setup_components {
2550 my $config = $class->config->{ setup_components };
2552 my @comps = $class->locate_components($config);
2553 my %comps = map { $_ => 1 } @comps;
2555 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2556 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2557 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2558 ) if $deprecatedcatalyst_component_names;
2560 for my $component ( @comps ) {
2562 # We pass ignore_loaded here so that overlay files for (e.g.)
2563 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2564 # we know M::P::O found a file on disk so this is safe
2566 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2569 for my $component (@comps) {
2570 my $instance = $class->components->{ $component } = $class->setup_component($component);
2571 my @expanded_components = $instance->can('expand_modules')
2572 ? $instance->expand_modules( $component, $config )
2573 : $class->expand_component_module( $component, $config );
2574 for my $component (@expanded_components) {
2575 next if $comps{$component};
2576 $class->components->{ $component } = $class->setup_component($component);
2581 =head2 $c->locate_components( $setup_component_config )
2583 This method is meant to provide a list of component modules that should be
2584 setup for the application. By default, it will use L<Module::Pluggable>.
2586 Specify a C<setup_components> config option to pass additional options directly
2587 to L<Module::Pluggable>. To add additional search paths, specify a key named
2588 C<search_extra> as an array reference. Items in the array beginning with C<::>
2589 will have the application class name prepended to them.
2593 sub locate_components {
2597 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2598 my $extra = delete $config->{ search_extra } || [];
2600 unshift @paths, @$extra;
2602 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2603 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2605 )->plugins } @paths;
2610 =head2 $c->expand_component_module( $component, $setup_component_config )
2612 Components found by C<locate_components> will be passed to this method, which
2613 is expected to return a list of component (package) names to be set up.
2617 sub expand_component_module {
2618 my ($class, $module) = @_;
2619 return Devel::InnerPackage::list_packages( $module );
2622 =head2 $c->setup_component
2626 sub setup_component {
2627 my( $class, $component ) = @_;
2629 unless ( $component->can( 'COMPONENT' ) ) {
2633 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2634 my $config = $class->config->{ $suffix } || {};
2635 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2636 # methods also pass it. local to avoid pointlessly shitting in config
2637 # for the debug screen, as $component is already the key name.
2638 local $config->{catalyst_component_name} = $component;
2640 my $instance = eval { $component->COMPONENT( $class, $config ); };
2642 if ( my $error = $@ ) {
2644 Catalyst::Exception->throw(
2645 message => qq/Couldn't instantiate component "$component", "$error"/
2649 unless (blessed $instance) {
2650 my $metaclass = Moose::Util::find_meta($component);
2651 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2652 my $component_method_from = $method_meta->associated_metaclass->name;
2653 my $value = defined($instance) ? $instance : 'undef';
2654 Catalyst::Exception->throw(
2656 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2662 =head2 $c->setup_dispatcher
2668 sub setup_dispatcher {
2669 my ( $class, $dispatcher ) = @_;
2672 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2675 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2676 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2679 unless ($dispatcher) {
2680 $dispatcher = $class->dispatcher_class;
2683 load_class($dispatcher);
2685 # dispatcher instance
2686 $class->dispatcher( $dispatcher->new );
2689 =head2 $c->setup_engine
2696 my ($class, $requested_engine) = @_;
2698 if (!$class->engine_loader || $requested_engine) {
2699 $class->engine_loader(
2700 Catalyst::EngineLoader->new({
2701 application_name => $class,
2702 (defined $requested_engine
2703 ? (catalyst_engine_class => $requested_engine) : ()),
2708 $class->engine_loader->catalyst_engine_class;
2712 my ($class, $requested_engine) = @_;
2715 my $loader = $class->engine_loader;
2717 if (!$loader || $requested_engine) {
2718 $loader = Catalyst::EngineLoader->new({
2719 application_name => $class,
2720 (defined $requested_engine
2721 ? (requested_engine => $requested_engine) : ()),
2724 $class->engine_loader($loader);
2727 $loader->catalyst_engine_class;
2730 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2731 return if $class->loading_psgi_file;
2733 load_class($engine);
2735 if ($ENV{MOD_PERL}) {
2736 my $apache = $class->engine_loader->auto;
2738 my $meta = find_meta($class);
2739 my $was_immutable = $meta->is_immutable;
2740 my %immutable_options = $meta->immutable_options;
2741 $meta->make_mutable if $was_immutable;
2743 $meta->add_method(handler => sub {
2745 my $psgi_app = $class->_finalized_psgi_app;
2746 $apache->call_app($r, $psgi_app);
2749 $meta->make_immutable(%immutable_options) if $was_immutable;
2752 $class->engine( $engine->new );
2757 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2758 ## build in server support (back compat support for pre psgi port behavior).
2759 ## This is so that we don't build a new psgi app for each request when using
2760 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2762 sub _finalized_psgi_app {
2765 unless ($app->_psgi_app) {
2766 my $psgi_app = $app->_setup_psgi_app;
2767 $app->_psgi_app($psgi_app);
2770 return $app->_psgi_app;
2773 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2774 ## home directory and load that and return it (just assume it is doing the
2775 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2776 ## in default_middleware and return it ( this is for backward compatibility
2777 ## with pre psgi port behavior ).
2779 sub _setup_psgi_app {
2782 for my $home (Path::Class::Dir->new($app->config->{home})) {
2783 my $psgi_file = $home->file(
2784 Catalyst::Utils::appprefix($app) . '.psgi',
2787 next unless -e $psgi_file;
2789 # If $psgi_file calls ->setup_engine, it's doing so to load
2790 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2791 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2792 # anyway. So set a flag (ick) that tells setup_engine not to populate
2793 # $c->engine or do any other things we might regret.
2795 $app->loading_psgi_file(1);
2796 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2797 $app->loading_psgi_file(0);
2800 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2803 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2805 Its content has been ignored. Please consult the Catalyst::Upgrading
2806 documentation on how to upgrade from Catalyst::Engine::PSGI.
2810 return $app->apply_default_middlewares($app->psgi_app);
2813 =head2 $c->apply_default_middlewares
2815 Adds the following L<Plack> middlewares to your application, since they are
2816 useful and commonly needed:
2818 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2819 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2820 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2821 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2822 applied since this middleware is smart enough to conditionally apply itself).
2824 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2825 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2831 sub apply_default_middlewares {
2832 my ($app, $psgi_app) = @_;
2834 $psgi_app = Plack::Middleware::Conditional->wrap(
2836 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2839 return if $app->config->{ignore_frontend_proxy};
2840 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2841 || $app->config->{using_frontend_proxy};
2845 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2846 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2847 $psgi_app = Plack::Middleware::Conditional->wrap(
2849 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2852 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2853 return unless $1 < 4.23;
2858 # we're applying this unconditionally as the middleware itself already makes
2859 # sure it doesn't fuck things up if it's not running under one of the right
2861 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2863 # And another IIS issue, this time with IIS7.
2864 $psgi_app = Plack::Middleware::Conditional->wrap(
2866 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2869 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2878 Returns a PSGI application code reference for the catalyst application
2879 C<$c>. This is the bare application without any middlewares
2880 applied. C<${myapp}.psgi> is not taken into account.
2882 This is what you want to be using to retrieve the PSGI application code
2883 reference of your Catalyst application for use in F<.psgi> files.
2889 my $psgi = $app->engine->build_psgi_app($app);
2890 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2893 =head2 $c->setup_home
2895 Sets up the home directory.
2900 my ( $class, $home ) = @_;
2902 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2906 $home ||= Catalyst::Utils::home($class);
2909 #I remember recently being scolded for assigning config values like this
2910 $class->config->{home} ||= $home;
2911 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2915 =head2 $c->setup_log
2917 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2918 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2921 This method also installs a C<debug> method that returns a true value into the
2922 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2923 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2925 Note that if the log has already been setup, by either a previous call to
2926 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2927 that this method won't actually set up the log object.
2932 my ( $class, $levels ) = @_;
2935 $levels =~ s/^\s+//;
2936 $levels =~ s/\s+$//;
2937 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2939 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2940 if ( defined $env_debug ) {
2941 $levels{debug} = 1 if $env_debug; # Ugly!
2942 delete($levels{debug}) unless $env_debug;
2945 unless ( $class->log ) {
2946 $class->log( Catalyst::Log->new(keys %levels) );
2949 if ( $levels{debug} ) {
2950 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2951 $class->log->debug('Debug messages enabled');
2955 =head2 $c->setup_plugins
2961 =head2 $c->setup_stats
2963 Sets up timing statistics class.
2968 my ( $class, $stats ) = @_;
2970 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2972 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2973 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2974 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2975 $class->log->debug('Statistics enabled');
2980 =head2 $c->registered_plugins
2982 Returns a sorted list of the plugins which have either been stated in the
2985 If passed a given plugin name, it will report a boolean value indicating
2986 whether or not that plugin is loaded. A fully qualified name is required if
2987 the plugin name does not begin with C<Catalyst::Plugin::>.
2989 if ($c->registered_plugins('Some::Plugin')) {
2997 sub registered_plugins {
2999 return sort keys %{ $proto->_plugins } unless @_;
3001 return 1 if exists $proto->_plugins->{$plugin};
3002 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3005 sub _register_plugin {
3006 my ( $proto, $plugin, $instant ) = @_;
3007 my $class = ref $proto || $proto;
3009 load_class( $plugin );
3010 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3011 if $plugin->isa( 'Catalyst::Component' );
3012 my $plugin_meta = Moose::Meta::Class->create($plugin);
3013 if (!$plugin_meta->has_method('new')
3014 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3015 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3017 if (!$instant && !$proto->_plugins->{$plugin}) {
3018 my $meta = Class::MOP::get_metaclass_by_name($class);
3019 $meta->superclasses($plugin, $meta->superclasses);
3021 $proto->_plugins->{$plugin} = 1;
3025 sub _default_plugins { return qw(Unicode::Encoding) }
3028 my ( $class, $plugins ) = @_;
3030 $class->_plugins( {} ) unless $class->_plugins;
3032 m/Unicode::Encoding/ ? do {
3034 'Unicode::Encoding plugin is auto-applied,'
3035 . ' please remove this from your appclass'
3036 . ' and make sure to define "encoding" config'
3038 unless (exists $class->config->{'encoding'}) {
3039 $class->config->{'encoding'} = 'UTF-8';
3044 push @$plugins, $class->_default_plugins;
3045 $plugins = Data::OptList::mkopt($plugins || []);
3048 [ Catalyst::Utils::resolve_namespace(
3049 $class . '::Plugin',
3050 'Catalyst::Plugin', $_->[0]
3056 for my $plugin ( reverse @plugins ) {
3057 load_class($plugin->[0], $plugin->[1]);
3058 my $meta = find_meta($plugin->[0]);
3059 next if $meta && $meta->isa('Moose::Meta::Role');
3061 $class->_register_plugin($plugin->[0]);
3065 map { $_->[0]->name, $_->[1] }
3066 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3067 map { [find_meta($_->[0]), $_->[1]] }
3070 Moose::Util::apply_all_roles(
3076 =head2 registered_middlewares
3078 Read only accessor that returns an array of all the middleware in the order
3079 that they were added (which is the REVERSE of the order they will be applied).
3081 The values returned will be either instances of L<Plack::Middleware> or of a
3082 compatible interface, or a coderef, which is assumed to be inlined middleware
3084 =head2 setup_middleware (?@middleware)
3086 Read configuration information stored in configuration key C<psgi_middleware> or
3089 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3090 to use it to enable L<Plack::Middleware>
3092 This method is automatically called during 'setup' of your application, so
3093 you really don't need to invoke it. However you may do so if you find the idea
3094 of loading middleware via configuration weird :). For example:
3100 __PACKAGE__->setup_middleware('Head');
3103 When we read middleware definitions from configuration, we reverse the list
3104 which sounds odd but is likely how you expect it to work if you have prior
3105 experience with L<Plack::Builder> or if you previously used the plugin
3106 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3108 So basically your middleware handles an incoming request from the first
3109 registered middleware, down and handles the response from the last middleware
3114 sub registered_middlewares {
3116 if(my $middleware = $class->_psgi_middleware) {
3118 Catalyst::Middleware::Stash->new,
3119 Plack::Middleware::HTTPExceptions->new,
3120 Plack::Middleware::RemoveRedundantBody->new,
3121 Plack::Middleware::FixMissingBodyInRedirect->new,
3122 Plack::Middleware::ContentLength->new,
3123 Plack::Middleware::MethodOverride->new,
3124 Plack::Middleware::Head->new,
3127 die "You cannot call ->registered_middlewares until middleware has been setup";
3131 sub setup_middleware {
3133 my @middleware_definitions = @_ ?
3134 reverse(@_) : reverse(@{$class->config->{'psgi_middleware'}||[]});
3136 my @middleware = ();
3137 while(my $next = shift(@middleware_definitions)) {
3139 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3140 push @middleware, $next;
3141 } elsif(ref $next eq 'CODE') {
3142 push @middleware, $next;
3143 } elsif(ref $next eq 'HASH') {
3144 my $namespace = shift @middleware_definitions;
3145 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3146 push @middleware, $mw;
3148 die "I can't handle middleware definition ${\ref $next}";
3151 my $mw = $class->Catalyst::Utils::build_middleware($next);
3152 push @middleware, $mw;
3156 my @existing = @{$class->_psgi_middleware || []};
3157 $class->_psgi_middleware([@middleware,@existing,]);
3160 =head2 registered_data_handlers
3162 A read only copy of registered Data Handlers returned as a Hash, where each key
3163 is a content type and each value is a subref that attempts to decode that content
3166 =head2 setup_data_handlers (?@data_handler)
3168 Read configuration information stored in configuration key C<data_handlers> or
3171 See under L</CONFIGURATION> information regarding C<data_handlers>.
3173 This method is automatically called during 'setup' of your application, so
3174 you really don't need to invoke it.
3176 =head2 default_data_handlers
3178 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3179 only two default data handlers, for 'application/json' and an alternative to
3180 'application/x-www-form-urlencoded' which supposed nested form parameters via
3181 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3183 The 'application/json' data handler is used to parse incoming JSON into a Perl
3184 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3185 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3186 JSON decoder, and has the smallest dependency impact.
3188 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3189 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3190 order to get the best performance. You should add either to your dependency
3191 list (Makefile.PL, dist.ini, cpanfile, etc.)
3195 sub registered_data_handlers {
3197 if(my $data_handlers = $class->_data_handlers) {
3198 return %$data_handlers;
3200 $class->setup_data_handlers;
3201 return $class->registered_data_handlers;
3205 sub setup_data_handlers {
3206 my ($class, %data_handler_callbacks) = @_;
3207 %data_handler_callbacks = (
3208 %{$class->default_data_handlers},
3209 %{$class->config->{'data_handlers'}||+{}},
3210 %data_handler_callbacks);
3212 $class->_data_handlers(\%data_handler_callbacks);
3215 sub default_data_handlers {
3218 'application/x-www-form-urlencoded' => sub {
3219 my ($fh, $req) = @_;
3220 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3221 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3222 ->can('build_cgi_struct')->($params);
3224 'application/json' => sub {
3225 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3226 ->can('decode_json')->(do { local $/; $_->getline });
3233 Returns an arrayref of the internal execution stack (actions that are
3234 currently executing).
3238 Returns the current timing statistics object. By default Catalyst uses
3239 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3240 L<< stats_class|/"$c->stats_class" >>.
3242 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3243 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3244 profile explicitly, although MyApp.pm still won't profile nor output anything
3247 =head2 $c->stats_class
3249 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3251 =head2 $c->use_stats
3253 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3255 Note that this is a static method, not an accessor and should be overridden
3256 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3263 =head2 $c->write( $data )
3265 Writes $data to the output stream. When using this method directly, you
3266 will need to manually set the C<Content-Length> header to the length of
3267 your output data, if known.
3274 # Finalize headers if someone manually writes output (for compat)
3275 $c->finalize_headers;
3277 return $c->response->write( @_ );
3282 Returns the Catalyst version number. Mostly useful for "powered by"
3283 messages in template systems.
3287 sub version { return $Catalyst::VERSION }
3289 =head1 CONFIGURATION
3291 There are a number of 'base' config variables which can be set:
3297 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3301 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3305 C<disable_component_resolution_regex_fallback> - Turns
3306 off the deprecated component resolution functionality so
3307 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3308 are called then regex search will not be attempted on string values and
3309 instead C<undef> will be returned.
3313 C<home> - The application home directory. In an uninstalled application,
3314 this is the top level application directory. In an installed application,
3315 this will be the directory containing C<< MyApp.pm >>.
3319 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3323 C<name> - The name of the application in debug messages and the debug and
3328 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3329 until it is accessed. This allows you to (for example) check authentication (and reject
3330 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3334 C<root> - The root directory for templates. Usually this is just a
3335 subdirectory of the home directory, but you can set it to change the
3336 templates to a different directory.
3340 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3341 namespaces from which components will be loaded (and constructed and stored in
3342 C<< $c->components >>).
3346 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3347 to be shown in hit debug tables in the test server.
3351 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3352 variable should be used for determining the request path.
3354 Most web server environments pass the requested path to the application using environment variables,
3355 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3356 exposed as C<< $c->request->base >>) and the request path below that base.
3358 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3359 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3363 =item use_request_uri_for_path => 0
3365 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3366 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3367 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3368 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3370 However this method has the major disadvantage that it is impossible to correctly decode some elements
3371 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3372 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3373 can't distinguish / vs %2F in paths (in addition to other encoded values).
3375 =item use_request_uri_for_path => 1
3377 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3378 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3379 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3381 Given that this method of path resolution is provably more correct, it is recommended that you use
3382 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3383 aware of the implications of not being able to handle encoded URI paths correctly.
3385 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3386 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3387 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3388 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3389 C<< $c->request->base >> will be incorrect.
3395 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3399 C<encoding> - See L</ENCODING>
3403 C<abort_chain_on_error_fix>
3405 When there is an error in an action chain, the default behavior is to continue
3406 processing the remaining actions and then catch the error upon chain end. This
3407 can lead to running actions when the application is in an unexpected state. If
3408 you have this issue, setting this config value to true will promptly exit a
3409 chain when there is an error raised in any action (thus terminating the chain
3414 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3416 In the future this might become the default behavior.
3420 C<use_hash_multivalue_in_request>
3422 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3423 and C<parameters> return a hashref where values might be scalar or an arrayref
3424 depending on the incoming data. In many cases this can be undesirable as it
3425 leads one to writing defensive code like the following:
3427 my ($val) = ref($c->req->parameters->{a}) ?
3428 @{$c->req->parameters->{a}} :
3429 $c->req->parameters->{a};
3431 Setting this configuration item to true will make L<Catalyst> populate the
3432 attributes underlying these methods with an instance of L<Hash::MultiValue>
3433 which is used by L<Plack::Request> and others to solve this very issue. You
3434 may prefer this behavior to the default, if so enable this option (be warned
3435 if you enable it in a legacy application we are not sure if it is completely
3436 backwardly compatible).
3440 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3444 C<data_handlers> - See L<DATA HANDLERS>.
3450 Generally when you throw an exception inside an Action (or somewhere in
3451 your stack, such as in a model that an Action is calling) that exception
3452 is caught by Catalyst and unless you either catch it yourself (via eval
3453 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
3454 will eventually reach L</finalize_errors> and return either the debugging
3455 error stack page, or the default error page. However, if your exception
3456 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
3457 instead rethrow it so that it can be handled by that middleware (which
3458 is part of the default middleware). For example this would allow
3460 use HTTP::Throwable::Factory 'http_throw';
3462 sub throws_exception :Local {
3463 my ($self, $c) = @_;
3465 http_throw(SeeOther => { location =>
3466 $c->uri_for($self->action_for('redirect')) });
3470 =head1 INTERNAL ACTIONS
3472 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3473 C<_ACTION>, and C<_END>. These are by default not shown in the private
3474 action table, but you can make them visible with a config parameter.
3476 MyApp->config(show_internal_actions => 1);
3478 =head1 ON-DEMAND PARSER
3480 The request body is usually parsed at the beginning of a request,
3481 but if you want to handle input yourself, you can enable on-demand
3482 parsing with a config parameter.
3484 MyApp->config(parse_on_demand => 1);
3486 =head1 PROXY SUPPORT
3488 Many production servers operate using the common double-server approach,
3489 with a lightweight frontend web server passing requests to a larger
3490 backend server. An application running on the backend server must deal
3491 with two problems: the remote user always appears to be C<127.0.0.1> and
3492 the server's hostname will appear to be C<localhost> regardless of the
3493 virtual host that the user connected through.
3495 Catalyst will automatically detect this situation when you are running
3496 the frontend and backend servers on the same machine. The following
3497 changes are made to the request.
3499 $c->req->address is set to the user's real IP address, as read from
3500 the HTTP X-Forwarded-For header.
3502 The host value for $c->req->base and $c->req->uri is set to the real
3503 host, as read from the HTTP X-Forwarded-Host header.
3505 Additionally, you may be running your backend application on an insecure
3506 connection (port 80) while your frontend proxy is running under SSL. If there
3507 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3508 tell Catalyst what port the frontend listens on. This will allow all URIs to
3509 be created properly.
3511 In the case of passing in:
3513 X-Forwarded-Port: 443
3515 All calls to C<uri_for> will result in an https link, as is expected.
3517 Obviously, your web server must support these headers for this to work.
3519 In a more complex server farm environment where you may have your
3520 frontend proxy server(s) on different machines, you will need to set a
3521 configuration option to tell Catalyst to read the proxied data from the
3524 MyApp->config(using_frontend_proxy => 1);
3526 If you do not wish to use the proxy support at all, you may set:
3528 MyApp->config(ignore_frontend_proxy => 0);
3530 =head2 Note about psgi files
3532 Note that if you supply your own .psgi file, calling
3533 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3535 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3536 in your psgi, for example:
3539 enable "Plack::Middleware::ReverseProxy";
3543 This will unconditionally add the ReverseProxy support, or you need to call
3544 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3545 apply the support depending upon your config).
3547 See L<Catalyst::PSGI> for more information.
3549 =head1 THREAD SAFETY
3551 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3552 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3553 believe the Catalyst core to be thread-safe.
3555 If you plan to operate in a threaded environment, remember that all other
3556 modules you are using must also be thread-safe. Some modules, most notably
3557 L<DBD::SQLite>, are not thread-safe.
3559 =head1 DATA HANDLERS
3561 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3562 form parameters and URL search query fields. However it has become common
3563 for various alternative content types to be PUT or POSTed to your controllers
3564 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3565 XML and other content types when communicating with an application server. In
3566 order to better support this use case, L<Catalyst> defines a global configuration
3567 option, C<data_handlers>, which lets you associate a content type with a coderef
3568 that parses that content type into something Perl can readily access.
3575 __PACKAGE__->config(
3577 'application/json' => sub { local $/; decode_json $_->getline },
3579 ## Any other configuration.
3584 By default L<Catalyst> comes with a generic JSON data handler similar to the
3585 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3586 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3587 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3588 or dist.ini, cpanfile, etc.)
3590 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
3591 (matched against the incoming request type using a regexp such as to be case
3592 insensitive) and whose values are coderefs that receive a localized version of
3593 C<$_> which is a filehandle object pointing to received body.
3595 This feature is considered an early access release and we reserve the right
3596 to alter the interface in order to provide a performant and secure solution to
3597 alternative request body content. Your reports welcomed!
3599 =head1 PSGI MIDDLEWARE
3601 You can define middleware, defined as L<Plack::Middleware> or a compatible
3602 interface in configuration. Your middleware definitions are in the form of an
3603 arrayref under the configuration key C<psgi_middleware>. Here's an example
3604 with details to follow:
3609 use Plack::Middleware::StackTrace;
3611 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3613 __PACKAGE__->config(
3614 'psgi_middleware', [
3617 $stacktrace_middleware,
3618 'Session' => {store => 'File'},
3623 $env->{myapp.customkey} = 'helloworld';
3632 So the general form is:
3634 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3636 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3637 the order listed (to make it function similarly to L<Plack::Builder>:
3639 Alternatively, you may also define middleware by calling the L</setup_middleware>
3646 __PACKAGE__->setup_middleware( \@middleware_definitions);
3649 In the case where you do both (use 'setup_middleware' and configuration) the
3650 package call to setup_middleware will be applied earlier (in other words its
3651 middleware will wrap closer to the application). Keep this in mind since in
3652 some cases the order of middleware is important.
3654 The two approaches are not exclusive.
3658 =item Middleware Object
3660 An already initialized object that conforms to the L<Plack::Middleware>
3663 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3665 __PACKAGE__->config(
3666 'psgi_middleware', [
3667 $stacktrace_middleware,
3673 A coderef that is an inlined middleware:
3675 __PACKAGE__->config(
3676 'psgi_middleware', [
3681 if($env->{PATH_INFO} =~m/forced/) {
3683 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3686 return $app->($env);
3696 We assume the scalar refers to a namespace after normalizing it using the
3699 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3700 is assumed to be 'as is', and we just install and use the middleware.
3702 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3703 (the package name of your Catalyst application subclass), we also assume then
3704 that it is a full namespace, and use it.
3706 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3707 resolve it first by looking for it under your application namespace (for example
3708 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3709 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3710 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3711 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3712 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3713 you find that a good idea.
3719 __PACKAGE__->config(
3720 'psgi_middleware', [
3721 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3722 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3723 '+MyApp::Custom', ## MyApp::Custom->wrap
3727 =item a scalar followed by a hashref
3729 Just like the previous, except the following C<HashRef> is used as arguments
3730 to initialize the middleware object.
3732 __PACKAGE__->config(
3733 'psgi_middleware', [
3734 'Session' => {store => 'File'},
3739 Please see L<PSGI> for more on middleware.
3743 On request, decodes all params from encoding into a sequence of
3744 logical characters. On response, encodes body into encoding.
3752 Returns an instance of an C<Encode> encoding
3754 print $c->encoding->name
3756 =item handle_unicode_encoding_exception ($exception_context)
3758 Method called when decoding process for a request fails.
3760 An C<$exception_context> hashref is provided to allow you to override the
3761 behaviour of your application when given data with incorrect encodings.
3763 The default method throws exceptions in the case of invalid request parameters
3764 (resulting in a 500 error), but ignores errors in upload filenames.
3766 The keys passed in the C<$exception_context> hash are:
3772 The value which was not able to be decoded.
3776 The exception received from L<Encode>.
3780 What type of data was being decoded. Valid values are (currently)
3781 C<params> - for request parameters / arguments / captures
3782 and C<uploads> - for request upload filenames.
3792 Join #catalyst on irc.perl.org.
3796 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3797 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3801 http://catalyst.perl.org
3805 http://dev.catalyst.perl.org
3809 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3811 =head2 L<Catalyst::Manual> - The Catalyst Manual
3813 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3815 =head2 L<Catalyst::Engine> - Core engine
3817 =head2 L<Catalyst::Log> - Log class.
3819 =head2 L<Catalyst::Request> - Request object
3821 =head2 L<Catalyst::Response> - Response object
3823 =head2 L<Catalyst::Test> - The test suite.
3825 =head1 PROJECT FOUNDER
3827 sri: Sebastian Riedel <sri@cpan.org>
3833 acme: Leon Brocard <leon@astray.com>
3835 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3839 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3843 andyg: Andy Grundman <andy@hybridized.org>
3845 audreyt: Audrey Tang
3847 bricas: Brian Cassidy <bricas@cpan.org>
3849 Caelum: Rafael Kitover <rkitover@io.com>
3851 chansen: Christian Hansen
3853 chicks: Christopher Hicks
3855 Chisel Wright C<pause@herlpacker.co.uk>
3857 Danijel Milicevic C<me@danijel.de>
3859 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3861 David Naughton, C<naughton@umn.edu>
3865 dhoss: Devin Austin <dhoss@cpan.org>
3867 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3871 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3873 esskar: Sascha Kiefer
3875 fireartist: Carl Franks <cfranks@cpan.org>
3877 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3879 gabb: Danijel Milicevic
3883 Gavin Henry C<ghenry@perl.me.uk>
3887 groditi: Guillermo Roditi <groditi@gmail.com>
3889 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3891 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3893 jcamacho: Juan Camacho
3895 jester: Jesse Sheidlower C<jester@panix.com>
3897 jhannah: Jay Hannah <jay@jays.net>
3903 jon: Jon Schutz <jjschutz@cpan.org>
3905 Jonathan Rockway C<< <jrockway@cpan.org> >>
3907 Kieren Diment C<kd@totaldatasolution.com>
3909 konobi: Scott McWhirter <konobi@cpan.org>
3911 marcus: Marcus Ramberg <mramberg@cpan.org>
3913 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3915 mgrimes: Mark Grimes <mgrimes@cpan.org>
3917 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3921 naughton: David Naughton
3923 ningu: David Kamholz <dkamholz@cpan.org>
3925 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3927 numa: Dan Sully <daniel@cpan.org>
3933 omega: Andreas Marienborg
3935 Oleg Kostyuk <cub.uanic@gmail.com>
3937 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3939 rafl: Florian Ragwitz <rafl@debian.org>
3941 random: Roland Lammel <lammel@cpan.org>
3943 Robert Sedlacek C<< <rs@474.at> >>
3945 SpiceMan: Marcel Montes
3949 szbalint: Balint Szilakszi <szbalint@cpan.org>
3951 t0m: Tomas Doran <bobtfish@bobtfish.net>
3955 vanstyn: Henry Van Styn <vanstyn@cpan.org>
3957 Viljo Marrandi C<vilts@yahoo.com>
3959 Will Hawes C<info@whawes.co.uk>
3961 willert: Sebastian Willert <willert@cpan.org>
3963 wreis: Wallace Reis <wreis@cpan.org>
3965 Yuval Kogman, C<nothingmuch@woobling.org>
3967 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3969 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3971 Upasana <me@upasana.me>
3975 Copyright (c) 2005-2014, the above named PROJECT FOUNDER and CONTRIBUTORS.
3979 This library is free software. You can redistribute it and/or modify it under
3980 the same terms as Perl itself.
3986 __PACKAGE__->meta->make_immutable;