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;
51 use Class::Load 'load_class';
53 BEGIN { require 5.008003; }
55 has stack => (is => 'ro', default => sub { [] });
56 has stash => (is => 'rw', 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.90061';
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' );
499 around stash => sub {
502 my $stash = $orig->($c);
504 my $new_stash = @_ > 1 ? {@_} : $_[0];
505 croak('stash takes a hash or hashref') unless ref $new_stash;
506 foreach my $key ( keys %$new_stash ) {
507 $stash->{$key} = $new_stash->{$key};
517 =head2 $c->error($error, ...)
519 =head2 $c->error($arrayref)
521 Returns an arrayref containing error messages. If Catalyst encounters an
522 error while processing a request, it stores the error in $c->error. This
523 method should only be used to store fatal error messages.
525 my @error = @{ $c->error };
529 $c->error('Something bad happened');
536 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
537 croak @$error unless ref $c;
538 push @{ $c->{error} }, @$error;
540 elsif ( defined $_[0] ) { $c->{error} = undef }
541 return $c->{error} || [];
547 Contains the return value of the last executed action.
548 Note that << $c->state >> operates in a scalar context which means that all
549 values it returns are scalar.
551 =head2 $c->clear_errors
553 Clear errors. You probably don't want to clear the errors unless you are
554 implementing a custom error screen.
556 This is equivalent to running
567 sub _comp_search_prefixes {
569 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
572 # search components given a name and some prefixes
573 sub _comp_names_search_prefixes {
574 my ( $c, $name, @prefixes ) = @_;
575 my $appclass = ref $c || $c;
576 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
577 $filter = qr/$filter/; # Compile regex now rather than once per loop
579 # map the original component name to the sub part that we will search against
580 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
581 grep { /$filter/ } keys %{ $c->components };
583 # undef for a name will return all
584 return keys %eligible if !defined $name;
586 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
587 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
589 return @result if @result;
591 # if we were given a regexp to search against, we're done.
592 return if $name->$_isa('Regexp');
594 # skip regexp fallback if configured
596 if $appclass->config->{disable_component_resolution_regex_fallback};
600 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
602 # no results? try against full names
604 @result = grep { m{$query} } keys %eligible;
607 # don't warn if we didn't find any results, it just might not exist
609 # Disgusting hack to work out correct method name
610 my $warn_for = lc $prefixes[0];
611 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
612 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
613 "component resolution is unreliable and unsafe.";
614 my $short = $result[0];
615 # remove the component namespace prefix
616 $short =~ s/.*?(Model|Controller|View):://;
617 my $shortmess = Carp::shortmess('');
618 if ($shortmess =~ m#Catalyst/Plugin#) {
619 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
621 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
622 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
623 "component's config";
625 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
626 "but if you really wanted to search, pass in a regexp as the argument " .
627 "like so: \$c->${warn_for}(qr/${name}/)";
629 $c->log->warn( "${msg}$shortmess" );
635 # Find possible names for a prefix
637 my ( $c, @prefixes ) = @_;
638 my $appclass = ref $c || $c;
640 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
642 my @names = map { s{$filter}{}; $_; }
643 $c->_comp_names_search_prefixes( undef, @prefixes );
648 # Filter a component before returning by calling ACCEPT_CONTEXT if available
649 sub _filter_component {
650 my ( $c, $comp, @args ) = @_;
652 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
653 return $comp->ACCEPT_CONTEXT( $c, @args );
659 =head2 COMPONENT ACCESSORS
661 =head2 $c->controller($name)
663 Gets a L<Catalyst::Controller> instance by name.
665 $c->controller('Foo')->do_stuff;
667 If the name is omitted, will return the controller for the dispatched
670 If you want to search for controllers, pass in a regexp as the argument.
672 # find all controllers that start with Foo
673 my @foo_controllers = $c->controller(qr{^Foo});
679 my ( $c, $name, @args ) = @_;
681 my $appclass = ref($c) || $c;
683 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
684 my $comps = $c->components;
685 my $check = $appclass."::Controller::".$name;
686 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
688 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
689 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
690 return $c->_filter_component( $result[ 0 ], @args );
693 return $c->component( $c->action->class );
696 =head2 $c->model($name)
698 Gets a L<Catalyst::Model> instance by name.
700 $c->model('Foo')->do_stuff;
702 Any extra arguments are directly passed to ACCEPT_CONTEXT.
704 If the name is omitted, it will look for
705 - a model object in $c->stash->{current_model_instance}, then
706 - a model name in $c->stash->{current_model}, then
707 - a config setting 'default_model', or
708 - check if there is only one model, and return it if that's the case.
710 If you want to search for models, pass in a regexp as the argument.
712 # find all models that start with Foo
713 my @foo_models = $c->model(qr{^Foo});
718 my ( $c, $name, @args ) = @_;
719 my $appclass = ref($c) || $c;
721 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
722 my $comps = $c->components;
723 my $check = $appclass."::Model::".$name;
724 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
726 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
727 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
728 return $c->_filter_component( $result[ 0 ], @args );
732 return $c->stash->{current_model_instance}
733 if $c->stash->{current_model_instance};
734 return $c->model( $c->stash->{current_model} )
735 if $c->stash->{current_model};
737 return $c->model( $appclass->config->{default_model} )
738 if $appclass->config->{default_model};
740 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
743 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
744 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
745 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
746 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
747 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
750 return $c->_filter_component( $comp );
754 =head2 $c->view($name)
756 Gets a L<Catalyst::View> instance by name.
758 $c->view('Foo')->do_stuff;
760 Any extra arguments are directly passed to ACCEPT_CONTEXT.
762 If the name is omitted, it will look for
763 - a view object in $c->stash->{current_view_instance}, then
764 - a view name in $c->stash->{current_view}, then
765 - a config setting 'default_view', or
766 - check if there is only one view, and return it if that's the case.
768 If you want to search for views, pass in a regexp as the argument.
770 # find all views that start with Foo
771 my @foo_views = $c->view(qr{^Foo});
776 my ( $c, $name, @args ) = @_;
778 my $appclass = ref($c) || $c;
780 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
781 my $comps = $c->components;
782 my $check = $appclass."::View::".$name;
783 if( exists $comps->{$check} ) {
784 return $c->_filter_component( $comps->{$check}, @args );
787 $c->log->warn( "Attempted to use view '$check', but does not exist" );
790 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
791 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
792 return $c->_filter_component( $result[ 0 ], @args );
796 return $c->stash->{current_view_instance}
797 if $c->stash->{current_view_instance};
798 return $c->view( $c->stash->{current_view} )
799 if $c->stash->{current_view};
801 return $c->view( $appclass->config->{default_view} )
802 if $appclass->config->{default_view};
804 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
807 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
808 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
809 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
810 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
811 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
814 return $c->_filter_component( $comp );
817 =head2 $c->controllers
819 Returns the available names which can be passed to $c->controller
825 return $c->_comp_names(qw/Controller C/);
830 Returns the available names which can be passed to $c->model
836 return $c->_comp_names(qw/Model M/);
842 Returns the available names which can be passed to $c->view
848 return $c->_comp_names(qw/View V/);
851 =head2 $c->comp($name)
853 =head2 $c->component($name)
855 Gets a component object by name. This method is not recommended,
856 unless you want to get a specific component by full
857 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
858 should be used instead.
860 If C<$name> is a regexp, a list of components matched against the full
861 component name will be returned.
863 If Catalyst can't find a component by name, it will fallback to regex
864 matching by default. To disable this behaviour set
865 disable_component_resolution_regex_fallback to a true value.
867 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
872 my ( $c, $name, @args ) = @_;
875 my $comps = $c->components;
878 # is it the exact name?
879 return $c->_filter_component( $comps->{ $name }, @args )
880 if exists $comps->{ $name };
882 # perhaps we just omitted "MyApp"?
883 my $composed = ( ref $c || $c ) . "::${name}";
884 return $c->_filter_component( $comps->{ $composed }, @args )
885 if exists $comps->{ $composed };
887 # search all of the models, views and controllers
888 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
889 return $c->_filter_component( $comp, @args ) if $comp;
893 if $c->config->{disable_component_resolution_regex_fallback};
895 # This is here so $c->comp( '::M::' ) works
896 my $query = ref $name ? $name : qr{$name}i;
898 my @result = grep { m{$query} } keys %{ $c->components };
899 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
902 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
903 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
904 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
905 return $c->_filter_component( $result[ 0 ], @args );
908 # I would expect to return an empty list here, but that breaks back-compat
912 return sort keys %{ $c->components };
915 =head2 CLASS DATA AND HELPER CLASSES
919 Returns or takes a hashref containing the application's configuration.
921 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
923 You can also use a C<YAML>, C<XML> or L<Config::General> config file
924 like C<myapp.conf> in your applications home directory. See
925 L<Catalyst::Plugin::ConfigLoader>.
927 =head3 Cascading configuration
929 The config method is present on all Catalyst components, and configuration
930 will be merged when an application is started. Configuration loaded with
931 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
932 followed by configuration in your top level C<MyApp> class. These two
933 configurations are merged, and then configuration data whose hash key matches a
934 component name is merged with configuration for that component.
936 The configuration for a component is then passed to the C<new> method when a
937 component is constructed.
941 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
942 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
944 will mean that C<MyApp::Model::Foo> receives the following data when
947 MyApp::Model::Foo->new({
953 It's common practice to use a Moose attribute
954 on the receiving component to access the config value.
956 package MyApp::Model::Foo;
960 # this attr will receive 'baz' at construction time
966 You can then get the value 'baz' by calling $c->model('Foo')->bar
967 (or $self->bar inside code in the model).
969 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
970 as a way of reading config within your code, as this B<will not> give you the
971 correctly merged config back. You B<MUST> take the config values supplied to
972 the constructor and use those instead.
976 around config => sub {
980 croak('Setting config after setup has been run is not allowed.')
981 if ( @_ and $c->setup_finished );
988 Returns the logging object instance. Unless it is already set, Catalyst
989 sets this up with a L<Catalyst::Log> object. To use your own log class,
990 set the logger with the C<< __PACKAGE__->log >> method prior to calling
991 C<< __PACKAGE__->setup >>.
993 __PACKAGE__->log( MyLogger->new );
998 $c->log->info( 'Now logging with my own logger!' );
1000 Your log class should implement the methods described in
1006 Returns 1 if debug mode is enabled, 0 otherwise.
1008 You can enable debug mode in several ways:
1012 =item By calling myapp_server.pl with the -d flag
1014 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1016 =item The -Debug option in your MyApp.pm
1018 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1022 The first three also set the log level to 'debug'.
1024 Calling C<< $c->debug(1) >> has no effect.
1030 =head2 $c->dispatcher
1032 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1036 Returns the engine instance. See L<Catalyst::Engine>.
1039 =head2 UTILITY METHODS
1041 =head2 $c->path_to(@path)
1043 Merges C<@path> with C<< $c->config->{home} >> and returns a
1044 L<Path::Class::Dir> object. Note you can usually use this object as
1045 a filename, but sometimes you will have to explicitly stringify it
1046 yourself by calling the C<< ->stringify >> method.
1050 $c->path_to( 'db', 'sqlite.db' );
1055 my ( $c, @path ) = @_;
1056 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1057 if ( -d $path ) { return $path }
1058 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1062 my ( $class, $name, $plugin, @args ) = @_;
1064 # See block comment in t/unit_core_plugin.t
1065 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1067 $class->_register_plugin( $plugin, 1 );
1069 eval { $plugin->import };
1070 $class->mk_classdata($name);
1072 eval { $obj = $plugin->new(@args) };
1075 Catalyst::Exception->throw( message =>
1076 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1079 $class->$name($obj);
1080 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1086 Initializes the dispatcher and engine, loads any plugins, and loads the
1087 model, view, and controller components. You may also specify an array
1088 of plugins to load here, if you choose to not load them in the C<use
1092 MyApp->setup( qw/-Debug/ );
1094 B<Note:> You B<should not> wrap this method with method modifiers
1095 or bad things will happen - wrap the C<setup_finalize> method instead.
1100 my ( $class, @arguments ) = @_;
1101 croak('Running setup more than once')
1102 if ( $class->setup_finished );
1104 unless ( $class->isa('Catalyst') ) {
1106 Catalyst::Exception->throw(
1107 message => qq/'$class' does not inherit from Catalyst/ );
1110 if ( $class->arguments ) {
1111 @arguments = ( @arguments, @{ $class->arguments } );
1117 foreach (@arguments) {
1121 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1123 elsif (/^-(\w+)=?(.*)$/) {
1124 $flags->{ lc $1 } = $2;
1127 push @{ $flags->{plugins} }, $_;
1131 $class->setup_home( delete $flags->{home} );
1133 $class->setup_log( delete $flags->{log} );
1134 $class->setup_plugins( delete $flags->{plugins} );
1136 $class->setup_data_handlers();
1137 $class->setup_dispatcher( delete $flags->{dispatcher} );
1138 if (my $engine = delete $flags->{engine}) {
1139 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1141 $class->setup_engine();
1142 $class->setup_stats( delete $flags->{stats} );
1144 for my $flag ( sort keys %{$flags} ) {
1146 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1147 &$code( $class, delete $flags->{$flag} );
1150 $class->log->warn(qq/Unknown flag "$flag"/);
1154 eval { require Catalyst::Devel; };
1155 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1156 $class->log->warn(<<"EOF");
1157 You are running an old script!
1159 Please update by running (this will overwrite existing files):
1160 catalyst.pl -force -scripts $class
1162 or (this will not overwrite existing files):
1163 catalyst.pl -scripts $class
1168 # Call plugins setup, this is stupid and evil.
1169 # Also screws C3 badly on 5.10, hack to avoid.
1171 no warnings qw/redefine/;
1172 local *setup = sub { };
1173 $class->setup unless $Catalyst::__AM_RESTARTING;
1176 $class->setup_middleware();
1178 # Initialize our data structure
1179 $class->components( {} );
1181 $class->setup_components;
1183 if ( $class->debug ) {
1184 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1187 my $column_width = Catalyst::Utils::term_width() - 6;
1188 my $t = Text::SimpleTable->new($column_width);
1189 $t->row($_) for @plugins;
1190 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1193 my @middleware = map {
1196 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1197 || '') } $class->registered_middlewares;
1200 my $column_width = Catalyst::Utils::term_width() - 6;
1201 my $t = Text::SimpleTable->new($column_width);
1202 $t->row($_) for @middleware;
1203 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1206 my %dh = $class->registered_data_handlers;
1207 if (my @data_handlers = keys %dh) {
1208 my $column_width = Catalyst::Utils::term_width() - 6;
1209 my $t = Text::SimpleTable->new($column_width);
1210 $t->row($_) for @data_handlers;
1211 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1214 my $dispatcher = $class->dispatcher;
1215 my $engine = $class->engine;
1216 my $home = $class->config->{home};
1218 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1219 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1223 ? $class->log->debug(qq/Found home "$home"/)
1224 : $class->log->debug(qq/Home "$home" doesn't exist/)
1225 : $class->log->debug(q/Couldn't find home/);
1227 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1228 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1229 for my $comp ( sort keys %{ $class->components } ) {
1230 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1231 $t->row( $comp, $type );
1233 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1234 if ( keys %{ $class->components } );
1237 # Add our self to components, since we are also a component
1238 if( $class->isa('Catalyst::Controller') ){
1239 $class->components->{$class} = $class;
1242 $class->setup_actions;
1244 if ( $class->debug ) {
1245 my $name = $class->config->{name} || 'Application';
1246 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1249 if ($class->config->{case_sensitive}) {
1250 $class->log->warn($class . "->config->{case_sensitive} is set.");
1251 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1254 $class->setup_finalize;
1255 # Should be the last thing we do so that user things hooking
1256 # setup_finalize can log..
1257 $class->log->_flush() if $class->log->can('_flush');
1258 return $class || 1; # Just in case someone named their Application 0...
1261 =head2 $app->setup_finalize
1263 A hook to attach modifiers to. This method does not do anything except set the
1264 C<setup_finished> accessor.
1266 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1270 after setup_finalize => sub {
1278 sub setup_finalize {
1280 $class->setup_finished(1);
1283 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1285 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1287 Constructs an absolute L<URI> object based on the application root, the
1288 provided path, and the additional arguments and query parameters provided.
1289 When used as a string, provides a textual URI. If you need more flexibility
1290 than this (i.e. the option to provide relative URIs etc.) see
1291 L<Catalyst::Plugin::SmartURI>.
1293 If no arguments are provided, the URI for the current action is returned.
1294 To return the current action and also provide @args, use
1295 C<< $c->uri_for( $c->action, @args ) >>.
1297 If the first argument is a string, it is taken as a public URI path relative
1298 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1299 relative to the application root (if it does). It is then merged with
1300 C<< $c->request->base >>; any C<@args> are appended as additional path
1301 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1303 If the first argument is a L<Catalyst::Action> it represents an action which
1304 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1305 optional C<\@captures> argument (an arrayref) allows passing the captured
1306 variables that are needed to fill in the paths of Chained and Regex actions;
1307 once the path is resolved, C<uri_for> continues as though a path was
1308 provided, appending any arguments or parameters and creating an absolute
1311 The captures for the current request can be found in
1312 C<< $c->request->captures >>, and actions can be resolved using
1313 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1314 path, use C<< $c->uri_for_action >> instead.
1316 # Equivalent to $c->req->uri
1317 $c->uri_for($c->action, $c->req->captures,
1318 @{ $c->req->args }, $c->req->params);
1320 # For the Foo action in the Bar controller
1321 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1323 # Path to a static resource
1324 $c->uri_for('/static/images/logo.png');
1329 my ( $c, $path, @args ) = @_;
1331 if ( $path->$_isa('Catalyst::Controller') ) {
1332 $path = $path->path_prefix;
1337 undef($path) if (defined $path && $path eq '');
1340 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1342 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1343 foreach my $arg (@args) {
1344 utf8::encode($arg) if utf8::is_utf8($arg);
1345 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1348 if ( $path->$_isa('Catalyst::Action') ) { # action object
1349 s|/|%2F|g for @args;
1350 my $captures = [ map { s|/|%2F|g; $_; }
1351 ( scalar @args && ref $args[0] eq 'ARRAY'
1355 foreach my $capture (@$captures) {
1356 utf8::encode($capture) if utf8::is_utf8($capture);
1357 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1361 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1362 if( !@args && $action->number_of_args ) {
1363 my $expanded_action = $c->dispatcher->expand_action( $action );
1365 my $num_captures = $expanded_action->number_of_captures;
1366 unshift @args, splice @$captures, $num_captures;
1369 $path = $c->dispatcher->uri_for_action($action, $captures);
1370 if (not defined $path) {
1371 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1375 $path = '/' if $path eq '';
1378 unshift(@args, $path);
1380 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1381 my $namespace = $c->namespace;
1382 if (defined $path) { # cheesy hack to handle path '../foo'
1383 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1385 unshift(@args, $namespace || '');
1388 # join args with '/', or a blank string
1389 my $args = join('/', grep { defined($_) } @args);
1390 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1393 my ($base, $class) = ('/', 'URI::_generic');
1395 $base = $c->req->base;
1396 $class = ref($base);
1397 $base =~ s{(?<!/)$}{/};
1402 if (my @keys = keys %$params) {
1403 # somewhat lifted from URI::_query's query_form
1404 $query = '?'.join('&', map {
1405 my $val = $params->{$_};
1406 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1409 $val = '' unless defined $val;
1412 utf8::encode( $param ) if utf8::is_utf8($param);
1413 # using the URI::Escape pattern here so utf8 chars survive
1414 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1416 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1420 my $res = bless(\"${base}${args}${query}", $class);
1424 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1426 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1432 A private path to the Catalyst action you want to create a URI for.
1434 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1435 >> and passing the resulting C<$action> and the remaining arguments to C<<
1438 You can also pass in a Catalyst::Action object, in which case it is passed to
1441 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.
1443 For example, if the action looks like:
1445 package MyApp::Controller::Users;
1447 sub lst : Path('the-list') {}
1451 $c->uri_for_action('/users/lst')
1453 and it will create the URI /users/the-list.
1455 =item \@captures_and_args?
1457 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1458 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1459 to interpolate all the parameters in the URI.
1463 Optional list of extra arguments - can be supplied in the
1464 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1467 Your action can have zero, a fixed or a variable number of args (e.g.
1468 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1470 =item \%query_values?
1472 Optional array reference of query parameters to append. E.g.
1478 /rest/of/your/uri?foo=bar
1484 sub uri_for_action {
1485 my ( $c, $path, @args ) = @_;
1486 my $action = blessed($path)
1488 : $c->dispatcher->get_action_by_path($path);
1489 unless (defined $action) {
1490 croak "Can't find action for path '$path'";
1492 return $c->uri_for( $action, @args );
1495 =head2 $c->welcome_message
1497 Returns the Catalyst welcome HTML page.
1501 sub welcome_message {
1503 my $name = $c->config->{name};
1504 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1505 my $prefix = Catalyst::Utils::appprefix( ref $c );
1506 $c->response->content_type('text/html; charset=utf-8');
1508 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1509 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1510 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1512 <meta http-equiv="Content-Language" content="en" />
1513 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1514 <title>$name on Catalyst $VERSION</title>
1515 <style type="text/css">
1518 background-color: #eee;
1525 margin-bottom: 10px;
1527 background-color: #ccc;
1528 border: 1px solid #aaa;
1533 font-family: verdana, tahoma, sans-serif;
1536 font-family: verdana, tahoma, sans-serif;
1539 text-decoration: none;
1541 border-bottom: 1px dotted #bbb;
1543 :link:hover, :visited:hover {
1556 background-color: #fff;
1557 border: 1px solid #aaa;
1561 font-weight: normal;
1583 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1588 <img src="$logo" alt="Catalyst Logo" />
1590 <p>Welcome to the world of Catalyst.
1591 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1592 framework will make web development something you had
1593 never expected it to be: Fun, rewarding, and quick.</p>
1594 <h2>What to do now?</h2>
1595 <p>That really depends on what <b>you</b> want to do.
1596 We do, however, provide you with a few starting points.</p>
1597 <p>If you want to jump right into web development with Catalyst
1598 you might want to start with a tutorial.</p>
1599 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1601 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1603 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1604 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1606 <h2>What to do next?</h2>
1607 <p>Next it's time to write an actual application. Use the
1608 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1609 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1610 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1611 they can save you a lot of work.</p>
1612 <pre><code>script/${prefix}_create.pl --help</code></pre>
1613 <p>Also, be sure to check out the vast and growing
1614 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1615 you are likely to find what you need there.
1619 <p>Catalyst has a very active community. Here are the main places to
1620 get in touch with us.</p>
1623 <a href="http://dev.catalyst.perl.org">Wiki</a>
1626 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1629 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1632 <h2>In conclusion</h2>
1633 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1634 as we enjoyed making it. Please contact us if you have ideas
1635 for improvement or other feedback.</p>
1645 Contains a hash of options passed from the application script, including
1646 the original ARGV the script received, the processed values from that
1647 ARGV and any extra arguments to the script which were not processed.
1649 This can be used to add custom options to your application's scripts
1650 and setup your application differently depending on the values of these
1653 =head1 INTERNAL METHODS
1655 These methods are not meant to be used by end users.
1657 =head2 $c->components
1659 Returns a hash of components.
1661 =head2 $c->context_class
1663 Returns or sets the context class.
1667 Returns a hashref containing coderefs and execution counts (needed for
1668 deep recursion detection).
1672 Returns the number of actions on the current internal execution stack.
1676 Dispatches a request to actions.
1680 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1682 =head2 $c->dispatcher_class
1684 Returns or sets the dispatcher class.
1686 =head2 $c->dump_these
1688 Returns a list of 2-element array references (name, structure) pairs
1689 that will be dumped on the error page in debug mode.
1695 [ Request => $c->req ],
1696 [ Response => $c->res ],
1697 [ Stash => $c->stash ],
1698 [ Config => $c->config ];
1701 =head2 $c->engine_class
1703 Returns or sets the engine class.
1705 =head2 $c->execute( $class, $coderef )
1707 Execute a coderef in given class and catch exceptions. Errors are available
1713 my ( $c, $class, $code ) = @_;
1714 $class = $c->component($class) || $class;
1717 if ( $c->depth >= $RECURSION ) {
1718 my $action = $code->reverse();
1719 $action = "/$action" unless $action =~ /->/;
1720 my $error = qq/Deep recursion detected calling "${action}"/;
1721 $c->log->error($error);
1727 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1729 push( @{ $c->stack }, $code );
1731 no warnings 'recursion';
1732 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1733 # I have no idea how, ergo $ret (which appears to fix the issue)
1734 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1736 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1738 my $last = pop( @{ $c->stack } );
1740 if ( my $error = $@ ) {
1741 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1742 $error->rethrow if $c->depth > 1;
1744 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1745 $error->rethrow if $c->depth > 0;
1748 unless ( ref $error ) {
1749 no warnings 'uninitialized';
1751 my $class = $last->class;
1752 my $name = $last->name;
1753 $error = qq/Caught exception in $class->$name "$error"/;
1762 sub _stats_start_execute {
1763 my ( $c, $code ) = @_;
1764 my $appclass = ref($c) || $c;
1765 return if ( ( $code->name =~ /^_.*/ )
1766 && ( !$appclass->config->{show_internal_actions} ) );
1768 my $action_name = $code->reverse();
1769 $c->counter->{$action_name}++;
1771 my $action = $action_name;
1772 $action = "/$action" unless $action =~ /->/;
1774 # determine if the call was the result of a forward
1775 # this is done by walking up the call stack and looking for a calling
1776 # sub of Catalyst::forward before the eval
1778 for my $index ( 2 .. 11 ) {
1780 if ( ( caller($index) )[0] eq 'Catalyst'
1781 && ( caller($index) )[3] eq '(eval)' );
1783 if ( ( caller($index) )[3] =~ /forward$/ ) {
1784 $callsub = ( caller($index) )[3];
1785 $action = "-> $action";
1790 my $uid = $action_name . $c->counter->{$action_name};
1792 # is this a root-level call or a forwarded call?
1793 if ( $callsub =~ /forward$/ ) {
1794 my $parent = $c->stack->[-1];
1796 # forward, locate the caller
1797 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1800 parent => "$parent" . $c->counter->{"$parent"},
1806 # forward with no caller may come from a plugin
1825 sub _stats_finish_execute {
1826 my ( $c, $info ) = @_;
1827 $c->stats->profile( end => $info );
1832 Finalizes the request.
1839 for my $error ( @{ $c->error } ) {
1840 $c->log->error($error);
1843 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1844 # stuff like cometd and websockets
1846 if($c->request->_has_io_fh) {
1851 # Allow engine to handle finalize flow (for POE)
1852 my $engine = $c->engine;
1853 if ( my $code = $engine->can('finalize') ) {
1858 $c->finalize_uploads;
1861 if ( $#{ $c->error } >= 0 ) {
1865 $c->finalize_headers unless $c->response->finalized_headers;
1872 if ($c->use_stats) {
1873 my $elapsed = $c->stats->elapsed;
1874 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1876 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1879 return $c->response->status;
1882 =head2 $c->finalize_body
1888 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1890 =head2 $c->finalize_cookies
1896 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1898 =head2 $c->finalize_error
1900 Finalizes error. If there is only one error in L</error> and it is an object that
1901 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
1902 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
1903 return the default error page (production mode).
1907 sub finalize_error {
1909 if($#{$c->error} > 0) {
1910 $c->engine->finalize_error( $c, @_ );
1912 my ($error) = @{$c->error};
1915 ($error->can('as_psgi') || $error->can('code'))
1917 # In the case where the error 'knows what it wants', becauses its PSGI
1918 # aware, just rethow and let middleware catch it
1919 $error->can('rethrow') ? $error->rethrow : croak $error;
1922 $c->engine->finalize_error( $c, @_ )
1927 =head2 $c->finalize_headers
1933 sub finalize_headers {
1936 my $response = $c->response; #accessor calls can add up?
1938 # Check if we already finalized headers
1939 return if $response->finalized_headers;
1942 if ( my $location = $response->redirect ) {
1943 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1944 $response->header( Location => $location );
1947 # Remove incorrectly added body and content related meta data when returning
1948 # an information response, or a response the is required to not include a body
1950 $c->finalize_cookies;
1952 $c->response->finalize_headers();
1955 $response->finalized_headers(1);
1958 =head2 $c->finalize_output
1960 An alias for finalize_body.
1962 =head2 $c->finalize_read
1964 Finalizes the input after reading is complete.
1968 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1970 =head2 $c->finalize_uploads
1972 Finalizes uploads. Cleans up any temporary files.
1976 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1978 =head2 $c->get_action( $action, $namespace )
1980 Gets an action in a given namespace.
1984 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
1986 =head2 $c->get_actions( $action, $namespace )
1988 Gets all actions of a given name in a namespace and all parent
1993 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
1995 =head2 $app->handle_request( @arguments )
1997 Called to handle each HTTP request.
2001 sub handle_request {
2002 my ( $class, @arguments ) = @_;
2004 # Always expect worst case!
2007 if ($class->debug) {
2008 my $secs = time - $START || 1;
2009 my $av = sprintf '%.3f', $COUNT / $secs;
2010 my $time = localtime time;
2011 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2014 my $c = $class->prepare(@arguments);
2016 $status = $c->finalize;
2018 chomp(my $error = $_);
2019 $class->log->error(qq/Caught exception in engine "$error"/);
2020 #rethow if this can be handled by middleware
2021 if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) {
2022 $error->can('rethrow') ? $error->rethrow : croak $error;
2028 if(my $coderef = $class->log->can('_flush')){
2029 $class->log->$coderef();
2034 =head2 $class->prepare( @arguments )
2036 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2043 predicate => '_has_uploadtmp',
2047 my ( $class, @arguments ) = @_;
2050 # After the app/ctxt split, this should become an attribute based on something passed
2051 # into the application.
2052 $class->context_class( ref $class || $class ) unless $class->context_class;
2054 my $uploadtmp = $class->config->{uploadtmp};
2055 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2057 $c->response->_context($c);
2059 #surely this is not the most efficient way to do things...
2060 $c->stats($class->stats_class->new)->enable($c->use_stats);
2061 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2062 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2066 # Allow engine to direct the prepare flow (for POE)
2067 if ( my $prepare = $c->engine->can('prepare') ) {
2068 $c->engine->$prepare( $c, @arguments );
2071 $c->prepare_request(@arguments);
2072 $c->prepare_connection;
2073 $c->prepare_query_parameters;
2074 $c->prepare_headers; # Just hooks, no longer needed - they just
2075 $c->prepare_cookies; # cause the lazy attribute on req to build
2078 # Prepare the body for reading, either by prepare_body
2079 # or the user, if they are using $c->read
2082 # Parse the body unless the user wants it on-demand
2083 unless ( ref($c)->config->{parse_on_demand} ) {
2089 # VERY ugly and probably shouldn't rely on ->finalize actually working
2091 # failed prepare is always due to an invalid request, right?
2092 $c->response->status(400);
2093 $c->response->content_type('text/plain');
2094 $c->response->body('Bad Request');
2095 # Note we call finalize and then die here, which escapes
2096 # finalize being called in the enclosing block..
2097 # It in fact couldn't be called, as we don't return $c..
2098 # This is a mess - but I'm unsure you can fix this without
2099 # breaking compat for people doing crazy things (we should set
2100 # the 400 and just return the ctx here IMO, letting finalize get called
2111 =head2 $c->prepare_action
2113 Prepares action. See L<Catalyst::Dispatcher>.
2117 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2119 =head2 $c->prepare_body
2121 Prepares message body.
2128 return if $c->request->_has_body;
2130 # Initialize on-demand data
2131 $c->engine->prepare_body( $c, @_ );
2132 $c->prepare_parameters;
2133 $c->prepare_uploads;
2136 =head2 $c->prepare_body_chunk( $chunk )
2138 Prepares a chunk of data before sending it to L<HTTP::Body>.
2140 See L<Catalyst::Engine>.
2144 sub prepare_body_chunk {
2146 $c->engine->prepare_body_chunk( $c, @_ );
2149 =head2 $c->prepare_body_parameters
2151 Prepares body parameters.
2155 sub prepare_body_parameters {
2157 $c->engine->prepare_body_parameters( $c, @_ );
2160 =head2 $c->prepare_connection
2162 Prepares connection.
2166 sub prepare_connection {
2168 # XXX - This is called on the engine (not the request) to maintain
2169 # Engine::PSGI back compat.
2170 $c->engine->prepare_connection($c);
2173 =head2 $c->prepare_cookies
2175 Prepares cookies by ensuring that the attribute on the request
2176 object has been built.
2180 sub prepare_cookies { my $c = shift; $c->request->cookies }
2182 =head2 $c->prepare_headers
2184 Prepares request headers by ensuring that the attribute on the request
2185 object has been built.
2189 sub prepare_headers { my $c = shift; $c->request->headers }
2191 =head2 $c->prepare_parameters
2193 Prepares parameters.
2197 sub prepare_parameters {
2199 $c->prepare_body_parameters;
2200 $c->engine->prepare_parameters( $c, @_ );
2203 =head2 $c->prepare_path
2205 Prepares path and base.
2209 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2211 =head2 $c->prepare_query_parameters
2213 Prepares query parameters.
2217 sub prepare_query_parameters {
2220 $c->engine->prepare_query_parameters( $c, @_ );
2223 =head2 $c->log_request
2225 Writes information about the request to the debug logs. This includes:
2229 =item * Request method, path, and remote IP address
2231 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2233 =item * Request parameters
2235 =item * File uploads
2244 return unless $c->debug;
2246 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2247 my $request = $dump->[1];
2249 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2251 $path = '/' unless length $path;
2253 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2255 $c->log_request_headers($request->headers);
2257 if ( my $keywords = $request->query_keywords ) {
2258 $c->log->debug("Query keywords are: $keywords");
2261 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2263 $c->log_request_uploads($request);
2266 =head2 $c->log_response
2268 Writes information about the response to the debug logs by calling
2269 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2276 return unless $c->debug;
2278 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2279 my $response = $dump->[1];
2281 $c->log_response_status_line($response);
2282 $c->log_response_headers($response->headers);
2285 =head2 $c->log_response_status_line($response)
2287 Writes one line of information about the response to the debug logs. This includes:
2291 =item * Response status code
2293 =item * Content-Type header (if present)
2295 =item * Content-Length header (if present)
2301 sub log_response_status_line {
2302 my ($c, $response) = @_;
2306 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2307 $response->status || 'unknown',
2308 $response->headers->header('Content-Type') || 'unknown',
2309 $response->headers->header('Content-Length') || 'unknown'
2314 =head2 $c->log_response_headers($headers);
2316 Hook method which can be wrapped by plugins to log the response headers.
2317 No-op in the default implementation.
2321 sub log_response_headers {}
2323 =head2 $c->log_request_parameters( query => {}, body => {} )
2325 Logs request parameters to debug logs
2329 sub log_request_parameters {
2331 my %all_params = @_;
2333 return unless $c->debug;
2335 my $column_width = Catalyst::Utils::term_width() - 44;
2336 foreach my $type (qw(query body)) {
2337 my $params = $all_params{$type};
2338 next if ! keys %$params;
2339 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2340 for my $key ( sort keys %$params ) {
2341 my $param = $params->{$key};
2342 my $value = defined($param) ? $param : '';
2343 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2345 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2349 =head2 $c->log_request_uploads
2351 Logs file uploads included in the request to the debug logs.
2352 The parameter name, filename, file type, and file size are all included in
2357 sub log_request_uploads {
2359 my $request = shift;
2360 return unless $c->debug;
2361 my $uploads = $request->uploads;
2362 if ( keys %$uploads ) {
2363 my $t = Text::SimpleTable->new(
2364 [ 12, 'Parameter' ],
2369 for my $key ( sort keys %$uploads ) {
2370 my $upload = $uploads->{$key};
2371 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2372 $t->row( $key, $u->filename, $u->type, $u->size );
2375 $c->log->debug( "File Uploads are:\n" . $t->draw );
2379 =head2 $c->log_request_headers($headers);
2381 Hook method which can be wrapped by plugins to log the request headers.
2382 No-op in the default implementation.
2386 sub log_request_headers {}
2388 =head2 $c->log_headers($type => $headers)
2390 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2397 my $headers = shift; # an HTTP::Headers instance
2399 return unless $c->debug;
2401 my $column_width = Catalyst::Utils::term_width() - 28;
2402 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2405 my ( $name, $value ) = @_;
2406 $t->row( $name, $value );
2409 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2413 =head2 $c->prepare_read
2415 Prepares the input for reading.
2419 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2421 =head2 $c->prepare_request
2423 Prepares the engine request.
2427 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2429 =head2 $c->prepare_uploads
2435 sub prepare_uploads {
2438 $c->engine->prepare_uploads( $c, @_ );
2441 =head2 $c->prepare_write
2443 Prepares the output for writing.
2447 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2449 =head2 $c->request_class
2451 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2453 =head2 $c->response_class
2455 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2457 =head2 $c->read( [$maxlength] )
2459 Reads a chunk of data from the request body. This method is designed to
2460 be used in a while loop, reading C<$maxlength> bytes on every call.
2461 C<$maxlength> defaults to the size of the request if not specified.
2463 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2466 Warning: If you use read(), Catalyst will not process the body,
2467 so you will not be able to access POST parameters or file uploads via
2468 $c->request. You must handle all body parsing yourself.
2472 sub read { my $c = shift; return $c->request->read( @_ ) }
2482 $app->_make_immutable_if_needed;
2483 $app->engine_loader->needs_psgi_engine_compat_hack ?
2484 $app->engine->run($app, @_) :
2485 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2488 sub _make_immutable_if_needed {
2490 my $meta = find_meta($class);
2491 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2494 && ! { $meta->immutable_options }->{replace_constructor}
2497 warn("You made your application class ($class) immutable, "
2498 . "but did not inline the\nconstructor. "
2499 . "This will break catalyst, as your app \@ISA "
2500 . "Class::Accessor(::Fast)?\nPlease pass "
2501 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2503 unless ($meta->is_immutable) {
2504 # XXX - FIXME warning here as you should make your app immutable yourself.
2505 $meta->make_immutable(
2506 replace_constructor => 1,
2511 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2513 Sets an action in a given namespace.
2517 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2519 =head2 $c->setup_actions($component)
2521 Sets up actions for a component.
2525 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2527 =head2 $c->setup_components
2529 This method is called internally to set up the application's components.
2531 It finds modules by calling the L<locate_components> method, expands them to
2532 package names with the L<expand_component_module> method, and then installs
2533 each component into the application.
2535 The C<setup_components> config option is passed to both of the above methods.
2537 Installation of each component is performed by the L<setup_component> method,
2542 sub setup_components {
2545 my $config = $class->config->{ setup_components };
2547 my @comps = $class->locate_components($config);
2548 my %comps = map { $_ => 1 } @comps;
2550 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2551 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2552 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2553 ) if $deprecatedcatalyst_component_names;
2555 for my $component ( @comps ) {
2557 # We pass ignore_loaded here so that overlay files for (e.g.)
2558 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2559 # we know M::P::O found a file on disk so this is safe
2561 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2564 for my $component (@comps) {
2565 my $instance = $class->components->{ $component } = $class->setup_component($component);
2566 my @expanded_components = $instance->can('expand_modules')
2567 ? $instance->expand_modules( $component, $config )
2568 : $class->expand_component_module( $component, $config );
2569 for my $component (@expanded_components) {
2570 next if $comps{$component};
2571 $class->components->{ $component } = $class->setup_component($component);
2576 =head2 $c->locate_components( $setup_component_config )
2578 This method is meant to provide a list of component modules that should be
2579 setup for the application. By default, it will use L<Module::Pluggable>.
2581 Specify a C<setup_components> config option to pass additional options directly
2582 to L<Module::Pluggable>. To add additional search paths, specify a key named
2583 C<search_extra> as an array reference. Items in the array beginning with C<::>
2584 will have the application class name prepended to them.
2588 sub locate_components {
2592 my @paths = qw( ::Controller ::C ::Model ::M ::View ::V );
2593 my $extra = delete $config->{ search_extra } || [];
2595 push @paths, @$extra;
2597 my $locator = Module::Pluggable::Object->new(
2598 search_path => [ map { s/^(?=::)/$class/; $_; } @paths ],
2602 # XXX think about ditching this sort entirely
2603 my @comps = sort { length $a <=> length $b } $locator->plugins;
2608 =head2 $c->expand_component_module( $component, $setup_component_config )
2610 Components found by C<locate_components> will be passed to this method, which
2611 is expected to return a list of component (package) names to be set up.
2615 sub expand_component_module {
2616 my ($class, $module) = @_;
2617 return Devel::InnerPackage::list_packages( $module );
2620 =head2 $c->setup_component
2624 sub setup_component {
2625 my( $class, $component ) = @_;
2627 unless ( $component->can( 'COMPONENT' ) ) {
2631 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2632 my $config = $class->config->{ $suffix } || {};
2633 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2634 # methods also pass it. local to avoid pointlessly shitting in config
2635 # for the debug screen, as $component is already the key name.
2636 local $config->{catalyst_component_name} = $component;
2638 my $instance = eval { $component->COMPONENT( $class, $config ); };
2640 if ( my $error = $@ ) {
2642 Catalyst::Exception->throw(
2643 message => qq/Couldn't instantiate component "$component", "$error"/
2647 unless (blessed $instance) {
2648 my $metaclass = Moose::Util::find_meta($component);
2649 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2650 my $component_method_from = $method_meta->associated_metaclass->name;
2651 my $value = defined($instance) ? $instance : 'undef';
2652 Catalyst::Exception->throw(
2654 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2660 =head2 $c->setup_dispatcher
2666 sub setup_dispatcher {
2667 my ( $class, $dispatcher ) = @_;
2670 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2673 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2674 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2677 unless ($dispatcher) {
2678 $dispatcher = $class->dispatcher_class;
2681 load_class($dispatcher);
2683 # dispatcher instance
2684 $class->dispatcher( $dispatcher->new );
2687 =head2 $c->setup_engine
2694 my ($class, $requested_engine) = @_;
2696 if (!$class->engine_loader || $requested_engine) {
2697 $class->engine_loader(
2698 Catalyst::EngineLoader->new({
2699 application_name => $class,
2700 (defined $requested_engine
2701 ? (catalyst_engine_class => $requested_engine) : ()),
2706 $class->engine_loader->catalyst_engine_class;
2710 my ($class, $requested_engine) = @_;
2713 my $loader = $class->engine_loader;
2715 if (!$loader || $requested_engine) {
2716 $loader = Catalyst::EngineLoader->new({
2717 application_name => $class,
2718 (defined $requested_engine
2719 ? (requested_engine => $requested_engine) : ()),
2722 $class->engine_loader($loader);
2725 $loader->catalyst_engine_class;
2728 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2729 return if $class->loading_psgi_file;
2731 load_class($engine);
2733 if ($ENV{MOD_PERL}) {
2734 my $apache = $class->engine_loader->auto;
2736 my $meta = find_meta($class);
2737 my $was_immutable = $meta->is_immutable;
2738 my %immutable_options = $meta->immutable_options;
2739 $meta->make_mutable if $was_immutable;
2741 $meta->add_method(handler => sub {
2743 my $psgi_app = $class->_finalized_psgi_app;
2744 $apache->call_app($r, $psgi_app);
2747 $meta->make_immutable(%immutable_options) if $was_immutable;
2750 $class->engine( $engine->new );
2755 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2756 ## build in server support (back compat support for pre psgi port behavior).
2757 ## This is so that we don't build a new psgi app for each request when using
2758 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2760 sub _finalized_psgi_app {
2763 unless ($app->_psgi_app) {
2764 my $psgi_app = $app->_setup_psgi_app;
2765 $app->_psgi_app($psgi_app);
2768 return $app->_psgi_app;
2771 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2772 ## home directory and load that and return it (just assume it is doing the
2773 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2774 ## in default_middleware and return it ( this is for backward compatibility
2775 ## with pre psgi port behavior ).
2777 sub _setup_psgi_app {
2780 for my $home (Path::Class::Dir->new($app->config->{home})) {
2781 my $psgi_file = $home->file(
2782 Catalyst::Utils::appprefix($app) . '.psgi',
2785 next unless -e $psgi_file;
2787 # If $psgi_file calls ->setup_engine, it's doing so to load
2788 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2789 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2790 # anyway. So set a flag (ick) that tells setup_engine not to populate
2791 # $c->engine or do any other things we might regret.
2793 $app->loading_psgi_file(1);
2794 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2795 $app->loading_psgi_file(0);
2798 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2801 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2803 Its content has been ignored. Please consult the Catalyst::Upgrading
2804 documentation on how to upgrade from Catalyst::Engine::PSGI.
2808 return $app->apply_default_middlewares($app->psgi_app);
2811 =head2 $c->apply_default_middlewares
2813 Adds the following L<Plack> middlewares to your application, since they are
2814 useful and commonly needed:
2816 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2817 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2818 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2819 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2820 applied since this middleware is smart enough to conditionally apply itself).
2822 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2823 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2829 sub apply_default_middlewares {
2830 my ($app, $psgi_app) = @_;
2832 $psgi_app = Plack::Middleware::Conditional->wrap(
2834 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2837 return if $app->config->{ignore_frontend_proxy};
2838 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2839 || $app->config->{using_frontend_proxy};
2843 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2844 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2845 $psgi_app = Plack::Middleware::Conditional->wrap(
2847 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2850 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2851 return unless $1 < 4.23;
2856 # we're applying this unconditionally as the middleware itself already makes
2857 # sure it doesn't fuck things up if it's not running under one of the right
2859 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2861 # And another IIS issue, this time with IIS7.
2862 $psgi_app = Plack::Middleware::Conditional->wrap(
2864 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2867 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2876 Returns a PSGI application code reference for the catalyst application
2877 C<$c>. This is the bare application without any middlewares
2878 applied. C<${myapp}.psgi> is not taken into account.
2880 This is what you want to be using to retrieve the PSGI application code
2881 reference of your Catalyst application for use in F<.psgi> files.
2887 my $psgi = $app->engine->build_psgi_app($app);
2888 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2891 =head2 $c->setup_home
2893 Sets up the home directory.
2898 my ( $class, $home ) = @_;
2900 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2904 $home ||= Catalyst::Utils::home($class);
2907 #I remember recently being scolded for assigning config values like this
2908 $class->config->{home} ||= $home;
2909 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2913 =head2 $c->setup_log
2915 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2916 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2919 This method also installs a C<debug> method that returns a true value into the
2920 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2921 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2923 Note that if the log has already been setup, by either a previous call to
2924 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2925 that this method won't actually set up the log object.
2930 my ( $class, $levels ) = @_;
2933 $levels =~ s/^\s+//;
2934 $levels =~ s/\s+$//;
2935 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2937 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2938 if ( defined $env_debug ) {
2939 $levels{debug} = 1 if $env_debug; # Ugly!
2940 delete($levels{debug}) unless $env_debug;
2943 unless ( $class->log ) {
2944 $class->log( Catalyst::Log->new(keys %levels) );
2947 if ( $levels{debug} ) {
2948 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2949 $class->log->debug('Debug messages enabled');
2953 =head2 $c->setup_plugins
2959 =head2 $c->setup_stats
2961 Sets up timing statistics class.
2966 my ( $class, $stats ) = @_;
2968 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2970 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2971 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2972 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2973 $class->log->debug('Statistics enabled');
2978 =head2 $c->registered_plugins
2980 Returns a sorted list of the plugins which have either been stated in the
2983 If passed a given plugin name, it will report a boolean value indicating
2984 whether or not that plugin is loaded. A fully qualified name is required if
2985 the plugin name does not begin with C<Catalyst::Plugin::>.
2987 if ($c->registered_plugins('Some::Plugin')) {
2995 sub registered_plugins {
2997 return sort keys %{ $proto->_plugins } unless @_;
2999 return 1 if exists $proto->_plugins->{$plugin};
3000 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3003 sub _register_plugin {
3004 my ( $proto, $plugin, $instant ) = @_;
3005 my $class = ref $proto || $proto;
3007 load_class( $plugin );
3008 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3009 if $plugin->isa( 'Catalyst::Component' );
3010 my $plugin_meta = Moose::Meta::Class->create($plugin);
3011 if (!$plugin_meta->has_method('new')
3012 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3013 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3015 if (!$instant && !$proto->_plugins->{$plugin}) {
3016 my $meta = Class::MOP::get_metaclass_by_name($class);
3017 $meta->superclasses($plugin, $meta->superclasses);
3019 $proto->_plugins->{$plugin} = 1;
3023 sub _default_plugins { return qw(Unicode::Encoding) }
3026 my ( $class, $plugins ) = @_;
3028 $class->_plugins( {} ) unless $class->_plugins;
3030 m/Unicode::Encoding/ ? do {
3032 'Unicode::Encoding plugin is auto-applied,'
3033 . ' please remove this from your appclass'
3034 . ' and make sure to define "encoding" config'
3036 unless (exists $class->config->{'encoding'}) {
3037 $class->config->{'encoding'} = 'UTF-8';
3042 push @$plugins, $class->_default_plugins;
3043 $plugins = Data::OptList::mkopt($plugins || []);
3046 [ Catalyst::Utils::resolve_namespace(
3047 $class . '::Plugin',
3048 'Catalyst::Plugin', $_->[0]
3054 for my $plugin ( reverse @plugins ) {
3055 load_class($plugin->[0], $plugin->[1]);
3056 my $meta = find_meta($plugin->[0]);
3057 next if $meta && $meta->isa('Moose::Meta::Role');
3059 $class->_register_plugin($plugin->[0]);
3063 map { $_->[0]->name, $_->[1] }
3064 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3065 map { [find_meta($_->[0]), $_->[1]] }
3068 Moose::Util::apply_all_roles(
3074 =head2 registered_middlewares
3076 Read only accessor that returns an array of all the middleware in the order
3077 that they were added (which is the REVERSE of the order they will be applied).
3079 The values returned will be either instances of L<Plack::Middleware> or of a
3080 compatible interface, or a coderef, which is assumed to be inlined middleware
3082 =head2 setup_middleware (?@middleware)
3084 Read configuration information stored in configuration key C<psgi_middleware> or
3087 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3088 to use it to enable L<Plack::Middleware>
3090 This method is automatically called during 'setup' of your application, so
3091 you really don't need to invoke it. However you may do so if you find the idea
3092 of loading middleware via configuration weird :). For example:
3098 __PACKAGE__->setup_middleware('Head');
3101 When we read middleware definitions from configuration, we reverse the list
3102 which sounds odd but is likely how you expect it to work if you have prior
3103 experience with L<Plack::Builder> or if you previously used the plugin
3104 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3108 sub registered_middlewares {
3110 if(my $middleware = $class->_psgi_middleware) {
3112 Plack::Middleware::HTTPExceptions->new,
3113 Plack::Middleware::RemoveRedundantBody->new,
3114 Plack::Middleware::FixMissingBodyInRedirect->new,
3115 Plack::Middleware::ContentLength->new,
3116 Plack::Middleware::MethodOverride->new,
3117 Plack::Middleware::Head->new,
3120 die "You cannot call ->registered_middlewares until middleware has been setup";
3124 sub setup_middleware {
3126 my @middleware_definitions = @_ ?
3127 @_ : reverse(@{$class->config->{'psgi_middleware'}||[]});
3129 my @middleware = ();
3130 while(my $next = shift(@middleware_definitions)) {
3132 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3133 push @middleware, $next;
3134 } elsif(ref $next eq 'CODE') {
3135 push @middleware, $next;
3136 } elsif(ref $next eq 'HASH') {
3137 my $namespace = shift @middleware_definitions;
3138 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3139 push @middleware, $mw;
3141 die "I can't handle middleware definition ${\ref $next}";
3144 my $mw = $class->Catalyst::Utils::build_middleware($next);
3145 push @middleware, $mw;
3149 my @existing = @{$class->_psgi_middleware || []};
3150 $class->_psgi_middleware([@middleware,@existing,]);
3153 =head2 registered_data_handlers
3155 A read only copy of registered Data Handlers returned as a Hash, where each key
3156 is a content type and each value is a subref that attempts to decode that content
3159 =head2 setup_data_handlers (?@data_handler)
3161 Read configuration information stored in configuration key C<data_handlers> or
3164 See under L</CONFIGURATION> information regarding C<data_handlers>.
3166 This method is automatically called during 'setup' of your application, so
3167 you really don't need to invoke it.
3169 =head2 default_data_handlers
3171 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3172 only two default data handlers, for 'application/json' and an alternative to
3173 'application/x-www-form-urlencoded' which supposed nested form parameters via
3174 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3176 The 'application/json' data handler is used to parse incoming JSON into a Perl
3177 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3178 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3179 JSON decoder, and has the smallest dependency impact.
3181 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3182 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3183 order to get the best performance. You should add either to your dependency
3184 list (Makefile.PL, dist.ini, cpanfile, etc.)
3188 sub registered_data_handlers {
3190 if(my $data_handlers = $class->_data_handlers) {
3191 return %$data_handlers;
3193 die "You cannot call ->registered_data_handlers until data_handers has been setup";
3197 sub setup_data_handlers {
3198 my ($class, %data_handler_callbacks) = @_;
3199 %data_handler_callbacks = (
3200 %{$class->default_data_handlers},
3201 %{$class->config->{'data_handlers'}||+{}},
3202 %data_handler_callbacks);
3204 $class->_data_handlers(\%data_handler_callbacks);
3207 sub default_data_handlers {
3210 'application/x-www-form-urlencoded' => sub {
3211 my ($fh, $req) = @_;
3212 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3213 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3214 ->can('build_cgi_struct')->($params);
3216 'application/json' => sub {
3217 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3218 ->can('decode_json')->(do { local $/; $_->getline });
3225 Returns an arrayref of the internal execution stack (actions that are
3226 currently executing).
3230 Returns the current timing statistics object. By default Catalyst uses
3231 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3232 L<< stats_class|/"$c->stats_class" >>.
3234 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3235 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3236 profile explicitly, although MyApp.pm still won't profile nor output anything
3239 =head2 $c->stats_class
3241 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3243 =head2 $c->use_stats
3245 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3247 Note that this is a static method, not an accessor and should be overridden
3248 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3255 =head2 $c->write( $data )
3257 Writes $data to the output stream. When using this method directly, you
3258 will need to manually set the C<Content-Length> header to the length of
3259 your output data, if known.
3266 # Finalize headers if someone manually writes output (for compat)
3267 $c->finalize_headers;
3269 return $c->response->write( @_ );
3274 Returns the Catalyst version number. Mostly useful for "powered by"
3275 messages in template systems.
3279 sub version { return $Catalyst::VERSION }
3281 =head1 CONFIGURATION
3283 There are a number of 'base' config variables which can be set:
3289 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3293 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3297 C<disable_component_resolution_regex_fallback> - Turns
3298 off the deprecated component resolution functionality so
3299 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3300 are called then regex search will not be attempted on string values and
3301 instead C<undef> will be returned.
3305 C<home> - The application home directory. In an uninstalled application,
3306 this is the top level application directory. In an installed application,
3307 this will be the directory containing C<< MyApp.pm >>.
3311 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3315 C<name> - The name of the application in debug messages and the debug and
3320 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3321 until it is accessed. This allows you to (for example) check authentication (and reject
3322 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3326 C<root> - The root directory for templates. Usually this is just a
3327 subdirectory of the home directory, but you can set it to change the
3328 templates to a different directory.
3332 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3333 namespaces from which components will be loaded (and constructed and stored in
3334 C<< $c->components >>).
3338 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3339 to be shown in hit debug tables in the test server.
3343 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3344 variable should be used for determining the request path.
3346 Most web server environments pass the requested path to the application using environment variables,
3347 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3348 exposed as C<< $c->request->base >>) and the request path below that base.
3350 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3351 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3355 =item use_request_uri_for_path => 0
3357 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3358 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3359 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3360 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3362 However this method has the major disadvantage that it is impossible to correctly decode some elements
3363 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3364 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3365 can't distinguish / vs %2F in paths (in addition to other encoded values).
3367 =item use_request_uri_for_path => 1
3369 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3370 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3371 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3373 Given that this method of path resolution is provably more correct, it is recommended that you use
3374 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3375 aware of the implications of not being able to handle encoded URI paths correctly.
3377 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3378 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3379 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3380 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3381 C<< $c->request->base >> will be incorrect.
3387 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3391 C<encoding> - See L</ENCODING>
3395 C<abort_chain_on_error_fix>
3397 When there is an error in an action chain, the default behavior is to continue
3398 processing the remaining actions and then catch the error upon chain end. This
3399 can lead to running actions when the application is in an unexpected state. If
3400 you have this issue, setting this config value to true will promptly exit a
3401 chain when there is an error raised in any action (thus terminating the chain
3406 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3408 In the future this might become the default behavior.
3412 C<use_hash_multivalue_in_request>
3414 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3415 and C<parameters> return a hashref where values might be scalar or an arrayref
3416 depending on the incoming data. In many cases this can be undesirable as it
3417 leads one to writing defensive code like the following:
3419 my ($val) = ref($c->req->parameters->{a}) ?
3420 @{$c->req->parameters->{a}} :
3421 $c->req->parameters->{a};
3423 Setting this configuration item to true will make L<Catalyst> populate the
3424 attributes underlying these methods with an instance of L<Hash::MultiValue>
3425 which is used by L<Plack::Request> and others to solve this very issue. You
3426 may prefer this behavior to the default, if so enable this option (be warned
3427 if you enable it in a legacy application we are not sure if it is completely
3428 backwardly compatible).
3432 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3436 C<data_handlers> - See L<DATA HANDLERS>.
3442 Generally when you throw an exception inside an Action (or somewhere in
3443 your stack, such as in a model that an Action is calling) that exception
3444 is caught by Catalyst and unless you either catch it yourself (via eval
3445 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
3446 will eventually reach L</finalize_errors> and return either the debugging
3447 error stack page, or the default error page. However, if your exception
3448 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
3449 instead rethrow it so that it can be handled by that middleware (which
3450 is part of the default middleware). For example this would allow
3452 use HTTP::Throwable::Factory 'http_throw';
3454 sub throws_exception :Local {
3455 my ($self, $c) = @_;
3457 http_throw(SeeOther => { location =>
3458 $c->uri_for($self->action_for('redirect')) });
3462 =head1 INTERNAL ACTIONS
3464 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3465 C<_ACTION>, and C<_END>. These are by default not shown in the private
3466 action table, but you can make them visible with a config parameter.
3468 MyApp->config(show_internal_actions => 1);
3470 =head1 ON-DEMAND PARSER
3472 The request body is usually parsed at the beginning of a request,
3473 but if you want to handle input yourself, you can enable on-demand
3474 parsing with a config parameter.
3476 MyApp->config(parse_on_demand => 1);
3478 =head1 PROXY SUPPORT
3480 Many production servers operate using the common double-server approach,
3481 with a lightweight frontend web server passing requests to a larger
3482 backend server. An application running on the backend server must deal
3483 with two problems: the remote user always appears to be C<127.0.0.1> and
3484 the server's hostname will appear to be C<localhost> regardless of the
3485 virtual host that the user connected through.
3487 Catalyst will automatically detect this situation when you are running
3488 the frontend and backend servers on the same machine. The following
3489 changes are made to the request.
3491 $c->req->address is set to the user's real IP address, as read from
3492 the HTTP X-Forwarded-For header.
3494 The host value for $c->req->base and $c->req->uri is set to the real
3495 host, as read from the HTTP X-Forwarded-Host header.
3497 Additionally, you may be running your backend application on an insecure
3498 connection (port 80) while your frontend proxy is running under SSL. If there
3499 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3500 tell Catalyst what port the frontend listens on. This will allow all URIs to
3501 be created properly.
3503 In the case of passing in:
3505 X-Forwarded-Port: 443
3507 All calls to C<uri_for> will result in an https link, as is expected.
3509 Obviously, your web server must support these headers for this to work.
3511 In a more complex server farm environment where you may have your
3512 frontend proxy server(s) on different machines, you will need to set a
3513 configuration option to tell Catalyst to read the proxied data from the
3516 MyApp->config(using_frontend_proxy => 1);
3518 If you do not wish to use the proxy support at all, you may set:
3520 MyApp->config(ignore_frontend_proxy => 0);
3522 =head2 Note about psgi files
3524 Note that if you supply your own .psgi file, calling
3525 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3527 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3528 in your psgi, for example:
3531 enable "Plack::Middleware::ReverseProxy";
3535 This will unconditionally add the ReverseProxy support, or you need to call
3536 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3537 apply the support depending upon your config).
3539 See L<Catalyst::PSGI> for more information.
3541 =head1 THREAD SAFETY
3543 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3544 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3545 believe the Catalyst core to be thread-safe.
3547 If you plan to operate in a threaded environment, remember that all other
3548 modules you are using must also be thread-safe. Some modules, most notably
3549 L<DBD::SQLite>, are not thread-safe.
3551 =head1 DATA HANDLERS
3553 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3554 form parameters and URL search query fields. However it has become common
3555 for various alternative content types to be PUT or POSTed to your controllers
3556 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3557 XML and other content types when communicating with an application server. In
3558 order to better support this use case, L<Catalyst> defines a global configuration
3559 option, C<data_handlers>, which lets you associate a content type with a coderef
3560 that parses that content type into something Perl can readily access.
3567 __PACKAGE__->config(
3569 'application/json' => sub { local $/; decode_json $_->getline },
3571 ## Any other configuration.
3576 By default L<Catalyst> comes with a generic JSON data handler similar to the
3577 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3578 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3579 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3580 or dist.ini, cpanfile, etc.)
3582 The C<data_handlers> configuation is a hashref whose keys are HTTP Content-Types
3583 (matched against the incoming request type using a regexp such as to be case
3584 insensitive) and whose values are coderefs that receive a localized version of
3585 C<$_> which is a filehandle object pointing to received body.
3587 This feature is considered an early access release and we reserve the right
3588 to alter the interface in order to provide a performant and secure solution to
3589 alternative request body content. Your reports welcomed!
3591 =head1 PSGI MIDDLEWARE
3593 You can define middleware, defined as L<Plack::Middleware> or a compatible
3594 interface in configuration. Your middleware definitions are in the form of an
3595 arrayref under the configuration key C<psgi_middleware>. Here's an example
3596 with details to follow:
3601 use Plack::Middleware::StackTrace;
3603 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3605 __PACKAGE__->config(
3606 'psgi_middleware', [
3609 $stacktrace_middleware,
3610 'Session' => {store => 'File'},
3615 $env->{myapp.customkey} = 'helloworld';
3624 So the general form is:
3626 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3628 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3629 the order listed (to make it function similarly to L<Plack::Builder>:
3631 Alternatively, you may also define middleware by calling the L</setup_middleware>
3638 __PACKAGE__->setup_middleware( \@middleware_definitions);
3641 In the case where you do both (use 'setup_middleware' and configuration) the
3642 package call to setup_middleware will be applied earlier (in other words its
3643 middleware will wrap closer to the application). Keep this in mind since in
3644 some cases the order of middleware is important.
3646 The two approaches are not exclusive.
3650 =item Middleware Object
3652 An already initialized object that conforms to the L<Plack::Middleware>
3655 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3657 __PACKAGE__->config(
3658 'psgi_middleware', [
3659 $stacktrace_middleware,
3665 A coderef that is an inlined middleware:
3667 __PACKAGE__->config(
3668 'psgi_middleware', [
3673 if($env->{PATH_INFO} =~m/forced/) {
3675 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3678 return $app->($env);
3688 We assume the scalar refers to a namespace after normalizing it using the
3691 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3692 is assumed to be 'as is', and we just install and use the middleware.
3694 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3695 (the package name of your Catalyst application subclass), we also assume then
3696 that it is a full namespace, and use it.
3698 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3699 resolve it first by looking for it under your application namespace (for example
3700 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3701 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3702 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3703 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3704 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3705 you find that a good idea.
3711 __PACKAGE__->config(
3712 'psgi_middleware', [
3713 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3714 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3715 '+MyApp::Custom', ## MyApp::Custom->wrap
3719 =item a scalar followed by a hashref
3721 Just like the previous, except the following C<HashRef> is used as arguments
3722 to initialize the middleware object.
3724 __PACKAGE__->config(
3725 'psgi_middleware', [
3726 'Session' => {store => 'File'},
3731 Please see L<PSGI> for more on middleware.
3735 On request, decodes all params from encoding into a sequence of
3736 logical characters. On response, encodes body into encoding.
3744 Returns an instance of an C<Encode> encoding
3746 print $c->encoding->name
3748 =item handle_unicode_encoding_exception ($exception_context)
3750 Method called when decoding process for a request fails.
3752 An C<$exception_context> hashref is provided to allow you to override the
3753 behaviour of your application when given data with incorrect encodings.
3755 The default method throws exceptions in the case of invalid request parameters
3756 (resulting in a 500 error), but ignores errors in upload filenames.
3758 The keys passed in the C<$exception_context> hash are:
3764 The value which was not able to be decoded.
3768 The exception received from L<Encode>.
3772 What type of data was being decoded. Valid values are (currently)
3773 C<params> - for request parameters / arguments / captures
3774 and C<uploads> - for request upload filenames.
3784 Join #catalyst on irc.perl.org.
3788 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3789 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3793 http://catalyst.perl.org
3797 http://dev.catalyst.perl.org
3801 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3803 =head2 L<Catalyst::Manual> - The Catalyst Manual
3805 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3807 =head2 L<Catalyst::Engine> - Core engine
3809 =head2 L<Catalyst::Log> - Log class.
3811 =head2 L<Catalyst::Request> - Request object
3813 =head2 L<Catalyst::Response> - Response object
3815 =head2 L<Catalyst::Test> - The test suite.
3817 =head1 PROJECT FOUNDER
3819 sri: Sebastian Riedel <sri@cpan.org>
3825 acme: Leon Brocard <leon@astray.com>
3827 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3831 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3835 andyg: Andy Grundman <andy@hybridized.org>
3837 audreyt: Audrey Tang
3839 bricas: Brian Cassidy <bricas@cpan.org>
3841 Caelum: Rafael Kitover <rkitover@io.com>
3843 chansen: Christian Hansen
3845 chicks: Christopher Hicks
3847 Chisel Wright C<pause@herlpacker.co.uk>
3849 Danijel Milicevic C<me@danijel.de>
3851 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3853 David Naughton, C<naughton@umn.edu>
3857 dhoss: Devin Austin <dhoss@cpan.org>
3859 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3863 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3865 esskar: Sascha Kiefer
3867 fireartist: Carl Franks <cfranks@cpan.org>
3869 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3871 gabb: Danijel Milicevic
3875 Gavin Henry C<ghenry@perl.me.uk>
3879 groditi: Guillermo Roditi <groditi@gmail.com>
3881 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3883 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3885 jcamacho: Juan Camacho
3887 jester: Jesse Sheidlower C<jester@panix.com>
3889 jhannah: Jay Hannah <jay@jays.net>
3895 jon: Jon Schutz <jjschutz@cpan.org>
3897 Jonathan Rockway C<< <jrockway@cpan.org> >>
3899 Kieren Diment C<kd@totaldatasolution.com>
3901 konobi: Scott McWhirter <konobi@cpan.org>
3903 marcus: Marcus Ramberg <mramberg@cpan.org>
3905 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3907 mgrimes: Mark Grimes <mgrimes@cpan.org>
3909 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3913 naughton: David Naughton
3915 ningu: David Kamholz <dkamholz@cpan.org>
3917 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3919 numa: Dan Sully <daniel@cpan.org>
3925 omega: Andreas Marienborg
3927 Oleg Kostyuk <cub.uanic@gmail.com>
3929 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3931 rafl: Florian Ragwitz <rafl@debian.org>
3933 random: Roland Lammel <lammel@cpan.org>
3935 Robert Sedlacek C<< <rs@474.at> >>
3937 SpiceMan: Marcel Montes
3941 szbalint: Balint Szilakszi <szbalint@cpan.org>
3943 t0m: Tomas Doran <bobtfish@bobtfish.net>
3947 Viljo Marrandi C<vilts@yahoo.com>
3949 Will Hawes C<info@whawes.co.uk>
3951 willert: Sebastian Willert <willert@cpan.org>
3953 wreis: Wallace Reis <wreis@cpan.org>
3955 Yuval Kogman, C<nothingmuch@woobling.org>
3957 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3959 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3961 Upasana <me@upasana.me>
3965 Copyright (c) 2005-2014, the above named PROJECT FOUNDER and CONTRIBUTORS.
3969 This library is free software. You can redistribute it and/or modify it under
3970 the same terms as Perl itself.
3976 __PACKAGE__->meta->make_immutable;