4 use Moose::Meta::Class ();
5 extends 'Catalyst::Component';
6 use Moose::Util qw/find_meta/;
7 use namespace::clean -except => 'meta';
8 use Catalyst::Exception;
9 use Catalyst::Exception::Detach;
10 use Catalyst::Exception::Go;
12 use Catalyst::Request;
13 use Catalyst::Request::Upload;
14 use Catalyst::Response;
16 use Catalyst::Controller;
18 use Devel::InnerPackage ();
19 use Module::Pluggable::Object ();
20 use Text::SimpleTable ();
21 use Path::Class::Dir ();
22 use Path::Class::File ();
27 use Tree::Simple qw/use_weak_refs/;
28 use Tree::Simple::Visitor::FindByUID;
29 use Class::C3::Adopt::NEXT;
30 use List::MoreUtils qw/uniq/;
32 use String::RewritePrefix;
33 use Catalyst::EngineLoader;
35 use Carp qw/croak carp shortmess/;
38 use Moose::Util 'find_meta';
39 use Plack::Middleware::Conditional;
40 use Plack::Middleware::ReverseProxy;
41 use Plack::Middleware::IIS6ScriptNameFix;
42 use Plack::Middleware::IIS7KeepAliveFix;
43 use Plack::Middleware::LighttpdScriptNameFix;
44 use Plack::Middleware::ContentLength;
45 use Plack::Middleware::Head;
46 use Plack::Middleware::HTTPExceptions;
47 use Plack::Middleware::FixMissingBodyInRedirect;
48 use Plack::Middleware::MethodOverride;
49 use Plack::Middleware::RemoveRedundantBody;
50 use Catalyst::Middleware::Stash;
52 use Class::Load 'load_class';
53 use Encode 2.21 'decode_utf8', 'encode_utf8';
56 BEGIN { require 5.008003; }
58 has stack => (is => 'ro', default => sub { [] });
59 has state => (is => 'rw', default => 0);
60 has stats => (is => 'rw');
61 has action => (is => 'rw');
62 has counter => (is => 'rw', default => sub { {} });
67 my $class = ref $self;
68 my $composed_request_class = $class->composed_request_class;
69 return $composed_request_class->new( $self->_build_request_constructor_args);
73 sub _build_request_constructor_args {
75 my %p = ( _log => $self->log );
76 $p{_uploadtmp} = $self->_uploadtmp if $self->_has_uploadtmp;
77 $p{data_handlers} = {$self->registered_data_handlers};
78 $p{_use_hash_multivalue} = $self->config->{use_hash_multivalue_in_request}
79 if $self->config->{use_hash_multivalue_in_request};
83 sub composed_request_class {
85 return $class->_composed_request_class if $class->_composed_request_class;
87 my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]});
89 # For each trait listed, figure out what the namespace is. First we try the $trait
90 # as it is in the config. Then try $MyApp::TraitFor::Request:$trait. Last we try
91 # Catalyst::TraitFor::Request::$trait. If none load, throw error.
93 my $trait_ns = 'TraitFor::Request';
94 my @normalized_traits = map {
95 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
98 if ($class->debug && scalar(@normalized_traits)) {
99 my $column_width = Catalyst::Utils::term_width() - 6;
100 my $t = Text::SimpleTable->new($column_width);
101 $t->row($_) for @normalized_traits;
102 $class->log->debug( "Composed Request Class Traits:\n" . $t->draw . "\n" );
105 return $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits));
112 my $class = ref $self;
113 my $composed_response_class = $class->composed_response_class;
114 return $composed_response_class->new( $self->_build_response_constructor_args);
118 sub _build_response_constructor_args {
121 encoding => $_[0]->encoding,
125 sub composed_response_class {
127 return $class->_composed_response_class if $class->_composed_response_class;
129 my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]});
131 my $trait_ns = 'TraitFor::Response';
132 my @normalized_traits = map {
133 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
136 if ($class->debug && scalar(@normalized_traits)) {
137 my $column_width = Catalyst::Utils::term_width() - 6;
138 my $t = Text::SimpleTable->new($column_width);
139 $t->row($_) for @normalized_traits;
140 $class->log->debug( "Composed Response Class Traits:\n" . $t->draw . "\n" );
143 return $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits));
146 has namespace => (is => 'rw');
148 sub depth { scalar @{ shift->stack || [] }; }
149 sub comp { shift->component(@_) }
152 my $self = shift; return $self->request(@_);
155 my $self = shift; return $self->response(@_);
158 # For backwards compatibility
159 sub finalize_output { shift->finalize_body(@_) };
164 our $RECURSION = 1000;
165 our $DETACH = Catalyst::Exception::Detach->new;
166 our $GO = Catalyst::Exception::Go->new;
168 #I imagine that very few of these really
169 #need to be class variables. if any.
170 #maybe we should just make them attributes with a default?
171 __PACKAGE__->mk_classdata($_)
172 for qw/components arguments dispatcher engine log dispatcher_class
173 engine_loader context_class request_class response_class stats_class
174 setup_finished _psgi_app loading_psgi_file run_options _psgi_middleware
175 _data_handlers _encoding _encode_check finalized_default_middleware
176 request_class_traits response_class_traits stats_class_traits
177 _composed_request_class _composed_response_class _composed_stats_class/;
179 __PACKAGE__->dispatcher_class('Catalyst::Dispatcher');
180 __PACKAGE__->request_class('Catalyst::Request');
181 __PACKAGE__->response_class('Catalyst::Response');
182 __PACKAGE__->stats_class('Catalyst::Stats');
184 sub composed_stats_class {
186 return $class->_composed_stats_class if $class->_composed_stats_class;
188 my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]});
190 my $trait_ns = 'TraitFor::Stats';
191 my @normalized_traits = map {
192 Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_)
195 if ($class->debug && scalar(@normalized_traits)) {
196 my $column_width = Catalyst::Utils::term_width() - 6;
197 my $t = Text::SimpleTable->new($column_width);
198 $t->row($_) for @normalized_traits;
199 $class->log->debug( "Composed Stats Class Traits:\n" . $t->draw . "\n" );
202 return $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits));
205 __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC);
207 # Remember to update this in Catalyst::Runtime as well!
208 our $VERSION = '5.90114';
209 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
212 my ( $class, @arguments ) = @_;
214 # We have to limit $class to Catalyst to avoid pushing Catalyst upon every
216 return unless $class eq 'Catalyst';
218 my $caller = caller();
219 return if $caller eq 'main';
221 my $meta = Moose::Meta::Class->initialize($caller);
222 unless ( $caller->isa('Catalyst') ) {
223 my @superclasses = ($meta->superclasses, $class, 'Catalyst::Controller');
224 $meta->superclasses(@superclasses);
226 # Avoid possible C3 issues if 'Moose::Object' is already on RHS of MyApp
227 $meta->superclasses(grep { $_ ne 'Moose::Object' } $meta->superclasses);
229 unless( $meta->has_method('meta') ){
230 if ($Moose::VERSION >= 1.15) {
231 $meta->_add_meta_method('meta');
234 $meta->add_method(meta => sub { Moose::Meta::Class->initialize("${caller}") } );
238 $caller->arguments( [@arguments] );
242 sub _application { $_[0] }
248 Catalyst - The Elegant MVC Web Application Framework
252 <a href="https://badge.fury.io/pl/Catalyst-Runtime"><img src="https://badge.fury.io/pl/Catalyst-Runtime.svg" alt="CPAN version" height="18"></a>
253 <a href="https://travis-ci.org/perl-catalyst/catalyst-runtime/"><img src="https://api.travis-ci.org/perl-catalyst/catalyst-runtime.png" alt="Catalyst></a>
254 <a href="http://cpants.cpanauthors.org/dist/Catalyst-Runtime"><img src="http://cpants.cpanauthors.org/dist/Catalyst-Runtime.png" alt='Kwalitee Score' /></a>
258 See the L<Catalyst::Manual> distribution for comprehensive
259 documentation and tutorials.
261 # Install Catalyst::Devel for helpers and other development tools
262 # use the helper to create a new application
265 # add models, views, controllers
266 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
267 script/myapp_create.pl view MyTemplate TT
268 script/myapp_create.pl controller Search
270 # built in testserver -- use -r to restart automatically on changes
271 # --help to see all available options
272 script/myapp_server.pl
274 # command line testing interface
275 script/myapp_test.pl /yada
278 use Catalyst qw/-Debug/; # include plugins here as well
280 ### In lib/MyApp/Controller/Root.pm (autocreated)
281 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
282 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
283 $c->stash->{template} = 'foo.tt'; # set the template
284 # lookup something from db -- stash vars are passed to TT
286 $c->model('Database::Foo')->search( { country => $args[0] } );
287 if ( $c->req->params->{bar} ) { # access GET or POST parameters
288 $c->forward( 'bar' ); # process another action
289 # do something else after forward returns
293 # The foo.tt TT template can use the stash data from the database
294 [% WHILE (item = data.next) %]
298 # called for /bar/of/soap, /bar/of/soap/10, etc.
299 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
301 # called after all actions are finished
303 my ( $self, $c ) = @_;
304 if ( scalar @{ $c->error } ) { ... } # handle errors
305 return if $c->res->body; # already have a response
306 $c->forward( 'MyApp::View::TT' ); # render template
309 See L<Catalyst::Manual::Intro> for additional information.
313 Catalyst is a modern framework for making web applications without the
314 pain usually associated with this process. This document is a reference
315 to the main Catalyst application. If you are a new user, we suggest you
316 start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
318 See L<Catalyst::Manual> for more documentation.
320 Catalyst plugins can be loaded by naming them as arguments to the "use
321 Catalyst" statement. Omit the C<Catalyst::Plugin::> prefix from the
322 plugin name, i.e., C<Catalyst::Plugin::My::Module> becomes
325 use Catalyst qw/My::Module/;
327 If your plugin starts with a name other than C<Catalyst::Plugin::>, you can
328 fully qualify the name by using a unary plus:
332 +Fully::Qualified::Plugin::Name
335 Special flags like C<-Debug> can also be specified as
336 arguments when Catalyst is loaded:
338 use Catalyst qw/-Debug My::Module/;
340 The position of plugins and flags in the chain is important, because
341 they are loaded in the order in which they appear.
343 The following flags are supported:
347 Enables debug output. You can also force this setting from the system
348 environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
349 settings override the application, with <MYAPP>_DEBUG having the highest
352 This sets the log level to 'debug' and enables full debug output on the
353 error screen. If you only want the latter, see L<< $c->debug >>.
357 Forces Catalyst to use a specific home directory, e.g.:
359 use Catalyst qw[-Home=/usr/mst];
361 This can also be done in the shell environment by setting either the
362 C<CATALYST_HOME> environment variable or C<MYAPP_HOME>; where C<MYAPP>
363 is replaced with the uppercased name of your application, any "::" in
364 the name will be replaced with underscores, e.g. MyApp::Web should use
365 MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
367 If none of these are set, Catalyst will attempt to automatically detect the
368 home directory. If you are working in a development environment, Catalyst
369 will try and find the directory containing either Makefile.PL, Build.PL,
370 dist.ini, or cpanfile. If the application has been installed into the system
371 (i.e. you have done C<make install>), then Catalyst will use the path to your
372 application module, without the .pm extension (e.g., /foo/MyApp if your
373 application was installed at /foo/MyApp.pm)
377 use Catalyst '-Log=warn,fatal,error';
379 Specifies a comma-delimited list of log levels.
383 Enables statistics collection and reporting.
385 use Catalyst qw/-Stats=1/;
387 You can also force this setting from the system environment with CATALYST_STATS
388 or <MYAPP>_STATS. The environment settings override the application, with
389 <MYAPP>_STATS having the highest priority.
391 Stats are also enabled if L<< debugging |/"-Debug" >> is enabled.
395 =head2 INFORMATION ABOUT THE CURRENT REQUEST
399 Returns a L<Catalyst::Action> object for the current action, which
400 stringifies to the action name. See L<Catalyst::Action>.
404 Returns the namespace of the current action, i.e., the URI prefix
405 corresponding to the controller of the current action. For example:
407 # in Controller::Foo::Bar
408 $c->namespace; # returns 'foo/bar';
414 Returns the current L<Catalyst::Request> object, giving access to
415 information about the current client request (including parameters,
416 cookies, HTTP headers, etc.). See L<Catalyst::Request>.
418 =head2 REQUEST FLOW HANDLING
420 =head2 $c->forward( $action [, \@arguments ] )
422 =head2 $c->forward( $class, $method, [, \@arguments ] )
424 This is one way of calling another action (method) in the same or
425 a different controller. You can also use C<< $self->my_method($c, @args) >>
426 in the same controller or C<< $c->controller('MyController')->my_method($c, @args) >>
427 in a different controller.
428 The main difference is that 'forward' uses some of the Catalyst request
429 cycle overhead, including debugging, which may be useful to you. On the
430 other hand, there are some complications to using 'forward', restrictions
431 on values returned from 'forward', and it may not handle errors as you prefer.
432 Whether you use 'forward' or not is up to you; it is not considered superior to
433 the other ways to call a method.
435 'forward' calls another action, by its private name. If you give a
436 class name but no method, C<process()> is called. You may also optionally
437 pass arguments in an arrayref. The action will receive the arguments in
438 C<@_> and C<< $c->req->args >>. Upon returning from the function,
439 C<< $c->req->args >> will be restored to the previous values.
441 Any data C<return>ed from the action forwarded to, will be returned by the
444 my $foodata = $c->forward('/foo');
445 $c->forward('index');
446 $c->forward(qw/Model::DBIC::Foo do_stuff/);
447 $c->forward('View::TT');
449 Note that L<< forward|/"$c->forward( $action [, \@arguments ] )" >> implies
450 an C<< eval { } >> around the call (actually
451 L<< execute|/"$c->execute( $class, $coderef )" >> does), thus rendering all
452 exceptions thrown by the called action non-fatal and pushing them onto
453 $c->error instead. If you want C<die> to propagate you need to do something
457 die join "\n", @{ $c->error } if @{ $c->error };
459 Or make sure to always return true values from your actions and write
462 $c->forward('foo') || return;
464 Another note is that C<< $c->forward >> always returns a scalar because it
465 actually returns $c->state which operates in a scalar context.
466 Thus, something like:
470 in an action that is forwarded to is going to return a scalar,
471 i.e. how many items are in that array, which is probably not what you want.
472 If you need to return an array then return a reference to it,
475 $c->stash->{array} = \@array;
477 and access it from the stash.
479 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.
483 sub forward { my $c = shift; no warnings 'recursion'; $c->dispatcher->forward( $c, @_ ) }
485 =head2 $c->detach( $action [, \@arguments ] )
487 =head2 $c->detach( $class, $method, [, \@arguments ] )
491 The same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, but
492 doesn't return to the previous action when processing is finished.
494 When called with no arguments it escapes the processing chain entirely.
498 sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
500 =head2 $c->visit( $action [, \@arguments ] )
502 =head2 $c->visit( $action [, \@captures, \@arguments ] )
504 =head2 $c->visit( $class, $method, [, \@arguments ] )
506 =head2 $c->visit( $class, $method, [, \@captures, \@arguments ] )
508 Almost the same as L<< forward|/"$c->forward( $action [, \@arguments ] )" >>,
509 but does a full dispatch, instead of just calling the new C<$action> /
510 C<< $class->$method >>. This means that C<begin>, C<auto> and the method
511 you go to are called, just like a new request.
513 In addition both C<< $c->action >> and C<< $c->namespace >> are localized.
514 This means, for example, that C<< $c->action >> methods such as
515 L<name|Catalyst::Action/name>, L<class|Catalyst::Action/class> and
516 L<reverse|Catalyst::Action/reverse> return information for the visited action
517 when they are invoked within the visited action. This is different from the
518 behavior of L<< forward|/"$c->forward( $action [, \@arguments ] )" >>, which
519 continues to use the $c->action object from the caller action even when
520 invoked from the called action.
522 C<< $c->stash >> is kept unchanged.
524 In effect, L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >>
525 allows you to "wrap" another action, just as it would have been called by
526 dispatching from a URL, while the analogous
527 L<< go|/"$c->go( $action [, \@captures, \@arguments ] )" >> allows you to
528 transfer control to another action as if it had been reached directly from a URL.
532 sub visit { my $c = shift; $c->dispatcher->visit( $c, @_ ) }
534 =head2 $c->go( $action [, \@arguments ] )
536 =head2 $c->go( $action [, \@captures, \@arguments ] )
538 =head2 $c->go( $class, $method, [, \@arguments ] )
540 =head2 $c->go( $class, $method, [, \@captures, \@arguments ] )
542 The relationship between C<go> and
543 L<< visit|/"$c->visit( $action [, \@captures, \@arguments ] )" >> is the same as
544 the relationship between
545 L<< forward|/"$c->forward( $class, $method, [, \@arguments ] )" >> and
546 L<< detach|/"$c->detach( $action [, \@arguments ] )" >>. Like C<< $c->visit >>,
547 C<< $c->go >> will perform a full dispatch on the specified action or method,
548 with localized C<< $c->action >> and C<< $c->namespace >>. Like C<detach>,
549 C<go> escapes the processing of the current request chain on completion, and
550 does not return to its caller.
552 @arguments are arguments to the final destination of $action. @captures are
553 arguments to the intermediate steps, if any, on the way to the final sub of
558 sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) }
564 Returns the current L<Catalyst::Response> object, see there for details.
568 Returns a hashref to the stash, which may be used to store data and pass
569 it between components during a request. You can also set hash keys by
570 passing arguments. The stash is automatically sent to the view. The
571 stash is cleared at the end of a request; it cannot be used for
572 persistent storage (for this you must use a session; see
573 L<Catalyst::Plugin::Session> for a complete system integrated with
576 $c->stash->{foo} = $bar;
577 $c->stash( { moose => 'majestic', qux => 0 } );
578 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
580 # stash is automatically passed to the view for use in a template
581 $c->forward( 'MyApp::View::TT' );
583 The stash hash is currently stored in the PSGI C<$env> and is managed by
584 L<Catalyst::Middleware::Stash>. Since it's part of the C<$env> items in
585 the stash can be accessed in sub applications mounted under your main
586 L<Catalyst> application. For example if you delegate the response of an
587 action to another L<Catalyst> application, that sub application will have
588 access to all the stash keys of the main one, and if can of course add
589 more keys of its own. However those new keys will not 'bubble' back up
590 to the main application.
592 For more information the best thing to do is to review the test case:
593 t/middleware-stash.t in the distribution /t directory.
599 $c->log->error("You are requesting the stash but you don't have a context") unless blessed $c;
600 return Catalyst::Middleware::Stash::get_stash($c->req->env)->(@_);
605 =head2 $c->error($error, ...)
607 =head2 $c->error($arrayref)
609 Returns an arrayref containing error messages. If Catalyst encounters an
610 error while processing a request, it stores the error in $c->error. This
611 method should only be used to store fatal error messages.
613 my @error = @{ $c->error };
617 $c->error('Something bad happened');
619 Calling this will always return an arrayref (if there are no errors it
620 will be an empty arrayref.
627 my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
628 croak @$error unless ref $c;
629 push @{ $c->{error} }, @$error;
631 elsif ( defined $_[0] ) { $c->{error} = undef }
632 return $c->{error} || [];
637 Contains the return value of the last executed action.
638 Note that << $c->state >> operates in a scalar context which means that all
639 values it returns are scalar.
641 Please note that if an action throws an exception, the value of state
642 should no longer be considered the return if the last action. It is generally
643 going to be 0, which indicates an error state. Examine $c->error for error
646 =head2 $c->clear_errors
648 Clear errors. You probably don't want to clear the errors unless you are
649 implementing a custom error screen.
651 This is equivalent to running
662 =head2 $c->has_errors
664 Returns true if you have errors
668 sub has_errors { scalar(@{shift->error}) ? 1:0 }
670 =head2 $c->last_error
672 Returns the most recent error in the stack (the one most recently added...)
673 or nothing if there are no errors. This does not modify the contents of the
679 my (@errs) = @{shift->error};
680 return scalar(@errs) ? $errs[-1]: undef;
685 shifts the most recently added error off the error stack and returns it. Returns
686 nothing if there are no more errors.
692 my @errors = @{$self->error};
693 my $err = shift(@errors);
694 $self->{error} = \@errors;
700 pops the most recently added error off the error stack and returns it. Returns
701 nothing if there are no more errors.
707 my @errors = @{$self->error};
708 my $err = pop(@errors);
709 $self->{error} = \@errors;
713 sub _comp_search_prefixes {
715 return map $c->components->{ $_ }, $c->_comp_names_search_prefixes(@_);
718 # search components given a name and some prefixes
719 sub _comp_names_search_prefixes {
720 my ( $c, $name, @prefixes ) = @_;
721 my $appclass = ref $c || $c;
722 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
723 $filter = qr/$filter/; # Compile regex now rather than once per loop
725 # map the original component name to the sub part that we will search against
726 my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; }
727 grep { /$filter/ } keys %{ $c->components };
729 # undef for a name will return all
730 return keys %eligible if !defined $name;
732 my $query = $name->$_isa('Regexp') ? $name : qr/^$name$/i;
733 my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible;
735 return @result if @result;
737 # if we were given a regexp to search against, we're done.
738 return if $name->$_isa('Regexp');
740 # skip regexp fallback if configured
742 if $appclass->config->{disable_component_resolution_regex_fallback};
746 @result = grep { $eligible{ $_ } =~ m{$query} } keys %eligible;
748 # no results? try against full names
750 @result = grep { m{$query} } keys %eligible;
753 # don't warn if we didn't find any results, it just might not exist
755 # Disgusting hack to work out correct method name
756 my $warn_for = lc $prefixes[0];
757 my $msg = "Used regexp fallback for \$c->${warn_for}('${name}'), which found '" .
758 (join '", "', @result) . "'. Relying on regexp fallback behavior for " .
759 "component resolution is unreliable and unsafe.";
760 my $short = $result[0];
761 # remove the component namespace prefix
762 $short =~ s/.*?(Model|Controller|View):://;
763 my $shortmess = Carp::shortmess('');
764 if ($shortmess =~ m#Catalyst/Plugin#) {
765 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
767 } elsif ($shortmess =~ m#Catalyst/lib/(View|Controller)#) {
768 $msg .= " You probably need to set '$short' instead of '${name}' in this " .
769 "component's config";
771 $msg .= " You probably meant \$c->${warn_for}('$short') instead of \$c->${warn_for}('${name}'), " .
772 "but if you really wanted to search, pass in a regexp as the argument " .
773 "like so: \$c->${warn_for}(qr/${name}/)";
775 $c->log->warn( "${msg}$shortmess" );
781 # Find possible names for a prefix
783 my ( $c, @prefixes ) = @_;
784 my $appclass = ref $c || $c;
786 my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::';
788 my @names = map { s{$filter}{}; $_; }
789 $c->_comp_names_search_prefixes( undef, @prefixes );
794 # Filter a component before returning by calling ACCEPT_CONTEXT if available
796 sub _filter_component {
797 my ( $c, $comp, @args ) = @_;
799 if(ref $comp eq 'CODE') {
803 if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) {
804 return $comp->ACCEPT_CONTEXT( $c, @args );
807 $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;
812 =head2 COMPONENT ACCESSORS
814 =head2 $c->controller($name)
816 Gets a L<Catalyst::Controller> instance by name.
818 $c->controller('Foo')->do_stuff;
820 If the name is omitted, will return the controller for the dispatched
823 If you want to search for controllers, pass in a regexp as the argument.
825 # find all controllers that start with Foo
826 my @foo_controllers = $c->controller(qr{^Foo});
832 my ( $c, $name, @args ) = @_;
834 my $appclass = ref($c) || $c;
836 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
837 my $comps = $c->components;
838 my $check = $appclass."::Controller::".$name;
839 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
840 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
841 next unless $path =~ /.*::Controller/;
842 $check = $path."::".$name;
843 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
846 my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ );
847 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
848 return $c->_filter_component( $result[ 0 ], @args );
851 return $c->component( $c->action->class );
854 =head2 $c->model($name)
856 Gets a L<Catalyst::Model> instance by name.
858 $c->model('Foo')->do_stuff;
860 Any extra arguments are directly passed to ACCEPT_CONTEXT, if the model
861 defines ACCEPT_CONTEXT. If it does not, the args are discarded.
863 If the name is omitted, it will look for
864 - a model object in $c->stash->{current_model_instance}, then
865 - a model name in $c->stash->{current_model}, then
866 - a config setting 'default_model', or
867 - check if there is only one model, and return it if that's the case.
869 If you want to search for models, pass in a regexp as the argument.
871 # find all models that start with Foo
872 my @foo_models = $c->model(qr{^Foo});
877 my ( $c, $name, @args ) = @_;
878 my $appclass = ref($c) || $c;
880 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
881 my $comps = $c->components;
882 my $check = $appclass."::Model::".$name;
883 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
884 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
885 next unless $path =~ /.*::Model/;
886 $check = $path."::".$name;
887 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
890 my @result = $c->_comp_search_prefixes( $name, qw/Model M/ );
891 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
892 return $c->_filter_component( $result[ 0 ], @args );
896 return $c->stash->{current_model_instance}
897 if $c->stash->{current_model_instance};
898 return $c->model( $c->stash->{current_model} )
899 if $c->stash->{current_model};
901 return $c->model( $appclass->config->{default_model} )
902 if $appclass->config->{default_model};
904 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/);
907 $c->log->warn( Carp::shortmess('Calling $c->model() will return a random model unless you specify one of:') );
908 $c->log->warn( '* $c->config(default_model => "the name of the default model to use")' );
909 $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' );
910 $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' );
911 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
914 return $c->_filter_component( $comp );
918 =head2 $c->view($name)
920 Gets a L<Catalyst::View> instance by name.
922 $c->view('Foo')->do_stuff;
924 Any extra arguments are directly passed to ACCEPT_CONTEXT.
926 If the name is omitted, it will look for
927 - a view object in $c->stash->{current_view_instance}, then
928 - a view name in $c->stash->{current_view}, then
929 - a config setting 'default_view', or
930 - check if there is only one view, and return it if that's the case.
932 If you want to search for views, pass in a regexp as the argument.
934 # find all views that start with Foo
935 my @foo_views = $c->view(qr{^Foo});
940 my ( $c, $name, @args ) = @_;
942 my $appclass = ref($c) || $c;
944 unless ( $name->$_isa('Regexp') ) { # Direct component hash lookup to avoid costly regexps
945 my $comps = $c->components;
946 my $check = $appclass."::View::".$name;
947 if( exists $comps->{$check} ) {
948 return $c->_filter_component( $comps->{$check}, @args );
951 $c->log->warn( "Attempted to use view '$check', but does not exist" );
953 foreach my $path (@{$appclass->config->{ setup_components }->{ search_extra }}) {
954 next unless $path =~ /.*::View/;
955 $check = $path."::".$name;
956 return $c->_filter_component( $comps->{$check}, @args ) if exists $comps->{$check};
959 my @result = $c->_comp_search_prefixes( $name, qw/View V/ );
960 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
961 return $c->_filter_component( $result[ 0 ], @args );
965 return $c->stash->{current_view_instance}
966 if $c->stash->{current_view_instance};
967 return $c->view( $c->stash->{current_view} )
968 if $c->stash->{current_view};
970 return $c->view( $appclass->config->{default_view} )
971 if $appclass->config->{default_view};
973 my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/);
976 $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' );
977 $c->log->warn( '* $c->config(default_view => "the name of the default view to use")' );
978 $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' );
979 $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' );
980 $c->log->warn( 'NB: in version 5.81, the "random" behavior will not work at all.' );
983 return $c->_filter_component( $comp );
986 =head2 $c->controllers
988 Returns the available names which can be passed to $c->controller
994 return $c->_comp_names(qw/Controller C/);
999 Returns the available names which can be passed to $c->model
1005 return $c->_comp_names(qw/Model M/);
1011 Returns the available names which can be passed to $c->view
1017 return $c->_comp_names(qw/View V/);
1020 =head2 $c->comp($name)
1022 =head2 $c->component($name)
1024 Gets a component object by name. This method is not recommended,
1025 unless you want to get a specific component by full
1026 class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
1027 should be used instead.
1029 If C<$name> is a regexp, a list of components matched against the full
1030 component name will be returned.
1032 If Catalyst can't find a component by name, it will fallback to regex
1033 matching by default. To disable this behaviour set
1034 disable_component_resolution_regex_fallback to a true value.
1036 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
1041 my ( $c, $name, @args ) = @_;
1044 my $comps = $c->components;
1047 # is it the exact name?
1048 return $c->_filter_component( $comps->{ $name }, @args )
1049 if exists $comps->{ $name };
1051 # perhaps we just omitted "MyApp"?
1052 my $composed = ( ref $c || $c ) . "::${name}";
1053 return $c->_filter_component( $comps->{ $composed }, @args )
1054 if exists $comps->{ $composed };
1056 # search all of the models, views and controllers
1057 my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ );
1058 return $c->_filter_component( $comp, @args ) if $comp;
1062 if $c->config->{disable_component_resolution_regex_fallback};
1064 # This is here so $c->comp( '::M::' ) works
1065 my $query = ref $name ? $name : qr{$name}i;
1067 my @result = grep { m{$query} } keys %{ $c->components };
1068 return map { $c->_filter_component( $_, @args ) } @result if ref $name;
1070 if( $result[ 0 ] ) {
1071 $c->log->warn( Carp::shortmess(qq(Found results for "${name}" using regexp fallback)) );
1072 $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' );
1073 $c->log->warn( 'is unreliable and unsafe. You have been warned' );
1074 return $c->_filter_component( $result[ 0 ], @args );
1077 # I would expect to return an empty list here, but that breaks back-compat
1081 return sort keys %{ $c->components };
1084 =head2 CLASS DATA AND HELPER CLASSES
1088 Returns or takes a hashref containing the application's configuration.
1090 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
1092 You can also use a C<YAML>, C<XML> or L<Config::General> config file
1093 like C<myapp.conf> in your applications home directory. See
1094 L<Catalyst::Plugin::ConfigLoader>.
1096 =head3 Cascading configuration
1098 The config method is present on all Catalyst components, and configuration
1099 will be merged when an application is started. Configuration loaded with
1100 L<Catalyst::Plugin::ConfigLoader> takes precedence over other configuration,
1101 followed by configuration in your top level C<MyApp> class. These two
1102 configurations are merged, and then configuration data whose hash key matches a
1103 component name is merged with configuration for that component.
1105 The configuration for a component is then passed to the C<new> method when a
1106 component is constructed.
1110 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
1111 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
1113 will mean that C<MyApp::Model::Foo> receives the following data when
1116 MyApp::Model::Foo->new({
1122 It's common practice to use a Moose attribute
1123 on the receiving component to access the config value.
1125 package MyApp::Model::Foo;
1129 # this attr will receive 'baz' at construction time
1135 You can then get the value 'baz' by calling $c->model('Foo')->bar
1136 (or $self->bar inside code in the model).
1138 B<NOTE:> you MUST NOT call C<< $self->config >> or C<< __PACKAGE__->config >>
1139 as a way of reading config within your code, as this B<will not> give you the
1140 correctly merged config back. You B<MUST> take the config values supplied to
1141 the constructor and use those instead.
1145 around config => sub {
1149 croak('Setting config after setup has been run is not allowed.')
1150 if ( @_ and $c->setup_finished );
1157 Returns the logging object instance. Unless it is already set, Catalyst
1158 sets this up with a L<Catalyst::Log> object. To use your own log class,
1159 set the logger with the C<< __PACKAGE__->log >> method prior to calling
1160 C<< __PACKAGE__->setup >>.
1162 __PACKAGE__->log( MyLogger->new );
1167 $c->log->info( 'Now logging with my own logger!' );
1169 Your log class should implement the methods described in
1174 Returned True if there's a valid encoding
1176 =head2 clear_encoding
1178 Clears the encoding for the current context
1182 Sets or gets the application encoding. Setting encoding takes either an
1183 Encoding object or a string that we try to resolve via L<Encode::find_encoding>.
1185 You would expect to get the encoding object back if you attempt to set it. If
1186 there is a failure you will get undef returned and an error message in the log.
1190 sub has_encoding { shift->encoding ? 1:0 }
1192 sub clear_encoding {
1195 $c->encoding(undef);
1197 $c->log->error("You can't clear encoding on the application");
1207 # Don't let one change this once we are too far into the response
1208 if(blessed $c && $c->res->finalized_headers) {
1209 Carp::croak("You may not change the encoding once the headers are finalized");
1213 # Let it be set to undef
1214 if (my $wanted = shift) {
1215 $encoding = Encode::find_encoding($wanted)
1216 or Carp::croak( qq/Unknown encoding '$wanted'/ );
1217 binmode(STDERR, ':encoding(' . $encoding->name . ')');
1224 ? $c->{encoding} = $encoding
1225 : $c->_encoding($encoding);
1227 $encoding = ref $c && exists $c->{encoding}
1237 Returns 1 if debug mode is enabled, 0 otherwise.
1239 You can enable debug mode in several ways:
1243 =item By calling myapp_server.pl with the -d flag
1245 =item With the environment variables MYAPP_DEBUG, or CATALYST_DEBUG
1247 =item The -Debug option in your MyApp.pm
1249 =item By declaring C<sub debug { 1 }> in your MyApp.pm.
1253 The first three also set the log level to 'debug'.
1255 Calling C<< $c->debug(1) >> has no effect.
1261 =head2 $c->dispatcher
1263 Returns the dispatcher instance. See L<Catalyst::Dispatcher>.
1267 Returns the engine instance. See L<Catalyst::Engine>.
1270 =head2 UTILITY METHODS
1272 =head2 $c->path_to(@path)
1274 Merges C<@path> with C<< $c->config->{home} >> and returns a
1275 L<Path::Class::Dir> object. Note you can usually use this object as
1276 a filename, but sometimes you will have to explicitly stringify it
1277 yourself by calling the C<< ->stringify >> method.
1281 $c->path_to( 'db', 'sqlite.db' );
1286 my ( $c, @path ) = @_;
1287 my $path = Path::Class::Dir->new( $c->config->{home}, @path );
1288 if ( -d $path ) { return $path }
1289 else { return Path::Class::File->new( $c->config->{home}, @path ) }
1293 my ( $class, $name, $plugin, @args ) = @_;
1295 # See block comment in t/unit_core_plugin.t
1296 $class->log->warn(qq/Adding plugin using the ->plugin method is deprecated, and will be removed in a future release/);
1298 $class->_register_plugin( $plugin, 1 );
1300 eval { $plugin->import };
1301 $class->mk_classdata($name);
1303 eval { $obj = $plugin->new(@args) };
1306 Catalyst::Exception->throw( message =>
1307 qq/Couldn't instantiate instant plugin "$plugin", "$@"/ );
1310 $class->$name($obj);
1311 $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/)
1317 Initializes the dispatcher and engine, loads any plugins, and loads the
1318 model, view, and controller components. You may also specify an array
1319 of plugins to load here, if you choose to not load them in the C<use
1323 MyApp->setup( qw/-Debug/ );
1325 B<Note:> You B<should not> wrap this method with method modifiers
1326 or bad things will happen - wrap the C<setup_finalize> method instead.
1328 B<Note:> You can create a custom setup stage that will execute when the
1329 application is starting. Use this to customize setup.
1331 MyApp->setup(-Custom=value);
1334 my ($class, $value) = @_;
1337 Can be handy if you want to hook into the setup phase.
1342 my ( $class, @arguments ) = @_;
1343 croak('Running setup more than once')
1344 if ( $class->setup_finished );
1346 unless ( $class->isa('Catalyst') ) {
1348 Catalyst::Exception->throw(
1349 message => qq/'$class' does not inherit from Catalyst/ );
1352 if ( $class->arguments ) {
1353 @arguments = ( @arguments, @{ $class->arguments } );
1359 foreach (@arguments) {
1363 ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug';
1365 elsif (/^-(\w+)=?(.*)$/) {
1366 $flags->{ lc $1 } = $2;
1369 push @{ $flags->{plugins} }, $_;
1373 $class->setup_home( delete $flags->{home} );
1375 $class->setup_log( delete $flags->{log} );
1376 $class->setup_plugins( delete $flags->{plugins} );
1378 $class->setup_data_handlers();
1379 $class->setup_dispatcher( delete $flags->{dispatcher} );
1380 if (my $engine = delete $flags->{engine}) {
1381 $class->log->warn("Specifying the engine in ->setup is no longer supported, see Catalyst::Upgrading");
1383 $class->setup_engine();
1384 $class->setup_stats( delete $flags->{stats} );
1386 for my $flag ( sort keys %{$flags} ) {
1388 if ( my $code = $class->can( 'setup_' . $flag ) ) {
1389 &$code( $class, delete $flags->{$flag} );
1392 $class->log->warn(qq/Unknown flag "$flag"/);
1396 eval { require Catalyst::Devel; };
1397 if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) {
1398 $class->log->warn(<<"EOF");
1399 You are running an old script!
1401 Please update by running (this will overwrite existing files):
1402 catalyst.pl -force -scripts $class
1404 or (this will not overwrite existing files):
1405 catalyst.pl -scripts $class
1410 # Call plugins setup, this is stupid and evil.
1411 # Also screws C3 badly on 5.10, hack to avoid.
1413 no warnings qw/redefine/;
1414 local *setup = sub { };
1415 $class->setup unless $Catalyst::__AM_RESTARTING;
1418 # If you are expecting configuration info as part of your setup, it needs
1419 # to get called here and below, since we need the above line to support
1420 # ConfigLoader based configs.
1422 $class->setup_encoding();
1423 $class->setup_middleware();
1425 # Initialize our data structure
1426 $class->components( {} );
1428 $class->setup_components;
1430 if ( $class->debug ) {
1431 my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins;
1434 my $column_width = Catalyst::Utils::term_width() - 6;
1435 my $t = Text::SimpleTable->new($column_width);
1436 $t->row($_) for @plugins;
1437 $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
1440 my @middleware = map {
1443 (ref($_) .' '. ($_->can('VERSION') ? $_->VERSION || '' : '')
1444 || '') } $class->registered_middlewares;
1447 my $column_width = Catalyst::Utils::term_width() - 6;
1448 my $t = Text::SimpleTable->new($column_width);
1449 $t->row($_) for @middleware;
1450 $class->log->debug( "Loaded PSGI Middleware:\n" . $t->draw . "\n" );
1453 my %dh = $class->registered_data_handlers;
1454 if (my @data_handlers = keys %dh) {
1455 my $column_width = Catalyst::Utils::term_width() - 6;
1456 my $t = Text::SimpleTable->new($column_width);
1457 $t->row($_) for @data_handlers;
1458 $class->log->debug( "Loaded Request Data Handlers:\n" . $t->draw . "\n" );
1461 my $dispatcher = $class->dispatcher;
1462 my $engine = $class->engine;
1463 my $home = $class->config->{home};
1465 $class->log->debug(sprintf(q/Loaded dispatcher "%s"/, blessed($dispatcher)));
1466 $class->log->debug(sprintf(q/Loaded engine "%s"/, blessed($engine)));
1470 ? $class->log->debug(qq/Found home "$home"/)
1471 : $class->log->debug(qq/Home "$home" doesn't exist/)
1472 : $class->log->debug(q/Couldn't find home/);
1474 my $column_width = Catalyst::Utils::term_width() - 8 - 9;
1476 my $t = Text::SimpleTable->new( [ $column_width, 'Class' ], [ 8, 'Type' ] );
1477 for my $comp ( sort keys %{ $class->components } ) {
1478 my $type = ref $class->components->{$comp} ? 'instance' : 'class';
1479 $t->row( $comp, $type );
1481 $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
1482 if ( keys %{ $class->components } );
1485 # Add our self to components, since we are also a component
1486 if( $class->isa('Catalyst::Controller') ){
1487 $class->components->{$class} = $class;
1490 $class->setup_actions;
1492 if ( $class->debug ) {
1493 my $name = $class->config->{name} || 'Application';
1494 $class->log->info("$name powered by Catalyst $Catalyst::VERSION");
1497 if ($class->config->{case_sensitive}) {
1498 $class->log->warn($class . "->config->{case_sensitive} is set.");
1499 $class->log->warn("This setting is deprecated and planned to be removed in Catalyst 5.81.");
1502 # call these so we pre setup the composed classes
1503 $class->composed_request_class;
1504 $class->composed_response_class;
1505 $class->composed_stats_class;
1507 $class->setup_finalize;
1509 # Flush the log for good measure (in case something turned off 'autoflush' early)
1510 $class->log->_flush() if $class->log->can('_flush');
1512 return $class || 1; # Just in case someone named their Application 0...
1515 =head2 $app->setup_finalize
1517 A hook to attach modifiers to. This method does not do anything except set the
1518 C<setup_finished> accessor.
1520 Applying method modifiers to the C<setup> method doesn't work, because of quirky things done for plugin setup.
1524 after setup_finalize => sub {
1532 sub setup_finalize {
1534 $class->setup_finished(1);
1537 =head2 $c->uri_for( $path?, @args?, \%query_values?, \$fragment? )
1539 =head2 $c->uri_for( $action, \@captures?, @args?, \%query_values?, \$fragment? )
1541 =head2 $c->uri_for( $action, [@captures, @args], \%query_values?, \$fragment? )
1543 Constructs an absolute L<URI> object based on the application root, the
1544 provided path, and the additional arguments and query parameters provided.
1545 When used as a string, provides a textual URI. If you need more flexibility
1546 than this (i.e. the option to provide relative URIs etc.) see
1547 L<Catalyst::Plugin::SmartURI>.
1549 If no arguments are provided, the URI for the current action is returned.
1550 To return the current action and also provide @args, use
1551 C<< $c->uri_for( $c->action, @args ) >>.
1553 If the first argument is a string, it is taken as a public URI path relative
1554 to C<< $c->namespace >> (if it doesn't begin with a forward slash) or
1555 relative to the application root (if it does). It is then merged with
1556 C<< $c->request->base >>; any C<@args> are appended as additional path
1557 components; and any C<%query_values> are appended as C<?foo=bar> parameters.
1559 B<NOTE> If you are using this 'stringy' first argument, we skip encoding and
1560 allow you to declare something like:
1562 $c->uri_for('/foo/bar#baz')
1564 Where 'baz' is a URI fragment. We consider this first argument string to be
1565 'expert' mode where you are expected to create a valid URL and we for the most
1566 part just pass it through without a lot of internal effort to escape and encode.
1568 If the first argument is a L<Catalyst::Action> it represents an action which
1569 will have its path resolved using C<< $c->dispatcher->uri_for_action >>. The
1570 optional C<\@captures> argument (an arrayref) allows passing the captured
1571 variables that are needed to fill in the paths of Chained and Regex actions;
1572 once the path is resolved, C<uri_for> continues as though a path was
1573 provided, appending any arguments or parameters and creating an absolute
1576 The captures for the current request can be found in
1577 C<< $c->request->captures >>, and actions can be resolved using
1578 C<< Catalyst::Controller->action_for($name) >>. If you have a private action
1579 path, use C<< $c->uri_for_action >> instead.
1581 # Equivalent to $c->req->uri
1582 $c->uri_for($c->action, $c->req->captures,
1583 @{ $c->req->args }, $c->req->params);
1585 # For the Foo action in the Bar controller
1586 $c->uri_for($c->controller('Bar')->action_for('Foo'));
1588 # Path to a static resource
1589 $c->uri_for('/static/images/logo.png');
1591 In general the scheme of the generated URI object will follow the incoming request
1592 however if your targeted action or action chain has the Scheme attribute it will
1595 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
1596 type constraints, we will require that your proposed URL verify on those declared
1602 my ( $c, $path, @args ) = @_;
1604 if ( $path->$_isa('Catalyst::Controller') ) {
1605 $path = $path->path_prefix;
1610 my $fragment = ((scalar(@args) && ref($args[-1]) eq 'SCALAR') ? pop @args : undef );
1612 unless(blessed $path) {
1613 if (defined($path) and $path =~ s/#(.+)$//) {
1614 if(defined($1) and $fragment) {
1615 carp "Abiguious fragment declaration: You cannot define a fragment in '$path' and as an argument '$fragment'";
1624 ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
1626 undef($path) if (defined $path && $path eq '');
1628 carp "uri_for called with undef argument" if grep { ! defined $_ } @args;
1630 my $target_action = $path->$_isa('Catalyst::Action') ? $path : undef;
1631 if ( $path->$_isa('Catalyst::Action') ) { # action object
1632 s|/|%2F|g for @args;
1633 my $captures = [ map { s|/|%2F|g; $_; }
1634 ( scalar @args && ref $args[0] eq 'ARRAY'
1639 my $expanded_action = $c->dispatcher->expand_action( $action );
1640 my $num_captures = $expanded_action->number_of_captures;
1642 # ->uri_for( $action, \@captures_and_args, \%query_values? )
1643 if( !@args && $action->number_of_args ) {
1644 unshift @args, splice @$captures, $num_captures;
1648 unless($expanded_action->match_captures_constraints($c, $captures)) {
1649 carp "captures [@{$captures}] do not match the type constraints in actionchain ending with '$expanded_action'";
1654 $path = $c->dispatcher->uri_for_action($action, $captures);
1655 if (not defined $path) {
1656 $c->log->debug(qq/Can't find uri_for action '$action' @$captures/)
1660 $path = '/' if $path eq '';
1662 # At this point @encoded_args is the remaining Args (all captures removed).
1663 if($expanded_action->has_args_constraints) {
1664 unless($expanded_action->match_args($c,\@args)) {
1665 carp "args [@args] do not match the type constraints in action '$expanded_action'";
1671 unshift(@args, $path);
1673 unless (defined $path && $path =~ s!^/!!) { # in-place strip
1674 my $namespace = $c->namespace;
1675 if (defined $path) { # cheesy hack to handle path '../foo'
1676 $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{};
1678 unshift(@args, $namespace || '');
1681 # join args with '/', or a blank string
1682 my $args = join('/', grep { defined($_) } @args);
1683 $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
1686 my ($base, $class) = ('/', 'URI::_generic');
1688 $base = $c->req->base;
1689 if($target_action) {
1690 $target_action = $c->dispatcher->expand_action($target_action);
1691 if(my $s = $target_action->scheme) {
1696 $class = ref($base);
1699 $class = ref($base);
1702 $base =~ s{(?<!/)$}{/};
1706 if (my @keys = keys %$params) {
1707 # somewhat lifted from URI::_query's query_form
1708 $query = '?'.join('&', map {
1709 my $val = $params->{$_};
1710 #s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; ## Commented out because seems to lead to double encoding - JNAP
1713 $val = '' unless defined $val;
1716 $param = encode_utf8($param);
1717 # using the URI::Escape pattern here so utf8 chars survive
1718 $param =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1721 $key = encode_utf8($key);
1722 # using the URI::Escape pattern here so utf8 chars survive
1723 $key =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1726 "${key}=$param"; } ( ref $val eq 'ARRAY' ? @$val : $val ));
1730 $base = encode_utf8 $base;
1731 $base =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1732 $args = encode_utf8 $args;
1733 $args =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
1735 if(defined $fragment) {
1737 $fragment = encode_utf8(${$fragment});
1738 $fragment =~ s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go;
1739 $fragment =~ s/ /+/g;
1741 $query .= "#$fragment";
1744 my $res = bless(\"${base}${args}${query}", $class);
1748 =head2 $c->uri_for_action( $path, \@captures_and_args?, @args?, \%query_values? )
1750 =head2 $c->uri_for_action( $action, \@captures_and_args?, @args?, \%query_values? )
1756 A private path to the Catalyst action you want to create a URI for.
1758 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path)
1759 >> and passing the resulting C<$action> and the remaining arguments to C<<
1762 You can also pass in a Catalyst::Action object, in which case it is passed to
1765 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.
1767 For example, if the action looks like:
1769 package MyApp::Controller::Users;
1771 sub lst : Path('the-list') {}
1775 $c->uri_for_action('/users/lst')
1777 and it will create the URI /users/the-list.
1779 =item \@captures_and_args?
1781 Optional array reference of Captures (i.e. C<<CaptureArgs or $c->req->captures>)
1782 and arguments to the request. Usually used with L<Catalyst::DispatchType::Chained>
1783 to interpolate all the parameters in the URI.
1787 Optional list of extra arguments - can be supplied in the
1788 C<< \@captures_and_args? >> array ref, or here - whichever is easier for your
1791 Your action can have zero, a fixed or a variable number of args (e.g.
1792 C<< Args(1) >> for a fixed number or C<< Args() >> for a variable number)..
1794 =item \%query_values?
1796 Optional array reference of query parameters to append. E.g.
1802 /rest/of/your/uri?foo=bar
1808 sub uri_for_action {
1809 my ( $c, $path, @args ) = @_;
1810 my $action = blessed($path)
1812 : $c->dispatcher->get_action_by_path($path);
1813 unless (defined $action) {
1814 croak "Can't find action for path '$path'";
1816 return $c->uri_for( $action, @args );
1819 =head2 $c->welcome_message
1821 Returns the Catalyst welcome HTML page.
1825 sub welcome_message {
1827 my $name = $c->config->{name};
1828 my $logo = $c->uri_for('/static/images/catalyst_logo.png');
1829 my $prefix = Catalyst::Utils::appprefix( ref $c );
1830 $c->response->content_type('text/html; charset=utf-8');
1832 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1833 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1834 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1836 <meta http-equiv="Content-Language" content="en" />
1837 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1838 <title>$name on Catalyst $VERSION</title>
1839 <style type="text/css">
1842 background-color: #eee;
1849 margin-bottom: 10px;
1851 background-color: #ccc;
1852 border: 1px solid #aaa;
1857 font-family: verdana, tahoma, sans-serif;
1860 font-family: verdana, tahoma, sans-serif;
1863 text-decoration: none;
1865 border-bottom: 1px dotted #bbb;
1867 :link:hover, :visited:hover {
1880 background-color: #fff;
1881 border: 1px solid #aaa;
1885 font-weight: normal;
1907 <h1><span id="appname">$name</span> on <a href="http://catalyst.perl.org">Catalyst</a>
1912 <img src="$logo" alt="Catalyst Logo" />
1914 <p>Welcome to the world of Catalyst.
1915 This <a href="http://en.wikipedia.org/wiki/MVC">MVC</a>
1916 framework will make web development something you had
1917 never expected it to be: Fun, rewarding, and quick.</p>
1918 <h2>What to do now?</h2>
1919 <p>That really depends on what <b>you</b> want to do.
1920 We do, however, provide you with a few starting points.</p>
1921 <p>If you want to jump right into web development with Catalyst
1922 you might want to start with a tutorial.</p>
1923 <pre>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Tutorial">Catalyst::Manual::Tutorial</a></code>
1925 <p>Afterwards you can go on to check out a more complete look at our features.</p>
1927 <code>perldoc <a href="https://metacpan.org/module/Catalyst::Manual::Intro">Catalyst::Manual::Intro</a>
1928 <!-- Something else should go here, but the Catalyst::Manual link seems unhelpful -->
1930 <h2>What to do next?</h2>
1931 <p>Next it's time to write an actual application. Use the
1932 helper scripts to generate <a href="https://metacpan.org/search?q=Catalyst%3A%3AController">controllers</a>,
1933 <a href="https://metacpan.org/search?q=Catalyst%3A%3AModel">models</a>, and
1934 <a href="https://metacpan.org/search?q=Catalyst%3A%3AView">views</a>;
1935 they can save you a lot of work.</p>
1936 <pre><code>script/${prefix}_create.pl --help</code></pre>
1937 <p>Also, be sure to check out the vast and growing
1938 collection of <a href="http://search.cpan.org/search?query=Catalyst">plugins for Catalyst on CPAN</a>;
1939 you are likely to find what you need there.
1943 <p>Catalyst has a very active community. Here are the main places to
1944 get in touch with us.</p>
1947 <a href="http://dev.catalyst.perl.org">Wiki</a>
1950 <a href="http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst">Mailing-List</a>
1953 <a href="irc://irc.perl.org/catalyst">IRC channel #catalyst on irc.perl.org</a>
1956 <h2>In conclusion</h2>
1957 <p>The Catalyst team hopes you will enjoy using Catalyst as much
1958 as we enjoyed making it. Please contact us if you have ideas
1959 for improvement or other feedback.</p>
1969 Contains a hash of options passed from the application script, including
1970 the original ARGV the script received, the processed values from that
1971 ARGV and any extra arguments to the script which were not processed.
1973 This can be used to add custom options to your application's scripts
1974 and setup your application differently depending on the values of these
1977 =head1 INTERNAL METHODS
1979 These methods are not meant to be used by end users.
1981 =head2 $c->components
1983 Returns a hash of components.
1985 =head2 $c->context_class
1987 Returns or sets the context class.
1991 Returns a hashref containing coderefs and execution counts (needed for
1992 deep recursion detection).
1996 Returns the number of actions on the current internal execution stack.
2000 Dispatches a request to actions.
2004 sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) }
2006 =head2 $c->dispatcher_class
2008 Returns or sets the dispatcher class.
2010 =head2 $c->dump_these
2012 Returns a list of 2-element array references (name, structure) pairs
2013 that will be dumped on the error page in debug mode.
2019 [ Request => $c->req ],
2020 [ Response => $c->res ],
2021 [ Stash => $c->stash ],
2022 [ Config => $c->config ];
2025 =head2 $c->engine_class
2027 Returns or sets the engine class.
2029 =head2 $c->execute( $class, $coderef )
2031 Execute a coderef in given class and catch exceptions. Errors are available
2037 my ( $c, $class, $code ) = @_;
2038 $class = $c->component($class) || $class;
2041 if ( $c->depth >= $RECURSION ) {
2042 my $action = $code->reverse();
2043 $action = "/$action" unless $action =~ /->/;
2044 my $error = qq/Deep recursion detected calling "${action}"/;
2045 $c->log->error($error);
2051 my $stats_info = $c->_stats_start_execute( $code ) if $c->use_stats;
2053 push( @{ $c->stack }, $code );
2055 no warnings 'recursion';
2056 # N.B. This used to be combined, but I have seen $c get clobbered if so, and
2057 # I have no idea how, ergo $ret (which appears to fix the issue)
2058 eval { my $ret = $code->execute( $class, $c, @{ $c->req->args } ) || 0; $c->state( $ret ) };
2060 $c->_stats_finish_execute( $stats_info ) if $c->use_stats and $stats_info;
2062 my $last = pop( @{ $c->stack } );
2064 if ( my $error = $@ ) {
2065 #rethow if this can be handled by middleware
2066 if ( $c->_handle_http_exception($error) ) {
2067 foreach my $err (@{$c->error}) {
2068 $c->log->error($err);
2071 $c->log->_flush if $c->log->can('_flush');
2073 $error->can('rethrow') ? $error->rethrow : croak $error;
2075 if ( blessed($error) and $error->isa('Catalyst::Exception::Detach') ) {
2076 $error->rethrow if $c->depth > 1;
2078 elsif ( blessed($error) and $error->isa('Catalyst::Exception::Go') ) {
2079 $error->rethrow if $c->depth > 0;
2082 unless ( ref $error ) {
2083 no warnings 'uninitialized';
2085 my $class = $last->class;
2086 my $name = $last->name;
2087 $error = qq/Caught exception in $class->$name "$error"/;
2096 sub _stats_start_execute {
2097 my ( $c, $code ) = @_;
2098 my $appclass = ref($c) || $c;
2099 return if ( ( $code->name =~ /^_.*/ )
2100 && ( !$appclass->config->{show_internal_actions} ) );
2102 my $action_name = $code->reverse();
2103 $c->counter->{$action_name}++;
2105 my $action = $action_name;
2106 $action = "/$action" unless $action =~ /->/;
2108 # determine if the call was the result of a forward
2109 # this is done by walking up the call stack and looking for a calling
2110 # sub of Catalyst::forward before the eval
2112 for my $index ( 2 .. 11 ) {
2114 if ( ( caller($index) )[0] eq 'Catalyst'
2115 && ( caller($index) )[3] eq '(eval)' );
2117 if ( ( caller($index) )[3] =~ /forward$/ ) {
2118 $callsub = ( caller($index) )[3];
2119 $action = "-> $action";
2124 my $uid = $action_name . $c->counter->{$action_name};
2126 # is this a root-level call or a forwarded call?
2127 if ( $callsub =~ /forward$/ ) {
2128 my $parent = $c->stack->[-1];
2130 # forward, locate the caller
2131 if ( defined $parent && exists $c->counter->{"$parent"} ) {
2134 parent => "$parent" . $c->counter->{"$parent"},
2140 # forward with no caller may come from a plugin
2159 sub _stats_finish_execute {
2160 my ( $c, $info ) = @_;
2161 $c->stats->profile( end => $info );
2166 Finalizes the request.
2173 for my $error ( @{ $c->error } ) {
2174 $c->log->error($error);
2177 # Support skipping finalize for psgix.io style 'jailbreak'. Used to support
2178 # stuff like cometd and websockets
2180 if($c->request->_has_io_fh) {
2185 # Allow engine to handle finalize flow (for POE)
2186 my $engine = $c->engine;
2187 if ( my $code = $engine->can('finalize') ) {
2192 $c->finalize_uploads;
2195 if ( $#{ $c->error } >= 0 ) {
2199 $c->finalize_encoding;
2200 $c->finalize_headers unless $c->response->finalized_headers;
2206 if ($c->use_stats) {
2207 my $elapsed = $c->stats->elapsed;
2208 my $av = $elapsed == 0 ? '??' : sprintf '%.3f', 1 / $elapsed;
2210 "Request took ${elapsed}s ($av/s)\n" . $c->stats->report . "\n" );
2213 return $c->response->status;
2216 =head2 $c->finalize_body
2222 sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) }
2224 =head2 $c->finalize_cookies
2230 sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) }
2232 =head2 $c->finalize_error
2234 Finalizes error. If there is only one error in L</error> and it is an object that
2235 does C<as_psgi> or C<code> we rethrow the error and presume it caught by middleware
2236 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
2237 return the default error page (production mode).
2241 sub finalize_error {
2243 if($#{$c->error} > 0) {
2244 $c->engine->finalize_error( $c, @_ );
2246 my ($error) = @{$c->error};
2247 if ( $c->_handle_http_exception($error) ) {
2248 # In the case where the error 'knows what it wants', becauses its PSGI
2249 # aware, just rethow and let middleware catch it
2250 $error->can('rethrow') ? $error->rethrow : croak $error;
2252 $c->engine->finalize_error( $c, @_ )
2257 =head2 $c->finalize_headers
2263 sub finalize_headers {
2266 my $response = $c->response; #accessor calls can add up?
2268 # Check if we already finalized headers
2269 return if $response->finalized_headers;
2272 if ( my $location = $response->redirect ) {
2273 $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
2274 $response->header( Location => $location );
2277 # Remove incorrectly added body and content related meta data when returning
2278 # an information response, or a response the is required to not include a body
2280 $c->finalize_cookies;
2282 # This currently is a NOOP but I don't want to remove it since I guess people
2283 # might have Response subclasses that use it for something... (JNAP)
2284 $c->response->finalize_headers();
2287 $response->finalized_headers(1);
2290 =head2 $c->finalize_encoding
2292 Make sure your body is encoded properly IF you set an encoding. By
2293 default the encoding is UTF-8 but you can disable it by explicitly setting the
2294 encoding configuration value to undef.
2296 We can only encode when the body is a scalar. Methods for encoding via the
2297 streaming interfaces (such as C<write> and C<write_fh> on L<Catalyst::Response>
2304 sub finalize_encoding {
2306 my $res = $c->res || return;
2308 # Warn if the set charset is different from the one you put into encoding. We need
2309 # to do this early since encodable_response is false for this condition and we need
2310 # to match the debug output for backcompat (there's a test for this...) -JNAP
2312 $res->content_type_charset and $c->encoding and
2313 (uc($c->encoding->mime_name) ne uc($res->content_type_charset))
2315 my $ct = lc($res->content_type_charset);
2316 $c->log->debug("Catalyst encoding config is set to encode in '" .
2317 $c->encoding->mime_name .
2318 "', content type is '$ct', not encoding ");
2322 ($res->encodable_response) and
2323 (defined($res->body)) and
2324 (ref(\$res->body) eq 'SCALAR')
2326 # if you are finding yourself here and your body is already encoded correctly
2327 # and you want to turn this off, use $c->clear_encoding to prevent encoding
2328 # at this step, or set encoding to undef in the config to do so for the whole
2329 # application. See the ENCODING documentaiton for better notes.
2330 $c->res->body( $c->encoding->encode( $c->res->body, $c->_encode_check ) );
2332 # Set the charset if necessary. This might be a bit bonkers since encodable response
2333 # is false when the set charset is not the same as the encoding mimetype (maybe
2334 # confusing action at a distance here..
2335 # Don't try to set the charset if one already exists or if headers are already finalized
2336 $c->res->content_type($c->res->content_type . "; charset=" . $c->encoding->mime_name)
2337 unless($c->res->content_type_charset ||
2338 ($c->res->_context && $c->res->finalized_headers && !$c->res->_has_response_cb));
2342 =head2 $c->finalize_output
2344 An alias for finalize_body.
2346 =head2 $c->finalize_read
2348 Finalizes the input after reading is complete.
2352 sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) }
2354 =head2 $c->finalize_uploads
2356 Finalizes uploads. Cleans up any temporary files.
2360 sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) }
2362 =head2 $c->get_action( $action, $namespace )
2364 Gets an action in a given namespace.
2368 sub get_action { my $c = shift; $c->dispatcher->get_action(@_) }
2370 =head2 $c->get_actions( $action, $namespace )
2372 Gets all actions of a given name in a namespace and all parent
2377 sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) }
2379 =head2 $app->handle_request( @arguments )
2381 Called to handle each HTTP request.
2385 sub handle_request {
2386 my ( $class, @arguments ) = @_;
2388 # Always expect worst case!
2391 if ($class->debug) {
2392 my $secs = time - $START || 1;
2393 my $av = sprintf '%.3f', $COUNT / $secs;
2394 my $time = localtime time;
2395 $class->log->info("*** Request $COUNT ($av/s) [$$] [$time] ***");
2398 my $c = $class->prepare(@arguments);
2400 $status = $c->finalize;
2402 #rethow if this can be handled by middleware
2403 if ( $class->_handle_http_exception($_) ) {
2404 $_->can('rethrow') ? $_->rethrow : croak $_;
2406 chomp(my $error = $_);
2407 $class->log->error(qq/Caught exception in engine "$error"/);
2412 if(my $coderef = $class->log->can('_flush')){
2413 $class->log->$coderef();
2418 =head2 $class->prepare( @arguments )
2420 Creates a Catalyst context from an engine-specific request (Apache, CGI,
2427 predicate => '_has_uploadtmp',
2431 my ( $class, @arguments ) = @_;
2434 # After the app/ctxt split, this should become an attribute based on something passed
2435 # into the application.
2436 $class->context_class( ref $class || $class ) unless $class->context_class;
2438 my $uploadtmp = $class->config->{uploadtmp};
2439 my $c = $class->context_class->new({ $uploadtmp ? (_uploadtmp => $uploadtmp) : ()});
2441 $c->response->_context($c);
2442 $c->stats($class->stats_class->new)->enable($c->use_stats);
2444 if ( $c->debug || $c->config->{enable_catalyst_header} ) {
2445 $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
2449 # Allow engine to direct the prepare flow (for POE)
2450 if ( my $prepare = $c->engine->can('prepare') ) {
2451 $c->engine->$prepare( $c, @arguments );
2454 $c->prepare_request(@arguments);
2455 $c->prepare_connection;
2456 $c->prepare_query_parameters;
2457 $c->prepare_headers; # Just hooks, no longer needed - they just
2458 $c->prepare_cookies; # cause the lazy attribute on req to build
2461 # Prepare the body for reading, either by prepare_body
2462 # or the user, if they are using $c->read
2465 # Parse the body unless the user wants it on-demand
2466 unless ( ref($c)->config->{parse_on_demand} ) {
2472 # VERY ugly and probably shouldn't rely on ->finalize actually working
2474 # failed prepare is always due to an invalid request, right?
2475 # Note we call finalize and then die here, which escapes
2476 # finalize being called in the enclosing block..
2477 # It in fact couldn't be called, as we don't return $c..
2478 # This is a mess - but I'm unsure you can fix this without
2479 # breaking compat for people doing crazy things (we should set
2480 # the 400 and just return the ctx here IMO, letting finalize get called
2482 if ( $c->_handle_http_exception($_) ) {
2483 foreach my $err (@{$c->error}) {
2484 $c->log->error($err);
2487 $c->log->_flush if $c->log->can('_flush');
2488 $_->can('rethrow') ? $_->rethrow : croak $_;
2490 $c->response->status(400);
2491 $c->response->content_type('text/plain');
2492 $c->response->body('Bad Request');
2499 $c->{stash} = $c->stash;
2500 Scalar::Util::weaken($c->{stash});
2505 =head2 $c->prepare_action
2507 Prepares action. See L<Catalyst::Dispatcher>.
2511 sub prepare_action {
2513 my $ret = $c->dispatcher->prepare_action( $c, @_);
2516 foreach (@{$c->req->arguments}, @{$c->req->captures}) {
2517 $_ = $c->_handle_param_unicode_decoding($_);
2525 =head2 $c->prepare_body
2527 Prepares message body.
2534 return if $c->request->_has_body;
2536 # Initialize on-demand data
2537 $c->engine->prepare_body( $c, @_ );
2538 $c->prepare_parameters;
2539 $c->prepare_uploads;
2542 =head2 $c->prepare_body_chunk( $chunk )
2544 Prepares a chunk of data before sending it to L<HTTP::Body>.
2546 See L<Catalyst::Engine>.
2550 sub prepare_body_chunk {
2552 $c->engine->prepare_body_chunk( $c, @_ );
2555 =head2 $c->prepare_body_parameters
2557 Prepares body parameters.
2561 sub prepare_body_parameters {
2563 $c->request->prepare_body_parameters( $c, @_ );
2566 =head2 $c->prepare_connection
2568 Prepares connection.
2572 sub prepare_connection {
2574 $c->request->prepare_connection($c);
2577 =head2 $c->prepare_cookies
2579 Prepares cookies by ensuring that the attribute on the request
2580 object has been built.
2584 sub prepare_cookies { my $c = shift; $c->request->cookies }
2586 =head2 $c->prepare_headers
2588 Prepares request headers by ensuring that the attribute on the request
2589 object has been built.
2593 sub prepare_headers { my $c = shift; $c->request->headers }
2595 =head2 $c->prepare_parameters
2597 Prepares parameters.
2601 sub prepare_parameters {
2603 $c->prepare_body_parameters;
2604 $c->engine->prepare_parameters( $c, @_ );
2607 =head2 $c->prepare_path
2609 Prepares path and base.
2613 sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) }
2615 =head2 $c->prepare_query_parameters
2617 Prepares query parameters.
2621 sub prepare_query_parameters {
2624 $c->engine->prepare_query_parameters( $c, @_ );
2627 =head2 $c->log_request
2629 Writes information about the request to the debug logs. This includes:
2633 =item * Request method, path, and remote IP address
2635 =item * Query keywords (see L<Catalyst::Request/query_keywords>)
2637 =item * Request parameters
2639 =item * File uploads
2648 return unless $c->debug;
2650 my($dump) = grep {$_->[0] eq 'Request' } $c->dump_these;
2651 my $request = $dump->[1];
2653 my ( $method, $path, $address ) = ( $request->method, $request->path, $request->address );
2655 $path = '/' unless length $path;
2658 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
2659 $path = decode_utf8($path);
2661 $c->log->debug(qq/"$method" request for "$path" from "$address"/);
2663 $c->log_request_headers($request->headers);
2665 if ( my $keywords = $request->query_keywords ) {
2666 $c->log->debug("Query keywords are: $keywords");
2669 $c->log_request_parameters( query => $request->query_parameters, $request->_has_body ? (body => $request->body_parameters) : () );
2671 $c->log_request_uploads($request);
2674 =head2 $c->log_response
2676 Writes information about the response to the debug logs by calling
2677 C<< $c->log_response_status_line >> and C<< $c->log_response_headers >>.
2684 return unless $c->debug;
2686 my($dump) = grep {$_->[0] eq 'Response' } $c->dump_these;
2687 my $response = $dump->[1];
2689 $c->log_response_status_line($response);
2690 $c->log_response_headers($response->headers);
2693 =head2 $c->log_response_status_line($response)
2695 Writes one line of information about the response to the debug logs. This includes:
2699 =item * Response status code
2701 =item * Content-Type header (if present)
2703 =item * Content-Length header (if present)
2709 sub log_response_status_line {
2710 my ($c, $response) = @_;
2714 'Response Code: %s; Content-Type: %s; Content-Length: %s',
2715 $response->status || 'unknown',
2716 $response->headers->header('Content-Type') || 'unknown',
2717 $response->headers->header('Content-Length') || 'unknown'
2722 =head2 $c->log_response_headers($headers);
2724 Hook method which can be wrapped by plugins to log the response headers.
2725 No-op in the default implementation.
2729 sub log_response_headers {}
2731 =head2 $c->log_request_parameters( query => {}, body => {} )
2733 Logs request parameters to debug logs
2737 sub log_request_parameters {
2739 my %all_params = @_;
2741 return unless $c->debug;
2743 my $column_width = Catalyst::Utils::term_width() - 44;
2744 foreach my $type (qw(query body)) {
2745 my $params = $all_params{$type};
2746 next if ! keys %$params;
2747 my $t = Text::SimpleTable->new( [ 35, 'Parameter' ], [ $column_width, 'Value' ] );
2748 for my $key ( sort keys %$params ) {
2750 if(ref $params eq 'Hash::MultiValue') {
2751 @values = $params->get_all($key);
2753 my $param = $params->{$key};
2754 if( defined($param) ) {
2755 @values = ref $param eq 'ARRAY' ? @$param : $param;
2758 $t->row( $key.( scalar @values > 1 ? ' [multiple]' : ''), join(', ', @values) );
2760 $c->log->debug( ucfirst($type) . " Parameters are:\n" . $t->draw );
2764 =head2 $c->log_request_uploads
2766 Logs file uploads included in the request to the debug logs.
2767 The parameter name, filename, file type, and file size are all included in
2772 sub log_request_uploads {
2774 my $request = shift;
2775 return unless $c->debug;
2776 my $uploads = $request->uploads;
2777 if ( keys %$uploads ) {
2778 my $t = Text::SimpleTable->new(
2779 [ 12, 'Parameter' ],
2784 for my $key ( sort keys %$uploads ) {
2785 my $upload = $uploads->{$key};
2786 for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) {
2787 $t->row( $key, $u->filename, $u->type, $u->size );
2790 $c->log->debug( "File Uploads are:\n" . $t->draw );
2794 =head2 $c->log_request_headers($headers);
2796 Hook method which can be wrapped by plugins to log the request headers.
2797 No-op in the default implementation.
2801 sub log_request_headers {}
2803 =head2 $c->log_headers($type => $headers)
2805 Logs L<HTTP::Headers> (either request or response) to the debug logs.
2812 my $headers = shift; # an HTTP::Headers instance
2814 return unless $c->debug;
2816 my $column_width = Catalyst::Utils::term_width() - 28;
2817 my $t = Text::SimpleTable->new( [ 15, 'Header Name' ], [ $column_width, 'Value' ] );
2820 my ( $name, $value ) = @_;
2821 $t->row( $name, $value );
2824 $c->log->debug( ucfirst($type) . " Headers:\n" . $t->draw );
2828 =head2 $c->prepare_read
2830 Prepares the input for reading.
2834 sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) }
2836 =head2 $c->prepare_request
2838 Prepares the engine request.
2842 sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) }
2844 =head2 $c->prepare_uploads
2850 sub prepare_uploads {
2852 $c->engine->prepare_uploads( $c, @_ );
2855 =head2 $c->prepare_write
2857 Prepares the output for writing.
2861 sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) }
2863 =head2 $c->request_class
2865 Returns or sets the request class. Defaults to L<Catalyst::Request>.
2867 =head2 $app->request_class_traits
2869 An arrayref of L<Moose::Role>s which are applied to the request class. You can
2870 name the full namespace of the role, or a namespace suffix, which will then
2871 be tried against the following standard namespace prefixes.
2873 $MyApp::TraitFor::Request::$trait_suffix
2874 Catalyst::TraitFor::Request::$trait_suffix
2876 So for example if you set:
2878 MyApp->request_class_traits(['Foo']);
2880 We try each possible role in turn (and throw an error if none load)
2883 MyApp::TraitFor::Request::Foo
2884 Catalyst::TraitFor::Request::Foo
2886 The namespace part 'TraitFor::Request' was chosen to assist in backwards
2887 compatibility with L<CatalystX::RoleApplicator> which previously provided
2888 these features in a stand alone package.
2890 =head2 $app->composed_request_class
2892 This is the request class which has been composed with any request_class_traits.
2894 =head2 $c->response_class
2896 Returns or sets the response class. Defaults to L<Catalyst::Response>.
2898 =head2 $app->response_class_traits
2900 An arrayref of L<Moose::Role>s which are applied to the response class. You can
2901 name the full namespace of the role, or a namespace suffix, which will then
2902 be tried against the following standard namespace prefixes.
2904 $MyApp::TraitFor::Response::$trait_suffix
2905 Catalyst::TraitFor::Response::$trait_suffix
2907 So for example if you set:
2909 MyApp->response_class_traits(['Foo']);
2911 We try each possible role in turn (and throw an error if none load)
2914 MyApp::TraitFor::Response::Foo
2915 Catalyst::TraitFor::Responset::Foo
2917 The namespace part 'TraitFor::Response' was chosen to assist in backwards
2918 compatibility with L<CatalystX::RoleApplicator> which previously provided
2919 these features in a stand alone package.
2922 =head2 $app->composed_response_class
2924 This is the request class which has been composed with any response_class_traits.
2926 =head2 $c->read( [$maxlength] )
2928 Reads a chunk of data from the request body. This method is designed to
2929 be used in a while loop, reading C<$maxlength> bytes on every call.
2930 C<$maxlength> defaults to the size of the request if not specified.
2932 You have to set C<< MyApp->config(parse_on_demand => 1) >> to use this
2935 Warning: If you use read(), Catalyst will not process the body,
2936 so you will not be able to access POST parameters or file uploads via
2937 $c->request. You must handle all body parsing yourself.
2941 sub read { my $c = shift; return $c->request->read( @_ ) }
2951 $app->_make_immutable_if_needed;
2952 $app->engine_loader->needs_psgi_engine_compat_hack ?
2953 $app->engine->run($app, @_) :
2954 $app->engine->run( $app, $app->_finalized_psgi_app, @_ );
2957 sub _make_immutable_if_needed {
2959 my $meta = find_meta($class);
2960 my $isa_ca = $class->isa('Class::Accessor::Fast') || $class->isa('Class::Accessor');
2963 && ! { $meta->immutable_options }->{replace_constructor}
2966 warn("You made your application class ($class) immutable, "
2967 . "but did not inline the\nconstructor. "
2968 . "This will break catalyst, as your app \@ISA "
2969 . "Class::Accessor(::Fast)?\nPlease pass "
2970 . "(replace_constructor => 1)\nwhen making your class immutable.\n");
2972 unless ($meta->is_immutable) {
2973 # XXX - FIXME warning here as you should make your app immutable yourself.
2974 $meta->make_immutable(
2975 replace_constructor => 1,
2980 =head2 $c->set_action( $action, $code, $namespace, $attrs )
2982 Sets an action in a given namespace.
2986 sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) }
2988 =head2 $c->setup_actions($component)
2990 Sets up actions for a component.
2994 sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) }
2996 =head2 $c->setup_components
2998 This method is called internally to set up the application's components.
3000 It finds modules by calling the L<locate_components> method, expands them to
3001 package names with the L<expand_component_module> method, and then installs
3002 each component into the application.
3004 The C<setup_components> config option is passed to both of the above methods.
3006 Installation of each component is performed by the L<setup_component> method,
3011 sub setup_components {
3014 my $config = $class->config->{ setup_components };
3016 my @comps = $class->locate_components($config);
3017 my %comps = map { $_ => 1 } @comps;
3019 my $deprecatedcatalyst_component_names = grep { /::[CMV]::/ } @comps;
3020 $class->log->warn(qq{Your application is using the deprecated ::[MVC]:: type naming scheme.\n}.
3021 qq{Please switch your class names to ::Model::, ::View:: and ::Controller: as appropriate.\n}
3022 ) if $deprecatedcatalyst_component_names;
3024 for my $component ( @comps ) {
3026 # We pass ignore_loaded here so that overlay files for (e.g.)
3027 # Model::DBI::Schema sub-classes are loaded - if it's in @comps
3028 # we know M::P::O found a file on disk so this is safe
3030 Catalyst::Utils::ensure_class_loaded( $component, { ignore_loaded => 1 } );
3033 for my $component (@comps) {
3034 my $instance = $class->components->{ $component } = $class->delayed_setup_component($component);
3037 # Inject a component or wrap a stand alone class in an adaptor. This makes a list
3038 # of named components in the configuration that are not actually existing (not a
3041 my @injected = $class->setup_injected_components;
3043 # All components are registered, now we need to 'init' them.
3044 foreach my $component_name (@comps, @injected) {
3045 $class->components->{$component_name} = $class->components->{$component_name}->() if
3046 (ref($class->components->{$component_name}) || '') eq 'CODE';
3050 =head2 $app->setup_injected_components
3052 Called by setup_compoents to setup components that are injected.
3056 sub setup_injected_components {
3058 my @injected_components = keys %{$class->config->{inject_components} ||+{}};
3060 foreach my $injected_comp_name(@injected_components) {
3061 $class->setup_injected_component(
3062 $injected_comp_name,
3063 $class->config->{inject_components}->{$injected_comp_name});
3066 return map { $class ."::" . $_ }
3067 @injected_components;
3070 =head2 $app->setup_injected_component( $injected_component_name, $config )
3072 Setup a given injected component.
3076 sub setup_injected_component {
3077 my ($class, $injected_comp_name, $config) = @_;
3078 if(my $component_class = $config->{from_component}) {
3079 my @roles = @{$config->{roles} ||[]};
3080 Catalyst::Utils::inject_component(
3082 component => $component_class,
3083 (scalar(@roles) ? (traits => \@roles) : ()),
3084 as => $injected_comp_name);
3088 =head2 $app->inject_component($MyApp_Component_name => \%args);
3090 Add a component that is injected at setup:
3092 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
3094 Must be called before ->setup. Expects a component name for your
3095 current application and \%args where
3099 =item from_component
3101 The target component being injected into your application
3105 An arrayref of L<Moose::Role>s that are applied to your component.
3111 MyApp->inject_component(
3113 from_component => 'Common::Model::Foo',
3114 roles => ['Role1', 'Role2'],
3117 =head2 $app->inject_components
3119 Inject a list of components:
3121 MyApp->inject_components(
3122 'Model::FooOne' => {
3123 from_component => 'Common::Model::Foo',
3124 roles => ['Role1', 'Role2'],
3126 'Model::FooTwo' => {
3127 from_component => 'Common::Model::Foo',
3128 roles => ['Role1', 'Role2'],
3133 sub inject_component {
3134 my ($app, $name, $args) = @_;
3135 die "Component $name exists" if
3136 $app->config->{inject_components}->{$name};
3137 $app->config->{inject_components}->{$name} = $args;
3140 sub inject_components {
3143 $app->inject_component(shift, shift);
3147 =head2 $c->locate_components( $setup_component_config )
3149 This method is meant to provide a list of component modules that should be
3150 setup for the application. By default, it will use L<Module::Pluggable>.
3152 Specify a C<setup_components> config option to pass additional options directly
3153 to L<Module::Pluggable>. To add additional search paths, specify a key named
3154 C<search_extra> as an array reference. Items in the array beginning with C<::>
3155 will have the application class name prepended to them.
3159 sub locate_components {
3163 my @paths = qw( ::M ::Model ::V ::View ::C ::Controller );
3164 my $extra = $config->{ search_extra } || [];
3166 unshift @paths, @$extra;
3168 my @comps = map { sort { length($a) <=> length($b) } Module::Pluggable::Object->new(
3169 search_path => [ map { s/^(?=::)/$class/; $_; } ($_) ],
3171 )->plugins } @paths;
3176 =head2 $c->expand_component_module( $component, $setup_component_config )
3178 Components found by C<locate_components> will be passed to this method, which
3179 is expected to return a list of component (package) names to be set up.
3183 sub expand_component_module {
3184 my ($class, $module) = @_;
3185 return Devel::InnerPackage::list_packages( $module );
3188 =head2 $app->delayed_setup_component
3190 Returns a coderef that points to a setup_component instance. Used
3191 internally for when you want to delay setup until the first time
3192 the component is called.
3196 sub delayed_setup_component {
3197 my($class, $component, @more) = @_;
3199 return my $instance = $class->setup_component($component, @more);
3203 =head2 $c->setup_component
3207 sub setup_component {
3208 my( $class, $component ) = @_;
3210 unless ( $component->can( 'COMPONENT' ) ) {
3214 my $config = $class->config_for($component);
3215 # Stash catalyst_component_name in the config here, so that custom COMPONENT
3216 # methods also pass it. local to avoid pointlessly shitting in config
3217 # for the debug screen, as $component is already the key name.
3218 local $config->{catalyst_component_name} = $component;
3220 my $instance = eval {
3221 $component->COMPONENT( $class, $config );
3225 Catalyst::Exception->throw(
3226 message => qq/Couldn't instantiate component "$component", "$error"/
3230 unless (blessed $instance) {
3231 my $metaclass = Moose::Util::find_meta($component);
3232 my $method_meta = $metaclass->find_method_by_name('COMPONENT');
3233 my $component_method_from = $method_meta->associated_metaclass->name;
3234 my $value = defined($instance) ? $instance : 'undef';
3235 Catalyst::Exception->throw(
3237 qq/Couldn't instantiate component "$component", COMPONENT() method (from $component_method_from) didn't return an object-like value (value was $value)./
3241 my @expanded_components = $instance->can('expand_modules')
3242 ? $instance->expand_modules( $component, $config )
3243 : $class->expand_component_module( $component, $config );
3244 for my $component (@expanded_components) {
3245 next if $class->components->{ $component };
3246 $class->components->{ $component } = $class->setup_component($component);
3252 =head2 $app->config_for( $component_name )
3254 Return the application level configuration (which is not yet merged with any
3255 local component configuration, via $component_class->config) for the named
3256 component or component object. Example:
3259 'Model::Foo' => { a => 1, b => 2},
3262 my $config = MyApp->config_for('MyApp::Model::Foo');
3264 In this case $config is the hashref C< {a=>1, b=>2} >.
3266 This is also handy for looking up configuration for a plugin, to make sure you follow
3267 existing L<Catalyst> standards for where a plugin should put its configuration.
3272 my ($class, $component_name) = @_;
3273 my $component_suffix = Catalyst::Utils::class2classsuffix($component_name);
3274 my $config = $class->config->{ $component_suffix } || {};
3279 =head2 $c->setup_dispatcher
3285 sub setup_dispatcher {
3286 my ( $class, $dispatcher ) = @_;
3289 $dispatcher = 'Catalyst::Dispatcher::' . $dispatcher;
3292 if ( my $env = Catalyst::Utils::env_value( $class, 'DISPATCHER' ) ) {
3293 $dispatcher = 'Catalyst::Dispatcher::' . $env;
3296 unless ($dispatcher) {
3297 $dispatcher = $class->dispatcher_class;
3300 load_class($dispatcher);
3302 # dispatcher instance
3303 $class->dispatcher( $dispatcher->new );
3306 =head2 $c->setup_engine
3313 my ($class, $requested_engine) = @_;
3315 if (!$class->engine_loader || $requested_engine) {
3316 $class->engine_loader(
3317 Catalyst::EngineLoader->new({
3318 application_name => $class,
3319 (defined $requested_engine
3320 ? (catalyst_engine_class => $requested_engine) : ()),
3325 $class->engine_loader->catalyst_engine_class;
3329 my ($class, $requested_engine) = @_;
3332 my $loader = $class->engine_loader;
3334 if (!$loader || $requested_engine) {
3335 $loader = Catalyst::EngineLoader->new({
3336 application_name => $class,
3337 (defined $requested_engine
3338 ? (requested_engine => $requested_engine) : ()),
3341 $class->engine_loader($loader);
3344 $loader->catalyst_engine_class;
3347 # Don't really setup_engine -- see _setup_psgi_app for explanation.
3348 return if $class->loading_psgi_file;
3350 load_class($engine);
3352 if ($ENV{MOD_PERL}) {
3353 my $apache = $class->engine_loader->auto;
3355 my $meta = find_meta($class);
3356 my $was_immutable = $meta->is_immutable;
3357 my %immutable_options = $meta->immutable_options;
3358 $meta->make_mutable if $was_immutable;
3360 $meta->add_method(handler => sub {
3362 my $psgi_app = $class->_finalized_psgi_app;
3363 $apache->call_app($r, $psgi_app);
3366 $meta->make_immutable(%immutable_options) if $was_immutable;
3369 $class->engine( $engine->new );
3374 ## This exists just to supply a prebuild psgi app for mod_perl and for the
3375 ## build in server support (back compat support for pre psgi port behavior).
3376 ## This is so that we don't build a new psgi app for each request when using
3377 ## the mod_perl handler or the built in servers (http and fcgi, etc).
3379 sub _finalized_psgi_app {
3382 unless ($app->_psgi_app) {
3383 my $psgi_app = $app->_setup_psgi_app;
3384 $app->_psgi_app($psgi_app);
3387 return $app->_psgi_app;
3390 ## Look for a psgi file like 'myapp_web.psgi' (if the app is MyApp::Web) in the
3391 ## home directory and load that and return it (just assume it is doing the
3392 ## right thing :) ). If that does not exist, call $app->psgi_app, wrap that
3393 ## in default_middleware and return it ( this is for backward compatibility
3394 ## with pre psgi port behavior ).
3396 sub _setup_psgi_app {
3399 for my $home (Path::Class::Dir->new($app->config->{home})) {
3400 my $psgi_file = $home->file(
3401 Catalyst::Utils::appprefix($app) . '.psgi',
3404 next unless -e $psgi_file;
3406 # If $psgi_file calls ->setup_engine, it's doing so to load
3407 # Catalyst::Engine::PSGI. But if it does that, we're only going to
3408 # throw away the loaded PSGI-app and load the 5.9 Catalyst::Engine
3409 # anyway. So set a flag (ick) that tells setup_engine not to populate
3410 # $c->engine or do any other things we might regret.
3412 $app->loading_psgi_file(1);
3413 my $psgi_app = Plack::Util::load_psgi($psgi_file);
3414 $app->loading_psgi_file(0);
3417 unless $app->engine_loader->needs_psgi_engine_compat_hack;
3420 Found a legacy Catalyst::Engine::PSGI .psgi file at ${psgi_file}.
3422 Its content has been ignored. Please consult the Catalyst::Upgrading
3423 documentation on how to upgrade from Catalyst::Engine::PSGI.
3427 return $app->apply_default_middlewares($app->psgi_app);
3430 =head2 $c->apply_default_middlewares
3432 Adds the following L<Plack> middlewares to your application, since they are
3433 useful and commonly needed:
3435 L<Plack::Middleware::LighttpdScriptNameFix> (if you are using Lighttpd),
3436 L<Plack::Middleware::IIS6ScriptNameFix> (always applied since this middleware
3437 is smart enough to conditionally apply itself).
3439 We will also automatically add L<Plack::Middleware::ReverseProxy> if we notice
3440 that your HTTP $env variable C<REMOTE_ADDR> is '127.0.0.1'. This is usually
3441 an indication that your server is running behind a proxy frontend. However in
3442 2014 this is often not the case. We preserve this code for backwards compatibility
3443 however I B<highly> recommend that if you are running the server behind a front
3444 end proxy that you clearly indicate so with the C<using_frontend_proxy> configuration
3445 setting to true for your environment configurations that run behind a proxy. This
3446 way if you change your front end proxy address someday your code would inexplicably
3447 stop working as expected.
3449 Additionally if we detect we are using Nginx, we add a bit of custom middleware
3450 to solve some problems with the way that server handles $ENV{PATH_INFO} and
3453 Please B<NOTE> that if you do use C<using_frontend_proxy> the middleware is now
3454 adding via C<registered_middleware> rather than this method.
3456 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
3457 general this is no longer a common case but we have this here for backward
3463 sub apply_default_middlewares {
3464 my ($app, $psgi_app) = @_;
3466 # Don't add this conditional IF we are explicitly saying we want the
3467 # frontend proxy support. We don't need it here since if that is the
3468 # case it will be always loaded in the default_middleware.
3470 unless($app->config->{using_frontend_proxy}) {
3471 $psgi_app = Plack::Middleware::Conditional->wrap(
3473 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
3476 return if $app->config->{ignore_frontend_proxy};
3477 return $env->{REMOTE_ADDR} eq '127.0.0.1';
3482 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
3483 # http://lists.scsys.co.uk/pipermail/catalyst/2006-June/008361.html
3484 $psgi_app = Plack::Middleware::Conditional->wrap(
3486 builder => sub { Plack::Middleware::LighttpdScriptNameFix->wrap($_[0]) },
3489 return unless $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!lighttpd[-/]1\.(\d+\.\d+)!;
3490 return unless $1 < 4.23;
3495 # we're applying this unconditionally as the middleware itself already makes
3496 # sure it doesn't fuck things up if it's not running under one of the right
3498 $psgi_app = Plack::Middleware::IIS6ScriptNameFix->wrap($psgi_app);
3500 # And another IIS issue, this time with IIS7.
3501 $psgi_app = Plack::Middleware::Conditional->wrap(
3503 builder => sub { Plack::Middleware::IIS7KeepAliveFix->wrap($_[0]) },
3506 return $env->{SERVER_SOFTWARE} && $env->{SERVER_SOFTWARE} =~ m!IIS/7\.[0-9]!;
3513 =head2 App->psgi_app
3517 Returns a PSGI application code reference for the catalyst application
3518 C<$c>. This is the bare application created without the C<apply_default_middlewares>
3519 method called. We do however apply C<registered_middleware> since those are
3520 integral to how L<Catalyst> functions. Also, unlike starting your application
3521 with a generated server script (via L<Catalyst::Devel> and C<catalyst.pl>) we do
3522 not attempt to return a valid L<PSGI> application using any existing C<${myapp}.psgi>
3523 scripts in your $HOME directory.
3525 B<NOTE> C<apply_default_middlewares> was originally created when the first PSGI
3526 port was done for v5.90000. These are middlewares that are added to achieve
3527 backward compatibility with older applications. If you start your application
3528 using one of the supplied server scripts (generated with L<Catalyst::Devel> and
3529 the project skeleton script C<catalyst.pl>) we apply C<apply_default_middlewares>
3530 automatically. This was done so that pre and post PSGI port applications would
3533 This is what you want to be using to retrieve the PSGI application code
3534 reference of your Catalyst application for use in a custom F<.psgi> or in your
3535 own created server modules.
3539 *to_app = \&psgi_app;
3543 my $psgi = $app->engine->build_psgi_app($app);
3544 return $app->Catalyst::Utils::apply_registered_middleware($psgi);
3547 =head2 $c->setup_home
3549 Sets up the home directory.
3554 my ( $class, $home ) = @_;
3556 if ( my $env = Catalyst::Utils::env_value( $class, 'HOME' ) ) {
3560 $home ||= Catalyst::Utils::home($class);
3563 #I remember recently being scolded for assigning config values like this
3564 $class->config->{home} ||= $home;
3565 $class->config->{root} ||= Path::Class::Dir->new($home)->subdir('root');
3569 =head2 $c->setup_encoding
3571 Sets up the input/output encoding. See L<ENCODING>
3575 sub setup_encoding {
3577 if( exists($c->config->{encoding}) && !defined($c->config->{encoding}) ) {
3578 # Ok, so the user has explicitly said "I don't want encoding..."
3581 my $enc = defined($c->config->{encoding}) ?
3582 delete $c->config->{encoding} : 'UTF-8'; # not sure why we delete it... (JNAP)
3587 =head2 handle_unicode_encoding_exception
3589 Hook to let you customize how encoding errors are handled. By default
3590 we just throw an exception and the default error page will pick it up.
3591 Receives a hashref of debug information. Example of call (from the
3592 Catalyst internals):
3594 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
3595 param_value => $value,
3597 encoding_step => 'params',
3600 The calling code expects to receive a decoded string or an exception.
3602 You can override this for custom handling of unicode errors. By
3603 default we just die. If you want a custom response here, one approach
3604 is to throw an HTTP style exception, instead of returning a decoded
3605 string or throwing a generic exception.
3607 sub handle_unicode_encoding_exception {
3608 my ($c, $params) = @_;
3609 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
3612 Alternatively you can 'catch' the error, stash it and write handling code later
3613 in your application:
3615 sub handle_unicode_encoding_exception {
3616 my ($c, $params) = @_;
3617 $c->stash(BAD_UNICODE_DATA=>$params);
3618 # return a dummy string.
3622 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
3623 the request setup is still ongoing, which means the state of C<$c> and
3624 related context parts like the request and response may not be setup
3625 up correctly (since we haven't finished the setup yet). If you throw
3626 an exception the setup is aborted.
3630 sub handle_unicode_encoding_exception {
3631 my ( $self, $exception_ctx ) = @_;
3632 die $exception_ctx->{error_msg};
3635 # Some unicode helpers cargo culted from the old plugin. These could likely
3638 sub _handle_unicode_decoding {
3639 my ( $self, $value ) = @_;
3641 return unless defined $value;
3643 ## I think this mess is to support the old nested
3644 if ( ref $value eq 'ARRAY' ) {
3645 foreach ( @$value ) {
3646 $_ = $self->_handle_unicode_decoding($_);
3650 elsif ( ref $value eq 'HASH' ) {
3651 foreach (keys %$value) {
3652 my $encoded_key = $self->_handle_param_unicode_decoding($_);
3653 $value->{$encoded_key} = $self->_handle_unicode_decoding($value->{$_});
3655 # If the key was encoded we now have two (the original and current so
3656 # delete the original.
3657 delete $value->{$_} if $_ ne $encoded_key;
3662 return $self->_handle_param_unicode_decoding($value);
3666 sub _handle_param_unicode_decoding {
3667 my ( $self, $value, $check ) = @_;
3668 return unless defined $value; # not in love with just ignoring undefs - jnap
3669 return $value if blessed($value); #don't decode when the value is an object.
3671 my $enc = $self->encoding;
3673 return $value unless $enc; # don't decode if no encoding is specified
3675 $check ||= $self->_encode_check;
3677 $enc->decode( $value, $check);
3680 return $self->handle_unicode_encoding_exception({
3681 param_value => $value,
3683 encoding_step => 'params',
3688 =head2 $c->setup_log
3690 Sets up log by instantiating a L<Catalyst::Log|Catalyst::Log> object and
3691 passing it to C<log()>. Pass in a comma-delimited list of levels to set the
3694 This method also installs a C<debug> method that returns a true value into the
3695 catalyst subclass if the "debug" level is passed in the comma-delimited list,
3696 or if the C<$CATALYST_DEBUG> environment variable is set to a true value.
3698 Note that if the log has already been setup, by either a previous call to
3699 C<setup_log> or by a call such as C<< __PACKAGE__->log( MyLogger->new ) >>,
3700 that this method won't actually set up the log object.
3705 my ( $class, $levels ) = @_;
3708 $levels =~ s/^\s+//;
3709 $levels =~ s/\s+$//;
3710 my %levels = map { $_ => 1 } split /\s*,\s*/, $levels;
3712 my $env_debug = Catalyst::Utils::env_value( $class, 'DEBUG' );
3713 if ( defined $env_debug ) {
3714 $levels{debug} = 1 if $env_debug; # Ugly!
3715 delete($levels{debug}) unless $env_debug;
3718 unless ( $class->log ) {
3719 $class->log( Catalyst::Log->new(keys %levels) );
3722 if ( $levels{debug} ) {
3723 Class::MOP::get_metaclass_by_name($class)->add_method('debug' => sub { 1 });
3724 $class->log->debug('Debug messages enabled');
3728 =head2 $c->setup_plugins
3734 =head2 $c->setup_stats
3736 Sets up timing statistics class.
3741 my ( $class, $stats ) = @_;
3743 Catalyst::Utils::ensure_class_loaded($class->stats_class);
3745 my $env = Catalyst::Utils::env_value( $class, 'STATS' );
3746 if ( defined($env) ? $env : ($stats || $class->debug ) ) {
3747 Class::MOP::get_metaclass_by_name($class)->add_method('use_stats' => sub { 1 });
3748 $class->log->debug('Statistics enabled');
3753 =head2 $c->registered_plugins
3755 Returns a sorted list of the plugins which have either been stated in the
3758 If passed a given plugin name, it will report a boolean value indicating
3759 whether or not that plugin is loaded. A fully qualified name is required if
3760 the plugin name does not begin with C<Catalyst::Plugin::>.
3762 if ($c->registered_plugins('Some::Plugin')) {
3770 sub registered_plugins {
3772 return sort keys %{ $proto->_plugins } unless @_;
3774 return 1 if exists $proto->_plugins->{$plugin};
3775 return exists $proto->_plugins->{"Catalyst::Plugin::$plugin"};
3778 sub _register_plugin {
3779 my ( $proto, $plugin, $instant ) = @_;
3780 my $class = ref $proto || $proto;
3782 load_class( $plugin );
3783 $class->log->warn( "$plugin inherits from 'Catalyst::Component' - this is deprecated and will not work in 5.81" )
3784 if $plugin->isa( 'Catalyst::Component' );
3785 my $plugin_meta = Moose::Meta::Class->create($plugin);
3786 if (!$plugin_meta->has_method('new')
3787 && ( $plugin->isa('Class::Accessor::Fast') || $plugin->isa('Class::Accessor') ) ) {
3788 $plugin_meta->add_method('new', Moose::Object->meta->get_method('new'))
3790 if (!$instant && !$proto->_plugins->{$plugin}) {
3791 my $meta = Class::MOP::get_metaclass_by_name($class);
3792 $meta->superclasses($plugin, $meta->superclasses);
3794 $proto->_plugins->{$plugin} = 1;
3798 sub _default_plugins { return qw() }
3801 my ( $class, $plugins ) = @_;
3803 $class->_plugins( {} ) unless $class->_plugins;
3805 m/Unicode::Encoding/ ? do {
3807 'Unicode::Encoding plugin is auto-applied,'
3808 . ' please remove this from your appclass'
3809 . ' and make sure to define "encoding" config'
3811 unless (exists $class->config->{'encoding'}) {
3812 $class->config->{'encoding'} = 'UTF-8';
3817 push @$plugins, $class->_default_plugins;
3818 $plugins = Data::OptList::mkopt($plugins || []);
3821 [ Catalyst::Utils::resolve_namespace(
3822 $class . '::Plugin',
3823 'Catalyst::Plugin', $_->[0]
3829 for my $plugin ( reverse @plugins ) {
3830 load_class($plugin->[0], $plugin->[1]);
3831 my $meta = find_meta($plugin->[0]);
3832 next if $meta && $meta->isa('Moose::Meta::Role');
3834 $class->_register_plugin($plugin->[0]);
3838 map { $_->[0]->name, $_->[1] }
3839 grep { blessed($_->[0]) && $_->[0]->isa('Moose::Meta::Role') }
3840 map { [find_meta($_->[0]), $_->[1]] }
3843 Moose::Util::apply_all_roles(
3849 =head2 default_middleware
3851 Returns a list of instantiated PSGI middleware objects which is the default
3852 middleware that is active for this application (taking any configuration
3853 options into account, excluding your custom added middleware via the C<psgi_middleware>
3854 configuration option). You can override this method if you wish to change
3855 the default middleware (although do so at risk since some middleware is vital
3856 to application function.)
3858 The current default middleware list is:
3860 Catalyst::Middleware::Stash
3861 Plack::Middleware::HTTPExceptions
3862 Plack::Middleware::RemoveRedundantBody
3863 Plack::Middleware::FixMissingBodyInRedirect
3864 Plack::Middleware::ContentLength
3865 Plack::Middleware::MethodOverride
3866 Plack::Middleware::Head
3868 If the configuration setting C<using_frontend_proxy> is true we add:
3870 Plack::Middleware::ReverseProxy
3872 If the configuration setting C<using_frontend_proxy_path> is true we add:
3874 Plack::Middleware::ReverseProxyPath
3876 But B<NOTE> that L<Plack::Middleware::ReverseProxyPath> is not a dependency of the
3877 L<Catalyst> distribution so if you want to use this option you should add it to
3878 your project distribution file.
3880 These middlewares will be added at L</setup_middleware> during the
3881 L</setup> phase of application startup.
3885 sub default_middleware {
3888 Catalyst::Middleware::Stash->new,
3889 Plack::Middleware::HTTPExceptions->new,
3890 Plack::Middleware::RemoveRedundantBody->new,
3891 Plack::Middleware::FixMissingBodyInRedirect->new,
3892 Plack::Middleware::ContentLength->new,
3893 Plack::Middleware::MethodOverride->new,
3894 Plack::Middleware::Head->new);
3896 if($class->config->{using_frontend_proxy}) {
3897 push @mw, Plack::Middleware::ReverseProxy->new;
3900 if($class->config->{using_frontend_proxy_path}) {
3901 if(Class::Load::try_load_class('Plack::Middleware::ReverseProxyPath')) {
3902 push @mw, Plack::Middleware::ReverseProxyPath->new;
3904 $class->log->error("Cannot use configuration 'using_frontend_proxy_path' because 'Plack::Middleware::ReverseProxyPath' is not installed");
3911 =head2 registered_middlewares
3913 Read only accessor that returns an array of all the middleware in the order
3914 that they were added (which is the REVERSE of the order they will be applied).
3916 The values returned will be either instances of L<Plack::Middleware> or of a
3917 compatible interface, or a coderef, which is assumed to be inlined middleware
3919 =head2 setup_middleware (?@middleware)
3921 Read configuration information stored in configuration key C<psgi_middleware> or
3924 See under L</CONFIGURATION> information regarding C<psgi_middleware> and how
3925 to use it to enable L<Plack::Middleware>
3927 This method is automatically called during 'setup' of your application, so
3928 you really don't need to invoke it. However you may do so if you find the idea
3929 of loading middleware via configuration weird :). For example:
3935 __PACKAGE__->setup_middleware('Head');
3938 When we read middleware definitions from configuration, we reverse the list
3939 which sounds odd but is likely how you expect it to work if you have prior
3940 experience with L<Plack::Builder> or if you previously used the plugin
3941 L<Catalyst::Plugin::EnableMiddleware> (which is now considered deprecated)
3943 So basically your middleware handles an incoming request from the first
3944 registered middleware, down and handles the response from the last middleware
3949 sub registered_middlewares {
3951 if(my $middleware = $class->_psgi_middleware) {
3952 my @mw = ($class->default_middleware, @$middleware);
3954 if($class->config->{using_frontend_proxy}) {
3955 push @mw, Plack::Middleware::ReverseProxy->new;
3960 die "You cannot call ->registered_middlewares until middleware has been setup";
3964 sub setup_middleware {
3966 my @middleware_definitions;
3968 # If someone calls this method you can add middleware with args. However if its
3969 # called without an arg we need to setup the configuration middleware.
3971 @middleware_definitions = reverse(@_);
3973 @middleware_definitions = reverse(@{$class->config->{'psgi_middleware'}||[]})
3974 unless $class->finalized_default_middleware;
3975 $class->finalized_default_middleware(1); # Only do this once, just in case some people call setup over and over...
3978 my @middleware = ();
3979 while(my $next = shift(@middleware_definitions)) {
3981 if(Scalar::Util::blessed $next && $next->can('wrap')) {
3982 push @middleware, $next;
3983 } elsif(ref $next eq 'CODE') {
3984 push @middleware, $next;
3985 } elsif(ref $next eq 'HASH') {
3986 my $namespace = shift @middleware_definitions;
3987 my $mw = $class->Catalyst::Utils::build_middleware($namespace, %$next);
3988 push @middleware, $mw;
3990 die "I can't handle middleware definition ${\ref $next}";
3993 my $mw = $class->Catalyst::Utils::build_middleware($next);
3994 push @middleware, $mw;
3998 my @existing = @{$class->_psgi_middleware || []};
3999 $class->_psgi_middleware([@middleware,@existing,]);
4002 =head2 registered_data_handlers
4004 A read only copy of registered Data Handlers returned as a Hash, where each key
4005 is a content type and each value is a subref that attempts to decode that content
4008 =head2 setup_data_handlers (?@data_handler)
4010 Read configuration information stored in configuration key C<data_handlers> or
4013 See under L</CONFIGURATION> information regarding C<data_handlers>.
4015 This method is automatically called during 'setup' of your application, so
4016 you really don't need to invoke it.
4018 =head2 default_data_handlers
4020 Default Data Handlers that come bundled with L<Catalyst>. Currently there are
4021 only two default data handlers, for 'application/json' and an alternative to
4022 'application/x-www-form-urlencoded' which supposed nested form parameters via
4023 L<CGI::Struct> or via L<CGI::Struct::XS> IF you've installed it.
4025 The 'application/json' data handler is used to parse incoming JSON into a Perl
4026 data structure. It used either L<JSON::MaybeXS> or L<JSON>, depending on which
4027 is installed. This allows you to fail back to L<JSON:PP>, which is a Pure Perl
4028 JSON decoder, and has the smallest dependency impact.
4030 Because we don't wish to add more dependencies to L<Catalyst>, if you wish to
4031 use this new feature we recommend installing L<JSON> or L<JSON::MaybeXS> in
4032 order to get the best performance. You should add either to your dependency
4033 list (Makefile.PL, dist.ini, cpanfile, etc.)
4037 sub registered_data_handlers {
4039 if(my $data_handlers = $class->_data_handlers) {
4040 return %$data_handlers;
4042 $class->setup_data_handlers;
4043 return $class->registered_data_handlers;
4047 sub setup_data_handlers {
4048 my ($class, %data_handler_callbacks) = @_;
4049 %data_handler_callbacks = (
4050 %{$class->default_data_handlers},
4051 %{$class->config->{'data_handlers'}||+{}},
4052 %data_handler_callbacks);
4054 $class->_data_handlers(\%data_handler_callbacks);
4057 sub default_data_handlers {
4060 'application/x-www-form-urlencoded' => sub {
4061 my ($fh, $req) = @_;
4062 my $params = $req->_use_hash_multivalue ? $req->body_parameters->mixed : $req->body_parameters;
4063 Class::Load::load_first_existing_class('CGI::Struct::XS', 'CGI::Struct')
4064 ->can('build_cgi_struct')->($params);
4066 'application/json' => sub {
4067 my ($fh, $req) = @_;
4068 my $parser = Class::Load::load_first_existing_class('JSON::MaybeXS', 'JSON');
4072 $slurped = $fh->getline;
4073 $parser->can("decode_json")->($slurped); # decode_json does utf8 decoding for us
4074 } || Catalyst::Exception->throw(sprintf "Error Parsing POST '%s', Error: %s", (defined($slurped) ? $slurped : 'undef') ,$@);
4079 sub _handle_http_exception {
4080 my ( $self, $error ) = @_;
4082 !$self->config->{always_catch_http_exceptions}
4085 $error->can('as_psgi')
4086 || ( $error->can('code')
4087 && $error->code =~ m/^[1-5][0-9][0-9]$/ )
4097 Returns an arrayref of the internal execution stack (actions that are
4098 currently executing).
4102 Returns the current timing statistics object. By default Catalyst uses
4103 L<Catalyst::Stats|Catalyst::Stats>, but can be set otherwise with
4104 L<< stats_class|/"$c->stats_class" >>.
4106 Even if L<< -Stats|/"-Stats" >> is not enabled, the stats object is still
4107 available. By enabling it with C< $c->stats->enabled(1) >, it can be used to
4108 profile explicitly, although MyApp.pm still won't profile nor output anything
4111 =head2 $c->stats_class
4113 Returns or sets the stats (timing statistics) class. L<Catalyst::Stats|Catalyst::Stats> is used by default.
4115 =head2 $app->stats_class_traits
4117 A arrayref of L<Moose::Role>s that are applied to the stats_class before creating it.
4119 =head2 $app->composed_stats_class
4121 this is the stats_class composed with any 'stats_class_traits'. You can
4122 name the full namespace of the role, or a namespace suffix, which will then
4123 be tried against the following standard namespace prefixes.
4125 $MyApp::TraitFor::Stats::$trait_suffix
4126 Catalyst::TraitFor::Stats::$trait_suffix
4128 So for example if you set:
4130 MyApp->stats_class_traits(['Foo']);
4132 We try each possible role in turn (and throw an error if none load)
4135 MyApp::TraitFor::Stats::Foo
4136 Catalyst::TraitFor::Stats::Foo
4138 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
4139 compatibility with L<CatalystX::RoleApplicator> which previously provided
4140 these features in a stand alone package.
4142 =head2 $c->use_stats
4144 Returns 1 when L<< stats collection|/"-Stats" >> is enabled.
4146 Note that this is a static method, not an accessor and should be overridden
4147 by declaring C<sub use_stats { 1 }> in your MyApp.pm, not by calling C<< $c->use_stats(1) >>.
4154 =head2 $c->write( $data )
4156 Writes $data to the output stream. When using this method directly, you
4157 will need to manually set the C<Content-Length> header to the length of
4158 your output data, if known.
4165 # Finalize headers if someone manually writes output (for compat)
4166 $c->finalize_headers;
4168 return $c->response->write( @_ );
4173 Returns the Catalyst version number. Mostly useful for "powered by"
4174 messages in template systems.
4178 sub version { return $Catalyst::VERSION }
4180 =head1 CONFIGURATION
4182 There are a number of 'base' config variables which can be set:
4188 C<always_catch_http_exceptions> - As of version 5.90060 Catalyst
4189 rethrows errors conforming to the interface described by
4190 L<Plack::Middleware::HTTPExceptions> and lets the middleware deal with it.
4191 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
4195 C<default_model> - The default model picked if you say C<< $c->model >>. See L<< /$c->model($name) >>.
4199 C<default_view> - The default view to be rendered or returned when C<< $c->view >> is called. See L<< /$c->view($name) >>.
4203 C<disable_component_resolution_regex_fallback> - Turns
4204 off the deprecated component resolution functionality so
4205 that if any of the component methods (e.g. C<< $c->controller('Foo') >>)
4206 are called then regex search will not be attempted on string values and
4207 instead C<undef> will be returned.
4211 C<home> - The application home directory. In an uninstalled application,
4212 this is the top level application directory. In an installed application,
4213 this will be the directory containing C<< MyApp.pm >>.
4217 C<ignore_frontend_proxy> - See L</PROXY SUPPORT>
4221 C<name> - The name of the application in debug messages and the debug and
4226 C<parse_on_demand> - The request body (for example file uploads) will not be parsed
4227 until it is accessed. This allows you to (for example) check authentication (and reject
4228 the upload) before actually receiving all the data. See L</ON-DEMAND PARSER>
4232 C<root> - The root directory for templates. Usually this is just a
4233 subdirectory of the home directory, but you can set it to change the
4234 templates to a different directory.
4238 C<search_extra> - Array reference passed to Module::Pluggable to for additional
4239 namespaces from which components will be loaded (and constructed and stored in
4240 C<< $c->components >>).
4244 C<show_internal_actions> - If true, causes internal actions such as C<< _DISPATCH >>
4245 to be shown in hit debug tables in the test server.
4249 C<use_request_uri_for_path> - Controls if the C<REQUEST_URI> or C<PATH_INFO> environment
4250 variable should be used for determining the request path.
4252 Most web server environments pass the requested path to the application using environment variables,
4253 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
4254 exposed as C<< $c->request->base >>) and the request path below that base.
4256 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
4257 is determined by the C<< $c->config(use_request_uri_for_path) >> setting (which can either be true or false).
4261 =item use_request_uri_for_path => 0
4263 This is the default (and the) traditional method that Catalyst has used for determining the path information.
4264 The path is generated from a combination of the C<PATH_INFO> and C<SCRIPT_NAME> environment variables.
4265 The allows the application to behave correctly when C<mod_rewrite> is being used to redirect requests
4266 into the application, as these variables are adjusted by mod_rewrite to take account for the redirect.
4268 However this method has the major disadvantage that it is impossible to correctly decode some elements
4269 of the path, as RFC 3875 says: "C<< Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
4270 contain path-segment parameters. >>" This means PATH_INFO is B<always> decoded, and therefore Catalyst
4271 can't distinguish / vs %2F in paths (in addition to other encoded values).
4273 =item use_request_uri_for_path => 1
4275 This method uses the C<REQUEST_URI> and C<SCRIPT_NAME> environment variables. As C<REQUEST_URI> is never
4276 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
4277 (i.e. with C<AllowEncodedSlashes> set to C<On> in Apache).
4279 Given that this method of path resolution is provably more correct, it is recommended that you use
4280 this unless you have a specific need to deploy your application in a non-standard environment, and you are
4281 aware of the implications of not being able to handle encoded URI paths correctly.
4283 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
4284 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public_html directory, with mod_rewrite in a
4285 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
4286 at other URIs than that which the app is 'normally' based at with C<mod_rewrite>), the resolution of
4287 C<< $c->request->base >> will be incorrect.
4293 C<using_frontend_proxy> - See L</PROXY SUPPORT>.
4297 C<using_frontend_proxy_path> - Enabled L<Plack::Middleware::ReverseProxyPath> on your application (if
4298 installed, otherwise log an error). This is useful if your application is not running on the
4299 'root' (or /) of your host server. B<NOTE> if you use this feature you should add the required
4300 middleware to your project dependency list since its not automatically a dependency of L<Catalyst>.
4301 This has been done since not all people need this feature and we wish to restrict the growth of
4302 L<Catalyst> dependencies.
4306 C<encoding> - See L</ENCODING>
4308 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
4313 C<abort_chain_on_error_fix>
4317 When there is an error in an action chain, the default behavior is to
4318 abort the processing of the remaining actions to avoid running them
4319 when the application is in an unexpected state.
4321 Before version 5.90070, the default used to be false. To keep the old
4322 behaviour, you can explicitely set the value to false. E.g.
4324 __PACKAGE__->config(abort_chain_on_error_fix => 0);
4326 If this setting is set to false, then the remaining actions are
4327 performed and the error is caught at the end of the chain.
4332 C<use_hash_multivalue_in_request>
4334 In L<Catalyst::Request> the methods C<query_parameters>, C<body_parametes>
4335 and C<parameters> return a hashref where values might be scalar or an arrayref
4336 depending on the incoming data. In many cases this can be undesirable as it
4337 leads one to writing defensive code like the following:
4339 my ($val) = ref($c->req->parameters->{a}) ?
4340 @{$c->req->parameters->{a}} :
4341 $c->req->parameters->{a};
4343 Setting this configuration item to true will make L<Catalyst> populate the
4344 attributes underlying these methods with an instance of L<Hash::MultiValue>
4345 which is used by L<Plack::Request> and others to solve this very issue. You
4346 may prefer this behavior to the default, if so enable this option (be warned
4347 if you enable it in a legacy application we are not sure if it is completely
4348 backwardly compatible).
4352 C<skip_complex_post_part_handling>
4354 When creating body parameters from a POST, if we run into a multipart POST
4355 that does not contain uploads, but instead contains inlined complex data
4356 (very uncommon) we cannot reliably convert that into field => value pairs. So
4357 instead we create an instance of L<Catalyst::Request::PartData>. If this causes
4358 issue for you, you can disable this by setting C<skip_complex_post_part_handling>
4359 to true (default is false).
4363 C<skip_body_param_unicode_decoding>
4365 Generally we decode incoming POST params based on your declared encoding (the
4366 default for this is to decode UTF-8). If this is causing you trouble and you
4367 do not wish to turn all encoding support off (with the C<encoding> configuration
4368 parameter) you may disable this step atomically by setting this configuration
4373 C<do_not_decode_query>
4375 If true, then do not try to character decode any wide characters in your
4376 request URL query or keywords. Most readings of the relevant specifications
4377 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
4378 will use, however if you are creating a lot of URLs manually or have external
4379 evil clients, this might cause you trouble. If you find the changes introduced
4380 in Catalyst version 5.90080+ break some of your query code, you may disable
4381 the UTF-8 decoding globally using this configuration.
4383 This setting takes precedence over C<default_query_encoding>
4387 C<do_not_check_query_encoding>
4389 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
4390 request but would not raise an exception when the decoding failed due to
4391 incorrect unicode. It now does, but if this change is giving you trouble
4392 you may disable it by setting this configuration to true.
4396 C<default_query_encoding>
4398 By default we decode query and keywords in your request URL using UTF-8, which
4399 is our reading of the relevant specifications. This setting allows one to
4400 specify a fixed value for how to decode your query. You might need this if
4401 you are doing a lot of custom encoding of your URLs and not using UTF-8.
4405 C<use_chained_args_0_special_case>
4407 In older versions of Catalyst, when more than one action matched the same path
4408 AND all those matching actions declared Args(0), we'd break the tie by choosing
4409 the first action defined. We now normalized how Args(0) works so that it
4410 follows the same rule as Args(N), which is to say when we need to break a tie
4411 we choose the LAST action defined. If this breaks your code and you don't
4412 have time to update to follow the new normalized approach, you may set this
4413 value to true and it will globally revert to the original chaining behavior.
4417 C<psgi_middleware> - See L<PSGI MIDDLEWARE>.
4421 C<data_handlers> - See L<DATA HANDLERS>.
4425 C<stats_class_traits>
4427 An arrayref of L<Moose::Role>s that get composed into your stats class.
4431 C<request_class_traits>
4433 An arrayref of L<Moose::Role>s that get composed into your request class.
4437 C<response_class_traits>
4439 An arrayref of L<Moose::Role>s that get composed into your response class.
4443 C<inject_components>
4445 A Hashref of L<Catalyst::Component> subclasses that are 'injected' into configuration.
4449 inject_components => {
4450 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
4451 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
4452 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
4454 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
4455 'Model::Zoo' => { a => 2 },
4456 'Model::Foo' => { a => 100 },
4459 Generally L<Catalyst> looks for components in your Model/View or Controller directories.
4460 However for cases when you which to use an existing component and you don't need any
4461 customization (where for when you can apply a role to customize it) you may inject those
4462 components into your application. Please note any configuration should be done 'in the
4463 normal way', with a key under configuration named after the component affix, as in the
4466 Using this type of injection allows you to construct significant amounts of your application
4467 with only configuration!. This may or may not lead to increased code understanding.
4469 Please not you may also call the ->inject_components application method as well, although
4470 you must do so BEFORE setup.
4476 Generally when you throw an exception inside an Action (or somewhere in
4477 your stack, such as in a model that an Action is calling) that exception
4478 is caught by Catalyst and unless you either catch it yourself (via eval
4479 or something like L<Try::Tiny> or by reviewing the L</error> stack, it
4480 will eventually reach L</finalize_errors> and return either the debugging
4481 error stack page, or the default error page. However, if your exception
4482 can be caught by L<Plack::Middleware::HTTPExceptions>, L<Catalyst> will
4483 instead rethrow it so that it can be handled by that middleware (which
4484 is part of the default middleware). For example this would allow
4486 use HTTP::Throwable::Factory 'http_throw';
4488 sub throws_exception :Local {
4489 my ($self, $c) = @_;
4491 http_throw(SeeOther => { location =>
4492 $c->uri_for($self->action_for('redirect')) });
4496 =head1 INTERNAL ACTIONS
4498 Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>,
4499 C<_ACTION>, and C<_END>. These are by default not shown in the private
4500 action table, but you can make them visible with a config parameter.
4502 MyApp->config(show_internal_actions => 1);
4504 =head1 ON-DEMAND PARSER
4506 The request body is usually parsed at the beginning of a request,
4507 but if you want to handle input yourself, you can enable on-demand
4508 parsing with a config parameter.
4510 MyApp->config(parse_on_demand => 1);
4512 =head1 PROXY SUPPORT
4514 Many production servers operate using the common double-server approach,
4515 with a lightweight frontend web server passing requests to a larger
4516 backend server. An application running on the backend server must deal
4517 with two problems: the remote user always appears to be C<127.0.0.1> and
4518 the server's hostname will appear to be C<localhost> regardless of the
4519 virtual host that the user connected through.
4521 Catalyst will automatically detect this situation when you are running
4522 the frontend and backend servers on the same machine. The following
4523 changes are made to the request.
4525 $c->req->address is set to the user's real IP address, as read from
4526 the HTTP X-Forwarded-For header.
4528 The host value for $c->req->base and $c->req->uri is set to the real
4529 host, as read from the HTTP X-Forwarded-Host header.
4531 Additionally, you may be running your backend application on an insecure
4532 connection (port 80) while your frontend proxy is running under SSL. If there
4533 is a discrepancy in the ports, use the HTTP header C<X-Forwarded-Port> to
4534 tell Catalyst what port the frontend listens on. This will allow all URIs to
4535 be created properly.
4537 In the case of passing in:
4539 X-Forwarded-Port: 443
4541 All calls to C<uri_for> will result in an https link, as is expected.
4543 Obviously, your web server must support these headers for this to work.
4545 In a more complex server farm environment where you may have your
4546 frontend proxy server(s) on different machines, you will need to set a
4547 configuration option to tell Catalyst to read the proxied data from the
4550 MyApp->config(using_frontend_proxy => 1);
4552 If you do not wish to use the proxy support at all, you may set:
4554 MyApp->config(ignore_frontend_proxy => 0);
4556 =head2 Note about psgi files
4558 Note that if you supply your own .psgi file, calling
4559 C<< MyApp->psgi_app(@_); >>, then B<this will not happen automatically>.
4561 You either need to apply L<Plack::Middleware::ReverseProxy> yourself
4562 in your psgi, for example:
4565 enable "Plack::Middleware::ReverseProxy";
4569 This will unconditionally add the ReverseProxy support, or you need to call
4570 C<< $app = MyApp->apply_default_middlewares($app) >> (to conditionally
4571 apply the support depending upon your config).
4573 See L<Catalyst::PSGI> for more information.
4575 =head1 THREAD SAFETY
4577 Catalyst has been tested under Apache 2's threading C<mpm_worker>,
4578 C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
4579 believe the Catalyst core to be thread-safe.
4581 If you plan to operate in a threaded environment, remember that all other
4582 modules you are using must also be thread-safe. Some modules, most notably
4583 L<DBD::SQLite>, are not thread-safe.
4585 =head1 DATA HANDLERS
4587 The L<Catalyst::Request> object uses L<HTTP::Body> to populate 'classic' HTML
4588 form parameters and URL search query fields. However it has become common
4589 for various alternative content types to be PUT or POSTed to your controllers
4590 and actions. People working on RESTful APIs, or using AJAX often use JSON,
4591 XML and other content types when communicating with an application server. In
4592 order to better support this use case, L<Catalyst> defines a global configuration
4593 option, C<data_handlers>, which lets you associate a content type with a coderef
4594 that parses that content type into something Perl can readily access.
4601 __PACKAGE__->config(
4603 'application/json' => sub { local $/; decode_json $_->getline },
4605 ## Any other configuration.
4610 By default L<Catalyst> comes with a generic JSON data handler similar to the
4611 example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
4612 (a pure Perl, dependency free JSON parser) or L<Cpanel::JSON::XS> if you have
4613 it installed (if you want the faster XS parser, add it to you project Makefile.PL
4614 or dist.ini, cpanfile, etc.)
4616 The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
4617 (matched against the incoming request type using a regexp such as to be case
4618 insensitive) and whose values are coderefs that receive a localized version of
4619 C<$_> which is a filehandle object pointing to received body.
4621 This feature is considered an early access release and we reserve the right
4622 to alter the interface in order to provide a performant and secure solution to
4623 alternative request body content. Your reports welcomed!
4625 =head1 PSGI MIDDLEWARE
4627 You can define middleware, defined as L<Plack::Middleware> or a compatible
4628 interface in configuration. Your middleware definitions are in the form of an
4629 arrayref under the configuration key C<psgi_middleware>. Here's an example
4630 with details to follow:
4635 use Plack::Middleware::StackTrace;
4637 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4639 __PACKAGE__->config(
4640 'psgi_middleware', [
4643 $stacktrace_middleware,
4644 'Session' => {store => 'File'},
4649 $env->{myapp.customkey} = 'helloworld';
4658 So the general form is:
4660 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
4662 Where C<@middleware> is one or more of the following, applied in the REVERSE of
4663 the order listed (to make it function similarly to L<Plack::Builder>:
4665 Alternatively, you may also define middleware by calling the L</setup_middleware>
4672 __PACKAGE__->setup_middleware( \@middleware_definitions);
4675 In the case where you do both (use 'setup_middleware' and configuration) the
4676 package call to setup_middleware will be applied earlier (in other words its
4677 middleware will wrap closer to the application). Keep this in mind since in
4678 some cases the order of middleware is important.
4680 The two approaches are not exclusive.
4684 =item Middleware Object
4686 An already initialized object that conforms to the L<Plack::Middleware>
4689 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
4691 __PACKAGE__->config(
4692 'psgi_middleware', [
4693 $stacktrace_middleware,
4699 A coderef that is an inlined middleware:
4701 __PACKAGE__->config(
4702 'psgi_middleware', [
4707 if($env->{PATH_INFO} =~m/forced/) {
4709 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
4712 return $app->($env);
4722 We assume the scalar refers to a namespace after normalizing it using the
4725 (1) If the scalar is prefixed with a "+" (as in C<+MyApp::Foo>) then the full string
4726 is assumed to be 'as is', and we just install and use the middleware.
4728 (2) If the scalar begins with "Plack::Middleware" or your application namespace
4729 (the package name of your Catalyst application subclass), we also assume then
4730 that it is a full namespace, and use it.
4732 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
4733 resolve it first by looking for it under your application namespace (for example
4734 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
4735 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
4736 will then look under the regular L<Plack::Middleware> namespace (i.e. for the
4737 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
4738 namespace first to let you 'override' common L<Plack::Middleware> locally, should
4739 you find that a good idea.
4745 __PACKAGE__->config(
4746 'psgi_middleware', [
4747 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
4748 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
4749 '+MyApp::Custom', ## MyApp::Custom->wrap
4753 =item a scalar followed by a hashref
4755 Just like the previous, except the following C<HashRef> is used as arguments
4756 to initialize the middleware object.
4758 __PACKAGE__->config(
4759 'psgi_middleware', [
4760 'Session' => {store => 'File'},
4765 Please see L<PSGI> for more on middleware.
4769 Starting in L<Catalyst> version 5.90080 encoding is automatically enabled
4770 and set to encode all body responses to UTF8 when possible and applicable.
4771 Following is documentation on this process. If you are using an older
4772 version of L<Catalyst> you should review documentation for that version since
4775 By default encoding is now 'UTF-8'. You may turn it off by setting
4776 the encoding configuration to undef.
4778 MyApp->config(encoding => undef);
4780 This is recommended for temporary backwards compatibility only.
4782 To turn it off for a single request use the L<clear_encoding>
4783 method to turn off encoding for this request. This can be useful
4784 when you are setting the body to be an arbitrary block of bytes,
4785 especially if that block happens to be a block of UTF8 text.
4787 Encoding is automatically applied when the content-type is set to
4788 a type that can be encoded. Currently we encode when the content type
4789 matches the following regular expression:
4791 $content_type =~ /^text|xml$|javascript$/
4793 Encoding is set on the application, but it is copied to the context object
4794 so that you can override it on a request basis.
4796 Be default we don't automatically encode 'application/json' since the most
4797 common approaches to generating this type of response (Either via L<Catalyst::View::JSON>
4798 or L<Catalyst::Action::REST>) will do so already and we want to avoid double
4801 If you are producing JSON response in an unconventional manner (such
4802 as via a template or manual strings) you should perform the UTF8 encoding
4803 manually as well such as to conform to the JSON specification.
4805 NOTE: We also examine the value of $c->response->content_encoding. If
4806 you set this (like for example 'gzip', and manually gzipping the body)
4807 we assume that you have done all the necessary encoding yourself, since
4808 we cannot encode the gzipped contents. If you use a plugin like
4809 L<Catalyst::Plugin::Compress> you need to update to a modern version in order
4810 to have this function correctly with the new UTF8 encoding code, or you
4811 can use L<Plack::Middleware::Deflater> or (probably best) do your compression on
4820 Returns an instance of an C<Encode> encoding
4822 print $c->encoding->name
4824 =item handle_unicode_encoding_exception ($exception_context)
4826 Method called when decoding process for a request fails.
4828 An C<$exception_context> hashref is provided to allow you to override the
4829 behaviour of your application when given data with incorrect encodings.
4831 The default method throws exceptions in the case of invalid request parameters
4832 (resulting in a 500 error), but ignores errors in upload filenames.
4834 The keys passed in the C<$exception_context> hash are:
4840 The value which was not able to be decoded.
4844 The exception received from L<Encode>.
4848 What type of data was being decoded. Valid values are (currently)
4849 C<params> - for request parameters / arguments / captures
4850 and C<uploads> - for request upload filenames.
4860 Join #catalyst on irc.perl.org.
4864 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
4865 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
4869 http://catalyst.perl.org
4873 http://dev.catalyst.perl.org
4877 =head2 L<Task::Catalyst> - All you need to start with Catalyst
4879 =head2 L<Catalyst::Manual> - The Catalyst Manual
4881 =head2 L<Catalyst::Component>, L<Catalyst::Controller> - Base classes for components
4883 =head2 L<Catalyst::Engine> - Core engine
4885 =head2 L<Catalyst::Log> - Log class.
4887 =head2 L<Catalyst::Request> - Request object
4889 =head2 L<Catalyst::Response> - Response object
4891 =head2 L<Catalyst::Test> - The test suite.
4893 =head1 PROJECT FOUNDER
4895 sri: Sebastian Riedel <sri@cpan.org>
4901 acme: Leon Brocard <leon@astray.com>
4903 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
4905 andrewalker: André Walker <andre@cpan.org>
4909 Andrew Ford <A.Ford@ford-mason.co.uk>
4913 andyg: Andy Grundman <andy@hybridized.org>
4915 audreyt: Audrey Tang
4917 bricas: Brian Cassidy <bricas@cpan.org>
4919 Caelum: Rafael Kitover <rkitover@io.com>
4921 chansen: Christian Hansen
4923 Chase Venters C<chase.venters@gmail.com>
4925 chicks: Christopher Hicks
4927 Chisel Wright C<pause@herlpacker.co.uk>
4929 Danijel Milicevic C<me@danijel.de>
4931 davewood: David Schmidt <davewood@cpan.org>
4933 David Kamholz <dkamholz@cpan.org>
4935 David Naughton, C<naughton@umn.edu>
4939 dhoss: Devin Austin <dhoss@cpan.org>
4941 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
4945 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
4947 esskar: Sascha Kiefer
4949 fireartist: Carl Franks <cfranks@cpan.org>
4951 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
4953 gabb: Danijel Milicevic
4957 Gavin Henry C<ghenry@perl.me.uk>
4961 groditi: Guillermo Roditi <groditi@gmail.com>
4963 hobbs: Andrew Rodland <andrew@cleverdomain.org>
4965 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
4967 jcamacho: Juan Camacho
4969 jester: Jesse Sheidlower C<jester@panix.com>
4971 jhannah: Jay Hannah <jay@jays.net>
4977 jon: Jon Schutz <jjschutz@cpan.org>
4979 Jonathan Rockway C<< <jrockway@cpan.org> >>
4981 Kieren Diment C<kd@totaldatasolution.com>
4983 konobi: Scott McWhirter <konobi@cpan.org>
4985 marcus: Marcus Ramberg <mramberg@cpan.org>
4987 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
4989 mgrimes: Mark Grimes <mgrimes@cpan.org>
4991 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
4995 naughton: David Naughton
4997 ningu: David Kamholz <dkamholz@cpan.org>
4999 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
5001 numa: Dan Sully <daniel@cpan.org>
5007 omega: Andreas Marienborg
5009 Oleg Kostyuk <cub.uanic@gmail.com>
5011 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
5013 rafl: Florian Ragwitz <rafl@debian.org>
5015 random: Roland Lammel <lammel@cpan.org>
5017 Robert Sedlacek C<< <rs@474.at> >>
5019 SpiceMan: Marcel Montes
5023 szbalint: Balint Szilakszi <szbalint@cpan.org>
5025 t0m: Tomas Doran <bobtfish@bobtfish.net>
5029 vanstyn: Henry Van Styn <vanstyn@cpan.org>
5031 Viljo Marrandi C<vilts@yahoo.com>
5033 Will Hawes C<info@whawes.co.uk>
5035 willert: Sebastian Willert <willert@cpan.org>
5037 wreis: Wallace Reis <wreis@cpan.org>
5039 Yuval Kogman, C<nothingmuch@woobling.org>
5041 rainboxx: Matthias Dietrich, C<perl@rainboxx.de>
5043 dd070: Dhaval Dhanani <dhaval070@gmail.com>
5045 Upasana <me@upasana.me>
5047 John Napiorkowski (jnap) <jjnapiork@cpan.org>
5051 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
5055 This library is free software. You can redistribute it and/or modify it under
5056 the same terms as Perl itself.
5062 __PACKAGE__->meta->make_immutable;