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;
31 use String::RewritePrefix;
32 use Catalyst::EngineLoader;
34 use Carp qw/croak carp shortmess/;
37 use Moose::Util 'find_meta';
38 use Plack::Middleware::Conditional;
39 use Plack::Middleware::ReverseProxy;
40 use Plack::Middleware::IIS6ScriptNameFix;
41 use Plack::Middleware::IIS7KeepAliveFix;
42 use Plack::Middleware::LighttpdScriptNameFix;
43 use Plack::Middleware::ContentLength;
44 use Plack::Middleware::Head;
45 use Plack::Middleware::HTTPExceptions;
46 use Plack::Middleware::FixMissingBodyInRedirect;
47 use Plack::Middleware::MethodOverride;
48 use Plack::Middleware::RemoveRedundantBody;
49 use Catalyst::Middleware::Stash;
51 use Class::Load 'load_class';
52 use Encode 2.21 'decode_utf8', 'encode_utf8';
55 BEGIN { require 5.008003; }
57 has stack => (is => 'ro', default => sub { [] });
58 has state => (is => 'rw', default => 0);
59 has stats => (is => 'rw');
60 has action => (is => 'rw');
61 has counter => (is => 'rw', default => sub { {} });
66 my $class = ref $self;
67 my $composed_request_class = $class->composed_request_class;
68 return $composed_request_class->new( $self->_build_request_constructor_args);
72 sub _build_request_constructor_args {
74 my %p = ( _log => $self->log );
75 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
76 $p{data_handlers} = {$self->registered_data_handlers};
77 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
78 if $self->config->{use_hash_multivalue_in_request};
82 sub composed_request_class {
84 return $class->_composed_request_class if $class->_composed_request_class;
86 my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
88 # For each trait listed, figure out what the namespace is. First we try the $trait
89 # as it is in the config. Then try $MyApp::TraitFor::Request:$trait. Last we try
90 # Catalyst::TraitFor::Request::$trait. If none load, throw error.
92 my $trait_ns = 'TraitFor::Request';
93 my @normalized_traits = map {
94 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
97 if ($class->debug && scalar(@normalized_traits)) {
98 my $column_width = Catalyst::Utils::term_width() - 6;
99 my $t = Text::SimpleTable->new($column_width);
100 $t->row($_) for @normalized_traits;
101 $class->log->debug( "Composed Request Class Traits:\n" . $t->draw . "\n" );
104 return $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits));
111 my $class = ref $self;
112 my $composed_response_class = $class->composed_response_class;
113 return $composed_response_class->new( $self->_build_response_constructor_args);
117 sub _build_response_constructor_args {
120 encoding => $_[0]->encoding,
124 sub composed_response_class {
126 return $class->_composed_response_class if $class->_composed_response_class;
128 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
130 my $trait_ns = 'TraitFor::Response';
131 my @normalized_traits = map {
132 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
135 if ($class->debug && scalar(@normalized_traits)) {
136 my $column_width = Catalyst::Utils::term_width() - 6;
137 my $t = Text::SimpleTable->new($column_width);
138 $t->row($_) for @normalized_traits;
139 $class->log->debug( "Composed Response Class Traits:\n" . $t->draw . "\n" );
142 return $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits));
145 has namespace => (is => 'rw');
147 sub depth { scalar @{ shift->stack || [] }; }
148 sub comp { shift->component(@_) }
151 my $self = shift; return $self->request(@_);
154 my $self = shift; return $self->response(@_);
157 # For backwards compatibility
158 sub finalize_output { shift->finalize_body(@_) };
163 our $RECURSION = 1000;
164 our $DETACH = Catalyst::Exception::Detach->new;
165 our $GO = Catalyst::Exception::Go->new;
167 #I imagine that very few of these really
168 #need to be class variables. if any.
169 #maybe we should just make them attributes with a default?
170 __PACKAGE__->mk_classdata($_)
171 for qw/components arguments dispatcher engine log dispatcher_class
172 engine_loader context_class request_class response_class stats_class
173 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
174 _data_handlers _encoding _encode_check finalized_default_middleware
175 request_class_traits response_class_traits stats_class_traits
176 _composed_request_class _composed_response_class _composed_stats_class/;
178 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
179 __PACKAGE__->request_class('Catalyst::Request');
180 __PACKAGE__->response_class('Catalyst::Response');
181 __PACKAGE__->stats_class('Catalyst::Stats');
183 sub composed_stats_class {
185 return $class->_composed_stats_class if $class->_composed_stats_class;
187 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
189 my $trait_ns = 'TraitFor::Stats';
190 my @normalized_traits = map {
191 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
194 if ($class->debug && scalar(@normalized_traits)) {
195 my $column_width = Catalyst::Utils::term_width() - 6;
196 my $t = Text::SimpleTable->new($column_width);
197 $t->row($_) for @normalized_traits;
198 $class->log->debug( "Composed Stats Class Traits:\n" . $t->draw . "\n" );
201 return $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits));
204 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
206 # Remember to update this in Catalyst::Runtime as well!
207 our $VERSION = '5.90115';
208 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
211 my ( $class, @arguments ) = @_;
213 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
215 return unless $class eq 'Catalyst';
217 my $caller = caller();
218 return if $caller eq 'main';
220 my $meta = Moose::Meta::Class->initialize($caller);
221 unless ( $caller->isa('Catalyst') ) {
222 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
223 $meta->superclasses(@superclasses);
225 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
226 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
228 unless( $meta->has_method('meta') ){
229 if ($Moose::VERSION >= 1.15) {
230 $meta->_add_meta_method('meta');
233 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
237 $caller->arguments( [@arguments] );
241 sub _application { $_[0] }
247 Catalyst - The Elegant MVC Web Application Framework
251 See the L<Catalyst::Manual> distribution for comprehensive
252 documentation and tutorials.
254 # Install Catalyst::Devel for helpers and other development tools
255 # use the helper to create a new application
258 # add models, views, controllers
259 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
260 script/myapp_create.pl view MyTemplate TT
261 script/myapp_create.pl controller Search
263 # built in testserver -- use -r to restart automatically on changes
264 # --help to see all available options
265 script/myapp_server.pl
267 # command line testing interface
268 script/myapp_test.pl /yada
271 use Catalyst qw/-Debug/; # include plugins here as well
273 ### In lib/MyApp/Controller/Root.pm (autocreated)
274 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
275 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
276 $c->stash->{template} = 'foo.tt'; # set the template
277 # lookup something from db -- stash vars are passed to TT
279 $c->model('Database::Foo')->search( { country => $args[0] } );
280 if ( $c->req->params->{bar} ) { # access GET or POST parameters
281 $c->forward( 'bar' ); # process another action
282 # do something else after forward returns
286 # The foo.tt TT template can use the stash data from the database
287 [% WHILE (item = data.next) %]
291 # called for /bar/of/soap, /bar/of/soap/10, etc.
292 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
294 # called after all actions are finished
296 my ( $self, $c ) = @_;
297 if ( scalar @{ $c->error } ) { ... } # handle errors
298 return if $c->res->body; # already have a response
299 $c->forward( 'MyApp::View::TT' ); # render template
302 See L<Catalyst::Manual::Intro> for additional information.
306 Catalyst is a modern framework for making web applications without the
307 pain usually associated with this process. This document is a reference
308 to the main Catalyst application. If you are a new user, we suggest you
309 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
311 See L<Catalyst::Manual> for more documentation.
313 Catalyst plugins can be loaded by naming them as arguments to the "use
314 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
315 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
318 use Catalyst qw/My::Module/;
320 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
321 fully qualify the name by using a unary plus:
325 +Fully::Qualified::Plugin::Name
328 Special flags like C<-Debug> can also be specified as
329 arguments when Catalyst is loaded:
331 use Catalyst qw/-Debug My::Module/;
333 The position of plugins and flags in the chain is important, because
334 they are loaded in the order in which they appear.
336 The following flags are supported:
340 Enables debug output. You can also force this setting from the system
341 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
342 settings override the application, with <MYAPP>_DEBUG having the highest
345 This sets the log level to 'debug' and enables full debug output on the
346 error screen. If you only want the latter, see L<< $c->debug >>.
350 Forces Catalyst to use a specific home directory, e.g.:
352 use Catalyst qw[-Home=/usr/mst];
354 This can also be done in the shell environment by setting either the
355 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
356 is replaced with the uppercased name of your application, any "::" in
357 the name will be replaced with underscores, e.g. MyApp::Web should use
358 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
360 If none of these are set, Catalyst will attempt to automatically detect the
361 home directory. If you are working in a development environment, Catalyst
362 will try and find the directory containing either Makefile.PL, Build.PL,
363 dist.ini, or cpanfile. If the application has been installed into the system
364 (i.e. you have done C<make install>), then Catalyst will use the path to your
365 application module, without the .pm extension (e.g., /foo/MyApp if your
366 application was installed at /foo/MyApp.pm)
370 use Catalyst '-Log=warn,fatal,error';
372 Specifies a comma-delimited list of log levels.
376 Enables statistics collection and reporting.
378 use Catalyst qw/-Stats=1/;
380 You can also force this setting from the system environment with CATALYST_STATS
381 or <MYAPP>_STATS. The environment settings override the application, with
382 <MYAPP>_STATS having the highest priority.
384 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
388 =head2 INFORMATION ABOUT THE CURRENT REQUEST
392 Returns a L<Catalyst::Action> object for the current action, which
393 stringifies to the action name. See L<Catalyst::Action>.
397 Returns the namespace of the current action, i.e., the URI prefix
398 corresponding to the controller of the current action. For example:
400 # in Controller::Foo::Bar
401 $c->namespace; # returns 'foo/bar';
407 Returns the current L<Catalyst::Request> object, giving access to
408 information about the current client request (including parameters,
409 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
411 =head2 REQUEST FLOW HANDLING
413 =head2 $c->forward( $action [, \@arguments ] )
415 =head2 $c->forward( $class, $method, [, \@arguments ] )
417 This is one way of calling another action (method) in the same or
418 a different controller. You can also use C<< $self->my_method($c, @args) >>
419 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
420 in a different controller.
421 The main difference is that 'forward' uses some of the Catalyst request
422 cycle overhead, including debugging, which may be useful to you. On the
423 other hand, there are some complications to using 'forward', restrictions
424 on values returned from 'forward', and it may not handle errors as you prefer.
425 Whether you use 'forward' or not is up to you; it is not considered superior to
426 the other ways to call a method.
428 'forward' calls another action, by its private name. If you give a
429 class name but no method, C<process()> is called. You may also optionally
430 pass arguments in an arrayref. The action will receive the arguments in
431 C<@_> and C<< $c->req->args >>. Upon returning from the function,
432 C<< $c->req->args >> will be restored to the previous values.
434 Any data C<return>ed from the action forwarded to, will be returned by the
437 my $foodata = $c->forward('/foo');
438 $c->forward('index');
439 $c->forward(qw/Model::DBIC::Foo do_stuff/);
440 $c->forward('View::TT');
442 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
443 an C<< eval { } >> around the call (actually
444 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
445 exceptions thrown by the called action non-fatal and pushing them onto
446 $c->error instead. If you want C<die> to propagate you need to do something
450 die join "\n", @{ $c->error } if @{ $c->error };
452 Or make sure to always return true values from your actions and write
455 $c->forward('foo') || return;
457 Another note is that C<< $c->forward >> always returns a scalar because it
458 actually returns $c->state which operates in a scalar context.
459 Thus, something like:
463 in an action that is forwarded to is going to return a scalar,
464 i.e. how many items are in that array, which is probably not what you want.
465 If you need to return an array then return a reference to it,
468 $c->stash->{array} = \@array;
470 and access it from the stash.
472 Keep in mind that the C<end> method used is that of the caller action. So a C<< $c->detach >> inside a forwarded action would run the C<end> method from the original action requested.
476 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
478 =head2 $c->detach( $action [, \@arguments ] )
480 =head2 $c->detach( $class, $method, [, \@arguments ] )
484 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
485 doesn't return to the previous action when processing is finished.
487 When called with no arguments it escapes the processing chain entirely.
491 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
493 =head2 $c->visit( $action [, \@arguments ] )
495 =head2 $c->visit( $action [, \@captures, \@arguments ] )
497 =head2 $c->visit( $class, $method, [, \@arguments ] )
499 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
501 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
502 but does a full dispatch, instead of just calling the new C<$action> /
503 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
504 you go to are called, just like a new request.
506 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
507 This means, for example, that C<< $c->action >> methods such as
508 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
509 L<reverse|Catalyst::Action/reverse> return information for the visited action
510 when they are invoked within the visited action. This is different from the
511 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
512 continues to use the $c->action object from the caller action even when
513 invoked from the called action.
515 C<< $c->stash >> is kept unchanged.
517 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
518 allows you to "wrap" another action, just as it would have been called by
519 dispatching from a URL, while the analogous
520 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
521 transfer control to another action as if it had been reached directly from a URL.
525 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
527 =head2 $c->go( $action [, \@arguments ] )
529 =head2 $c->go( $action [, \@captures, \@arguments ] )
531 =head2 $c->go( $class, $method, [, \@arguments ] )
533 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
535 The relationship between C<go> and
536 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
537 the relationship between
538 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
539 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
540 C<< $c->go >> will perform a full dispatch on the specified action or method,
541 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
542 C<go> escapes the processing of the current request chain on completion, and
543 does not return to its caller.
545 @arguments are arguments to the final destination of $action. @captures are
546 arguments to the intermediate steps, if any, on the way to the final sub of
551 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
557 Returns the current L<Catalyst::Response> object, see there for details.
561 Returns a hashref to the stash, which may be used to store data and pass
562 it between components during a request. You can also set hash keys by
563 passing arguments. The stash is automatically sent to the view. The
564 stash is cleared at the end of a request; it cannot be used for
565 persistent storage (for this you must use a session; see
566 L<Catalyst::Plugin::Session> for a complete system integrated with
569 $c->stash->{foo} = $bar;
570 $c->stash( { moose => 'majestic', qux => 0 } );
571 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
573 # stash is automatically passed to the view for use in a template
574 $c->forward( 'MyApp::View::TT' );
576 The stash hash is currently stored in the PSGI C<$env> and is managed by
577 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
578 the stash can be accessed in sub applications mounted under your main
579 L<Catalyst> application. For example if you delegate the response of an
580 action to another L<Catalyst> application, that sub application will have
581 access to all the stash keys of the main one, and if can of course add
582 more keys of its own. However those new keys will not 'bubble' back up
583 to the main application.
585 For more information the best thing to do is to review the test case:
586 t/middleware-stash.t in the distribution /t directory.
592 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
593 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
598 =head2 $c->error($error, ...)
600 =head2 $c->error($arrayref)
602 Returns an arrayref containing error messages. If Catalyst encounters an
603 error while processing a request, it stores the error in $c->error. This
604 method should only be used to store fatal error messages.
606 my @error = @{ $c->error };
610 $c->error('Something bad happened');
612 Calling this will always return an arrayref (if there are no errors it
613 will be an empty arrayref.
620 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
621 croak @$error unless ref $c;
622 push @{ $c->{error} }, @$error;
624 elsif ( defined $_[0] ) { $c->{error} = undef }
625 return $c->{error} || [];
630 Contains the return value of the last executed action.
631 Note that << $c->state >> operates in a scalar context which means that all
632 values it returns are scalar.
634 Please note that if an action throws an exception, the value of state
635 should no longer be considered the return if the last action. It is generally
636 going to be 0, which indicates an error state. Examine $c->error for error
639 =head2 $c->clear_errors
641 Clear errors. You probably don't want to clear the errors unless you are
642 implementing a custom error screen.
644 This is equivalent to running
655 =head2 $c->has_errors
657 Returns true if you have errors
661 sub has_errors { scalar(@{shift->error}) ? 1:0 }
663 =head2 $c->last_error
665 Returns the most recent error in the stack (the one most recently added...)
666 or nothing if there are no errors. This does not modify the contents of the
672 my (@errs) = @{shift->error};
673 return scalar(@errs) ? $errs[-1]: undef;
678 shifts the most recently added error off the error stack and returns it. Returns
679 nothing if there are no more errors.
685 my @errors = @{$self->error};
686 my $err = shift(@errors);
687 $self->{error} = \@errors;
693 pops the most recently added error off the error stack and returns it. Returns
694 nothing if there are no more errors.
700 my @errors = @{$self->error};
701 my $err = pop(@errors);
702 $self->{error} = \@errors;
706 sub _comp_search_prefixes {
708 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
711 # search components given a name and some prefixes
712 sub _comp_names_search_prefixes {
713 my ( $c, $name, @prefixes ) = @_;
714 my $appclass = ref $c || $c;
715 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
716 $filter = qr/$filter/; # Compile regex now rather than once per loop
718 # map the original component name to the sub part that we will search against
719 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
720 grep { /$filter/ } keys %{ $c->components };
722 # undef for a name will return all
723 return keys %eligible if !defined $name;
725 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
726 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
728 return @result if @result;
730 # if we were given a regexp to search against, we're done.
731 return if $name->$_isa('Regexp');
733 # skip regexp fallback if configured
735 if $appclass->config->{disable_component_resolution_regex_fallback};
739 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
741 # no results? try against full names
743 @result = grep { m{$query} } keys %eligible;
746 # don't warn if we didn't find any results, it just might not exist
748 # Disgusting hack to work out correct method name
749 my $warn_for = lc $prefixes[0];
750 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
751 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
752 "component resolution is unreliable and unsafe.";
753 my $short = $result[0];
754 # remove the component namespace prefix
755 $short =~ s/.*?(Model|Controller|View):://;
756 my $shortmess = Carp::shortmess('');
757 if ($shortmess =~ m#Catalyst/Plugin#) {
758 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
760 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
761 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
762 "component's config";
764 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
765 "but if you really wanted to search, pass in a regexp as the argument " .
766 "like so: \$c->${warn_for}(qr/${name}/)";
768 $c->log->warn( "${msg}$shortmess" );
774 # Find possible names for a prefix
776 my ( $c, @prefixes ) = @_;
777 my $appclass = ref $c || $c;
779 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
781 my @names = map { s{$filter}{}; $_; }
782 $c->_comp_names_search_prefixes( undef, @prefixes );
787 # Filter a component before returning by calling ACCEPT_CONTEXT if available
789 sub _filter_component {
790 my ( $c, $comp, @args ) = @_;
792 if(ref $comp eq 'CODE') {
796 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
797 return $comp->ACCEPT_CONTEXT( $c, @args );
800 $c->log->warn("You called component '${\$comp->catalyst_component_name}' with arguments [@args], but this component does not ACCEPT_CONTEXT, so args are ignored.") if scalar(@args) && $c->debug;
805 =head2 COMPONENT ACCESSORS
807 =head2 $c->controller($name)
809 Gets a L<Catalyst::Controller> instance by name.
811 $c->controller('Foo')->do_stuff;
813 If the name is omitted, will return the controller for the dispatched
816 If you want to search for controllers, pass in a regexp as the argument.
818 # find all controllers that start with Foo
819 my @foo_controllers = $c->controller(qr{^Foo});
825 my ( $c, $name, @args ) = @_;
827 my $appclass = ref($c) || $c;
829 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
830 my $comps = $c->components;
831 my $check = $appclass."::Controller::".$name;
832 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
833 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
834 next unless $path =~ /.*::Controller/;
835 $check = $path."::".$name;
836 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
839 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
840 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
841 return $c->_filter_component( $result[ 0 ], @args );
844 return $c->component( $c->action->class );
847 =head2 $c->model($name)
849 Gets a L<Catalyst::Model> instance by name.
851 $c->model('Foo')->do_stuff;
853 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
854 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
856 If the name is omitted, it will look for
857 - a model object in $c->stash->{current_model_instance}, then
858 - a model name in $c->stash->{current_model}, then
859 - a config setting 'default_model', or
860 - check if there is only one model, and return it if that's the case.
862 If you want to search for models, pass in a regexp as the argument.
864 # find all models that start with Foo
865 my @foo_models = $c->model(qr{^Foo});
870 my ( $c, $name, @args ) = @_;
871 my $appclass = ref($c) || $c;
873 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
874 my $comps = $c->components;
875 my $check = $appclass."::Model::".$name;
876 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
877 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
878 next unless $path =~ /.*::Model/;
879 $check = $path."::".$name;
880 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
883 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
884 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
885 return $c->_filter_component( $result[ 0 ], @args );
889 return $c->stash->{current_model_instance}
890 if $c->stash->{current_model_instance};
891 return $c->model( $c->stash->{current_model} )
892 if $c->stash->{current_model};
894 return $c->model( $appclass->config->{default_model} )
895 if $appclass->config->{default_model};
897 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
900 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
901 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
902 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
903 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
904 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
907 return $c->_filter_component( $comp );
911 =head2 $c->view($name)
913 Gets a L<Catalyst::View> instance by name.
915 $c->view('Foo')->do_stuff;
917 Any extra arguments are directly passed to ACCEPT_CONTEXT.
919 If the name is omitted, it will look for
920 - a view object in $c->stash->{current_view_instance}, then
921 - a view name in $c->stash->{current_view}, then
922 - a config setting 'default_view', or
923 - check if there is only one view, and return it if that's the case.
925 If you want to search for views, pass in a regexp as the argument.
927 # find all views that start with Foo
928 my @foo_views = $c->view(qr{^Foo});
933 my ( $c, $name, @args ) = @_;
935 my $appclass = ref($c) || $c;
937 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
938 my $comps = $c->components;
939 my $check = $appclass."::View::".$name;
940 if( exists $comps->{$check} ) {
941 return $c->_filter_component( $comps->{$check}, @args );
944 $c->log->warn( "Attempted to use view '$check', but does not exist" );
946 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
947 next unless $path =~ /.*::View/;
948 $check = $path."::".$name;
949 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
952 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
953 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
954 return $c->_filter_component( $result[ 0 ], @args );
958 return $c->stash->{current_view_instance}
959 if $c->stash->{current_view_instance};
960 return $c->view( $c->stash->{current_view} )
961 if $c->stash->{current_view};
963 return $c->view( $appclass->config->{default_view} )
964 if $appclass->config->{default_view};
966 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
969 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
970 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
971 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
972 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
973 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
976 return $c->_filter_component( $comp );
979 =head2 $c->controllers
981 Returns the available names which can be passed to $c->controller
987 return $c->_comp_names(qw/Controller C/);
992 Returns the available names which can be passed to $c->model
998 return $c->_comp_names(qw/Model M/);
1004 Returns the available names which can be passed to $c->view
1010 return $c->_comp_names(qw/View V/);
1013 =head2 $c->comp($name)
1015 =head2 $c->component($name)
1017 Gets a component object by name. This method is not recommended,
1018 unless you want to get a specific component by full
1019 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
1020 should be used instead.
1022 If C<$name> is a regexp, a list of components matched against the full
1023 component name will be returned.
1025 If Catalyst can't find a component by name, it will fallback to regex
1026 matching by default. To disable this behaviour set
1027 disable_component_resolution_regex_fallback to a true value.
1029 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
1034 my ( $c, $name, @args ) = @_;
1037 my $comps = $c->components;
1040 # is it the exact name?
1041 return $c->_filter_component( $comps->{ $name }, @args )
1042 if exists $comps->{ $name };
1044 # perhaps we just omitted "MyApp"?
1045 my $composed = ( ref $c || $c ) . "::${name}";
1046 return $c->_filter_component( $comps->{ $composed }, @args )
1047 if exists $comps->{ $composed };
1049 # search all of the models, views and controllers
1050 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
1051 return $c->_filter_component( $comp, @args ) if $comp;
1055 if $c->config->{disable_component_resolution_regex_fallback};
1057 # This is here so $c->comp( '::M::' ) works
1058 my $query = ref $name ? $name : qr{$name}i;
1060 my @result = grep { m{$query} } keys %{ $c->components };
1061 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1063 if( $result[ 0 ] ) {
1064 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1065 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1066 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1067 return $c->_filter_component( $result[ 0 ], @args );
1070 # I would expect to return an empty list here, but that breaks back-compat
1074 return sort keys %{ $c->components };
1077 =head2 CLASS DATA AND HELPER CLASSES
1081 Returns or takes a hashref containing the application's configuration.
1083 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1085 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1086 like C<myapp.conf> in your applications home directory. See
1087 L<Catalyst::Plugin::ConfigLoader>.
1089 =head3 Cascading configuration
1091 The config method is present on all Catalyst components, and configuration
1092 will be merged when an application is started. Configuration loaded with
1093 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1094 followed by configuration in your top level C<MyApp> class. These two
1095 configurations are merged, and then configuration data whose hash key matches a
1096 component name is merged with configuration for that component.
1098 The configuration for a component is then passed to the C<new> method when a
1099 component is constructed.
1103 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1104 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1106 will mean that C<MyApp::Model::Foo> receives the following data when
1109 MyApp::Model::Foo->new({
1115 It's common practice to use a Moose attribute
1116 on the receiving component to access the config value.
1118 package MyApp::Model::Foo;
1122 # this attr will receive 'baz' at construction time
1128 You can then get the value 'baz' by calling $c->model('Foo')->bar
1129 (or $self->bar inside code in the model).
1131 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1132 as a way of reading config within your code, as this B<will not> give you the
1133 correctly merged config back. You B<MUST> take the config values supplied to
1134 the constructor and use those instead.
1138 around config => sub {
1142 croak('Setting config after setup has been run is not allowed.')
1143 if ( @_ and $c->setup_finished );
1150 Returns the logging object instance. Unless it is already set, Catalyst
1151 sets this up with a L<Catalyst::Log> object. To use your own log class,
1152 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1153 C<< __PACKAGE__->setup >>.
1155 __PACKAGE__->log( MyLogger->new );
1160 $c->log->info( 'Now logging with my own logger!' );
1162 Your log class should implement the methods described in
1167 Returned True if there's a valid encoding
1169 =head2 clear_encoding
1171 Clears the encoding for the current context
1175 Sets or gets the application encoding. Setting encoding takes either an
1176 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1178 You would expect to get the encoding object back if you attempt to set it. If
1179 there is a failure you will get undef returned and an error message in the log.
1183 sub has_encoding { shift->encoding ? 1:0 }
1185 sub clear_encoding {
1188 $c->encoding(undef);
1190 $c->log->error("You can't clear encoding on the application");
1200 # Don't let one change this once we are too far into the response
1201 if(blessed $c && $c->res->finalized_headers) {
1202 Carp::croak("You may not change the encoding once the headers are finalized");
1206 # Let it be set to undef
1207 if (my $wanted = shift) {
1208 $encoding = Encode::find_encoding($wanted)
1209 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1210 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1217 ? $c->{encoding} = $encoding
1218 : $c->_encoding($encoding);
1220 $encoding = ref $c && exists $c->{encoding}
1230 Returns 1 if debug mode is enabled, 0 otherwise.
1232 You can enable debug mode in several ways:
1236 =item By calling myapp_server.pl with the -d flag
1238 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1240 =item The -Debug option in your MyApp.pm
1242 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1246 The first three also set the log level to 'debug'.
1248 Calling C<< $c->debug(1) >> has no effect.
1254 =head2 $c->dispatcher
1256 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1260 Returns the engine instance. See L<Catalyst::Engine>.
1263 =head2 UTILITY METHODS
1265 =head2 $c->path_to(@path)
1267 Merges C<@path> with C<< $c->config->{home} >> and returns a
1268 L<Path::Class::Dir> object. Note you can usually use this object as
1269 a filename, but sometimes you will have to explicitly stringify it
1270 yourself by calling the C<< ->stringify >> method.
1274 $c->path_to( 'db', 'sqlite.db' );
1279 my ( $c, @path ) = @_;
1280 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1281 if ( -d $path ) { return $path }
1282 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1286 my ( $class, $name, $plugin, @args ) = @_;
1288 # See block comment in t/unit_core_plugin.t
1289 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1291 $class->_register_plugin( $plugin, 1 );
1293 eval { $plugin->import };
1294 $class->mk_classdata($name);
1296 eval { $obj = $plugin->new(@args) };
1299 Catalyst::Exception->throw( message =>
1300 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1303 $class->$name($obj);
1304 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1310 Initializes the dispatcher and engine, loads any plugins, and loads the
1311 model, view, and controller components. You may also specify an array
1312 of plugins to load here, if you choose to not load them in the C<use
1316 MyApp->setup( qw/-Debug/ );
1318 B<Note:> You B<should not> wrap this method with method modifiers
1319 or bad things will happen - wrap the C<setup_finalize> method instead.
1321 B<Note:> You can create a custom setup stage that will execute when the
1322 application is starting. Use this to customize setup.
1324 MyApp->setup(-Custom=value);
1327 my ($class, $value) = @_;
1330 Can be handy if you want to hook into the setup phase.
1335 my ( $class, @arguments ) = @_;
1336 croak('Running setup more than once')
1337 if ( $class->setup_finished );
1339 unless ( $class->isa('Catalyst') ) {
1341 Catalyst::Exception->throw(
1342 message => qq/'$class' does not inherit from Catalyst/ );
1345 if ( $class->arguments ) {
1346 @arguments = ( @arguments, @{ $class->arguments } );
1352 foreach (@arguments) {
1356 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1358 elsif (/^-(\w+)=?(.*)$/) {
1359 $flags->{ lc $1 } = $2;
1362 push @{ $flags->{plugins} }, $_;
1366 $class->setup_home( delete $flags->{home} );
1368 $class->setup_log( delete $flags->{log} );
1369 $class->setup_plugins( delete $flags->{plugins} );
1371 $class->setup_data_handlers();
1372 $class->setup_dispatcher( delete $flags->{dispatcher} );
1373 if (my $engine = delete $flags->{engine}) {
1374 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1376 $class->setup_engine();
1377 $class->setup_stats( delete $flags->{stats} );
1379 for my $flag ( sort keys %{$flags} ) {
1381 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1382 &$code( $class, delete $flags->{$flag} );
1385 $class->log->warn(qq/Unknown flag "$flag"/);
1389 eval { require Catalyst::Devel; };
1390 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1391 $class->log->warn(<<"EOF");
1392 You are running an old script!
1394 Please update by running (this will overwrite existing files):
1395 catalyst.pl -force -scripts $class
1397 or (this will not overwrite existing files):
1398 catalyst.pl -scripts $class
1403 # Call plugins setup, this is stupid and evil.
1404 # Also screws C3 badly on 5.10, hack to avoid.
1406 no warnings qw/redefine/;
1407 local *setup = sub { };
1408 $class->setup unless $Catalyst::__AM_RESTARTING;
1411 # If you are expecting configuration info as part of your setup, it needs
1412 # to get called here and below, since we need the above line to support
1413 # ConfigLoader based configs.
1415 $class->setup_encoding();
1416 $class->setup_middleware();
1418 # Initialize our data structure
1419 $class->components( {} );
1421 $class->setup_components;
1423 if ( $class->debug ) {
1424 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1427 my $column_width = Catalyst::Utils::term_width() - 6;
1428 my $t = Text::SimpleTable->new($column_width);
1429 $t->row($_) for @plugins;
1430 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1433 my @middleware = map {
1436 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1437 || '') } $class->registered_middlewares;
1440 my $column_width = Catalyst::Utils::term_width() - 6;
1441 my $t = Text::SimpleTable->new($column_width);
1442 $t->row($_) for @middleware;
1443 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1446 my %dh = $class->registered_data_handlers;
1447 if (my @data_handlers = keys %dh) {
1448 my $column_width = Catalyst::Utils::term_width() - 6;
1449 my $t = Text::SimpleTable->new($column_width);
1450 $t->row($_) for @data_handlers;
1451 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1454 my $dispatcher = $class->dispatcher;
1455 my $engine = $class->engine;
1456 my $home = $class->config->{home};
1458 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1459 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1463 ? $class->log->debug(qq/Found home "$home"/)
1464 : $class->log->debug(qq/Home "$home" doesn't exist/)
1465 : $class->log->debug(q/Couldn't find home/);
1467 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1469 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1470 for my $comp ( sort keys %{ $class->components } ) {
1471 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1472 $t->row( $comp, $type );
1474 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1475 if ( keys %{ $class->components } );
1478 # Add our self to components, since we are also a component
1479 if( $class->isa('Catalyst::Controller') ){
1480 $class->components->{$class} = $class;
1483 $class->setup_actions;
1485 if ( $class->debug ) {
1486 my $name = $class->config->{name} || 'Application';
1487 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1490 if ($class->config->{case_sensitive}) {
1491 $class->log->warn($class . "->config->{case_sensitive} is set.");
1492 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1495 # call these so we pre setup the composed classes
1496 $class->composed_request_class;
1497 $class->composed_response_class;
1498 $class->composed_stats_class;
1500 $class->setup_finalize;
1502 # Flush the log for good measure (in case something turned off 'autoflush' early)
1503 $class->log->_flush() if $class->log->can('_flush');
1505 return $class || 1; # Just in case someone named their Application 0...
1508 =head2 $app->setup_finalize
1510 A hook to attach modifiers to. This method does not do anything except set the
1511 C<setup_finished> accessor.
1513 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1517 after setup_finalize => sub {
1525 sub setup_finalize {
1527 $class->setup_finished(1);
1530 =head2 $c->uri_for( $path?, @args?, \%query_values?, \$fragment? )
1532 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values?, \$fragment? )
1534 =head2 $c->uri_for( $action, [@captures, @args], \%query_values?, \$fragment? )
1536 Constructs an absolute L<URI> object based on the application root, the
1537 provided path, and the additional arguments and query parameters provided.
1538 When used as a string, provides a textual URI. If you need more flexibility
1539 than this (i.e. the option to provide relative URIs etc.) see
1540 L<Catalyst::Plugin::SmartURI>.
1542 If no arguments are provided, the URI for the current action is returned.
1543 To return the current action and also provide @args, use
1544 C<< $c->uri_for( $c->action, @args ) >>.
1546 If the first argument is a string, it is taken as a public URI path relative
1547 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1548 relative to the application root (if it does). It is then merged with
1549 C<< $c->request->base >>; any C<@args> are appended as additional path
1550 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1552 B<NOTE> If you are using this 'stringy' first argument, we skip encoding and
1553 allow you to declare something like:
1555 $c->uri_for('/foo/bar#baz')
1557 Where 'baz' is a URI fragment. We consider this first argument string to be
1558 'expert' mode where you are expected to create a valid URL and we for the most
1559 part just pass it through without a lot of internal effort to escape and encode.
1561 If the first argument is a L<Catalyst::Action> it represents an action which
1562 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1563 optional C<\@captures> argument (an arrayref) allows passing the captured
1564 variables that are needed to fill in the paths of Chained and Regex actions;
1565 once the path is resolved, C<uri_for> continues as though a path was
1566 provided, appending any arguments or parameters and creating an absolute
1569 The captures for the current request can be found in
1570 C<< $c->request->captures >>, and actions can be resolved using
1571 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1572 path, use C<< $c->uri_for_action >> instead.
1574 # Equivalent to $c->req->uri
1575 $c->uri_for($c->action, $c->req->captures,
1576 @{ $c->req->args }, $c->req->params);
1578 # For the Foo action in the Bar controller
1579 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1581 # Path to a static resource
1582 $c->uri_for('/static/images/logo.png');
1584 In general the scheme of the generated URI object will follow the incoming request
1585 however if your targeted action or action chain has the Scheme attribute it will
1588 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1589 type constraints, we will require that your proposed URL verify on those declared
1595 my ( $c, $path, @args ) = @_;
1597 if ( $path->$_isa('Catalyst::Controller') ) {
1598 $path = $path->path_prefix;
1603 my $fragment = ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? pop @args : undef );
1605 unless(blessed $path) {
1606 if (defined($path) and $path =~ s/#(.+)$//) {
1607 if(defined($1) and $fragment) {
1608 carp "Abiguious fragment declaration: You cannot define a fragment in '$path' and as an argument '$fragment'";
1617 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1619 undef($path) if (defined $path && $path eq '');
1621 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1623 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1624 if ( $path->$_isa('Catalyst::Action') ) { # action object
1625 s|/|%2F|g for @args;
1626 my $captures = [ map { s|/|%2F|g; $_; }
1627 ( scalar @args && ref $args[0] eq 'ARRAY'
1632 my $expanded_action = $c->dispatcher->expand_action( $action );
1633 my $num_captures = $expanded_action->number_of_captures;
1635 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1636 if( !@args && $action->number_of_args ) {
1637 unshift @args, splice @$captures, $num_captures;
1641 unless($expanded_action->match_captures_constraints($c, $captures)) {
1642 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1647 $path = $c->dispatcher->uri_for_action($action, $captures);
1648 if (not defined $path) {
1649 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1653 $path = '/' if $path eq '';
1655 # At this point @encoded_args is the remaining Args (all captures removed).
1656 if($expanded_action->has_args_constraints) {
1657 unless($expanded_action->match_args($c,\@args)) {
1658 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1664 unshift(@args, $path);
1666 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1667 my $namespace = $c->namespace;
1668 if (defined $path) { # cheesy hack to handle path '../foo'
1669 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1671 unshift(@args, $namespace || '');
1674 # join args with '/', or a blank string
1675 my $args = join('/', grep { defined($_) } @args);
1676 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1679 my ($base, $class) = ('/', 'URI::_generic');
1681 $base = $c->req->base;
1682 if($target_action) {
1683 $target_action = $c->dispatcher->expand_action($target_action);
1684 if(my $s = $target_action->scheme) {
1689 $class = ref($base);
1692 $class = ref($base);
1695 $base =~ s{(?<!/)$}{/};
1699 if (my @keys = keys %$params) {
1700 # somewhat lifted from URI::_query's query_form
1701 $query = '?'.join('&', map {
1702 my $val = $params->{$_};
1703 my $key = encode_utf8($_);
1704 # using the URI::Escape pattern here so utf8 chars survive
1705 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1708 $val = '' unless defined $val;
1710 my $param = encode_utf8($_);
1711 # using the URI::Escape pattern here so utf8 chars survive
1712 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1716 } ( ref $val eq 'ARRAY' ? @$val : $val ));
1720 $base = encode_utf8 $base;
1721 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1722 $args = encode_utf8 $args;
1723 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1725 if(defined $fragment) {
1727 $fragment = encode_utf8(${$fragment});
1728 $fragment =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1729 $fragment =~ s/ /+/g;
1731 $query .= "#$fragment";
1734 my $res = bless(\"${base}${args}${query}", $class);
1738 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1740 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1746 A private path to the Catalyst action you want to create a URI for.
1748 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1749 >> and passing the resulting C<$action> and the remaining arguments to C<<
1752 You can also pass in a Catalyst::Action object, in which case it is passed to
1755 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.
1757 For example, if the action looks like:
1759 package MyApp::Controller::Users;
1761 sub lst : Path('the-list') {}
1765 $c->uri_for_action('/users/lst')
1767 and it will create the URI /users/the-list.
1769 =item \@captures_and_args?
1771 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1772 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1773 to interpolate all the parameters in the URI.
1777 Optional list of extra arguments - can be supplied in the
1778 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1781 Your action can have zero, a fixed or a variable number of args (e.g.
1782 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1784 =item \%query_values?
1786 Optional array reference of query parameters to append. E.g.
1792 /rest/of/your/uri?foo=bar
1798 sub uri_for_action {
1799 my ( $c, $path, @args ) = @_;
1800 my $action = blessed($path)
1802 : $c->dispatcher->get_action_by_path($path);
1803 unless (defined $action) {
1804 croak "Can't find action for path '$path'";
1806 return $c->uri_for( $action, @args );
1809 =head2 $c->welcome_message
1811 Returns the Catalyst welcome HTML page.
1815 sub welcome_message {
1817 my $name = $c->config->{name};
1818 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1819 my $prefix = Catalyst::Utils::appprefix( ref $c );
1820 $c->response->content_type('text/html; charset=utf-8');
1822 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1823 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1824 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1826 <meta http-equiv="Content-Language" content="en" />
1827 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1828 <title>$name on Catalyst $VERSION</title>
1829 <style type="text/css">
1832 background-color: #eee;
1839 margin-bottom: 10px;
1841 background-color: #ccc;
1842 border: 1px solid #aaa;
1847 font-family: verdana, tahoma, sans-serif;
1850 font-family: verdana, tahoma, sans-serif;
1853 text-decoration: none;
1855 border-bottom: 1px dotted #bbb;
1857 :link:hover, :visited:hover {
1870 background-color: #fff;
1871 border: 1px solid #aaa;
1875 font-weight: normal;
1897 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1902 <img src="$logo" alt="Catalyst Logo" />
1904 <p>Welcome to the world of Catalyst.
1905 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1906 framework will make web development something you had
1907 never expected it to be: Fun, rewarding, and quick.</p>
1908 <h2>What to do now?</h2>
1909 <p>That really depends on what <b>you</b> want to do.
1910 We do, however, provide you with a few starting points.</p>
1911 <p>If you want to jump right into web development with Catalyst
1912 you might want to start with a tutorial.</p>
1913 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1915 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1917 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1918 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1920 <h2>What to do next?</h2>
1921 <p>Next it's time to write an actual application. Use the
1922 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1923 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1924 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1925 they can save you a lot of work.</p>
1926 <pre><code>script/${prefix}_create.pl --help</code></pre>
1927 <p>Also, be sure to check out the vast and growing
1928 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1929 you are likely to find what you need there.
1933 <p>Catalyst has a very active community. Here are the main places to
1934 get in touch with us.</p>
1937 <a href="http://dev.catalyst.perl.org">Wiki</a>
1940 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1943 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1946 <h2>In conclusion</h2>
1947 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1948 as we enjoyed making it. Please contact us if you have ideas
1949 for improvement or other feedback.</p>
1959 Contains a hash of options passed from the application script, including
1960 the original ARGV the script received, the processed values from that
1961 ARGV and any extra arguments to the script which were not processed.
1963 This can be used to add custom options to your application's scripts
1964 and setup your application differently depending on the values of these
1967 =head1 INTERNAL METHODS
1969 These methods are not meant to be used by end users.
1971 =head2 $c->components
1973 Returns a hash of components.
1975 =head2 $c->context_class
1977 Returns or sets the context class.
1981 Returns a hashref containing coderefs and execution counts (needed for
1982 deep recursion detection).
1986 Returns the number of actions on the current internal execution stack.
1990 Dispatches a request to actions.
1994 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
1996 =head2 $c->dispatcher_class
1998 Returns or sets the dispatcher class.
2000 =head2 $c->dump_these
2002 Returns a list of 2-element array references (name, structure) pairs
2003 that will be dumped on the error page in debug mode.
2009 [ Request => $c->req ],
2010 [ Response => $c->res ],
2011 [ Stash => $c->stash ],
2012 [ Config => $c->config ];
2015 =head2 $c->engine_class
2017 Returns or sets the engine class.
2019 =head2 $c->execute( $class, $coderef )
2021 Execute a coderef in given class and catch exceptions. Errors are available
2027 my ( $c, $class, $code ) = @_;
2028 $class = $c->component($class) || $class;
2031 if ( $c->depth >= $RECURSION ) {
2032 my $action = $code->reverse();
2033 $action = "/$action" unless $action =~ /->/;
2034 my $error = qq/Deep recursion detected calling "${action}"/;
2035 $c->log->error($error);
2041 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
2043 push( @{ $c->stack }, $code );
2045 no warnings 'recursion';
2046 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
2047 # I have no idea how, ergo $ret (which appears to fix the issue)
2048 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
2050 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
2052 my $last = pop( @{ $c->stack } );
2054 if ( my $error = $@ ) {
2055 #rethow if this can be handled by middleware
2056 if ( $c->_handle_http_exception($error) ) {
2057 foreach my $err (@{$c->error}) {
2058 $c->log->error($err);
2061 $c->log->_flush if $c->log->can('_flush');
2063 $error->can('rethrow') ? $error->rethrow : croak $error;
2065 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
2066 $error->rethrow if $c->depth > 1;
2068 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
2069 $error->rethrow if $c->depth > 0;
2072 unless ( ref $error ) {
2073 no warnings 'uninitialized';
2075 my $class = $last->class;
2076 my $name = $last->name;
2077 $error = qq/Caught exception in $class->$name "$error"/;
2086 sub _stats_start_execute {
2087 my ( $c, $code ) = @_;
2088 my $appclass = ref($c) || $c;
2089 return if ( ( $code->name =~ /^_.*/ )
2090 && ( !$appclass->config->{show_internal_actions} ) );
2092 my $action_name = $code->reverse();
2093 $c->counter->{$action_name}++;
2095 my $action = $action_name;
2096 $action = "/$action" unless $action =~ /->/;
2098 # determine if the call was the result of a forward
2099 # this is done by walking up the call stack and looking for a calling
2100 # sub of Catalyst::forward before the eval
2102 for my $index ( 2 .. 11 ) {
2104 if ( ( caller($index) )[0] eq 'Catalyst'
2105 && ( caller($index) )[3] eq '(eval)' );
2107 if ( ( caller($index) )[3] =~ /forward$/ ) {
2108 $callsub = ( caller($index) )[3];
2109 $action = "-> $action";
2114 my $uid = $action_name . $c->counter->{$action_name};
2116 # is this a root-level call or a forwarded call?
2117 if ( $callsub =~ /forward$/ ) {
2118 my $parent = $c->stack->[-1];
2120 # forward, locate the caller
2121 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2124 parent => "$parent" . $c->counter->{"$parent"},
2130 # forward with no caller may come from a plugin
2149 sub _stats_finish_execute {
2150 my ( $c, $info ) = @_;
2151 $c->stats->profile( end => $info );
2156 Finalizes the request.
2163 for my $error ( @{ $c->error } ) {
2164 $c->log->error($error);
2167 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2168 # stuff like cometd and websockets
2170 if($c->request->_has_io_fh) {
2175 # Allow engine to handle finalize flow (for POE)
2176 my $engine = $c->engine;
2177 if ( my $code = $engine->can('finalize') ) {
2182 $c->finalize_uploads;
2185 if ( $#{ $c->error } >= 0 ) {
2189 $c->finalize_encoding;
2190 $c->finalize_headers unless $c->response->finalized_headers;
2196 if ($c->use_stats) {
2197 my $elapsed = $c->stats->elapsed;
2198 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2200 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2203 return $c->response->status;
2206 =head2 $c->finalize_body
2212 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2214 =head2 $c->finalize_cookies
2220 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2222 =head2 $c->finalize_error
2224 Finalizes error. If there is only one error in L</error> and it is an object that
2225 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2226 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2227 return the default error page (production mode).
2231 sub finalize_error {
2233 if($#{$c->error} > 0) {
2234 $c->engine->finalize_error( $c, @_ );
2236 my ($error) = @{$c->error};
2237 if ( $c->_handle_http_exception($error) ) {
2238 # In the case where the error 'knows what it wants', becauses its PSGI
2239 # aware, just rethow and let middleware catch it
2240 $error->can('rethrow') ? $error->rethrow : croak $error;
2242 $c->engine->finalize_error( $c, @_ )
2247 =head2 $c->finalize_headers
2253 sub finalize_headers {
2256 my $response = $c->response; #accessor calls can add up?
2258 # Check if we already finalized headers
2259 return if $response->finalized_headers;
2262 if ( my $location = $response->redirect ) {
2263 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2264 $response->header( Location => $location );
2267 # Remove incorrectly added body and content related meta data when returning
2268 # an information response, or a response the is required to not include a body
2270 $c->finalize_cookies;
2272 # This currently is a NOOP but I don't want to remove it since I guess people
2273 # might have Response subclasses that use it for something... (JNAP)
2274 $c->response->finalize_headers();
2277 $response->finalized_headers(1);
2280 =head2 $c->finalize_encoding
2282 Make sure your body is encoded properly IF you set an encoding. By
2283 default the encoding is UTF-8 but you can disable it by explicitly setting the
2284 encoding configuration value to undef.
2286 We can only encode when the body is a scalar. Methods for encoding via the
2287 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2294 sub finalize_encoding {
2296 my $res = $c->res || return;
2298 # Warn if the set charset is different from the one you put into encoding. We need
2299 # to do this early since encodable_response is false for this condition and we need
2300 # to match the debug output for backcompat (there's a test for this...) -JNAP
2302 $res->content_type_charset and $c->encoding and
2303 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2305 my $ct = lc($res->content_type_charset);
2306 $c->log->debug("Catalyst encoding config is set to encode in '" .
2307 $c->encoding->mime_name .
2308 "', content type is '$ct', not encoding ");
2312 ($res->encodable_response) and
2313 (defined($res->body)) and
2314 (ref(\$res->body) eq 'SCALAR')
2316 # if you are finding yourself here and your body is already encoded correctly
2317 # and you want to turn this off, use $c->clear_encoding to prevent encoding
2318 # at this step, or set encoding to undef in the config to do so for the whole
2319 # application. See the ENCODING documentaiton for better notes.
2320 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2322 # Set the charset if necessary. This might be a bit bonkers since encodable response
2323 # is false when the set charset is not the same as the encoding mimetype (maybe
2324 # confusing action at a distance here..
2325 # Don't try to set the charset if one already exists or if headers are already finalized
2326 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2327 unless($c->res->content_type_charset ||
2328 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2332 =head2 $c->finalize_output
2334 An alias for finalize_body.
2336 =head2 $c->finalize_read
2338 Finalizes the input after reading is complete.
2342 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2344 =head2 $c->finalize_uploads
2346 Finalizes uploads. Cleans up any temporary files.
2350 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2352 =head2 $c->get_action( $action, $namespace )
2354 Gets an action in a given namespace.
2358 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2360 =head2 $c->get_actions( $action, $namespace )
2362 Gets all actions of a given name in a namespace and all parent
2367 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2369 =head2 $app->handle_request( @arguments )
2371 Called to handle each HTTP request.
2375 sub handle_request {
2376 my ( $class, @arguments ) = @_;
2378 # Always expect worst case!
2381 if ($class->debug) {
2382 my $secs = time - $START || 1;
2383 my $av = sprintf '%.3f', $COUNT / $secs;
2384 my $time = localtime time;
2385 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2388 my $c = $class->prepare(@arguments);
2390 $status = $c->finalize;
2392 #rethow if this can be handled by middleware
2393 if ( $class->_handle_http_exception($_) ) {
2394 $_->can('rethrow') ? $_->rethrow : croak $_;
2396 chomp(my $error = $_);
2397 $class->log->error(qq/Caught exception in engine "$error"/);
2402 if(my $coderef = $class->log->can('_flush')){
2403 $class->log->$coderef();
2408 =head2 $class->prepare( @arguments )
2410 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2417 predicate => '_has_uploadtmp',
2421 my ( $class, @arguments ) = @_;
2424 # After the app/ctxt split, this should become an attribute based on something passed
2425 # into the application.
2426 $class->context_class( ref $class || $class ) unless $class->context_class;
2428 my $uploadtmp = $class->config->{uploadtmp};
2429 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2431 $c->response->_context($c);
2432 $c->stats($class->stats_class->new)->enable($c->use_stats);
2434 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2435 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2439 # Allow engine to direct the prepare flow (for POE)
2440 if ( my $prepare = $c->engine->can('prepare') ) {
2441 $c->engine->$prepare( $c, @arguments );
2444 $c->prepare_request(@arguments);
2445 $c->prepare_connection;
2446 $c->prepare_query_parameters;
2447 $c->prepare_headers; # Just hooks, no longer needed - they just
2448 $c->prepare_cookies; # cause the lazy attribute on req to build
2451 # Prepare the body for reading, either by prepare_body
2452 # or the user, if they are using $c->read
2455 # Parse the body unless the user wants it on-demand
2456 unless ( ref($c)->config->{parse_on_demand} ) {
2462 # VERY ugly and probably shouldn't rely on ->finalize actually working
2464 # failed prepare is always due to an invalid request, right?
2465 # Note we call finalize and then die here, which escapes
2466 # finalize being called in the enclosing block..
2467 # It in fact couldn't be called, as we don't return $c..
2468 # This is a mess - but I'm unsure you can fix this without
2469 # breaking compat for people doing crazy things (we should set
2470 # the 400 and just return the ctx here IMO, letting finalize get called
2472 if ( $c->_handle_http_exception($_) ) {
2473 foreach my $err (@{$c->error}) {
2474 $c->log->error($err);
2477 $c->log->_flush if $c->log->can('_flush');
2478 $_->can('rethrow') ? $_->rethrow : croak $_;
2480 $c->response->status(400);
2481 $c->response->content_type('text/plain');
2482 $c->response->body('Bad Request');
2489 $c->{stash} = $c->stash;
2490 Scalar::Util::weaken($c->{stash});
2495 =head2 $c->prepare_action
2497 Prepares action. See L<Catalyst::Dispatcher>.
2501 sub prepare_action {
2503 my $ret = $c->dispatcher->prepare_action( $c, @_);
2506 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2507 $_ = $c->_handle_param_unicode_decoding($_);
2515 =head2 $c->prepare_body
2517 Prepares message body.
2524 return if $c->request->_has_body;
2526 # Initialize on-demand data
2527 $c->engine->prepare_body( $c, @_ );
2528 $c->prepare_parameters;
2529 $c->prepare_uploads;
2532 =head2 $c->prepare_body_chunk( $chunk )
2534 Prepares a chunk of data before sending it to L<HTTP::Body>.
2536 See L<Catalyst::Engine>.
2540 sub prepare_body_chunk {
2542 $c->engine->prepare_body_chunk( $c, @_ );
2545 =head2 $c->prepare_body_parameters
2547 Prepares body parameters.
2551 sub prepare_body_parameters {
2553 $c->request->prepare_body_parameters( $c, @_ );
2556 =head2 $c->prepare_connection
2558 Prepares connection.
2562 sub prepare_connection {
2564 $c->request->prepare_connection($c);
2567 =head2 $c->prepare_cookies
2569 Prepares cookies by ensuring that the attribute on the request
2570 object has been built.
2574 sub prepare_cookies { my $c = shift; $c->request->cookies }
2576 =head2 $c->prepare_headers
2578 Prepares request headers by ensuring that the attribute on the request
2579 object has been built.
2583 sub prepare_headers { my $c = shift; $c->request->headers }
2585 =head2 $c->prepare_parameters
2587 Prepares parameters.
2591 sub prepare_parameters {
2593 $c->prepare_body_parameters;
2594 $c->engine->prepare_parameters( $c, @_ );
2597 =head2 $c->prepare_path
2599 Prepares path and base.
2603 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2605 =head2 $c->prepare_query_parameters
2607 Prepares query parameters.
2611 sub prepare_query_parameters {
2614 $c->engine->prepare_query_parameters( $c, @_ );
2617 =head2 $c->log_request
2619 Writes information about the request to the debug logs. This includes:
2623 =item * Request method, path, and remote IP address
2625 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2627 =item * Request parameters
2629 =item * File uploads
2638 return unless $c->debug;
2640 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2641 my $request = $dump->[1];
2643 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2645 $path = '/' unless length $path;
2648 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2649 $path = decode_utf8($path);
2651 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2653 $c->log_request_headers($request->headers);
2655 if ( my $keywords = $request->query_keywords ) {
2656 $c->log->debug("Query keywords are: $keywords");
2659 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2661 $c->log_request_uploads($request);
2664 =head2 $c->log_response
2666 Writes information about the response to the debug logs by calling
2667 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2674 return unless $c->debug;
2676 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2677 my $response = $dump->[1];
2679 $c->log_response_status_line($response);
2680 $c->log_response_headers($response->headers);
2683 =head2 $c->log_response_status_line($response)
2685 Writes one line of information about the response to the debug logs. This includes:
2689 =item * Response status code
2691 =item * Content-Type header (if present)
2693 =item * Content-Length header (if present)
2699 sub log_response_status_line {
2700 my ($c, $response) = @_;
2704 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2705 $response->status || 'unknown',
2706 $response->headers->header('Content-Type') || 'unknown',
2707 $response->headers->header('Content-Length') || 'unknown'
2712 =head2 $c->log_response_headers($headers);
2714 Hook method which can be wrapped by plugins to log the response headers.
2715 No-op in the default implementation.
2719 sub log_response_headers {}
2721 =head2 $c->log_request_parameters( query => {}, body => {} )
2723 Logs request parameters to debug logs
2727 sub log_request_parameters {
2729 my %all_params = @_;
2731 return unless $c->debug;
2733 my $column_width = Catalyst::Utils::term_width() - 44;
2734 foreach my $type (qw(query body)) {
2735 my $params = $all_params{$type};
2736 next if ! keys %$params;
2737 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2738 for my $key ( sort keys %$params ) {
2740 if(ref $params eq 'Hash::MultiValue') {
2741 @values = $params->get_all($key);
2743 my $param = $params->{$key};
2744 if( defined($param) ) {
2745 @values = ref $param eq 'ARRAY' ? @$param : $param;
2748 $t->row( $key.( scalar @values > 1 ? ' [multiple]' : ''), join(', ', @values) );
2750 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2754 =head2 $c->log_request_uploads
2756 Logs file uploads included in the request to the debug logs.
2757 The parameter name, filename, file type, and file size are all included in
2762 sub log_request_uploads {
2764 my $request = shift;
2765 return unless $c->debug;
2766 my $uploads = $request->uploads;
2767 if ( keys %$uploads ) {
2768 my $t = Text::SimpleTable->new(
2769 [ 12, 'Parameter' ],
2774 for my $key ( sort keys %$uploads ) {
2775 my $upload = $uploads->{$key};
2776 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2777 $t->row( $key, $u->filename, $u->type, $u->size );
2780 $c->log->debug( "File Uploads are:\n" . $t->draw );
2784 =head2 $c->log_request_headers($headers);
2786 Hook method which can be wrapped by plugins to log the request headers.
2787 No-op in the default implementation.
2791 sub log_request_headers {}
2793 =head2 $c->log_headers($type => $headers)
2795 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2802 my $headers = shift; # an HTTP::Headers instance
2804 return unless $c->debug;
2806 my $column_width = Catalyst::Utils::term_width() - 28;
2807 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2810 my ( $name, $value ) = @_;
2811 $t->row( $name, $value );
2814 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2818 =head2 $c->prepare_read
2820 Prepares the input for reading.
2824 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2826 =head2 $c->prepare_request
2828 Prepares the engine request.
2832 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2834 =head2 $c->prepare_uploads
2840 sub prepare_uploads {
2842 $c->engine->prepare_uploads( $c, @_ );
2845 =head2 $c->prepare_write
2847 Prepares the output for writing.
2851 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2853 =head2 $c->request_class
2855 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2857 =head2 $app->request_class_traits
2859 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2860 name the full namespace of the role, or a namespace suffix, which will then
2861 be tried against the following standard namespace prefixes.
2863 $MyApp::TraitFor::Request::$trait_suffix
2864 Catalyst::TraitFor::Request::$trait_suffix
2866 So for example if you set:
2868 MyApp->request_class_traits(['Foo']);
2870 We try each possible role in turn (and throw an error if none load)
2873 MyApp::TraitFor::Request::Foo
2874 Catalyst::TraitFor::Request::Foo
2876 The namespace part 'TraitFor::Request' was chosen to assist in backwards
2877 compatibility with L<CatalystX::RoleApplicator> which previously provided
2878 these features in a stand alone package.
2880 =head2 $app->composed_request_class
2882 This is the request class which has been composed with any request_class_traits.
2884 =head2 $c->response_class
2886 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2888 =head2 $app->response_class_traits
2890 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2891 name the full namespace of the role, or a namespace suffix, which will then
2892 be tried against the following standard namespace prefixes.
2894 $MyApp::TraitFor::Response::$trait_suffix
2895 Catalyst::TraitFor::Response::$trait_suffix
2897 So for example if you set:
2899 MyApp->response_class_traits(['Foo']);
2901 We try each possible role in turn (and throw an error if none load)
2904 MyApp::TraitFor::Response::Foo
2905 Catalyst::TraitFor::Responset::Foo
2907 The namespace part 'TraitFor::Response' was chosen to assist in backwards
2908 compatibility with L<CatalystX::RoleApplicator> which previously provided
2909 these features in a stand alone package.
2912 =head2 $app->composed_response_class
2914 This is the request class which has been composed with any response_class_traits.
2916 =head2 $c->read( [$maxlength] )
2918 Reads a chunk of data from the request body. This method is designed to
2919 be used in a while loop, reading C<$maxlength> bytes on every call.
2920 C<$maxlength> defaults to the size of the request if not specified.
2922 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2925 Warning: If you use read(), Catalyst will not process the body,
2926 so you will not be able to access POST parameters or file uploads via
2927 $c->request. You must handle all body parsing yourself.
2931 sub read { my $c = shift; return $c->request->read( @_ ) }
2941 $app->_make_immutable_if_needed;
2942 $app->engine_loader->needs_psgi_engine_compat_hack ?
2943 $app->engine->run($app, @_) :
2944 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2947 sub _make_immutable_if_needed {
2949 my $meta = find_meta($class);
2950 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2953 && ! { $meta->immutable_options }->{replace_constructor}
2956 warn("You made your application class ($class) immutable, "
2957 . "but did not inline the\nconstructor. "
2958 . "This will break catalyst, as your app \@ISA "
2959 . "Class::Accessor(::Fast)?\nPlease pass "
2960 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2962 unless ($meta->is_immutable) {
2963 # XXX - FIXME warning here as you should make your app immutable yourself.
2964 $meta->make_immutable(
2965 replace_constructor => 1,
2970 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2972 Sets an action in a given namespace.
2976 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2978 =head2 $c->setup_actions($component)
2980 Sets up actions for a component.
2984 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2986 =head2 $c->setup_components
2988 This method is called internally to set up the application's components.
2990 It finds modules by calling the L<locate_components> method, expands them to
2991 package names with the L<expand_component_module> method, and then installs
2992 each component into the application.
2994 The C<setup_components> config option is passed to both of the above methods.
2996 Installation of each component is performed by the L<setup_component> method,
3001 sub setup_components {
3004 my $config = $class->config->{ setup_components };
3006 my @comps = $class->locate_components($config);
3007 my %comps = map { $_ => 1 } @comps;
3009 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
3010 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
3011 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
3012 ) if $deprecatedcatalyst_component_names;
3014 for my $component ( @comps ) {
3016 # We pass ignore_loaded here so that overlay files for (e.g.)
3017 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
3018 # we know M::P::O found a file on disk so this is safe
3020 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
3023 for my $component (@comps) {
3024 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
3027 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
3028 # of named components in the configuration that are not actually existing (not a
3031 my @injected = $class->setup_injected_components;
3033 # All components are registered, now we need to 'init' them.
3034 foreach my $component_name (@comps, @injected) {
3035 $class->components->{$component_name} = $class->components->{$component_name}->() if
3036 (ref($class->components->{$component_name}) || '') eq 'CODE';
3040 =head2 $app->setup_injected_components
3042 Called by setup_compoents to setup components that are injected.
3046 sub setup_injected_components {
3048 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
3050 foreach my $injected_comp_name(@injected_components) {
3051 $class->setup_injected_component(
3052 $injected_comp_name,
3053 $class->config->{inject_components}->{$injected_comp_name});
3056 return map { $class ."::" . $_ }
3057 @injected_components;
3060 =head2 $app->setup_injected_component( $injected_component_name, $config )
3062 Setup a given injected component.
3066 sub setup_injected_component {
3067 my ($class, $injected_comp_name, $config) = @_;
3068 if(my $component_class = $config->{from_component}) {
3069 my @roles = @{$config->{roles} ||[]};
3070 Catalyst::Utils::inject_component(
3072 component => $component_class,
3073 (scalar(@roles) ? (traits => \@roles) : ()),
3074 as => $injected_comp_name);
3078 =head2 $app->inject_component($MyApp_Component_name => \%args);
3080 Add a component that is injected at setup:
3082 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3084 Must be called before ->setup. Expects a component name for your
3085 current application and \%args where
3089 =item from_component
3091 The target component being injected into your application
3095 An arrayref of L<Moose::Role>s that are applied to your component.
3101 MyApp->inject_component(
3103 from_component => 'Common::Model::Foo',
3104 roles => ['Role1', 'Role2'],
3107 =head2 $app->inject_components
3109 Inject a list of components:
3111 MyApp->inject_components(
3112 'Model::FooOne' => {
3113 from_component => 'Common::Model::Foo',
3114 roles => ['Role1', 'Role2'],
3116 'Model::FooTwo' => {
3117 from_component => 'Common::Model::Foo',
3118 roles => ['Role1', 'Role2'],
3123 sub inject_component {
3124 my ($app, $name, $args) = @_;
3125 die "Component $name exists" if
3126 $app->config->{inject_components}->{$name};
3127 $app->config->{inject_components}->{$name} = $args;
3130 sub inject_components {
3133 $app->inject_component(shift, shift);
3137 =head2 $c->locate_components( $setup_component_config )
3139 This method is meant to provide a list of component modules that should be
3140 setup for the application. By default, it will use L<Module::Pluggable>.
3142 Specify a C<setup_components> config option to pass additional options directly
3143 to L<Module::Pluggable>. To add additional search paths, specify a key named
3144 C<search_extra> as an array reference. Items in the array beginning with C<::>
3145 will have the application class name prepended to them.
3149 sub locate_components {
3153 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3154 my $extra = $config->{ search_extra } || [];
3156 unshift @paths, @$extra;
3158 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3159 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3161 )->plugins } @paths;
3166 =head2 $c->expand_component_module( $component, $setup_component_config )
3168 Components found by C<locate_components> will be passed to this method, which
3169 is expected to return a list of component (package) names to be set up.
3173 sub expand_component_module {
3174 my ($class, $module) = @_;
3175 return Devel::InnerPackage::list_packages( $module );
3178 =head2 $app->delayed_setup_component
3180 Returns a coderef that points to a setup_component instance. Used
3181 internally for when you want to delay setup until the first time
3182 the component is called.
3186 sub delayed_setup_component {
3187 my($class, $component, @more) = @_;
3189 return my $instance = $class->setup_component($component, @more);
3193 =head2 $c->setup_component
3197 sub setup_component {
3198 my( $class, $component ) = @_;
3200 unless ( $component->can( 'COMPONENT' ) ) {
3204 my $config = $class->config_for($component);
3205 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3206 # methods also pass it. local to avoid pointlessly shitting in config
3207 # for the debug screen, as $component is already the key name.
3208 local $config->{catalyst_component_name} = $component;
3210 my $instance = eval {
3211 $component->COMPONENT( $class, $config );
3215 Catalyst::Exception->throw(
3216 message => qq/Couldn't instantiate component "$component", "$error"/
3220 unless (blessed $instance) {
3221 my $metaclass = Moose::Util::find_meta($component);
3222 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3223 my $component_method_from = $method_meta->associated_metaclass->name;
3224 my $value = defined($instance) ? $instance : 'undef';
3225 Catalyst::Exception->throw(
3227 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3231 my @expanded_components = $instance->can('expand_modules')
3232 ? $instance->expand_modules( $component, $config )
3233 : $class->expand_component_module( $component, $config );
3234 for my $component (@expanded_components) {
3235 next if $class->components->{ $component };
3236 $class->components->{ $component } = $class->setup_component($component);
3242 =head2 $app->config_for( $component_name )
3244 Return the application level configuration (which is not yet merged with any
3245 local component configuration, via $component_class->config) for the named
3246 component or component object. Example:
3249 'Model::Foo' => { a => 1, b => 2},
3252 my $config = MyApp->config_for('MyApp::Model::Foo');
3254 In this case $config is the hashref C< {a=>1, b=>2} >.
3256 This is also handy for looking up configuration for a plugin, to make sure you follow
3257 existing L<Catalyst> standards for where a plugin should put its configuration.
3262 my ($class, $component_name) = @_;
3263 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3264 my $config = $class->config->{ $component_suffix } || {};
3269 =head2 $c->setup_dispatcher
3275 sub setup_dispatcher {
3276 my ( $class, $dispatcher ) = @_;
3279 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3282 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3283 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3286 unless ($dispatcher) {
3287 $dispatcher = $class->dispatcher_class;
3290 load_class($dispatcher);
3292 # dispatcher instance
3293 $class->dispatcher( $dispatcher->new );
3296 =head2 $c->setup_engine
3303 my ($class, $requested_engine) = @_;
3305 if (!$class->engine_loader || $requested_engine) {
3306 $class->engine_loader(
3307 Catalyst::EngineLoader->new({
3308 application_name => $class,
3309 (defined $requested_engine
3310 ? (catalyst_engine_class => $requested_engine) : ()),
3315 $class->engine_loader->catalyst_engine_class;
3319 my ($class, $requested_engine) = @_;
3322 my $loader = $class->engine_loader;
3324 if (!$loader || $requested_engine) {
3325 $loader = Catalyst::EngineLoader->new({
3326 application_name => $class,
3327 (defined $requested_engine
3328 ? (requested_engine => $requested_engine) : ()),
3331 $class->engine_loader($loader);
3334 $loader->catalyst_engine_class;
3337 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3338 return if $class->loading_psgi_file;
3340 load_class($engine);
3342 if ($ENV{MOD_PERL}) {
3343 my $apache = $class->engine_loader->auto;
3345 my $meta = find_meta($class);
3346 my $was_immutable = $meta->is_immutable;
3347 my %immutable_options = $meta->immutable_options;
3348 $meta->make_mutable if $was_immutable;
3350 $meta->add_method(handler => sub {
3352 my $psgi_app = $class->_finalized_psgi_app;
3353 $apache->call_app($r, $psgi_app);
3356 $meta->make_immutable(%immutable_options) if $was_immutable;
3359 $class->engine( $engine->new );
3364 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3365 ## build in server support (back compat support for pre psgi port behavior).
3366 ## This is so that we don't build a new psgi app for each request when using
3367 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3369 sub _finalized_psgi_app {
3372 unless ($app->_psgi_app) {
3373 my $psgi_app = $app->_setup_psgi_app;
3374 $app->_psgi_app($psgi_app);
3377 return $app->_psgi_app;
3380 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3381 ## home directory and load that and return it (just assume it is doing the
3382 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3383 ## in default_middleware and return it ( this is for backward compatibility
3384 ## with pre psgi port behavior ).
3386 sub _setup_psgi_app {
3389 for my $home (Path::Class::Dir->new($app->config->{home})) {
3390 my $psgi_file = $home->file(
3391 Catalyst::Utils::appprefix($app) . '.psgi',
3394 next unless -e $psgi_file;
3396 # If $psgi_file calls ->setup_engine, it's doing so to load
3397 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3398 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3399 # anyway. So set a flag (ick) that tells setup_engine not to populate
3400 # $c->engine or do any other things we might regret.
3402 $app->loading_psgi_file(1);
3403 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3404 $app->loading_psgi_file(0);
3407 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3410 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3412 Its content has been ignored. Please consult the Catalyst::Upgrading
3413 documentation on how to upgrade from Catalyst::Engine::PSGI.
3417 return $app->apply_default_middlewares($app->psgi_app);
3420 =head2 $c->apply_default_middlewares
3422 Adds the following L<Plack> middlewares to your application, since they are
3423 useful and commonly needed:
3425 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3426 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3427 is smart enough to conditionally apply itself).
3429 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3430 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3431 an indication that your server is running behind a proxy frontend. However in
3432 2014 this is often not the case. We preserve this code for backwards compatibility
3433 however I B<highly> recommend that if you are running the server behind a front
3434 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3435 setting to true for your environment configurations that run behind a proxy. This
3436 way if you change your front end proxy address someday your code would inexplicably
3437 stop working as expected.
3439 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3440 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3443 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3444 adding via C<registered_middleware> rather than this method.
3446 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3447 general this is no longer a common case but we have this here for backward
3453 sub apply_default_middlewares {
3454 my ($app, $psgi_app) = @_;
3456 # Don't add this conditional IF we are explicitly saying we want the
3457 # frontend proxy support. We don't need it here since if that is the
3458 # case it will be always loaded in the default_middleware.
3460 unless($app->config->{using_frontend_proxy}) {
3461 $psgi_app = Plack::Middleware::Conditional->wrap(
3463 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3466 return if $app->config->{ignore_frontend_proxy};
3467 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3472 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3473 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3474 $psgi_app = Plack::Middleware::Conditional->wrap(
3476 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3479 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3480 return unless $1 < 4.23;
3485 # we're applying this unconditionally as the middleware itself already makes
3486 # sure it doesn't fuck things up if it's not running under one of the right
3488 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3490 # And another IIS issue, this time with IIS7.
3491 $psgi_app = Plack::Middleware::Conditional->wrap(
3493 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3496 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3503 =head2 App->psgi_app
3507 Returns a PSGI application code reference for the catalyst application
3508 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3509 method called. We do however apply C<registered_middleware> since those are
3510 integral to how L<Catalyst> functions. Also, unlike starting your application
3511 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3512 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3513 scripts in your $HOME directory.
3515 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3516 port was done for v5.90000. These are middlewares that are added to achieve
3517 backward compatibility with older applications. If you start your application
3518 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3519 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3520 automatically. This was done so that pre and post PSGI port applications would
3523 This is what you want to be using to retrieve the PSGI application code
3524 reference of your Catalyst application for use in a custom F<.psgi> or in your
3525 own created server modules.
3529 *to_app = \&psgi_app;
3533 my $psgi = $app->engine->build_psgi_app($app);
3534 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3537 =head2 $c->setup_home
3539 Sets up the home directory.
3544 my ( $class, $home ) = @_;
3546 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3550 $home ||= Catalyst::Utils::home($class);
3553 #I remember recently being scolded for assigning config values like this
3554 $class->config->{home} ||= $home;
3555 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3559 =head2 $c->setup_encoding
3561 Sets up the input/output encoding. See L<ENCODING>
3565 sub setup_encoding {
3567 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3568 # Ok, so the user has explicitly said "I don't want encoding..."
3571 my $enc = defined($c->config->{encoding}) ?
3572 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3577 =head2 handle_unicode_encoding_exception
3579 Hook to let you customize how encoding errors are handled. By default
3580 we just throw an exception and the default error page will pick it up.
3581 Receives a hashref of debug information. Example of call (from the
3582 Catalyst internals):
3584 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
3585 param_value => $value,
3587 encoding_step => 'params',
3590 The calling code expects to receive a decoded string or an exception.
3592 You can override this for custom handling of unicode errors. By
3593 default we just die. If you want a custom response here, one approach
3594 is to throw an HTTP style exception, instead of returning a decoded
3595 string or throwing a generic exception.
3597 sub handle_unicode_encoding_exception {
3598 my ($c, $params) = @_;
3599 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
3602 Alternatively you can 'catch' the error, stash it and write handling code later
3603 in your application:
3605 sub handle_unicode_encoding_exception {
3606 my ($c, $params) = @_;
3607 $c->stash(BAD_UNICODE_DATA=>$params);
3608 # return a dummy string.
3612 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
3613 the request setup is still ongoing, which means the state of C<$c> and
3614 related context parts like the request and response may not be setup
3615 up correctly (since we haven't finished the setup yet). If you throw
3616 an exception the setup is aborted.
3620 sub handle_unicode_encoding_exception {
3621 my ( $self, $exception_ctx ) = @_;
3622 die $exception_ctx->{error_msg};
3625 # Some unicode helpers cargo culted from the old plugin. These could likely
3628 sub _handle_unicode_decoding {
3629 my ( $self, $value ) = @_;
3631 return unless defined $value;
3633 ## I think this mess is to support the old nested
3634 if ( ref $value eq 'ARRAY' ) {
3635 foreach ( @$value ) {
3636 $_ = $self->_handle_unicode_decoding($_);
3640 elsif ( ref $value eq 'HASH' ) {
3641 foreach (keys %$value) {
3642 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3643 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3645 # If the key was encoded we now have two (the original and current so
3646 # delete the original.
3647 delete $value->{$_} if $_ ne $encoded_key;
3652 return $self->_handle_param_unicode_decoding($value);
3656 sub _handle_param_unicode_decoding {
3657 my ( $self, $value, $check ) = @_;
3658 return unless defined $value; # not in love with just ignoring undefs - jnap
3659 return $value if blessed($value); #don't decode when the value is an object.
3661 my $enc = $self->encoding;
3663 return $value unless $enc; # don't decode if no encoding is specified
3665 $check ||= $self->_encode_check;
3667 $enc->decode( $value, $check);
3670 return $self->handle_unicode_encoding_exception({
3671 param_value => $value,
3673 encoding_step => 'params',
3678 =head2 $c->setup_log
3680 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3681 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3684 This method also installs a C<debug> method that returns a true value into the
3685 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3686 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3688 Note that if the log has already been setup, by either a previous call to
3689 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3690 that this method won't actually set up the log object.
3695 my ( $class, $levels ) = @_;
3698 $levels =~ s/^\s+//;
3699 $levels =~ s/\s+$//;
3700 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3702 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3703 if ( defined $env_debug ) {
3704 $levels{debug} = 1 if $env_debug; # Ugly!
3705 delete($levels{debug}) unless $env_debug;
3708 unless ( $class->log ) {
3709 $class->log( Catalyst::Log->new(keys %levels) );
3712 if ( $levels{debug} ) {
3713 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3714 $class->log->debug('Debug messages enabled');
3718 =head2 $c->setup_plugins
3724 =head2 $c->setup_stats
3726 Sets up timing statistics class.
3731 my ( $class, $stats ) = @_;
3733 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3735 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3736 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3737 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3738 $class->log->debug('Statistics enabled');
3743 =head2 $c->registered_plugins
3745 Returns a sorted list of the plugins which have either been stated in the
3748 If passed a given plugin name, it will report a boolean value indicating
3749 whether or not that plugin is loaded. A fully qualified name is required if
3750 the plugin name does not begin with C<Catalyst::Plugin::>.
3752 if ($c->registered_plugins('Some::Plugin')) {
3760 sub registered_plugins {
3762 return sort keys %{ $proto->_plugins } unless @_;
3764 return 1 if exists $proto->_plugins->{$plugin};
3765 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3768 sub _register_plugin {
3769 my ( $proto, $plugin, $instant ) = @_;
3770 my $class = ref $proto || $proto;
3772 load_class( $plugin );
3773 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3774 if $plugin->isa( 'Catalyst::Component' );
3775 my $plugin_meta = Moose::Meta::Class->create($plugin);
3776 if (!$plugin_meta->has_method('new')
3777 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3778 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3780 if (!$instant && !$proto->_plugins->{$plugin}) {
3781 my $meta = Class::MOP::get_metaclass_by_name($class);
3782 $meta->superclasses($plugin, $meta->superclasses);
3784 $proto->_plugins->{$plugin} = 1;
3788 sub _default_plugins { return qw() }
3791 my ( $class, $plugins ) = @_;
3793 $class->_plugins( {} ) unless $class->_plugins;
3795 m/Unicode::Encoding/ ? do {
3797 'Unicode::Encoding plugin is auto-applied,'
3798 . ' please remove this from your appclass'
3799 . ' and make sure to define "encoding" config'
3801 unless (exists $class->config->{'encoding'}) {
3802 $class->config->{'encoding'} = 'UTF-8';
3807 push @$plugins, $class->_default_plugins;
3808 $plugins = Data::OptList::mkopt($plugins || []);
3811 [ Catalyst::Utils::resolve_namespace(
3812 $class . '::Plugin',
3813 'Catalyst::Plugin', $_->[0]
3819 for my $plugin ( reverse @plugins ) {
3820 load_class($plugin->[0], $plugin->[1]);
3821 my $meta = find_meta($plugin->[0]);
3822 next if $meta && $meta->isa('Moose::Meta::Role');
3824 $class->_register_plugin($plugin->[0]);
3828 map { $_->[0]->name, $_->[1] }
3829 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3830 map { [find_meta($_->[0]), $_->[1]] }
3833 Moose::Util::apply_all_roles(
3839 =head2 default_middleware
3841 Returns a list of instantiated PSGI middleware objects which is the default
3842 middleware that is active for this application (taking any configuration
3843 options into account, excluding your custom added middleware via the C<psgi_middleware>
3844 configuration option). You can override this method if you wish to change
3845 the default middleware (although do so at risk since some middleware is vital
3846 to application function.)
3848 The current default middleware list is:
3850 Catalyst::Middleware::Stash
3851 Plack::Middleware::HTTPExceptions
3852 Plack::Middleware::RemoveRedundantBody
3853 Plack::Middleware::FixMissingBodyInRedirect
3854 Plack::Middleware::ContentLength
3855 Plack::Middleware::MethodOverride
3856 Plack::Middleware::Head
3858 If the configuration setting C<using_frontend_proxy> is true we add:
3860 Plack::Middleware::ReverseProxy
3862 If the configuration setting C<using_frontend_proxy_path> is true we add:
3864 Plack::Middleware::ReverseProxyPath
3866 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3867 L<Catalyst> distribution so if you want to use this option you should add it to
3868 your project distribution file.
3870 These middlewares will be added at L</setup_middleware> during the
3871 L</setup> phase of application startup.
3875 sub default_middleware {
3878 Catalyst::Middleware::Stash->new,
3879 Plack::Middleware::HTTPExceptions->new,
3880 Plack::Middleware::RemoveRedundantBody->new,
3881 Plack::Middleware::FixMissingBodyInRedirect->new,
3882 Plack::Middleware::ContentLength->new,
3883 Plack::Middleware::MethodOverride->new,
3884 Plack::Middleware::Head->new);
3886 if($class->config->{using_frontend_proxy}) {
3887 push @mw, Plack::Middleware::ReverseProxy->new;
3890 if($class->config->{using_frontend_proxy_path}) {
3891 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3892 push @mw, Plack::Middleware::ReverseProxyPath->new;
3894 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3901 =head2 registered_middlewares
3903 Read only accessor that returns an array of all the middleware in the order
3904 that they were added (which is the REVERSE of the order they will be applied).
3906 The values returned will be either instances of L<Plack::Middleware> or of a
3907 compatible interface, or a coderef, which is assumed to be inlined middleware
3909 =head2 setup_middleware (?@middleware)
3911 Read configuration information stored in configuration key C<psgi_middleware> or
3914 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3915 to use it to enable L<Plack::Middleware>
3917 This method is automatically called during 'setup' of your application, so
3918 you really don't need to invoke it. However you may do so if you find the idea
3919 of loading middleware via configuration weird :). For example:
3925 __PACKAGE__->setup_middleware('Head');
3928 When we read middleware definitions from configuration, we reverse the list
3929 which sounds odd but is likely how you expect it to work if you have prior
3930 experience with L<Plack::Builder> or if you previously used the plugin
3931 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3933 So basically your middleware handles an incoming request from the first
3934 registered middleware, down and handles the response from the last middleware
3939 sub registered_middlewares {
3941 if(my $middleware = $class->_psgi_middleware) {
3942 my @mw = ($class->default_middleware, @$middleware);
3944 if($class->config->{using_frontend_proxy}) {
3945 push @mw, Plack::Middleware::ReverseProxy->new;
3950 die "You cannot call ->registered_middlewares until middleware has been setup";
3954 sub setup_middleware {
3956 my @middleware_definitions;
3958 # If someone calls this method you can add middleware with args. However if its
3959 # called without an arg we need to setup the configuration middleware.
3961 @middleware_definitions = reverse(@_);
3963 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3964 unless $class->finalized_default_middleware;
3965 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3968 my @middleware = ();
3969 while(my $next = shift(@middleware_definitions)) {
3971 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3972 push @middleware, $next;
3973 } elsif(ref $next eq 'CODE') {
3974 push @middleware, $next;
3975 } elsif(ref $next eq 'HASH') {
3976 my $namespace = shift @middleware_definitions;
3977 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3978 push @middleware, $mw;
3980 die "I can't handle middleware definition ${\ref $next}";
3983 my $mw = $class->Catalyst::Utils::build_middleware($next);
3984 push @middleware, $mw;
3988 my @existing = @{$class->_psgi_middleware || []};
3989 $class->_psgi_middleware([@middleware,@existing,]);
3992 =head2 registered_data_handlers
3994 A read only copy of registered Data Handlers returned as a Hash, where each key
3995 is a content type and each value is a subref that attempts to decode that content
3998 =head2 setup_data_handlers (?@data_handler)
4000 Read configuration information stored in configuration key C<data_handlers> or
4003 See under L</CONFIGURATION> information regarding C<data_handlers>.
4005 This method is automatically called during 'setup' of your application, so
4006 you really don't need to invoke it.
4008 =head2 default_data_handlers
4010 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
4011 only two default data handlers, for 'application/json' and an alternative to
4012 'application/x-www-form-urlencoded' which supposed nested form parameters via
4013 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
4015 The 'application/json' data handler is used to parse incoming JSON into a Perl
4016 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
4017 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
4018 JSON decoder, and has the smallest dependency impact.
4020 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
4021 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
4022 order to get the best performance. You should add either to your dependency
4023 list (Makefile.PL, dist.ini, cpanfile, etc.)
4027 sub registered_data_handlers {
4029 if(my $data_handlers = $class->_data_handlers) {
4030 return %$data_handlers;
4032 $class->setup_data_handlers;
4033 return $class->registered_data_handlers;
4037 sub setup_data_handlers {
4038 my ($class, %data_handler_callbacks) = @_;
4039 %data_handler_callbacks = (
4040 %{$class->default_data_handlers},
4041 %{$class->config->{'data_handlers'}||+{}},
4042 %data_handler_callbacks);
4044 $class->_data_handlers(\%data_handler_callbacks);
4047 sub default_data_handlers {
4050 'application/x-www-form-urlencoded' => sub {
4051 my ($fh, $req) = @_;
4052 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
4053 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
4054 ->can('build_cgi_struct')->($params);
4056 'application/json' => sub {
4057 my ($fh, $req) = @_;
4058 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
4062 $slurped = $fh->getline;
4063 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
4064 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
4069 sub _handle_http_exception {
4070 my ( $self, $error ) = @_;
4072 !$self->config->{always_catch_http_exceptions}
4075 $error->can('as_psgi')
4076 || ( $error->can('code')
4077 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
4087 Returns an arrayref of the internal execution stack (actions that are
4088 currently executing).
4092 Returns the current timing statistics object. By default Catalyst uses
4093 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4094 L<< stats_class|/"$c->stats_class" >>.
4096 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4097 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
4098 profile explicitly, although MyApp.pm still won't profile nor output anything
4101 =head2 $c->stats_class
4103 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4105 =head2 $app->stats_class_traits
4107 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4109 =head2 $app->composed_stats_class
4111 this is the stats_class composed with any 'stats_class_traits'. You can
4112 name the full namespace of the role, or a namespace suffix, which will then
4113 be tried against the following standard namespace prefixes.
4115 $MyApp::TraitFor::Stats::$trait_suffix
4116 Catalyst::TraitFor::Stats::$trait_suffix
4118 So for example if you set:
4120 MyApp->stats_class_traits(['Foo']);
4122 We try each possible role in turn (and throw an error if none load)
4125 MyApp::TraitFor::Stats::Foo
4126 Catalyst::TraitFor::Stats::Foo
4128 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
4129 compatibility with L<CatalystX::RoleApplicator> which previously provided
4130 these features in a stand alone package.
4132 =head2 $c->use_stats
4134 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4136 Note that this is a static method, not an accessor and should be overridden
4137 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4144 =head2 $c->write( $data )
4146 Writes $data to the output stream. When using this method directly, you
4147 will need to manually set the C<Content-Length> header to the length of
4148 your output data, if known.
4155 # Finalize headers if someone manually writes output (for compat)
4156 $c->finalize_headers;
4158 return $c->response->write( @_ );
4163 Returns the Catalyst version number. Mostly useful for "powered by"
4164 messages in template systems.
4168 sub version { return $Catalyst::VERSION }
4170 =head1 CONFIGURATION
4172 There are a number of 'base' config variables which can be set:
4178 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4179 rethrows errors conforming to the interface described by
4180 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4181 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4185 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4189 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4193 C<disable_component_resolution_regex_fallback> - Turns
4194 off the deprecated component resolution functionality so
4195 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4196 are called then regex search will not be attempted on string values and
4197 instead C<undef> will be returned.
4201 C<home> - The application home directory. In an uninstalled application,
4202 this is the top level application directory. In an installed application,
4203 this will be the directory containing C<< MyApp.pm >>.
4207 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4211 C<name> - The name of the application in debug messages and the debug and
4216 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4217 until it is accessed. This allows you to (for example) check authentication (and reject
4218 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4222 C<root> - The root directory for templates. Usually this is just a
4223 subdirectory of the home directory, but you can set it to change the
4224 templates to a different directory.
4228 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4229 namespaces from which components will be loaded (and constructed and stored in
4230 C<< $c->components >>).
4234 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4235 to be shown in hit debug tables in the test server.
4239 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4240 variable should be used for determining the request path.
4242 Most web server environments pass the requested path to the application using environment variables,
4243 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4244 exposed as C<< $c->request->base >>) and the request path below that base.
4246 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4247 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4251 =item use_request_uri_for_path => 0
4253 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4254 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4255 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4256 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4258 However this method has the major disadvantage that it is impossible to correctly decode some elements
4259 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4260 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4261 can't distinguish / vs %2F in paths (in addition to other encoded values).
4263 =item use_request_uri_for_path => 1
4265 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4266 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4267 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4269 Given that this method of path resolution is provably more correct, it is recommended that you use
4270 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4271 aware of the implications of not being able to handle encoded URI paths correctly.
4273 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4274 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4275 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4276 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4277 C<< $c->request->base >> will be incorrect.
4283 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4287 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4288 installed, otherwise log an error). This is useful if your application is not running on the
4289 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4290 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4291 This has been done since not all people need this feature and we wish to restrict the growth of
4292 L<Catalyst> dependencies.
4296 C<encoding> - See L</ENCODING>
4298 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4303 C<abort_chain_on_error_fix>
4307 When there is an error in an action chain, the default behavior is to
4308 abort the processing of the remaining actions to avoid running them
4309 when the application is in an unexpected state.
4311 Before version 5.90070, the default used to be false. To keep the old
4312 behaviour, you can explicitly set the value to false. E.g.
4314 __PACKAGE__->config(abort_chain_on_error_fix => 0);
4316 If this setting is set to false, then the remaining actions are
4317 performed and the error is caught at the end of the chain.
4322 C<use_hash_multivalue_in_request>
4324 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4325 and C<parameters> return a hashref where values might be scalar or an arrayref
4326 depending on the incoming data. In many cases this can be undesirable as it
4327 leads one to writing defensive code like the following:
4329 my ($val) = ref($c->req->parameters->{a}) ?
4330 @{$c->req->parameters->{a}} :
4331 $c->req->parameters->{a};
4333 Setting this configuration item to true will make L<Catalyst> populate the
4334 attributes underlying these methods with an instance of L<Hash::MultiValue>
4335 which is used by L<Plack::Request> and others to solve this very issue. You
4336 may prefer this behavior to the default, if so enable this option (be warned
4337 if you enable it in a legacy application we are not sure if it is completely
4338 backwardly compatible).
4342 C<skip_complex_post_part_handling>
4344 When creating body parameters from a POST, if we run into a multipart POST
4345 that does not contain uploads, but instead contains inlined complex data
4346 (very uncommon) we cannot reliably convert that into field => value pairs. So
4347 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4348 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4349 to true (default is false).
4353 C<skip_body_param_unicode_decoding>
4355 Generally we decode incoming POST params based on your declared encoding (the
4356 default for this is to decode UTF-8). If this is causing you trouble and you
4357 do not wish to turn all encoding support off (with the C<encoding> configuration
4358 parameter) you may disable this step atomically by setting this configuration
4363 C<do_not_decode_query>
4365 If true, then do not try to character decode any wide characters in your
4366 request URL query or keywords. Most readings of the relevant specifications
4367 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4368 will use, however if you are creating a lot of URLs manually or have external
4369 evil clients, this might cause you trouble. If you find the changes introduced
4370 in Catalyst version 5.90080+ break some of your query code, you may disable
4371 the UTF-8 decoding globally using this configuration.
4373 This setting takes precedence over C<default_query_encoding>
4377 C<do_not_check_query_encoding>
4379 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
4380 request but would not raise an exception when the decoding failed due to
4381 incorrect unicode. It now does, but if this change is giving you trouble
4382 you may disable it by setting this configuration to true.
4386 C<default_query_encoding>
4388 By default we decode query and keywords in your request URL using UTF-8, which
4389 is our reading of the relevant specifications. This setting allows one to
4390 specify a fixed value for how to decode your query. You might need this if
4391 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4395 C<use_chained_args_0_special_case>
4397 In older versions of Catalyst, when more than one action matched the same path
4398 AND all those matching actions declared Args(0), we'd break the tie by choosing
4399 the first action defined. We now normalized how Args(0) works so that it
4400 follows the same rule as Args(N), which is to say when we need to break a tie
4401 we choose the LAST action defined. If this breaks your code and you don't
4402 have time to update to follow the new normalized approach, you may set this
4403 value to true and it will globally revert to the original chaining behavior.
4407 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4411 C<data_handlers> - See L<DATA HANDLERS>.
4415 C<stats_class_traits>
4417 An arrayref of L<Moose::Role>s that get composed into your stats class.
4421 C<request_class_traits>
4423 An arrayref of L<Moose::Role>s that get composed into your request class.
4427 C<response_class_traits>
4429 An arrayref of L<Moose::Role>s that get composed into your response class.
4433 C<inject_components>
4435 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4439 inject_components => {
4440 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4441 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4442 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4444 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4445 'Model::Zoo' => { a => 2 },
4446 'Model::Foo' => { a => 100 },
4449 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4450 However for cases when you which to use an existing component and you don't need any
4451 customization (where for when you can apply a role to customize it) you may inject those
4452 components into your application. Please note any configuration should be done 'in the
4453 normal way', with a key under configuration named after the component affix, as in the
4456 Using this type of injection allows you to construct significant amounts of your application
4457 with only configuration!. This may or may not lead to increased code understanding.
4459 Please not you may also call the ->inject_components application method as well, although
4460 you must do so BEFORE setup.
4466 Generally when you throw an exception inside an Action (or somewhere in
4467 your stack, such as in a model that an Action is calling) that exception
4468 is caught by Catalyst and unless you either catch it yourself (via eval
4469 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4470 will eventually reach L</finalize_errors> and return either the debugging
4471 error stack page, or the default error page. However, if your exception
4472 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4473 instead rethrow it so that it can be handled by that middleware (which
4474 is part of the default middleware). For example this would allow
4476 use HTTP::Throwable::Factory 'http_throw';
4478 sub throws_exception :Local {
4479 my ($self, $c) = @_;
4481 http_throw(SeeOther => { location =>
4482 $c->uri_for($self->action_for('redirect')) });
4486 =head1 INTERNAL ACTIONS
4488 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4489 C<_ACTION>, and C<_END>. These are by default not shown in the private
4490 action table, but you can make them visible with a config parameter.
4492 MyApp->config(show_internal_actions => 1);
4494 =head1 ON-DEMAND PARSER
4496 The request body is usually parsed at the beginning of a request,
4497 but if you want to handle input yourself, you can enable on-demand
4498 parsing with a config parameter.
4500 MyApp->config(parse_on_demand => 1);
4502 =head1 PROXY SUPPORT
4504 Many production servers operate using the common double-server approach,
4505 with a lightweight frontend web server passing requests to a larger
4506 backend server. An application running on the backend server must deal
4507 with two problems: the remote user always appears to be C<127.0.0.1> and
4508 the server's hostname will appear to be C<localhost> regardless of the
4509 virtual host that the user connected through.
4511 Catalyst will automatically detect this situation when you are running
4512 the frontend and backend servers on the same machine. The following
4513 changes are made to the request.
4515 $c->req->address is set to the user's real IP address, as read from
4516 the HTTP X-Forwarded-For header.
4518 The host value for $c->req->base and $c->req->uri is set to the real
4519 host, as read from the HTTP X-Forwarded-Host header.
4521 Additionally, you may be running your backend application on an insecure
4522 connection (port 80) while your frontend proxy is running under SSL. If there
4523 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4524 tell Catalyst what port the frontend listens on. This will allow all URIs to
4525 be created properly.
4527 In the case of passing in:
4529 X-Forwarded-Port: 443
4531 All calls to C<uri_for> will result in an https link, as is expected.
4533 Obviously, your web server must support these headers for this to work.
4535 In a more complex server farm environment where you may have your
4536 frontend proxy server(s) on different machines, you will need to set a
4537 configuration option to tell Catalyst to read the proxied data from the
4540 MyApp->config(using_frontend_proxy => 1);
4542 If you do not wish to use the proxy support at all, you may set:
4544 MyApp->config(ignore_frontend_proxy => 0);
4546 =head2 Note about psgi files
4548 Note that if you supply your own .psgi file, calling
4549 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4551 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4552 in your psgi, for example:
4555 enable "Plack::Middleware::ReverseProxy";
4559 This will unconditionally add the ReverseProxy support, or you need to call
4560 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4561 apply the support depending upon your config).
4563 See L<Catalyst::PSGI> for more information.
4565 =head1 THREAD SAFETY
4567 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4568 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4569 believe the Catalyst core to be thread-safe.
4571 If you plan to operate in a threaded environment, remember that all other
4572 modules you are using must also be thread-safe. Some modules, most notably
4573 L<DBD::SQLite>, are not thread-safe.
4575 =head1 DATA HANDLERS
4577 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4578 form parameters and URL search query fields. However it has become common
4579 for various alternative content types to be PUT or POSTed to your controllers
4580 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4581 XML and other content types when communicating with an application server. In
4582 order to better support this use case, L<Catalyst> defines a global configuration
4583 option, C<data_handlers>, which lets you associate a content type with a coderef
4584 that parses that content type into something Perl can readily access.
4591 __PACKAGE__->config(
4593 'application/json' => sub { local $/; decode_json $_->getline },
4595 ## Any other configuration.
4600 By default L<Catalyst> comes with a generic JSON data handler similar to the
4601 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4602 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4603 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4604 or dist.ini, cpanfile, etc.)
4606 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4607 (matched against the incoming request type using a regexp such as to be case
4608 insensitive) and whose values are coderefs that receive a localized version of
4609 C<$_> which is a filehandle object pointing to received body.
4611 This feature is considered an early access release and we reserve the right
4612 to alter the interface in order to provide a performant and secure solution to
4613 alternative request body content. Your reports welcomed!
4615 =head1 PSGI MIDDLEWARE
4617 You can define middleware, defined as L<Plack::Middleware> or a compatible
4618 interface in configuration. Your middleware definitions are in the form of an
4619 arrayref under the configuration key C<psgi_middleware>. Here's an example
4620 with details to follow:
4625 use Plack::Middleware::StackTrace;
4627 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4629 __PACKAGE__->config(
4630 'psgi_middleware', [
4633 $stacktrace_middleware,
4634 'Session' => {store => 'File'},
4639 $env->{myapp.customkey} = 'helloworld';
4648 So the general form is:
4650 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4652 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4653 the order listed (to make it function similarly to L<Plack::Builder>:
4655 Alternatively, you may also define middleware by calling the L</setup_middleware>
4662 __PACKAGE__->setup_middleware( \@middleware_definitions);
4665 In the case where you do both (use 'setup_middleware' and configuration) the
4666 package call to setup_middleware will be applied earlier (in other words its
4667 middleware will wrap closer to the application). Keep this in mind since in
4668 some cases the order of middleware is important.
4670 The two approaches are not exclusive.
4674 =item Middleware Object
4676 An already initialized object that conforms to the L<Plack::Middleware>
4679 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4681 __PACKAGE__->config(
4682 'psgi_middleware', [
4683 $stacktrace_middleware,
4689 A coderef that is an inlined middleware:
4691 __PACKAGE__->config(
4692 'psgi_middleware', [
4697 if($env->{PATH_INFO} =~m/forced/) {
4699 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4702 return $app->($env);
4712 We assume the scalar refers to a namespace after normalizing it using the
4715 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4716 is assumed to be 'as is', and we just install and use the middleware.
4718 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4719 (the package name of your Catalyst application subclass), we also assume then
4720 that it is a full namespace, and use it.
4722 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4723 resolve it first by looking for it under your application namespace (for example
4724 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4725 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4726 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4727 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4728 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4729 you find that a good idea.
4735 __PACKAGE__->config(
4736 'psgi_middleware', [
4737 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4738 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4739 '+MyApp::Custom', ## MyApp::Custom->wrap
4743 =item a scalar followed by a hashref
4745 Just like the previous, except the following C<HashRef> is used as arguments
4746 to initialize the middleware object.
4748 __PACKAGE__->config(
4749 'psgi_middleware', [
4750 'Session' => {store => 'File'},
4755 Please see L<PSGI> for more on middleware.
4759 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4760 and set to encode all body responses to UTF8 when possible and applicable.
4761 Following is documentation on this process. If you are using an older
4762 version of L<Catalyst> you should review documentation for that version since
4765 By default encoding is now 'UTF-8'. You may turn it off by setting
4766 the encoding configuration to undef.
4768 MyApp->config(encoding => undef);
4770 This is recommended for temporary backwards compatibility only.
4772 To turn it off for a single request use the L<clear_encoding>
4773 method to turn off encoding for this request. This can be useful
4774 when you are setting the body to be an arbitrary block of bytes,
4775 especially if that block happens to be a block of UTF8 text.
4777 Encoding is automatically applied when the content-type is set to
4778 a type that can be encoded. Currently we encode when the content type
4779 matches the following regular expression:
4781 $content_type =~ /^text|xml$|javascript$/
4783 Encoding is set on the application, but it is copied to the context object
4784 so that you can override it on a request basis.
4786 Be default we don't automatically encode 'application/json' since the most
4787 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4788 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4791 If you are producing JSON response in an unconventional manner (such
4792 as via a template or manual strings) you should perform the UTF8 encoding
4793 manually as well such as to conform to the JSON specification.
4795 NOTE: We also examine the value of $c->response->content_encoding. If
4796 you set this (like for example 'gzip', and manually gzipping the body)
4797 we assume that you have done all the necessary encoding yourself, since
4798 we cannot encode the gzipped contents. If you use a plugin like
4799 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4800 to have this function correctly with the new UTF8 encoding code, or you
4801 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4810 Returns an instance of an C<Encode> encoding
4812 print $c->encoding->name
4814 =item handle_unicode_encoding_exception ($exception_context)
4816 Method called when decoding process for a request fails.
4818 An C<$exception_context> hashref is provided to allow you to override the
4819 behaviour of your application when given data with incorrect encodings.
4821 The default method throws exceptions in the case of invalid request parameters
4822 (resulting in a 500 error), but ignores errors in upload filenames.
4824 The keys passed in the C<$exception_context> hash are:
4830 The value which was not able to be decoded.
4834 The exception received from L<Encode>.
4838 What type of data was being decoded. Valid values are (currently)
4839 C<params> - for request parameters / arguments / captures
4840 and C<uploads> - for request upload filenames.
4850 Join #catalyst on irc.perl.org.
4854 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4855 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4859 http://catalyst.perl.org
4863 http://dev.catalyst.perl.org
4867 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4869 =head2 L<Catalyst::Manual> - The Catalyst Manual
4871 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4873 =head2 L<Catalyst::Engine> - Core engine
4875 =head2 L<Catalyst::Log> - Log class.
4877 =head2 L<Catalyst::Request> - Request object
4879 =head2 L<Catalyst::Response> - Response object
4881 =head2 L<Catalyst::Test> - The test suite.
4883 =head1 PROJECT FOUNDER
4885 sri: Sebastian Riedel <sri@cpan.org>
4891 acme: Leon Brocard <leon@astray.com>
4893 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4895 andrewalker: André Walker <andre@cpan.org>
4899 Andrew Ford <A.Ford@ford-mason.co.uk>
4903 andyg: Andy Grundman <andy@hybridized.org>
4905 audreyt: Audrey Tang
4907 bricas: Brian Cassidy <bricas@cpan.org>
4909 Caelum: Rafael Kitover <rkitover@io.com>
4911 chansen: Christian Hansen
4913 Chase Venters <chase.venters@gmail.com>
4915 chicks: Christopher Hicks
4917 Chisel Wright <pause@herlpacker.co.uk>
4919 Danijel Milicevic <me@danijel.de>
4921 davewood: David Schmidt <davewood@cpan.org>
4923 David Kamholz <dkamholz@cpan.org>
4925 David Naughton <naughton@umn.edu>
4929 dhoss: Devin Austin <dhoss@cpan.org>
4931 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4935 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4937 esskar: Sascha Kiefer
4939 fireartist: Carl Franks <cfranks@cpan.org>
4941 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4943 gabb: Danijel Milicevic
4947 Gavin Henry <ghenry@perl.me.uk>
4951 groditi: Guillermo Roditi <groditi@gmail.com>
4953 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4955 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4957 jcamacho: Juan Camacho
4959 jester: Jesse Sheidlower <jester@panix.com>
4961 jhannah: Jay Hannah <jay@jays.net>
4967 jon: Jon Schutz <jjschutz@cpan.org>
4969 Jonathan Rockway <jrockway@cpan.org>
4971 Kieren Diment <kd@totaldatasolution.com>
4973 konobi: Scott McWhirter <konobi@cpan.org>
4975 marcus: Marcus Ramberg <mramberg@cpan.org>
4977 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4979 mgrimes: Mark Grimes <mgrimes@cpan.org>
4981 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4985 naughton: David Naughton
4987 ningu: David Kamholz <dkamholz@cpan.org>
4989 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
4991 numa: Dan Sully <daniel@cpan.org>
4997 omega: Andreas Marienborg
4999 Oleg Kostyuk <cub.uanic@gmail.com>
5001 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
5003 rafl: Florian Ragwitz <rafl@debian.org>
5005 random: Roland Lammel <lammel@cpan.org>
5007 revmischa: Mischa Spiegelmock <revmischa@cpan.org>
5009 Robert Sedlacek <rs@474.at>
5011 SpiceMan: Marcel Montes
5015 szbalint: Balint Szilakszi <szbalint@cpan.org>
5017 t0m: Tomas Doran <bobtfish@bobtfish.net>
5021 vanstyn: Henry Van Styn <vanstyn@cpan.org>
5023 Viljo Marrandi <vilts@yahoo.com>
5025 Will Hawes <info@whawes.co.uk>
5027 willert: Sebastian Willert <willert@cpan.org>
5029 wreis: Wallace Reis <wreis@cpan.org>
5031 Yuval Kogman <nothingmuch@woobling.org>
5033 rainboxx: Matthias Dietrich <perl@rainboxx.de>
5035 dd070: Dhaval Dhanani <dhaval070@gmail.com>
5037 Upasana <me@upasana.me>
5039 John Napiorkowski (jnap) <jjnapiork@cpan.org>
5043 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
5047 This library is free software. You can redistribute it and/or modify it under
5048 the same terms as Perl itself.
5054 __PACKAGE__->meta->make_immutable;