4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Moose::Util 'find_meta';
39 use Plack::Middleware::Conditional;
40 use Plack::Middleware::ReverseProxy;
41 use Plack::Middleware::IIS6ScriptNameFix;
42 use Plack::Middleware::IIS7KeepAliveFix;
43 use Plack::Middleware::LighttpdScriptNameFix;
44 use Plack::Middleware::ContentLength;
45 use Plack::Middleware::Head;
46 use Plack::Middleware::HTTPExceptions;
47 use Plack::Middleware::FixMissingBodyInRedirect;
48 use Plack::Middleware::MethodOverride;
49 use Plack::Middleware::RemoveRedundantBody;
50 use Catalyst::Middleware::Stash;
52 use Class::Load 'load_class';
54 BEGIN { require 5.008003; }
56 has stack => (is => 'ro', default => sub { [] });
57 has state => (is => 'rw', default => 0);
58 has stats => (is => 'rw');
59 has action => (is => 'rw');
60 has counter => (is => 'rw', default => sub { {} });
65 $self->request_class->new($self->_build_request_constructor_args);
69 sub _build_request_constructor_args {
71 my %p = ( _log => $self->log );
72 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
73 $p{data_handlers} = {$self->registered_data_handlers};
74 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
75 if $self->config->{use_hash_multivalue_in_request};
83 $self->response_class->new($self->_build_response_constructor_args);
87 sub _build_response_constructor_args {
89 { _log => $self->log };
92 has namespace => (is => 'rw');
94 sub depth { scalar @{ shift->stack || [] }; }
95 sub comp { shift->component(@_) }
98 my $self = shift; return $self->request(@_);
101 my $self = shift; return $self->response(@_);
104 # For backwards compatibility
105 sub finalize_output { shift->finalize_body(@_) };
110 our $RECURSION = 1000;
111 our $DETACH = Catalyst::Exception::Detach->new;
112 our $GO = Catalyst::Exception::Go->new;
114 #I imagine that very few of these really need to be class variables. if any.
115 #maybe we should just make them attributes with a default?
116 __PACKAGE__->mk_classdata($_)
117 for qw/components arguments dispatcher engine log dispatcher_class
118 engine_loader context_class request_class response_class stats_class
119 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
122 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
123 __PACKAGE__->request_class('Catalyst::Request');
124 __PACKAGE__->response_class('Catalyst::Response');
125 __PACKAGE__->stats_class('Catalyst::Stats');
127 # Remember to update this in Catalyst::Runtime as well!
129 our $VERSION = '5.90069_002';
132 my ( $class, @arguments ) = @_;
134 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
136 return unless $class eq 'Catalyst';
138 my $caller = caller();
139 return if $caller eq 'main';
141 my $meta = Moose::Meta::Class->initialize($caller);
142 unless ( $caller->isa('Catalyst') ) {
143 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
144 $meta->superclasses(@superclasses);
146 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
147 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
149 unless( $meta->has_method('meta') ){
150 if ($Moose::VERSION >= 1.15) {
151 $meta->_add_meta_method('meta');
154 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
158 $caller->arguments( [@arguments] );
162 sub _application { $_[0] }
168 Catalyst - The Elegant MVC Web Application Framework
172 See the L<Catalyst::Manual> distribution for comprehensive
173 documentation and tutorials.
175 # Install Catalyst::Devel for helpers and other development tools
176 # use the helper to create a new application
179 # add models, views, controllers
180 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
181 script/myapp_create.pl view MyTemplate TT
182 script/myapp_create.pl controller Search
184 # built in testserver -- use -r to restart automatically on changes
185 # --help to see all available options
186 script/myapp_server.pl
188 # command line testing interface
189 script/myapp_test.pl /yada
192 use Catalyst qw/-Debug/; # include plugins here as well
194 ### In lib/MyApp/Controller/Root.pm (autocreated)
195 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
196 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
197 $c->stash->{template} = 'foo.tt'; # set the template
198 # lookup something from db -- stash vars are passed to TT
200 $c->model('Database::Foo')->search( { country => $args[0] } );
201 if ( $c->req->params->{bar} ) { # access GET or POST parameters
202 $c->forward( 'bar' ); # process another action
203 # do something else after forward returns
207 # The foo.tt TT template can use the stash data from the database
208 [% WHILE (item = data.next) %]
212 # called for /bar/of/soap, /bar/of/soap/10, etc.
213 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
215 # called after all actions are finished
217 my ( $self, $c ) = @_;
218 if ( scalar @{ $c->error } ) { ... } # handle errors
219 return if $c->res->body; # already have a response
220 $c->forward( 'MyApp::View::TT' ); # render template
223 See L<Catalyst::Manual::Intro> for additional information.
227 Catalyst is a modern framework for making web applications without the
228 pain usually associated with this process. This document is a reference
229 to the main Catalyst application. If you are a new user, we suggest you
230 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
232 See L<Catalyst::Manual> for more documentation.
234 Catalyst plugins can be loaded by naming them as arguments to the "use
235 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
236 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
239 use Catalyst qw/My::Module/;
241 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
242 fully qualify the name by using a unary plus:
246 +Fully::Qualified::Plugin::Name
249 Special flags like C<-Debug> can also be specified as
250 arguments when Catalyst is loaded:
252 use Catalyst qw/-Debug My::Module/;
254 The position of plugins and flags in the chain is important, because
255 they are loaded in the order in which they appear.
257 The following flags are supported:
261 Enables debug output. You can also force this setting from the system
262 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
263 settings override the application, with <MYAPP>_DEBUG having the highest
266 This sets the log level to 'debug' and enables full debug output on the
267 error screen. If you only want the latter, see L<< $c->debug >>.
271 Forces Catalyst to use a specific home directory, e.g.:
273 use Catalyst qw[-Home=/usr/mst];
275 This can also be done in the shell environment by setting either the
276 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
277 is replaced with the uppercased name of your application, any "::" in
278 the name will be replaced with underscores, e.g. MyApp::Web should use
279 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
281 If none of these are set, Catalyst will attempt to automatically detect the
282 home directory. If you are working in a development environment, Catalyst
283 will try and find the directory containing either Makefile.PL, Build.PL,
284 dist.ini, or cpanfile. If the application has been installed into the system
285 (i.e. you have done C<make install>), then Catalyst will use the path to your
286 application module, without the .pm extension (e.g., /foo/MyApp if your
287 application was installed at /foo/MyApp.pm)
291 use Catalyst '-Log=warn,fatal,error';
293 Specifies a comma-delimited list of log levels.
297 Enables statistics collection and reporting.
299 use Catalyst qw/-Stats=1/;
301 You can also force this setting from the system environment with CATALYST_STATS
302 or <MYAPP>_STATS. The environment settings override the application, with
303 <MYAPP>_STATS having the highest priority.
305 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
309 =head2 INFORMATION ABOUT THE CURRENT REQUEST
313 Returns a L<Catalyst::Action> object for the current action, which
314 stringifies to the action name. See L<Catalyst::Action>.
318 Returns the namespace of the current action, i.e., the URI prefix
319 corresponding to the controller of the current action. For example:
321 # in Controller::Foo::Bar
322 $c->namespace; # returns 'foo/bar';
328 Returns the current L<Catalyst::Request> object, giving access to
329 information about the current client request (including parameters,
330 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
332 =head2 REQUEST FLOW HANDLING
334 =head2 $c->forward( $action [, \@arguments ] )
336 =head2 $c->forward( $class, $method, [, \@arguments ] )
338 This is one way of calling another action (method) in the same or
339 a different controller. You can also use C<< $self->my_method($c, @args) >>
340 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
341 in a different controller.
342 The main difference is that 'forward' uses some of the Catalyst request
343 cycle overhead, including debugging, which may be useful to you. On the
344 other hand, there are some complications to using 'forward', restrictions
345 on values returned from 'forward', and it may not handle errors as you prefer.
346 Whether you use 'forward' or not is up to you; it is not considered superior to
347 the other ways to call a method.
349 'forward' calls another action, by its private name. If you give a
350 class name but no method, C<process()> is called. You may also optionally
351 pass arguments in an arrayref. The action will receive the arguments in
352 C<@_> and C<< $c->req->args >>. Upon returning from the function,
353 C<< $c->req->args >> will be restored to the previous values.
355 Any data C<return>ed from the action forwarded to, will be returned by the
358 my $foodata = $c->forward('/foo');
359 $c->forward('index');
360 $c->forward(qw/Model::DBIC::Foo do_stuff/);
361 $c->forward('View::TT');
363 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
364 an C<< eval { } >> around the call (actually
365 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
366 exceptions thrown by the called action non-fatal and pushing them onto
367 $c->error instead. If you want C<die> to propagate you need to do something
371 die join "\n", @{ $c->error } if @{ $c->error };
373 Or make sure to always return true values from your actions and write
376 $c->forward('foo') || return;
378 Another note is that C<< $c->forward >> always returns a scalar because it
379 actually returns $c->state which operates in a scalar context.
380 Thus, something like:
384 in an action that is forwarded to is going to return a scalar,
385 i.e. how many items are in that array, which is probably not what you want.
386 If you need to return an array then return a reference to it,
389 $c->stash->{array} = \@array;
391 and access it from the stash.
393 Keep in mind that the C<end> method used is that of the caller action. So a C<$c-E<gt>detach> inside a forwarded action would run the C<end> method from the original action requested.
397 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
399 =head2 $c->detach( $action [, \@arguments ] )
401 =head2 $c->detach( $class, $method, [, \@arguments ] )
405 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
406 doesn't return to the previous action when processing is finished.
408 When called with no arguments it escapes the processing chain entirely.
412 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
414 =head2 $c->visit( $action [, \@arguments ] )
416 =head2 $c->visit( $action [, \@captures, \@arguments ] )
418 =head2 $c->visit( $class, $method, [, \@arguments ] )
420 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
422 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
423 but does a full dispatch, instead of just calling the new C<$action> /
424 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
425 you go to are called, just like a new request.
427 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
428 This means, for example, that C<< $c->action >> methods such as
429 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
430 L<reverse|Catalyst::Action/reverse> return information for the visited action
431 when they are invoked within the visited action. This is different from the
432 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
433 continues to use the $c->action object from the caller action even when
434 invoked from the called action.
436 C<< $c->stash >> is kept unchanged.
438 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
439 allows you to "wrap" another action, just as it would have been called by
440 dispatching from a URL, while the analogous
441 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
442 transfer control to another action as if it had been reached directly from a URL.
446 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
448 =head2 $c->go( $action [, \@arguments ] )
450 =head2 $c->go( $action [, \@captures, \@arguments ] )
452 =head2 $c->go( $class, $method, [, \@arguments ] )
454 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
456 The relationship between C<go> and
457 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
458 the relationship between
459 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
460 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
461 C<< $c->go >> will perform a full dispatch on the specified action or method,
462 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
463 C<go> escapes the processing of the current request chain on completion, and
464 does not return to its caller.
466 @arguments are arguments to the final destination of $action. @captures are
467 arguments to the intermediate steps, if any, on the way to the final sub of
472 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
478 Returns the current L<Catalyst::Response> object, see there for details.
482 Returns a hashref to the stash, which may be used to store data and pass
483 it between components during a request. You can also set hash keys by
484 passing arguments. The stash is automatically sent to the view. The
485 stash is cleared at the end of a request; it cannot be used for
486 persistent storage (for this you must use a session; see
487 L<Catalyst::Plugin::Session> for a complete system integrated with
490 $c->stash->{foo} = $bar;
491 $c->stash( { moose => 'majestic', qux => 0 } );
492 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
494 # stash is automatically passed to the view for use in a template
495 $c->forward( 'MyApp::View::TT' );
501 my $stash = Catalyst::Middleware::Stash->get($c->req->env);
503 my $new_stash = @_ > 1 ? {@_} : $_[0];
504 croak('stash takes a hash or hashref') unless ref $new_stash;
505 foreach my $key ( keys %$new_stash ) {
506 $stash->{$key} = $new_stash->{$key};
514 =head2 $c->error($error, ...)
516 =head2 $c->error($arrayref)
518 Returns an arrayref containing error messages. If Catalyst encounters an
519 error while processing a request, it stores the error in $c->error. This
520 method should only be used to store fatal error messages.
522 my @error = @{ $c->error };
526 $c->error('Something bad happened');
533 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
534 croak @$error unless ref $c;
535 push @{ $c->{error} }, @$error;
537 elsif ( defined $_[0] ) { $c->{error} = undef }
538 return $c->{error} || [];
544 Contains the return value of the last executed action.
545 Note that << $c->state >> operates in a scalar context which means that all
546 values it returns are scalar.
548 =head2 $c->clear_errors
550 Clear errors. You probably don't want to clear the errors unless you are
551 implementing a custom error screen.
553 This is equivalent to running
564 =head2 $c->has_errors
566 Returns true if you have errors
570 sub has_errors { scalar(@{shift->error}) ? 1:0 }
572 sub _comp_search_prefixes {
574 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
577 # search components given a name and some prefixes
578 sub _comp_names_search_prefixes {
579 my ( $c, $name, @prefixes ) = @_;
580 my $appclass = ref $c || $c;
581 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
582 $filter = qr/$filter/; # Compile regex now rather than once per loop
584 # map the original component name to the sub part that we will search against
585 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
586 grep { /$filter/ } keys %{ $c->components };
588 # undef for a name will return all
589 return keys %eligible if !defined $name;
591 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
592 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
594 return @result if @result;
596 # if we were given a regexp to search against, we're done.
597 return if $name->$_isa('Regexp');
599 # skip regexp fallback if configured
601 if $appclass->config->{disable_component_resolution_regex_fallback};
605 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
607 # no results? try against full names
609 @result = grep { m{$query} } keys %eligible;
612 # don't warn if we didn't find any results, it just might not exist
614 # Disgusting hack to work out correct method name
615 my $warn_for = lc $prefixes[0];
616 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
617 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
618 "component resolution is unreliable and unsafe.";
619 my $short = $result[0];
620 # remove the component namespace prefix
621 $short =~ s/.*?(Model|Controller|View):://;
622 my $shortmess = Carp::shortmess('');
623 if ($shortmess =~ m#Catalyst/Plugin#) {
624 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
626 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
627 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
628 "component's config";
630 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
631 "but if you really wanted to search, pass in a regexp as the argument " .
632 "like so: \$c->${warn_for}(qr/${name}/)";
634 $c->log->warn( "${msg}$shortmess" );
640 # Find possible names for a prefix
642 my ( $c, @prefixes ) = @_;
643 my $appclass = ref $c || $c;
645 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
647 my @names = map { s{$filter}{}; $_; }
648 $c->_comp_names_search_prefixes( undef, @prefixes );
653 # Filter a component before returning by calling ACCEPT_CONTEXT if available
654 sub _filter_component {
655 my ( $c, $comp, @args ) = @_;
657 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
658 return $comp->ACCEPT_CONTEXT( $c, @args );
664 =head2 COMPONENT ACCESSORS
666 =head2 $c->controller($name)
668 Gets a L<Catalyst::Controller> instance by name.
670 $c->controller('Foo')->do_stuff;
672 If the name is omitted, will return the controller for the dispatched
675 If you want to search for controllers, pass in a regexp as the argument.
677 # find all controllers that start with Foo
678 my @foo_controllers = $c->controller(qr{^Foo});
684 my ( $c, $name, @args ) = @_;
686 my $appclass = ref($c) || $c;
688 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
689 my $comps = $c->components;
690 my $check = $appclass."::Controller::".$name;
691 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
693 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
694 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
695 return $c->_filter_component( $result[ 0 ], @args );
698 return $c->component( $c->action->class );
701 =head2 $c->model($name)
703 Gets a L<Catalyst::Model> instance by name.
705 $c->model('Foo')->do_stuff;
707 Any extra arguments are directly passed to ACCEPT_CONTEXT.
709 If the name is omitted, it will look for
710 - a model object in $c->stash->{current_model_instance}, then
711 - a model name in $c->stash->{current_model}, then
712 - a config setting 'default_model', or
713 - check if there is only one model, and return it if that's the case.
715 If you want to search for models, pass in a regexp as the argument.
717 # find all models that start with Foo
718 my @foo_models = $c->model(qr{^Foo});
723 my ( $c, $name, @args ) = @_;
724 my $appclass = ref($c) || $c;
726 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
727 my $comps = $c->components;
728 my $check = $appclass."::Model::".$name;
729 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
731 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
732 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
733 return $c->_filter_component( $result[ 0 ], @args );
737 return $c->stash->{current_model_instance}
738 if $c->stash->{current_model_instance};
739 return $c->model( $c->stash->{current_model} )
740 if $c->stash->{current_model};
742 return $c->model( $appclass->config->{default_model} )
743 if $appclass->config->{default_model};
745 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
748 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
749 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
750 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
751 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
752 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
755 return $c->_filter_component( $comp );
759 =head2 $c->view($name)
761 Gets a L<Catalyst::View> instance by name.
763 $c->view('Foo')->do_stuff;
765 Any extra arguments are directly passed to ACCEPT_CONTEXT.
767 If the name is omitted, it will look for
768 - a view object in $c->stash->{current_view_instance}, then
769 - a view name in $c->stash->{current_view}, then
770 - a config setting 'default_view', or
771 - check if there is only one view, and return it if that's the case.
773 If you want to search for views, pass in a regexp as the argument.
775 # find all views that start with Foo
776 my @foo_views = $c->view(qr{^Foo});
781 my ( $c, $name, @args ) = @_;
783 my $appclass = ref($c) || $c;
785 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
786 my $comps = $c->components;
787 my $check = $appclass."::View::".$name;
788 if( exists $comps->{$check} ) {
789 return $c->_filter_component( $comps->{$check}, @args );
792 $c->log->warn( "Attempted to use view '$check', but does not exist" );
795 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
796 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
797 return $c->_filter_component( $result[ 0 ], @args );
801 return $c->stash->{current_view_instance}
802 if $c->stash->{current_view_instance};
803 return $c->view( $c->stash->{current_view} )
804 if $c->stash->{current_view};
806 return $c->view( $appclass->config->{default_view} )
807 if $appclass->config->{default_view};
809 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
812 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
813 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
814 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
815 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
816 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
819 return $c->_filter_component( $comp );
822 =head2 $c->controllers
824 Returns the available names which can be passed to $c->controller
830 return $c->_comp_names(qw/Controller C/);
835 Returns the available names which can be passed to $c->model
841 return $c->_comp_names(qw/Model M/);
847 Returns the available names which can be passed to $c->view
853 return $c->_comp_names(qw/View V/);
856 =head2 $c->comp($name)
858 =head2 $c->component($name)
860 Gets a component object by name. This method is not recommended,
861 unless you want to get a specific component by full
862 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
863 should be used instead.
865 If C<$name> is a regexp, a list of components matched against the full
866 component name will be returned.
868 If Catalyst can't find a component by name, it will fallback to regex
869 matching by default. To disable this behaviour set
870 disable_component_resolution_regex_fallback to a true value.
872 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
877 my ( $c, $name, @args ) = @_;
880 my $comps = $c->components;
883 # is it the exact name?
884 return $c->_filter_component( $comps->{ $name }, @args )
885 if exists $comps->{ $name };
887 # perhaps we just omitted "MyApp"?
888 my $composed = ( ref $c || $c ) . "::${name}";
889 return $c->_filter_component( $comps->{ $composed }, @args )
890 if exists $comps->{ $composed };
892 # search all of the models, views and controllers
893 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
894 return $c->_filter_component( $comp, @args ) if $comp;
898 if $c->config->{disable_component_resolution_regex_fallback};
900 # This is here so $c->comp( '::M::' ) works
901 my $query = ref $name ? $name : qr{$name}i;
903 my @result = grep { m{$query} } keys %{ $c->components };
904 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
907 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
908 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
909 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
910 return $c->_filter_component( $result[ 0 ], @args );
913 # I would expect to return an empty list here, but that breaks back-compat
917 return sort keys %{ $c->components };
920 =head2 CLASS DATA AND HELPER CLASSES
924 Returns or takes a hashref containing the application's configuration.
926 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
928 You can also use a C<YAML>, C<XML> or L<Config::General> config file
929 like C<myapp.conf> in your applications home directory. See
930 L<Catalyst::Plugin::ConfigLoader>.
932 =head3 Cascading configuration
934 The config method is present on all Catalyst components, and configuration
935 will be merged when an application is started. Configuration loaded with
936 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
937 followed by configuration in your top level C<MyApp> class. These two
938 configurations are merged, and then configuration data whose hash key matches a
939 component name is merged with configuration for that component.
941 The configuration for a component is then passed to the C<new> method when a
942 component is constructed.
946 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
947 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
949 will mean that C<MyApp::Model::Foo> receives the following data when
952 MyApp::Model::Foo->new({
958 It's common practice to use a Moose attribute
959 on the receiving component to access the config value.
961 package MyApp::Model::Foo;
965 # this attr will receive 'baz' at construction time
971 You can then get the value 'baz' by calling $c->model('Foo')->bar
972 (or $self->bar inside code in the model).
974 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
975 as a way of reading config within your code, as this B<will not> give you the
976 correctly merged config back. You B<MUST> take the config values supplied to
977 the constructor and use those instead.
981 around config => sub {
985 croak('Setting config after setup has been run is not allowed.')
986 if ( @_ and $c->setup_finished );
993 Returns the logging object instance. Unless it is already set, Catalyst
994 sets this up with a L<Catalyst::Log> object. To use your own log class,
995 set the logger with the C<< __PACKAGE__->log >> method prior to calling
996 C<< __PACKAGE__->setup >>.
998 __PACKAGE__->log( MyLogger->new );
1003 $c->log->info( 'Now logging with my own logger!' );
1005 Your log class should implement the methods described in
1011 Returns 1 if debug mode is enabled, 0 otherwise.
1013 You can enable debug mode in several ways:
1017 =item By calling myapp_server.pl with the -d flag
1019 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1021 =item The -Debug option in your MyApp.pm
1023 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1027 The first three also set the log level to 'debug'.
1029 Calling C<< $c->debug(1) >> has no effect.
1035 =head2 $c->dispatcher
1037 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1041 Returns the engine instance. See L<Catalyst::Engine>.
1044 =head2 UTILITY METHODS
1046 =head2 $c->path_to(@path)
1048 Merges C<@path> with C<< $c->config->{home} >> and returns a
1049 L<Path::Class::Dir> object. Note you can usually use this object as
1050 a filename, but sometimes you will have to explicitly stringify it
1051 yourself by calling the C<< ->stringify >> method.
1055 $c->path_to( 'db', 'sqlite.db' );
1060 my ( $c, @path ) = @_;
1061 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1062 if ( -d $path ) { return $path }
1063 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1067 my ( $class, $name, $plugin, @args ) = @_;
1069 # See block comment in t/unit_core_plugin.t
1070 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1072 $class->_register_plugin( $plugin, 1 );
1074 eval { $plugin->import };
1075 $class->mk_classdata($name);
1077 eval { $obj = $plugin->new(@args) };
1080 Catalyst::Exception->throw( message =>
1081 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1084 $class->$name($obj);
1085 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1091 Initializes the dispatcher and engine, loads any plugins, and loads the
1092 model, view, and controller components. You may also specify an array
1093 of plugins to load here, if you choose to not load them in the C<use
1097 MyApp->setup( qw/-Debug/ );
1099 B<Note:> You B<should not> wrap this method with method modifiers
1100 or bad things will happen - wrap the C<setup_finalize> method instead.
1105 my ( $class, @arguments ) = @_;
1106 croak('Running setup more than once')
1107 if ( $class->setup_finished );
1109 unless ( $class->isa('Catalyst') ) {
1111 Catalyst::Exception->throw(
1112 message => qq/'$class' does not inherit from Catalyst/ );
1115 if ( $class->arguments ) {
1116 @arguments = ( @arguments, @{ $class->arguments } );
1122 foreach (@arguments) {
1126 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1128 elsif (/^-(\w+)=?(.*)$/) {
1129 $flags->{ lc $1 } = $2;
1132 push @{ $flags->{plugins} }, $_;
1136 $class->setup_home( delete $flags->{home} );
1138 $class->setup_log( delete $flags->{log} );
1139 $class->setup_plugins( delete $flags->{plugins} );
1141 $class->setup_data_handlers();
1142 $class->setup_dispatcher( delete $flags->{dispatcher} );
1143 if (my $engine = delete $flags->{engine}) {
1144 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1146 $class->setup_engine();
1147 $class->setup_stats( delete $flags->{stats} );
1149 for my $flag ( sort keys %{$flags} ) {
1151 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1152 &$code( $class, delete $flags->{$flag} );
1155 $class->log->warn(qq/Unknown flag "$flag"/);
1159 eval { require Catalyst::Devel; };
1160 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1161 $class->log->warn(<<"EOF");
1162 You are running an old script!
1164 Please update by running (this will overwrite existing files):
1165 catalyst.pl -force -scripts $class
1167 or (this will not overwrite existing files):
1168 catalyst.pl -scripts $class
1173 # Call plugins setup, this is stupid and evil.
1174 # Also screws C3 badly on 5.10, hack to avoid.
1176 no warnings qw/redefine/;
1177 local *setup = sub { };
1178 $class->setup unless $Catalyst::__AM_RESTARTING;
1181 $class->setup_middleware();
1183 # Initialize our data structure
1184 $class->components( {} );
1186 $class->setup_components;
1188 if ( $class->debug ) {
1189 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1192 my $column_width = Catalyst::Utils::term_width() - 6;
1193 my $t = Text::SimpleTable->new($column_width);
1194 $t->row($_) for @plugins;
1195 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1198 my @middleware = map {
1201 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1202 || '') } $class->registered_middlewares;
1205 my $column_width = Catalyst::Utils::term_width() - 6;
1206 my $t = Text::SimpleTable->new($column_width);
1207 $t->row($_) for @middleware;
1208 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1211 my %dh = $class->registered_data_handlers;
1212 if (my @data_handlers = keys %dh) {
1213 my $column_width = Catalyst::Utils::term_width() - 6;
1214 my $t = Text::SimpleTable->new($column_width);
1215 $t->row($_) for @data_handlers;
1216 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1219 my $dispatcher = $class->dispatcher;
1220 my $engine = $class->engine;
1221 my $home = $class->config->{home};
1223 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1224 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1228 ? $class->log->debug(qq/Found home "$home"/)
1229 : $class->log->debug(qq/Home "$home" doesn't exist/)
1230 : $class->log->debug(q/Couldn't find home/);
1232 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1233 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1234 for my $comp ( sort keys %{ $class->components } ) {
1235 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1236 $t->row( $comp, $type );
1238 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1239 if ( keys %{ $class->components } );
1242 # Add our self to components, since we are also a component
1243 if( $class->isa('Catalyst::Controller') ){
1244 $class->components->{$class} = $class;
1247 $class->setup_actions;
1249 if ( $class->debug ) {
1250 my $name = $class->config->{name} || 'Application';
1251 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1254 if ($class->config->{case_sensitive}) {
1255 $class->log->warn($class . "->config->{case_sensitive} is set.");
1256 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1259 $class->setup_finalize;
1261 # Flush the log for good measure (in case something turned off 'autoflush' early)
1262 $class->log->_flush() if $class->log->can('_flush');
1264 return $class || 1; # Just in case someone named their Application 0...
1267 =head2 $app->setup_finalize
1269 A hook to attach modifiers to. This method does not do anything except set the
1270 C<setup_finished> accessor.
1272 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1276 after setup_finalize => sub {
1284 sub setup_finalize {
1286 $class->setup_finished(1);
1289 =head2 $c->uri_for( $path?, @args?, \%query_values? )
1291 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values? )
1293 Constructs an absolute L<URI> object based on the application root, the
1294 provided path, and the additional arguments and query parameters provided.
1295 When used as a string, provides a textual URI. If you need more flexibility
1296 than this (i.e. the option to provide relative URIs etc.) see
1297 L<Catalyst::Plugin::SmartURI>.
1299 If no arguments are provided, the URI for the current action is returned.
1300 To return the current action and also provide @args, use
1301 C<< $c->uri_for( $c->action, @args ) >>.
1303 If the first argument is a string, it is taken as a public URI path relative
1304 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1305 relative to the application root (if it does). It is then merged with
1306 C<< $c->request->base >>; any C<@args> are appended as additional path
1307 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1309 If the first argument is a L<Catalyst::Action> it represents an action which
1310 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1311 optional C<\@captures> argument (an arrayref) allows passing the captured
1312 variables that are needed to fill in the paths of Chained and Regex actions;
1313 once the path is resolved, C<uri_for> continues as though a path was
1314 provided, appending any arguments or parameters and creating an absolute
1317 The captures for the current request can be found in
1318 C<< $c->request->captures >>, and actions can be resolved using
1319 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1320 path, use C<< $c->uri_for_action >> instead.
1322 # Equivalent to $c->req->uri
1323 $c->uri_for($c->action, $c->req->captures,
1324 @{ $c->req->args }, $c->req->params);
1326 # For the Foo action in the Bar controller
1327 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1329 # Path to a static resource
1330 $c->uri_for('/static/images/logo.png');
1335 my ( $c, $path, @args ) = @_;
1337 if ( $path->$_isa('Catalyst::Controller') ) {
1338 $path = $path->path_prefix;
1343 undef($path) if (defined $path && $path eq '');
1346 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1348 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1349 foreach my $arg (@args) {
1350 utf8::encode($arg) if utf8::is_utf8($arg);
1351 $arg =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1354 if ( $path->$_isa('Catalyst::Action') ) { # action object
1355 s|/|%2F|g for @args;
1356 my $captures = [ map { s|/|%2F|g; $_; }
1357 ( scalar @args && ref $args[0] eq 'ARRAY'
1361 foreach my $capture (@$captures) {
1362 utf8::encode($capture) if utf8::is_utf8($capture);
1363 $capture =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1367 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1368 if( !@args && $action->number_of_args ) {
1369 my $expanded_action = $c->dispatcher->expand_action( $action );
1371 my $num_captures = $expanded_action->number_of_captures;
1372 unshift @args, splice @$captures, $num_captures;
1375 $path = $c->dispatcher->uri_for_action($action, $captures);
1376 if (not defined $path) {
1377 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1381 $path = '/' if $path eq '';
1384 unshift(@args, $path);
1386 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1387 my $namespace = $c->namespace;
1388 if (defined $path) { # cheesy hack to handle path '../foo'
1389 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1391 unshift(@args, $namespace || '');
1394 # join args with '/', or a blank string
1395 my $args = join('/', grep { defined($_) } @args);
1396 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1399 my ($base, $class) = ('/', 'URI::_generic');
1401 $base = $c->req->base;
1402 $class = ref($base);
1403 $base =~ s{(?<!/)$}{/};
1408 if (my @keys = keys %$params) {
1409 # somewhat lifted from URI::_query's query_form
1410 $query = '?'.join('&', map {
1411 my $val = $params->{$_};
1412 s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go;
1415 $val = '' unless defined $val;
1418 utf8::encode( $param ) if utf8::is_utf8($param);
1419 # using the URI::Escape pattern here so utf8 chars survive
1420 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1422 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1426 my $res = bless(\"${base}${args}${query}", $class);
1430 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1432 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1438 A private path to the Catalyst action you want to create a URI for.
1440 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1441 >> and passing the resulting C<$action> and the remaining arguments to C<<
1444 You can also pass in a Catalyst::Action object, in which case it is passed to
1447 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.
1449 For example, if the action looks like:
1451 package MyApp::Controller::Users;
1453 sub lst : Path('the-list') {}
1457 $c->uri_for_action('/users/lst')
1459 and it will create the URI /users/the-list.
1461 =item \@captures_and_args?
1463 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1464 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1465 to interpolate all the parameters in the URI.
1469 Optional list of extra arguments - can be supplied in the
1470 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1473 Your action can have zero, a fixed or a variable number of args (e.g.
1474 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1476 =item \%query_values?
1478 Optional array reference of query parameters to append. E.g.
1484 /rest/of/your/uri?foo=bar
1490 sub uri_for_action {
1491 my ( $c, $path, @args ) = @_;
1492 my $action = blessed($path)
1494 : $c->dispatcher->get_action_by_path($path);
1495 unless (defined $action) {
1496 croak "Can't find action for path '$path'";
1498 return $c->uri_for( $action, @args );
1501 =head2 $c->welcome_message
1503 Returns the Catalyst welcome HTML page.
1507 sub welcome_message {
1509 my $name = $c->config->{name};
1510 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1511 my $prefix = Catalyst::Utils::appprefix( ref $c );
1512 $c->response->content_type('text/html; charset=utf-8');
1514 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1515 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1516 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1518 <meta http-equiv="Content-Language" content="en" />
1519 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1520 <title>$name on Catalyst $VERSION</title>
1521 <style type="text/css">
1524 background-color: #eee;
1531 margin-bottom: 10px;
1533 background-color: #ccc;
1534 border: 1px solid #aaa;
1539 font-family: verdana, tahoma, sans-serif;
1542 font-family: verdana, tahoma, sans-serif;
1545 text-decoration: none;
1547 border-bottom: 1px dotted #bbb;
1549 :link:hover, :visited:hover {
1562 background-color: #fff;
1563 border: 1px solid #aaa;
1567 font-weight: normal;
1589 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1594 <img src="$logo" alt="Catalyst Logo" />
1596 <p>Welcome to the world of Catalyst.
1597 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1598 framework will make web development something you had
1599 never expected it to be: Fun, rewarding, and quick.</p>
1600 <h2>What to do now?</h2>
1601 <p>That really depends on what <b>you</b> want to do.
1602 We do, however, provide you with a few starting points.</p>
1603 <p>If you want to jump right into web development with Catalyst
1604 you might want to start with a tutorial.</p>
1605 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1607 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1609 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1610 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1612 <h2>What to do next?</h2>
1613 <p>Next it's time to write an actual application. Use the
1614 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1615 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1616 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1617 they can save you a lot of work.</p>
1618 <pre><code>script/${prefix}_create.pl --help</code></pre>
1619 <p>Also, be sure to check out the vast and growing
1620 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1621 you are likely to find what you need there.
1625 <p>Catalyst has a very active community. Here are the main places to
1626 get in touch with us.</p>
1629 <a href="http://dev.catalyst.perl.org">Wiki</a>
1632 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1635 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1638 <h2>In conclusion</h2>
1639 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1640 as we enjoyed making it. Please contact us if you have ideas
1641 for improvement or other feedback.</p>
1651 Contains a hash of options passed from the application script, including
1652 the original ARGV the script received, the processed values from that
1653 ARGV and any extra arguments to the script which were not processed.
1655 This can be used to add custom options to your application's scripts
1656 and setup your application differently depending on the values of these
1659 =head1 INTERNAL METHODS
1661 These methods are not meant to be used by end users.
1663 =head2 $c->components
1665 Returns a hash of components.
1667 =head2 $c->context_class
1669 Returns or sets the context class.
1673 Returns a hashref containing coderefs and execution counts (needed for
1674 deep recursion detection).
1678 Returns the number of actions on the current internal execution stack.
1682 Dispatches a request to actions.
1686 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1688 =head2 $c->dispatcher_class
1690 Returns or sets the dispatcher class.
1692 =head2 $c->dump_these
1694 Returns a list of 2-element array references (name, structure) pairs
1695 that will be dumped on the error page in debug mode.
1701 [ Request => $c->req ],
1702 [ Response => $c->res ],
1703 [ Stash => $c->stash ],
1704 [ Config => $c->config ];
1707 =head2 $c->engine_class
1709 Returns or sets the engine class.
1711 =head2 $c->execute( $class, $coderef )
1713 Execute a coderef in given class and catch exceptions. Errors are available
1719 my ( $c, $class, $code ) = @_;
1720 $class = $c->component($class) || $class;
1723 if ( $c->depth >= $RECURSION ) {
1724 my $action = $code->reverse();
1725 $action = "/$action" unless $action =~ /->/;
1726 my $error = qq/Deep recursion detected calling "${action}"/;
1727 $c->log->error($error);
1733 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
1735 push( @{ $c->stack }, $code );
1737 no warnings 'recursion';
1738 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
1739 # I have no idea how, ergo $ret (which appears to fix the issue)
1740 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
1742 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
1744 my $last = pop( @{ $c->stack } );
1746 if ( my $error = $@ ) {
1747 #rethow if this can be handled by middleware
1748 if(blessed $error && ($error->can('as_psgi') || $error->can('code'))) {
1749 foreach my $err (@{$c->error}) {
1750 $c->log->error($err);
1753 $c->log->_flush if $c->log->can('_flush');
1755 $error->can('rethrow') ? $error->rethrow : croak $error;
1757 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
1758 $error->rethrow if $c->depth > 1;
1760 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
1761 $error->rethrow if $c->depth > 0;
1764 unless ( ref $error ) {
1765 no warnings 'uninitialized';
1767 my $class = $last->class;
1768 my $name = $last->name;
1769 $error = qq/Caught exception in $class->$name "$error"/;
1778 sub _stats_start_execute {
1779 my ( $c, $code ) = @_;
1780 my $appclass = ref($c) || $c;
1781 return if ( ( $code->name =~ /^_.*/ )
1782 && ( !$appclass->config->{show_internal_actions} ) );
1784 my $action_name = $code->reverse();
1785 $c->counter->{$action_name}++;
1787 my $action = $action_name;
1788 $action = "/$action" unless $action =~ /->/;
1790 # determine if the call was the result of a forward
1791 # this is done by walking up the call stack and looking for a calling
1792 # sub of Catalyst::forward before the eval
1794 for my $index ( 2 .. 11 ) {
1796 if ( ( caller($index) )[0] eq 'Catalyst'
1797 && ( caller($index) )[3] eq '(eval)' );
1799 if ( ( caller($index) )[3] =~ /forward$/ ) {
1800 $callsub = ( caller($index) )[3];
1801 $action = "-> $action";
1806 my $uid = $action_name . $c->counter->{$action_name};
1808 # is this a root-level call or a forwarded call?
1809 if ( $callsub =~ /forward$/ ) {
1810 my $parent = $c->stack->[-1];
1812 # forward, locate the caller
1813 if ( defined $parent && exists $c->counter->{"$parent"} ) {
1816 parent => "$parent" . $c->counter->{"$parent"},
1822 # forward with no caller may come from a plugin
1841 sub _stats_finish_execute {
1842 my ( $c, $info ) = @_;
1843 $c->stats->profile( end => $info );
1848 Finalizes the request.
1855 for my $error ( @{ $c->error } ) {
1856 $c->log->error($error);
1859 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
1860 # stuff like cometd and websockets
1862 if($c->request->_has_io_fh) {
1867 # Allow engine to handle finalize flow (for POE)
1868 my $engine = $c->engine;
1869 if ( my $code = $engine->can('finalize') ) {
1874 $c->finalize_uploads;
1877 if ( $#{ $c->error } >= 0 ) {
1881 $c->finalize_headers unless $c->response->finalized_headers;
1888 if ($c->use_stats) {
1889 my $elapsed = $c->stats->elapsed;
1890 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
1892 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
1895 return $c->response->status;
1898 =head2 $c->finalize_body
1904 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
1906 =head2 $c->finalize_cookies
1912 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
1914 =head2 $c->finalize_error
1916 Finalizes error. If there is only one error in L</error> and it is an object that
1917 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
1918 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
1919 return the default error page (production mode).
1923 sub finalize_error {
1925 if($#{$c->error} > 0) {
1926 $c->engine->finalize_error( $c, @_ );
1928 my ($error) = @{$c->error};
1931 ($error->can('as_psgi') || $error->can('code'))
1933 # In the case where the error 'knows what it wants', becauses its PSGI
1934 # aware, just rethow and let middleware catch it
1935 $error->can('rethrow') ? $error->rethrow : croak $error;
1937 $c->engine->finalize_error( $c, @_ )
1942 =head2 $c->finalize_headers
1948 sub finalize_headers {
1951 my $response = $c->response; #accessor calls can add up?
1953 # Check if we already finalized headers
1954 return if $response->finalized_headers;
1957 if ( my $location = $response->redirect ) {
1958 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
1959 $response->header( Location => $location );
1962 # Remove incorrectly added body and content related meta data when returning
1963 # an information response, or a response the is required to not include a body
1965 $c->finalize_cookies;
1967 $c->response->finalize_headers();
1970 $response->finalized_headers(1);
1973 =head2 $c->finalize_output
1975 An alias for finalize_body.
1977 =head2 $c->finalize_read
1979 Finalizes the input after reading is complete.
1983 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
1985 =head2 $c->finalize_uploads
1987 Finalizes uploads. Cleans up any temporary files.
1991 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
1993 =head2 $c->get_action( $action, $namespace )
1995 Gets an action in a given namespace.
1999 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2001 =head2 $c->get_actions( $action, $namespace )
2003 Gets all actions of a given name in a namespace and all parent
2008 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2010 =head2 $app->handle_request( @arguments )
2012 Called to handle each HTTP request.
2016 sub handle_request {
2017 my ( $class, @arguments ) = @_;
2019 # Always expect worst case!
2022 if ($class->debug) {
2023 my $secs = time - $START || 1;
2024 my $av = sprintf '%.3f', $COUNT / $secs;
2025 my $time = localtime time;
2026 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2029 my $c = $class->prepare(@arguments);
2031 $status = $c->finalize;
2033 #rethow if this can be handled by middleware
2034 if(blessed $_ && ($_->can('as_psgi') || $_->can('code'))) {
2035 $_->can('rethrow') ? $_->rethrow : croak $_;
2037 chomp(my $error = $_);
2038 $class->log->error(qq/Caught exception in engine "$error"/);
2043 if(my $coderef = $class->log->can('_flush')){
2044 $class->log->$coderef();
2049 =head2 $class->prepare( @arguments )
2051 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2058 predicate => '_has_uploadtmp',
2062 my ( $class, @arguments ) = @_;
2065 # After the app/ctxt split, this should become an attribute based on something passed
2066 # into the application.
2067 $class->context_class( ref $class || $class ) unless $class->context_class;
2069 my $uploadtmp = $class->config->{uploadtmp};
2070 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2072 $c->response->_context($c);
2074 #surely this is not the most efficient way to do things...
2075 $c->stats($class->stats_class->new)->enable($c->use_stats);
2076 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2077 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2081 # Allow engine to direct the prepare flow (for POE)
2082 if ( my $prepare = $c->engine->can('prepare') ) {
2083 $c->engine->$prepare( $c, @arguments );
2086 $c->prepare_request(@arguments);
2087 $c->prepare_connection;
2088 $c->prepare_query_parameters;
2089 $c->prepare_headers; # Just hooks, no longer needed - they just
2090 $c->prepare_cookies; # cause the lazy attribute on req to build
2093 # Prepare the body for reading, either by prepare_body
2094 # or the user, if they are using $c->read
2097 # Parse the body unless the user wants it on-demand
2098 unless ( ref($c)->config->{parse_on_demand} ) {
2104 # VERY ugly and probably shouldn't rely on ->finalize actually working
2106 # failed prepare is always due to an invalid request, right?
2107 $c->response->status(400);
2108 $c->response->content_type('text/plain');
2109 $c->response->body('Bad Request');
2110 # Note we call finalize and then die here, which escapes
2111 # finalize being called in the enclosing block..
2112 # It in fact couldn't be called, as we don't return $c..
2113 # This is a mess - but I'm unsure you can fix this without
2114 # breaking compat for people doing crazy things (we should set
2115 # the 400 and just return the ctx here IMO, letting finalize get called
2126 =head2 $c->prepare_action
2128 Prepares action. See L<Catalyst::Dispatcher>.
2132 sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) }
2134 =head2 $c->prepare_body
2136 Prepares message body.
2143 return if $c->request->_has_body;
2145 # Initialize on-demand data
2146 $c->engine->prepare_body( $c, @_ );
2147 $c->prepare_parameters;
2148 $c->prepare_uploads;
2151 =head2 $c->prepare_body_chunk( $chunk )
2153 Prepares a chunk of data before sending it to L<HTTP::Body>.
2155 See L<Catalyst::Engine>.
2159 sub prepare_body_chunk {
2161 $c->engine->prepare_body_chunk( $c, @_ );
2164 =head2 $c->prepare_body_parameters
2166 Prepares body parameters.
2170 sub prepare_body_parameters {
2172 $c->engine->prepare_body_parameters( $c, @_ );
2175 =head2 $c->prepare_connection
2177 Prepares connection.
2181 sub prepare_connection {
2183 # XXX - This is called on the engine (not the request) to maintain
2184 # Engine::PSGI back compat.
2185 $c->engine->prepare_connection($c);
2188 =head2 $c->prepare_cookies
2190 Prepares cookies by ensuring that the attribute on the request
2191 object has been built.
2195 sub prepare_cookies { my $c = shift; $c->request->cookies }
2197 =head2 $c->prepare_headers
2199 Prepares request headers by ensuring that the attribute on the request
2200 object has been built.
2204 sub prepare_headers { my $c = shift; $c->request->headers }
2206 =head2 $c->prepare_parameters
2208 Prepares parameters.
2212 sub prepare_parameters {
2214 $c->prepare_body_parameters;
2215 $c->engine->prepare_parameters( $c, @_ );
2218 =head2 $c->prepare_path
2220 Prepares path and base.
2224 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2226 =head2 $c->prepare_query_parameters
2228 Prepares query parameters.
2232 sub prepare_query_parameters {
2235 $c->engine->prepare_query_parameters( $c, @_ );
2238 =head2 $c->log_request
2240 Writes information about the request to the debug logs. This includes:
2244 =item * Request method, path, and remote IP address
2246 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2248 =item * Request parameters
2250 =item * File uploads
2259 return unless $c->debug;
2261 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2262 my $request = $dump->[1];
2264 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2266 $path = '/' unless length $path;
2268 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2270 $c->log_request_headers($request->headers);
2272 if ( my $keywords = $request->query_keywords ) {
2273 $c->log->debug("Query keywords are: $keywords");
2276 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2278 $c->log_request_uploads($request);
2281 =head2 $c->log_response
2283 Writes information about the response to the debug logs by calling
2284 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2291 return unless $c->debug;
2293 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2294 my $response = $dump->[1];
2296 $c->log_response_status_line($response);
2297 $c->log_response_headers($response->headers);
2300 =head2 $c->log_response_status_line($response)
2302 Writes one line of information about the response to the debug logs. This includes:
2306 =item * Response status code
2308 =item * Content-Type header (if present)
2310 =item * Content-Length header (if present)
2316 sub log_response_status_line {
2317 my ($c, $response) = @_;
2321 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2322 $response->status || 'unknown',
2323 $response->headers->header('Content-Type') || 'unknown',
2324 $response->headers->header('Content-Length') || 'unknown'
2329 =head2 $c->log_response_headers($headers);
2331 Hook method which can be wrapped by plugins to log the response headers.
2332 No-op in the default implementation.
2336 sub log_response_headers {}
2338 =head2 $c->log_request_parameters( query => {}, body => {} )
2340 Logs request parameters to debug logs
2344 sub log_request_parameters {
2346 my %all_params = @_;
2348 return unless $c->debug;
2350 my $column_width = Catalyst::Utils::term_width() - 44;
2351 foreach my $type (qw(query body)) {
2352 my $params = $all_params{$type};
2353 next if ! keys %$params;
2354 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2355 for my $key ( sort keys %$params ) {
2356 my $param = $params->{$key};
2357 my $value = defined($param) ? $param : '';
2358 $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value );
2360 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2364 =head2 $c->log_request_uploads
2366 Logs file uploads included in the request to the debug logs.
2367 The parameter name, filename, file type, and file size are all included in
2372 sub log_request_uploads {
2374 my $request = shift;
2375 return unless $c->debug;
2376 my $uploads = $request->uploads;
2377 if ( keys %$uploads ) {
2378 my $t = Text::SimpleTable->new(
2379 [ 12, 'Parameter' ],
2384 for my $key ( sort keys %$uploads ) {
2385 my $upload = $uploads->{$key};
2386 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2387 $t->row( $key, $u->filename, $u->type, $u->size );
2390 $c->log->debug( "File Uploads are:\n" . $t->draw );
2394 =head2 $c->log_request_headers($headers);
2396 Hook method which can be wrapped by plugins to log the request headers.
2397 No-op in the default implementation.
2401 sub log_request_headers {}
2403 =head2 $c->log_headers($type => $headers)
2405 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2412 my $headers = shift; # an HTTP::Headers instance
2414 return unless $c->debug;
2416 my $column_width = Catalyst::Utils::term_width() - 28;
2417 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2420 my ( $name, $value ) = @_;
2421 $t->row( $name, $value );
2424 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2428 =head2 $c->prepare_read
2430 Prepares the input for reading.
2434 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2436 =head2 $c->prepare_request
2438 Prepares the engine request.
2442 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2444 =head2 $c->prepare_uploads
2450 sub prepare_uploads {
2453 $c->engine->prepare_uploads( $c, @_ );
2456 =head2 $c->prepare_write
2458 Prepares the output for writing.
2462 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2464 =head2 $c->request_class
2466 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2468 =head2 $c->response_class
2470 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2472 =head2 $c->read( [$maxlength] )
2474 Reads a chunk of data from the request body. This method is designed to
2475 be used in a while loop, reading C<$maxlength> bytes on every call.
2476 C<$maxlength> defaults to the size of the request if not specified.
2478 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2481 Warning: If you use read(), Catalyst will not process the body,
2482 so you will not be able to access POST parameters or file uploads via
2483 $c->request. You must handle all body parsing yourself.
2487 sub read { my $c = shift; return $c->request->read( @_ ) }
2497 $app->_make_immutable_if_needed;
2498 $app->engine_loader->needs_psgi_engine_compat_hack ?
2499 $app->engine->run($app, @_) :
2500 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2503 sub _make_immutable_if_needed {
2505 my $meta = find_meta($class);
2506 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2509 && ! { $meta->immutable_options }->{replace_constructor}
2512 warn("You made your application class ($class) immutable, "
2513 . "but did not inline the\nconstructor. "
2514 . "This will break catalyst, as your app \@ISA "
2515 . "Class::Accessor(::Fast)?\nPlease pass "
2516 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2518 unless ($meta->is_immutable) {
2519 # XXX - FIXME warning here as you should make your app immutable yourself.
2520 $meta->make_immutable(
2521 replace_constructor => 1,
2526 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2528 Sets an action in a given namespace.
2532 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2534 =head2 $c->setup_actions($component)
2536 Sets up actions for a component.
2540 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2542 =head2 $c->setup_components
2544 This method is called internally to set up the application's components.
2546 It finds modules by calling the L<locate_components> method, expands them to
2547 package names with the L<expand_component_module> method, and then installs
2548 each component into the application.
2550 The C<setup_components> config option is passed to both of the above methods.
2552 Installation of each component is performed by the L<setup_component> method,
2557 sub setup_components {
2560 my $config = $class->config->{ setup_components };
2562 my @comps = $class->locate_components($config);
2563 my %comps = map { $_ => 1 } @comps;
2565 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
2566 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
2567 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
2568 ) if $deprecatedcatalyst_component_names;
2570 for my $component ( @comps ) {
2572 # We pass ignore_loaded here so that overlay files for (e.g.)
2573 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
2574 # we know M::P::O found a file on disk so this is safe
2576 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
2579 for my $component (@comps) {
2580 my $instance = $class->components->{ $component } = $class->setup_component($component);
2581 my @expanded_components = $instance->can('expand_modules')
2582 ? $instance->expand_modules( $component, $config )
2583 : $class->expand_component_module( $component, $config );
2584 for my $component (@expanded_components) {
2585 next if $comps{$component};
2586 $class->components->{ $component } = $class->setup_component($component);
2591 =head2 $c->locate_components( $setup_component_config )
2593 This method is meant to provide a list of component modules that should be
2594 setup for the application. By default, it will use L<Module::Pluggable>.
2596 Specify a C<setup_components> config option to pass additional options directly
2597 to L<Module::Pluggable>. To add additional search paths, specify a key named
2598 C<search_extra> as an array reference. Items in the array beginning with C<::>
2599 will have the application class name prepended to them.
2603 sub locate_components {
2607 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
2608 my $extra = delete $config->{ search_extra } || [];
2610 unshift @paths, @$extra;
2612 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
2613 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
2615 )->plugins } @paths;
2620 =head2 $c->expand_component_module( $component, $setup_component_config )
2622 Components found by C<locate_components> will be passed to this method, which
2623 is expected to return a list of component (package) names to be set up.
2627 sub expand_component_module {
2628 my ($class, $module) = @_;
2629 return Devel::InnerPackage::list_packages( $module );
2632 =head2 $c->setup_component
2636 sub setup_component {
2637 my( $class, $component ) = @_;
2639 unless ( $component->can( 'COMPONENT' ) ) {
2643 my $suffix = Catalyst::Utils::class2classsuffix( $component );
2644 my $config = $class->config->{ $suffix } || {};
2645 # Stash catalyst_component_name in the config here, so that custom COMPONENT
2646 # methods also pass it. local to avoid pointlessly shitting in config
2647 # for the debug screen, as $component is already the key name.
2648 local $config->{catalyst_component_name} = $component;
2650 my $instance = eval { $component->COMPONENT( $class, $config ); };
2652 if ( my $error = $@ ) {
2654 Catalyst::Exception->throw(
2655 message => qq/Couldn't instantiate component "$component", "$error"/
2659 unless (blessed $instance) {
2660 my $metaclass = Moose::Util::find_meta($component);
2661 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
2662 my $component_method_from = $method_meta->associated_metaclass->name;
2663 my $value = defined($instance) ? $instance : 'undef';
2664 Catalyst::Exception->throw(
2666 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
2672 =head2 $c->setup_dispatcher
2678 sub setup_dispatcher {
2679 my ( $class, $dispatcher ) = @_;
2682 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
2685 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
2686 $dispatcher = 'Catalyst::Dispatcher::' . $env;
2689 unless ($dispatcher) {
2690 $dispatcher = $class->dispatcher_class;
2693 load_class($dispatcher);
2695 # dispatcher instance
2696 $class->dispatcher( $dispatcher->new );
2699 =head2 $c->setup_engine
2706 my ($class, $requested_engine) = @_;
2708 if (!$class->engine_loader || $requested_engine) {
2709 $class->engine_loader(
2710 Catalyst::EngineLoader->new({
2711 application_name => $class,
2712 (defined $requested_engine
2713 ? (catalyst_engine_class => $requested_engine) : ()),
2718 $class->engine_loader->catalyst_engine_class;
2722 my ($class, $requested_engine) = @_;
2725 my $loader = $class->engine_loader;
2727 if (!$loader || $requested_engine) {
2728 $loader = Catalyst::EngineLoader->new({
2729 application_name => $class,
2730 (defined $requested_engine
2731 ? (requested_engine => $requested_engine) : ()),
2734 $class->engine_loader($loader);
2737 $loader->catalyst_engine_class;
2740 # Don't really setup_engine -- see _setup_psgi_app for explanation.
2741 return if $class->loading_psgi_file;
2743 load_class($engine);
2745 if ($ENV{MOD_PERL}) {
2746 my $apache = $class->engine_loader->auto;
2748 my $meta = find_meta($class);
2749 my $was_immutable = $meta->is_immutable;
2750 my %immutable_options = $meta->immutable_options;
2751 $meta->make_mutable if $was_immutable;
2753 $meta->add_method(handler => sub {
2755 my $psgi_app = $class->_finalized_psgi_app;
2756 $apache->call_app($r, $psgi_app);
2759 $meta->make_immutable(%immutable_options) if $was_immutable;
2762 $class->engine( $engine->new );
2767 ## This exists just to supply a prebuild psgi app for mod_perl and for the
2768 ## build in server support (back compat support for pre psgi port behavior).
2769 ## This is so that we don't build a new psgi app for each request when using
2770 ## the mod_perl handler or the built in servers (http and fcgi, etc).
2772 sub _finalized_psgi_app {
2775 unless ($app->_psgi_app) {
2776 my $psgi_app = $app->_setup_psgi_app;
2777 $app->_psgi_app($psgi_app);
2780 return $app->_psgi_app;
2783 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
2784 ## home directory and load that and return it (just assume it is doing the
2785 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
2786 ## in default_middleware and return it ( this is for backward compatibility
2787 ## with pre psgi port behavior ).
2789 sub _setup_psgi_app {
2792 for my $home (Path::Class::Dir->new($app->config->{home})) {
2793 my $psgi_file = $home->file(
2794 Catalyst::Utils::appprefix($app) . '.psgi',
2797 next unless -e $psgi_file;
2799 # If $psgi_file calls ->setup_engine, it's doing so to load
2800 # Catalyst::Engine::PSGI. But if it does that, we're only going to
2801 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
2802 # anyway. So set a flag (ick) that tells setup_engine not to populate
2803 # $c->engine or do any other things we might regret.
2805 $app->loading_psgi_file(1);
2806 my $psgi_app = Plack::Util::load_psgi($psgi_file);
2807 $app->loading_psgi_file(0);
2810 unless $app->engine_loader->needs_psgi_engine_compat_hack;
2813 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
2815 Its content has been ignored. Please consult the Catalyst::Upgrading
2816 documentation on how to upgrade from Catalyst::Engine::PSGI.
2820 return $app->apply_default_middlewares($app->psgi_app);
2823 =head2 $c->apply_default_middlewares
2825 Adds the following L<Plack> middlewares to your application, since they are
2826 useful and commonly needed:
2828 L<Plack::Middleware::ReverseProxy>, (conditionally added based on the status
2829 of your $ENV{REMOTE_ADDR}, and can be forced on with C<using_frontend_proxy>
2830 or forced off with C<ignore_frontend_proxy>), L<Plack::Middleware::LighttpdScriptNameFix>
2831 (if you are using Lighttpd), L<Plack::Middleware::IIS6ScriptNameFix> (always
2832 applied since this middleware is smart enough to conditionally apply itself).
2834 Additionally if we detect we are using Nginx, we add a bit of custom middleware
2835 to solve some problems with the way that server handles $ENV{PATH_INFO} and
2841 sub apply_default_middlewares {
2842 my ($app, $psgi_app) = @_;
2844 $psgi_app = Plack::Middleware::Conditional->wrap(
2846 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
2849 return if $app->config->{ignore_frontend_proxy};
2850 return $env->{REMOTE_ADDR} eq '127.0.0.1'
2851 || $app->config->{using_frontend_proxy};
2855 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
2856 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
2857 $psgi_app = Plack::Middleware::Conditional->wrap(
2859 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
2862 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
2863 return unless $1 < 4.23;
2868 # we're applying this unconditionally as the middleware itself already makes
2869 # sure it doesn't fuck things up if it's not running under one of the right
2871 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
2873 # And another IIS issue, this time with IIS7.
2874 $psgi_app = Plack::Middleware::Conditional->wrap(
2876 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
2879 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
2888 Returns a PSGI application code reference for the catalyst application
2889 C<$c>. This is the bare application without any middlewares
2890 applied. C<${myapp}.psgi> is not taken into account.
2892 This is what you want to be using to retrieve the PSGI application code
2893 reference of your Catalyst application for use in F<.psgi> files.
2899 my $psgi = $app->engine->build_psgi_app($app);
2900 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
2903 =head2 $c->setup_home
2905 Sets up the home directory.
2910 my ( $class, $home ) = @_;
2912 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
2916 $home ||= Catalyst::Utils::home($class);
2919 #I remember recently being scolded for assigning config values like this
2920 $class->config->{home} ||= $home;
2921 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
2925 =head2 $c->setup_log
2927 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
2928 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
2931 This method also installs a C<debug> method that returns a true value into the
2932 catalyst subclass if the "debug" level is passed in the comma-delimited list,
2933 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
2935 Note that if the log has already been setup, by either a previous call to
2936 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
2937 that this method won't actually set up the log object.
2942 my ( $class, $levels ) = @_;
2945 $levels =~ s/^\s+//;
2946 $levels =~ s/\s+$//;
2947 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
2949 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
2950 if ( defined $env_debug ) {
2951 $levels{debug} = 1 if $env_debug; # Ugly!
2952 delete($levels{debug}) unless $env_debug;
2955 unless ( $class->log ) {
2956 $class->log( Catalyst::Log->new(keys %levels) );
2959 if ( $levels{debug} ) {
2960 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
2961 $class->log->debug('Debug messages enabled');
2965 =head2 $c->setup_plugins
2971 =head2 $c->setup_stats
2973 Sets up timing statistics class.
2978 my ( $class, $stats ) = @_;
2980 Catalyst::Utils::ensure_class_loaded($class->stats_class);
2982 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
2983 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
2984 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
2985 $class->log->debug('Statistics enabled');
2990 =head2 $c->registered_plugins
2992 Returns a sorted list of the plugins which have either been stated in the
2995 If passed a given plugin name, it will report a boolean value indicating
2996 whether or not that plugin is loaded. A fully qualified name is required if
2997 the plugin name does not begin with C<Catalyst::Plugin::>.
2999 if ($c->registered_plugins('Some::Plugin')) {
3007 sub registered_plugins {
3009 return sort keys %{ $proto->_plugins } unless @_;
3011 return 1 if exists $proto->_plugins->{$plugin};
3012 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3015 sub _register_plugin {
3016 my ( $proto, $plugin, $instant ) = @_;
3017 my $class = ref $proto || $proto;
3019 load_class( $plugin );
3020 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3021 if $plugin->isa( 'Catalyst::Component' );
3022 my $plugin_meta = Moose::Meta::Class->create($plugin);
3023 if (!$plugin_meta->has_method('new')
3024 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3025 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3027 if (!$instant && !$proto->_plugins->{$plugin}) {
3028 my $meta = Class::MOP::get_metaclass_by_name($class);
3029 $meta->superclasses($plugin, $meta->superclasses);
3031 $proto->_plugins->{$plugin} = 1;
3035 sub _default_plugins { return qw(Unicode::Encoding) }
3038 my ( $class, $plugins ) = @_;
3040 $class->_plugins( {} ) unless $class->_plugins;
3042 m/Unicode::Encoding/ ? do {
3044 'Unicode::Encoding plugin is auto-applied,'
3045 . ' please remove this from your appclass'
3046 . ' and make sure to define "encoding" config'
3048 unless (exists $class->config->{'encoding'}) {
3049 $class->config->{'encoding'} = 'UTF-8';
3054 push @$plugins, $class->_default_plugins;
3055 $plugins = Data::OptList::mkopt($plugins || []);
3058 [ Catalyst::Utils::resolve_namespace(
3059 $class . '::Plugin',
3060 'Catalyst::Plugin', $_->[0]
3066 for my $plugin ( reverse @plugins ) {
3067 load_class($plugin->[0], $plugin->[1]);
3068 my $meta = find_meta($plugin->[0]);
3069 next if $meta && $meta->isa('Moose::Meta::Role');
3071 $class->_register_plugin($plugin->[0]);
3075 map { $_->[0]->name, $_->[1] }
3076 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3077 map { [find_meta($_->[0]), $_->[1]] }
3080 Moose::Util::apply_all_roles(
3086 =head2 registered_middlewares
3088 Read only accessor that returns an array of all the middleware in the order
3089 that they were added (which is the REVERSE of the order they will be applied).
3091 The values returned will be either instances of L<Plack::Middleware> or of a
3092 compatible interface, or a coderef, which is assumed to be inlined middleware
3094 =head2 setup_middleware (?@middleware)
3096 Read configuration information stored in configuration key C<psgi_middleware> or
3099 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3100 to use it to enable L<Plack::Middleware>
3102 This method is automatically called during 'setup' of your application, so
3103 you really don't need to invoke it. However you may do so if you find the idea
3104 of loading middleware via configuration weird :). For example:
3110 __PACKAGE__->setup_middleware('Head');
3113 When we read middleware definitions from configuration, we reverse the list
3114 which sounds odd but is likely how you expect it to work if you have prior
3115 experience with L<Plack::Builder> or if you previously used the plugin
3116 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3118 So basically your middleware handles an incoming request from the first
3119 registered middleware, down and handles the response from the last middleware
3124 sub registered_middlewares {
3126 if(my $middleware = $class->_psgi_middleware) {
3128 Catalyst::Middleware::Stash->new,
3129 Plack::Middleware::HTTPExceptions->new,
3130 Plack::Middleware::RemoveRedundantBody->new,
3131 Plack::Middleware::FixMissingBodyInRedirect->new,
3132 Plack::Middleware::ContentLength->new,
3133 Plack::Middleware::MethodOverride->new,
3134 Plack::Middleware::Head->new,
3137 die "You cannot call ->registered_middlewares until middleware has been setup";
3141 sub setup_middleware {
3143 my @middleware_definitions = @_ ?
3144 reverse(@_) : reverse(@{$class->config->{'psgi_middleware'}||[]});
3146 my @middleware = ();
3147 while(my $next = shift(@middleware_definitions)) {
3149 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3150 push @middleware, $next;
3151 } elsif(ref $next eq 'CODE') {
3152 push @middleware, $next;
3153 } elsif(ref $next eq 'HASH') {
3154 my $namespace = shift @middleware_definitions;
3155 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3156 push @middleware, $mw;
3158 die "I can't handle middleware definition ${\ref $next}";
3161 my $mw = $class->Catalyst::Utils::build_middleware($next);
3162 push @middleware, $mw;
3166 my @existing = @{$class->_psgi_middleware || []};
3167 $class->_psgi_middleware([@middleware,@existing,]);
3170 =head2 registered_data_handlers
3172 A read only copy of registered Data Handlers returned as a Hash, where each key
3173 is a content type and each value is a subref that attempts to decode that content
3176 =head2 setup_data_handlers (?@data_handler)
3178 Read configuration information stored in configuration key C<data_handlers> or
3181 See under L</CONFIGURATION> information regarding C<data_handlers>.
3183 This method is automatically called during 'setup' of your application, so
3184 you really don't need to invoke it.
3186 =head2 default_data_handlers
3188 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
3189 only two default data handlers, for 'application/json' and an alternative to
3190 'application/x-www-form-urlencoded' which supposed nested form parameters via
3191 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
3193 The 'application/json' data handler is used to parse incoming JSON into a Perl
3194 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
3195 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
3196 JSON decoder, and has the smallest dependency impact.
3198 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
3199 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
3200 order to get the best performance. You should add either to your dependency
3201 list (Makefile.PL, dist.ini, cpanfile, etc.)
3205 sub registered_data_handlers {
3207 if(my $data_handlers = $class->_data_handlers) {
3208 return %$data_handlers;
3210 $class->setup_data_handlers;
3211 return $class->registered_data_handlers;
3215 sub setup_data_handlers {
3216 my ($class, %data_handler_callbacks) = @_;
3217 %data_handler_callbacks = (
3218 %{$class->default_data_handlers},
3219 %{$class->config->{'data_handlers'}||+{}},
3220 %data_handler_callbacks);
3222 $class->_data_handlers(\%data_handler_callbacks);
3225 sub default_data_handlers {
3228 'application/x-www-form-urlencoded' => sub {
3229 my ($fh, $req) = @_;
3230 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
3231 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
3232 ->can('build_cgi_struct')->($params);
3234 'application/json' => sub {
3235 Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON')
3236 ->can('decode_json')->(do { local $/; $_->getline });
3243 Returns an arrayref of the internal execution stack (actions that are
3244 currently executing).
3248 Returns the current timing statistics object. By default Catalyst uses
3249 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
3250 L<< stats_class|/"$c->stats_class" >>.
3252 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
3253 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
3254 profile explicitly, although MyApp.pm still won't profile nor output anything
3257 =head2 $c->stats_class
3259 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
3261 =head2 $c->use_stats
3263 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
3265 Note that this is a static method, not an accessor and should be overridden
3266 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
3273 =head2 $c->write( $data )
3275 Writes $data to the output stream. When using this method directly, you
3276 will need to manually set the C<Content-Length> header to the length of
3277 your output data, if known.
3284 # Finalize headers if someone manually writes output (for compat)
3285 $c->finalize_headers;
3287 return $c->response->write( @_ );
3292 Returns the Catalyst version number. Mostly useful for "powered by"
3293 messages in template systems.
3297 sub version { return $Catalyst::VERSION }
3299 =head1 CONFIGURATION
3301 There are a number of 'base' config variables which can be set:
3307 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
3311 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
3315 C<disable_component_resolution_regex_fallback> - Turns
3316 off the deprecated component resolution functionality so
3317 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
3318 are called then regex search will not be attempted on string values and
3319 instead C<undef> will be returned.
3323 C<home> - The application home directory. In an uninstalled application,
3324 this is the top level application directory. In an installed application,
3325 this will be the directory containing C<< MyApp.pm >>.
3329 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
3333 C<name> - The name of the application in debug messages and the debug and
3338 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
3339 until it is accessed. This allows you to (for example) check authentication (and reject
3340 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
3344 C<root> - The root directory for templates. Usually this is just a
3345 subdirectory of the home directory, but you can set it to change the
3346 templates to a different directory.
3350 C<search_extra> - Array reference passed to Module::Pluggable to for additional
3351 namespaces from which components will be loaded (and constructed and stored in
3352 C<< $c->components >>).
3356 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
3357 to be shown in hit debug tables in the test server.
3361 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
3362 variable should be used for determining the request path.
3364 Most web server environments pass the requested path to the application using environment variables,
3365 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
3366 exposed as C<< $c->request->base >>) and the request path below that base.
3368 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
3369 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
3373 =item use_request_uri_for_path => 0
3375 This is the default (and the) traditional method that Catalyst has used for determining the path information.
3376 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
3377 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
3378 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
3380 However this method has the major disadvantage that it is impossible to correctly decode some elements
3381 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
3382 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
3383 can't distinguish / vs %2F in paths (in addition to other encoded values).
3385 =item use_request_uri_for_path => 1
3387 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
3388 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
3389 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
3391 Given that this method of path resolution is provably more correct, it is recommended that you use
3392 this unless you have a specific need to deploy your application in a non-standard environment, and you are
3393 aware of the implications of not being able to handle encoded URI paths correctly.
3395 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
3396 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
3397 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
3398 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
3399 C<< $c->request->base >> will be incorrect.
3405 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
3409 C<encoding> - See L</ENCODING>
3413 C<abort_chain_on_error_fix>
3415 When there is an error in an action chain, the default behavior is to continue
3416 processing the remaining actions and then catch the error upon chain end. This
3417 can lead to running actions when the application is in an unexpected state. If
3418 you have this issue, setting this config value to true will promptly exit a
3419 chain when there is an error raised in any action (thus terminating the chain
3424 __PACKAGE__->config(abort_chain_on_error_fix => 1);
3426 In the future this might become the default behavior.
3430 C<use_hash_multivalue_in_request>
3432 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
3433 and C<parameters> return a hashref where values might be scalar or an arrayref
3434 depending on the incoming data. In many cases this can be undesirable as it
3435 leads one to writing defensive code like the following:
3437 my ($val) = ref($c->req->parameters->{a}) ?
3438 @{$c->req->parameters->{a}} :
3439 $c->req->parameters->{a};
3441 Setting this configuration item to true will make L<Catalyst> populate the
3442 attributes underlying these methods with an instance of L<Hash::MultiValue>
3443 which is used by L<Plack::Request> and others to solve this very issue. You
3444 may prefer this behavior to the default, if so enable this option (be warned
3445 if you enable it in a legacy application we are not sure if it is completely
3446 backwardly compatible).
3450 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
3454 C<data_handlers> - See L<DATA HANDLERS>.
3460 Generally when you throw an exception inside an Action (or somewhere in
3461 your stack, such as in a model that an Action is calling) that exception
3462 is caught by Catalyst and unless you either catch it yourself (via eval
3463 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
3464 will eventually reach L</finalize_errors> and return either the debugging
3465 error stack page, or the default error page. However, if your exception
3466 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
3467 instead rethrow it so that it can be handled by that middleware (which
3468 is part of the default middleware). For example this would allow
3470 use HTTP::Throwable::Factory 'http_throw';
3472 sub throws_exception :Local {
3473 my ($self, $c) = @_;
3475 http_throw(SeeOther => { location =>
3476 $c->uri_for($self->action_for('redirect')) });
3480 =head1 INTERNAL ACTIONS
3482 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
3483 C<_ACTION>, and C<_END>. These are by default not shown in the private
3484 action table, but you can make them visible with a config parameter.
3486 MyApp->config(show_internal_actions => 1);
3488 =head1 ON-DEMAND PARSER
3490 The request body is usually parsed at the beginning of a request,
3491 but if you want to handle input yourself, you can enable on-demand
3492 parsing with a config parameter.
3494 MyApp->config(parse_on_demand => 1);
3496 =head1 PROXY SUPPORT
3498 Many production servers operate using the common double-server approach,
3499 with a lightweight frontend web server passing requests to a larger
3500 backend server. An application running on the backend server must deal
3501 with two problems: the remote user always appears to be C<127.0.0.1> and
3502 the server's hostname will appear to be C<localhost> regardless of the
3503 virtual host that the user connected through.
3505 Catalyst will automatically detect this situation when you are running
3506 the frontend and backend servers on the same machine. The following
3507 changes are made to the request.
3509 $c->req->address is set to the user's real IP address, as read from
3510 the HTTP X-Forwarded-For header.
3512 The host value for $c->req->base and $c->req->uri is set to the real
3513 host, as read from the HTTP X-Forwarded-Host header.
3515 Additionally, you may be running your backend application on an insecure
3516 connection (port 80) while your frontend proxy is running under SSL. If there
3517 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
3518 tell Catalyst what port the frontend listens on. This will allow all URIs to
3519 be created properly.
3521 In the case of passing in:
3523 X-Forwarded-Port: 443
3525 All calls to C<uri_for> will result in an https link, as is expected.
3527 Obviously, your web server must support these headers for this to work.
3529 In a more complex server farm environment where you may have your
3530 frontend proxy server(s) on different machines, you will need to set a
3531 configuration option to tell Catalyst to read the proxied data from the
3534 MyApp->config(using_frontend_proxy => 1);
3536 If you do not wish to use the proxy support at all, you may set:
3538 MyApp->config(ignore_frontend_proxy => 0);
3540 =head2 Note about psgi files
3542 Note that if you supply your own .psgi file, calling
3543 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
3545 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
3546 in your psgi, for example:
3549 enable "Plack::Middleware::ReverseProxy";
3553 This will unconditionally add the ReverseProxy support, or you need to call
3554 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
3555 apply the support depending upon your config).
3557 See L<Catalyst::PSGI> for more information.
3559 =head1 THREAD SAFETY
3561 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
3562 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
3563 believe the Catalyst core to be thread-safe.
3565 If you plan to operate in a threaded environment, remember that all other
3566 modules you are using must also be thread-safe. Some modules, most notably
3567 L<DBD::SQLite>, are not thread-safe.
3569 =head1 DATA HANDLERS
3571 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
3572 form parameters and URL search query fields. However it has become common
3573 for various alternative content types to be PUT or POSTed to your controllers
3574 and actions. People working on RESTful APIs, or using AJAX often use JSON,
3575 XML and other content types when communicating with an application server. In
3576 order to better support this use case, L<Catalyst> defines a global configuration
3577 option, C<data_handlers>, which lets you associate a content type with a coderef
3578 that parses that content type into something Perl can readily access.
3585 __PACKAGE__->config(
3587 'application/json' => sub { local $/; decode_json $_->getline },
3589 ## Any other configuration.
3594 By default L<Catalyst> comes with a generic JSON data handler similar to the
3595 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
3596 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
3597 it installed (if you want the faster XS parser, add it to you project Makefile.PL
3598 or dist.ini, cpanfile, etc.)
3600 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
3601 (matched against the incoming request type using a regexp such as to be case
3602 insensitive) and whose values are coderefs that receive a localized version of
3603 C<$_> which is a filehandle object pointing to received body.
3605 This feature is considered an early access release and we reserve the right
3606 to alter the interface in order to provide a performant and secure solution to
3607 alternative request body content. Your reports welcomed!
3609 =head1 PSGI MIDDLEWARE
3611 You can define middleware, defined as L<Plack::Middleware> or a compatible
3612 interface in configuration. Your middleware definitions are in the form of an
3613 arrayref under the configuration key C<psgi_middleware>. Here's an example
3614 with details to follow:
3619 use Plack::Middleware::StackTrace;
3621 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3623 __PACKAGE__->config(
3624 'psgi_middleware', [
3627 $stacktrace_middleware,
3628 'Session' => {store => 'File'},
3633 $env->{myapp.customkey} = 'helloworld';
3642 So the general form is:
3644 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
3646 Where C<@middleware> is one or more of the following, applied in the REVERSE of
3647 the order listed (to make it function similarly to L<Plack::Builder>:
3649 Alternatively, you may also define middleware by calling the L</setup_middleware>
3656 __PACKAGE__->setup_middleware( \@middleware_definitions);
3659 In the case where you do both (use 'setup_middleware' and configuration) the
3660 package call to setup_middleware will be applied earlier (in other words its
3661 middleware will wrap closer to the application). Keep this in mind since in
3662 some cases the order of middleware is important.
3664 The two approaches are not exclusive.
3668 =item Middleware Object
3670 An already initialized object that conforms to the L<Plack::Middleware>
3673 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
3675 __PACKAGE__->config(
3676 'psgi_middleware', [
3677 $stacktrace_middleware,
3683 A coderef that is an inlined middleware:
3685 __PACKAGE__->config(
3686 'psgi_middleware', [
3691 if($env->{PATH_INFO} =~m/forced/) {
3693 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
3696 return $app->($env);
3706 We assume the scalar refers to a namespace after normalizing it using the
3709 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
3710 is assumed to be 'as is', and we just install and use the middleware.
3712 (2) If the scalar begins with "Plack::Middleware" or your application namespace
3713 (the package name of your Catalyst application subclass), we also assume then
3714 that it is a full namespace, and use it.
3716 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
3717 resolve it first by looking for it under your application namespace (for example
3718 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
3719 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
3720 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
3721 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
3722 namespace first to let you 'override' common L<Plack::Middleware> locally, should
3723 you find that a good idea.
3729 __PACKAGE__->config(
3730 'psgi_middleware', [
3731 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
3732 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
3733 '+MyApp::Custom', ## MyApp::Custom->wrap
3737 =item a scalar followed by a hashref
3739 Just like the previous, except the following C<HashRef> is used as arguments
3740 to initialize the middleware object.
3742 __PACKAGE__->config(
3743 'psgi_middleware', [
3744 'Session' => {store => 'File'},
3749 Please see L<PSGI> for more on middleware.
3753 On request, decodes all params from encoding into a sequence of
3754 logical characters. On response, encodes body into encoding.
3762 Returns an instance of an C<Encode> encoding
3764 print $c->encoding->name
3766 =item handle_unicode_encoding_exception ($exception_context)
3768 Method called when decoding process for a request fails.
3770 An C<$exception_context> hashref is provided to allow you to override the
3771 behaviour of your application when given data with incorrect encodings.
3773 The default method throws exceptions in the case of invalid request parameters
3774 (resulting in a 500 error), but ignores errors in upload filenames.
3776 The keys passed in the C<$exception_context> hash are:
3782 The value which was not able to be decoded.
3786 The exception received from L<Encode>.
3790 What type of data was being decoded. Valid values are (currently)
3791 C<params> - for request parameters / arguments / captures
3792 and C<uploads> - for request upload filenames.
3802 Join #catalyst on irc.perl.org.
3806 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
3807 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
3811 http://catalyst.perl.org
3815 http://dev.catalyst.perl.org
3819 =head2 L<Task::Catalyst> - All you need to start with Catalyst
3821 =head2 L<Catalyst::Manual> - The Catalyst Manual
3823 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
3825 =head2 L<Catalyst::Engine> - Core engine
3827 =head2 L<Catalyst::Log> - Log class.
3829 =head2 L<Catalyst::Request> - Request object
3831 =head2 L<Catalyst::Response> - Response object
3833 =head2 L<Catalyst::Test> - The test suite.
3835 =head1 PROJECT FOUNDER
3837 sri: Sebastian Riedel <sri@cpan.org>
3843 acme: Leon Brocard <leon@astray.com>
3845 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
3849 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
3853 andyg: Andy Grundman <andy@hybridized.org>
3855 audreyt: Audrey Tang
3857 bricas: Brian Cassidy <bricas@cpan.org>
3859 Caelum: Rafael Kitover <rkitover@io.com>
3861 chansen: Christian Hansen
3863 chicks: Christopher Hicks
3865 Chisel Wright C<pause@herlpacker.co.uk>
3867 Danijel Milicevic C<me@danijel.de>
3869 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
3871 David Naughton, C<naughton@umn.edu>
3875 dhoss: Devin Austin <dhoss@cpan.org>
3877 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
3881 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
3883 esskar: Sascha Kiefer
3885 fireartist: Carl Franks <cfranks@cpan.org>
3887 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
3889 gabb: Danijel Milicevic
3893 Gavin Henry C<ghenry@perl.me.uk>
3897 groditi: Guillermo Roditi <groditi@gmail.com>
3899 hobbs: Andrew Rodland <andrew@cleverdomain.org>
3901 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
3903 jcamacho: Juan Camacho
3905 jester: Jesse Sheidlower C<jester@panix.com>
3907 jhannah: Jay Hannah <jay@jays.net>
3913 jon: Jon Schutz <jjschutz@cpan.org>
3915 Jonathan Rockway C<< <jrockway@cpan.org> >>
3917 Kieren Diment C<kd@totaldatasolution.com>
3919 konobi: Scott McWhirter <konobi@cpan.org>
3921 marcus: Marcus Ramberg <mramberg@cpan.org>
3923 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
3925 mgrimes: Mark Grimes <mgrimes@cpan.org>
3927 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
3931 naughton: David Naughton
3933 ningu: David Kamholz <dkamholz@cpan.org>
3935 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
3937 numa: Dan Sully <daniel@cpan.org>
3943 omega: Andreas Marienborg
3945 Oleg Kostyuk <cub.uanic@gmail.com>
3947 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
3949 rafl: Florian Ragwitz <rafl@debian.org>
3951 random: Roland Lammel <lammel@cpan.org>
3953 Robert Sedlacek C<< <rs@474.at> >>
3955 SpiceMan: Marcel Montes
3959 szbalint: Balint Szilakszi <szbalint@cpan.org>
3961 t0m: Tomas Doran <bobtfish@bobtfish.net>
3965 vanstyn: Henry Van Styn <vanstyn@cpan.org>
3967 Viljo Marrandi C<vilts@yahoo.com>
3969 Will Hawes C<info@whawes.co.uk>
3971 willert: Sebastian Willert <willert@cpan.org>
3973 wreis: Wallace Reis <wreis@cpan.org>
3975 Yuval Kogman, C<nothingmuch@woobling.org>
3977 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
3979 dd070: Dhaval Dhanani <dhaval070@gmail.com>
3981 Upasana <me@upasana.me>
3985 Copyright (c) 2005-2014, the above named PROJECT FOUNDER and CONTRIBUTORS.
3989 This library is free software. You can redistribute it and/or modify it under
3990 the same terms as Perl itself.
3996 __PACKAGE__->meta->make_immutable;